You are here

Home » API reference » Workflow 7.2 » EntityWorkflowUIController.php

class EntityWorkflowUIController in Workflow 7.2

@file Contains workflow_admin_ui\includes\Entity\EntityWorkflowUIController.

Hierarchy

Expanded class hierarchy of EntityWorkflowUIController

1 string reference to 'EntityWorkflowUIController'
workflow_admin_ui_entity_info_alter in workflow_admin_ui/workflow_admin_ui.module
Implements hook_entity_info_alter().

File

workflow_admin_ui/includes/Entity/EntityWorkflowUIController.php, line 8
Contains workflow_admin_ui\includes\Entity\EntityWorkflowUIController.

View source 
class EntityWorkflowUIController extends EntityDefaultUIController {

  /**
   * Provides definitions for implementing hook_menu().
   */
  public function hook_menu() {
    $items = parent::hook_menu();

    // Set this on the object so classes that extend hook_menu() can use it.
    $admin_path = $this->path;
    $id_count = count(explode('/', $admin_path));
    $wildcard = isset($this->entityInfo['admin ui']['menu wildcard']) ? $this->entityInfo['admin ui']['menu wildcard'] : '%entity_object';
    $plural_label = isset($this->entityInfo['plural label']) ? $this->entityInfo['plural label'] : $this->entityInfo['label'] . 's';
    $entityType = $this->entityInfo['entity class'];

    // @todo: Allow modules to insert their own action links to the 'workflow',
    // $workflow_operations = module_invoke_all('workflow_operations', 'workflow', NULL);
    $item = array(
      'file path' => isset($this->entityInfo['admin ui']['file path']) ? $this->entityInfo['admin ui']['file path'] : drupal_get_path('module', $this->entityInfo['module']),
      'access arguments' => array(
        'administer workflow',
      ),
      'type' => MENU_LOCAL_TASK,
    );
    $items["{$admin_path}/manage/{$wildcard}/states"] = $item + array(
      'file' => 'workflow_admin_ui/workflow_admin_ui.page.states.inc',
      'title' => 'States',
      'weight' => '11',
      'page callback' => 'drupal_get_form',
      'page arguments' => array(
        'workflow_admin_ui_states_form',
        $id_count + 1,
        $id_count + 2,
      ),
    );
    $items["{$admin_path}/manage/{$wildcard}/transitions"] = $item + array(
      'file' => 'workflow_admin_ui/workflow_admin_ui.page.transitions.inc',
      'title' => 'Transitions',
      'weight' => '12',
      'page callback' => 'drupal_get_form',
      'page arguments' => array(
        'workflow_admin_ui_transitions_form',
        $id_count + 1,
        $id_count + 2,
      ),
    );
    $items["{$admin_path}/manage/{$wildcard}/labels"] = $item + array(
      'file' => 'workflow_admin_ui/workflow_admin_ui.page.labels.inc',
      'title' => 'Labels',
      'weight' => '13',
      'page callback' => 'drupal_get_form',
      'page arguments' => array(
        'workflow_admin_ui_labels_form',
        $id_count + 1,
        $id_count + 2,
      ),
    );
    $items["{$admin_path}/manage/{$wildcard}/permissions"] = $item + array(
      'file' => 'workflow_admin_ui/workflow_admin_ui.page.permissions.inc',
      'title' => 'Permission summary',
      'weight' => '14',
      'page callback' => 'workflow_admin_ui_view_permissions_form',
      'page arguments' => array(
        $id_count + 1,
        $id_count + 2,
      ),
    );
    return $items;
  }
  protected function operationCount() {

    // Add more then enough colspan.
    return parent::operationCount() + 8;
  }

  /*
   public function operationForm($form, &$form_state, $entity, $op) {}
  */
  public function overviewForm($form, &$form_state) {

    // Add table and pager.
    $form = parent::overviewForm($form, $form_state);

    // Allow modules to insert their own action links to the 'table', like cleanup module.
    $top_actions = module_invoke_all('workflow_operations', 'top_actions', NULL);

    // Allow modules to insert their own workflow operations.
    foreach ($form['table']['#rows'] as &$row) {
      $url = $row[0]['data']['#url'];
      $workflow = $url['options']['entity'];
      foreach ($actions = module_invoke_all('workflow_operations', 'workflow', $workflow) as $action) {
        $action['attributes'] = isset($action['attributes']) ? $action['attributes'] : array();
        $row[] = l(strtolower($action['title']), $action['href'], $action['attributes']);
      }
    }

    // @todo: add these top actions next to the core 'Add workflow' action.
    $top_actions_args = array(
      'links' => $top_actions,
      'attributes' => array(
        'class' => array(
          'inline',
          'action-links',
        ),
      ),
    );
    $form['action-links'] = array(
      '#type' => 'markup',
      '#markup' => theme('links', $top_actions_args),
      '#weight' => -1,
    );
    if (module_exists('workflownode')) {

      // Append the type_map form, changing the form by reference.
      // The 'type_map' form is only valid for Workflow Node API.
      module_load_include('inc', 'workflow_admin_ui', 'workflow_admin_ui.page.type_map');
      workflow_admin_ui_type_map_form($form);
    }

    // Add a submit button. The submit functions are added in the sub-forms.
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Save'),
      '#weight' => 100,
    );
    return $form;
  }

  /*
   * Avoids the 'Delete' action if the Workflow is used somewhere.
   */
  protected function overviewTableRow($conditions, $id, $entity, $additional_cols = array()) {

    // Avoid the 'delete' operation if the Workflow is used somewhere.
    $status = $entity->status;

    // @see parent::overviewTableRow() how to determine a deletable entity.
    if (!entity_has_status($this->entityType, $entity, ENTITY_IN_CODE) && !$entity
      ->isDeletable()) {

      // Set to a state that does not allow deleting, but allows other actions.
      $entity->status = ENTITY_IN_CODE;
    }
    $row = parent::overviewTableRow($conditions, $id, $entity, $additional_cols);

    // Just to be sure: reset status.
    $entity->status = $status;
    return $row;
  }

  /**
   * Overrides the 'revert' action, to not delete the workflows.
   *
   * @see https://www.drupal.org/node/2051079
   * @see https://www.drupal.org/node/1043634
   */
  public function applyOperation($op, $entity) {
    $admin_path = $this->path;
    $label = entity_label($this->entityType, $entity);
    $vars = array(
      '%entity' => $this->entityInfo['label'],
      '%label' => $label,
    );
    $wid = entity_id($this->entityType, $entity);
    $edit_link = l(t('edit'), "{$admin_path}/manage/{$wid}/edit");
    switch ($op) {
      case 'revert':
        $defaults = workflow_get_defaults($entity->module);
        workflow_revert($defaults, $entity
          ->getName());
        watchdog($this->entityType, 'Reverted %entity %label to the defaults.', $vars, WATCHDOG_NOTICE, $edit_link);
        return t('Reverted %entity %label to the defaults.', $vars);
      case 'delete':
      case 'import':
      default:
        return parent::applyOperation($op, $entity);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
EntityDefaultUIController::$entityInfo protected property
EntityDefaultUIController::$entityType protected property
EntityDefaultUIController::$id_count protected property
EntityDefaultUIController::$overviewPagerLimit public property Defines the number of entries to show per page in overview table.
EntityDefaultUIController::entityFormSubmitBuildEntity public function Entity submit builder invoked via entity_ui_form_submit_build_entity().
EntityDefaultUIController::hook_forms public function Provides definitions for implementing hook_forms().
EntityDefaultUIController::operationForm public function Builds the operation form.
EntityDefaultUIController::operationFormSubmit public function Operation form submit callback. 1
EntityDefaultUIController::operationFormValidate public function Operation form validation callback.
EntityDefaultUIController::overviewFormSubmit public function Overview form submit callback.
EntityDefaultUIController::overviewFormValidate public function Overview form validation callback.
EntityDefaultUIController::overviewTable public function Generates the render array for a overview table for arbitrary entities matching the given conditions.
EntityDefaultUIController::overviewTableHeaders protected function Generates the table headers for the overview table.
EntityDefaultUIController::__construct public function
EntityWorkflowUIController::applyOperation public function Overrides the 'revert' action, to not delete the workflows. Overrides EntityDefaultUIController::applyOperation
EntityWorkflowUIController::hook_menu public function Provides definitions for implementing hook_menu(). Overrides EntityDefaultUIController::hook_menu
EntityWorkflowUIController::operationCount protected function Returns the operation count for calculating colspans. Overrides EntityDefaultUIController::operationCount
EntityWorkflowUIController::overviewForm public function Builds the entity overview form. Overrides EntityDefaultUIController::overviewForm
EntityWorkflowUIController::overviewTableRow protected function Generates the row for the passed entity and may be overridden in order to customize the rows. Overrides EntityDefaultUIController::overviewTableRow