public function WorkflowTransitionListController::historyOverview in Workflow 8

Shows a list of an entity's state transitions, but only if WorkflowHistoryAccess::access() allows it.

Parameters

\Drupal\Core\Entity\EntityInterface $node: A node object.

Return value

array An array as expected by drupal_render().

File

src/Controller/WorkflowTransitionListController.php, line 78

Class

WorkflowTransitionListController

Defines a controller to list Transition on entity's Workflow history tab.

Namespace

Drupal\workflow\Controller

Code

public function historyOverview(EntityInterface $node = NULL) {
  $form = [];

  // @todo D8: make Workflow History tab happen for every entity_type.
  // For workflow_tab_page with multiple workflows, use a separate view. See [#2217291].
  // @see workflow.routing.yml, workflow.links.task.yml, WorkflowTransitionListController.
  // workflow_debug(__FILE__, __FUNCTION__, __LINE__);  // @todo D8: test this snippet.
  // ATM it only works for Nodes and Terms.
  // This is a hack. The Route should always pass an object.
  // On view tab, $entity is object,
  // On workflow tab, $entity is id().
  // Get the entity for this form.
  if (!($entity = workflow_url_get_entity($node))) {
    return $form;
  }

  /*
   * Get derived data from parameters.
   */
  if (!($field_name = workflow_get_field_name($entity, workflow_url_get_field_name()))) {
    return $form;
  }

  /*
   * Step 1: generate the Transition Form.
   */

  // Add the WorkflowTransitionForm to the page.
  $form = WorkflowManager::getWorkflowTransitionForm($entity, $field_name, []);

  /*
   * Step 2: generate the Transition History List.
   */
  $view = NULL;
  if ($this->moduleHandler
    ->moduleExists('views')) {
    $view = Views::getView('workflow_entity_history');
    if (is_object($view) && $view->storage
      ->status()) {

      // Add the history list from configured Views display.
      $args = [
        $entity
          ->id(),
      ];
      $view
        ->setArguments($args);
      $view
        ->setDisplay('workflow_history_tab');
      $view
        ->preExecute();
      $view
        ->execute();
      $form['table'] = $view
        ->buildRenderable();
    }
  }
  if (!is_object($view)) {

    // @deprecated. Use the Views display above.
    // Add the history list from programmed WorkflowTransitionListController.
    $entity_type = 'workflow_transition';
    $list_builder = $this
      ->entityTypeManager()
      ->getListBuilder($entity_type);

    // Add the Node explicitly, since $list_builder expects a Transition.
    $list_builder->workflow_entity = $entity;
    $form += $list_builder
      ->render();
  }

  /*
   * Finally: sort the elements (overriding their weight).
   */
  $form['actions']['#weight'] = 100;
  $form['table']['#weight'] = 201;
  return $form;
}