class WorkflowStateListBuilder in Workflow 8

Defines a class to build a draggable listing of Workflow State entities.

View source

class WorkflowStateListBuilder extends DraggableListBuilder {

  /**
   * Load the Transitions, and filter for Workflow type.
   *
   * {@inheritdoc}
   */
  public function load() {
    $entities = [];
    if (!($workflow = workflow_url_get_workflow())) {
      return $entities;
    }
    $wid = $workflow
      ->id();

    /** @var \Drupal\workflow\Entity\WorkflowState[] $entities */
    $entities = parent::load();
    foreach ($entities as $key => $entity) {
      if ($entity
        ->getWorkflowId() != $wid) {
        unset($entities[$key]);
      }
    }
    return $entities;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'workflow_state_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {

    // The column 'weight' is added by parent in the draggable EntityList.
    //  $header['weight'] = $this->t('Weight');
    // Some columns are not welcome in the list.
    //  $header['module'] = $this->t('Module');
    //  $header['wid'] = $this->t('Workflow');
    //  $header['sysid'] = $this->t('Sysid');
    // Add separate empty column for Drag handle for UX reasons.
    $header['drag_handle'] = '';

    // Column 'label' is manipulated in parent::buildForm(). Use 'label_new'.
    $header['label_new'] = $this
      ->t('Label');
    $header['id'] = $this
      ->t('ID');
    $header['sysid'] = '';
    $header['status'] = $this
      ->t('Active');
    $header['reassign'] = $this
      ->t('Reassign');
    $header['count'] = $this
      ->t('Count');

    // The parent::buildHeader() adds a column for the possible actions
    // and inserts 'edit' and 'delete' links as defined for the entity type.
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row = [];
    if (!($workflow = workflow_url_get_workflow())) {
      return $row;
    }
    $wid = $url_wid = $workflow
      ->id();

    /** @var \Drupal\workflow\Entity\WorkflowState $entity */
    $state = $entity;
    $sid = $state
      ->id();
    $label = $state
      ->label();
    $count = $state
      ->count();

    // Build select options for reassigning states.
    // We put a blank state first for validation.
    $state_options = [
      '' => ' ',
    ];
    $state_options += workflow_get_workflow_state_names($wid, FALSE);

    // Make it impossible to reassign to the same state that is disabled.
    $current_state_options = [];
    if ($state
      ->isActive() && !$state
      ->isCreationState() && $sid) {
      $current_state = [
        $sid => $state_options[$sid],
      ];
      $current_state_options = array_diff($state_options, $current_state);
    }

    /*
     *  Build the Row.
     */

    // The column 'weight' is added by parent in the draggable EntityList.
    //  $row['weight'] = $state->weight;
    // Some columns are not welcome in the list.
    //  $row['module'] = $state->getModule();
    //  $row['wid'] = $state->getWorkflow();
    // Add separate empty column for Drag handle for UX reasons.
    // Drag handle can be invisible at the end of this function.
    $row['drag_handle'] = [
      '#type' => 'label',
    ];

    // Column 'label' is manipulated in parent::buildForm(). Use 'label_new'.
    $row['label_new'] = [
      '#markup' => $label,
      '#type' => 'textfield',
      '#size' => 30,
      '#maxlength' => 255,
      '#default_value' => $label,
      '#title' => NULL,
      // This hides the red 'required' asterisk.
      '#disabled' => !$state
        ->isActive(),
    ];
    $row['id'] = [
      '#type' => 'machine_name',
      '#title' => NULL,
      // This hides the red 'required' asterisk.
      '#size' => 30,
      '#description' => NULL,
      '#disabled' => TRUE,
      '#default_value' => $state
        ->id(),
      // N.B.: Keep machine_name in WorkflowState and ~ListBuilder aligned.
      '#required' => FALSE,
      // @todo D8: enable machine_name as interactive WorkflowState element.
      '#machine_name' => [
        // Add local helper function 'exists' at the bottom of this class.
        'exists' => [
          $this,
          'exists',
        ],
        // 'source' => ['label_new'],
        'source' => [
          'states',
          $state
            ->id(),
          'label_new',
        ],
        // 'replace_pattern' =>'([^a-z0-9_]+)|(^custom$)',
        // Add '()' characters from exclusion list since creation state has it.
        'replace_pattern' => '[^a-z0-9_()]+',
        // Add '()' characters from exclusion list since creation state has it.
        'error' => $this
          ->t('The machine-readable name must be unique, and can only contain lowercase letters, numbers, and underscores.'),
      ],
    ];
    $row['sysid'] = [
      '#type' => 'value',
      '#value' => $state->sysid,
    ];
    $row['status'] = [
      '#type' => 'checkbox',
      '#default_value' => $state
        ->isActive(),
      '#disabled' => $state
        ->isCreationState() || !$sid,
    ];

    // The new value of states that are inactivated.
    $row['reassign'] = [
      '#type' => 'select',
      '#options' => $current_state_options,
    ];
    $row['count'] = [
      '#type' => 'value',
      '#value' => $count,
      '#markup' => $count,
    ];
    $row += parent::buildRow($entity);
    if ($state
      ->isCreationState()) {

      // Hide Drag handle for Creation state. It is always first.
      $row['#attributes']['class'] = array_diff($row['#attributes']['class'], [
        'draggable',
      ]);
    }
    if (!$state
      ->isActive() || $state
      ->isCreationState() || !$sid || !$count) {

      // New state and disabled states cannot be reassigned.
      $row['reassign']['#type'] = 'hidden';
      $row['reassign']['#disabled'] = TRUE;
    }
    return $row;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    if (!($workflow = workflow_url_get_workflow())) {
      return $form;
    }
    $form = parent::buildForm($form, $form_state);

    // Add a sticky header.
    $form[$this->entitiesKey] += [
      '#sticky' => TRUE,
    ];
    $wid = $workflow
      ->id();

    // Build select options for reassigning states.
    // We put a blank state first for validation.
    $state_options = workflow_get_workflow_state_names($wid, FALSE);

    // Is this the last state available?
    $form['#last_mohican'] = count($state_options) == 1;
    $form['entities']['#prefix'] = '<div id="states_table_wrapper">';
    $form['entities']['#suffix'] = '</div>';

    // Create a placeholder WorkflowState (It must NOT be saved to DB). Add it to the item list.
    if ($form_state
      ->getTriggeringElement() && $form_state
      ->getTriggeringElement()['#name'] === 'add_state') {
      $sid = '';
      $placeholder = $workflow
        ->createState($sid, FALSE);
      $placeholder
        ->set('label', '');
      $this->entities['placeholder'] = $placeholder;
      $form['entities']['placeholder'] = $this
        ->buildRow($placeholder);
    }

    // Rename 'submit' button.
    $form['actions']['submit']['#value'] = $this
      ->t('Save');

    // Add 'Add State' button.
    $form['actions']['add_state'] = [
      '#name' => 'add_state',
      '#type' => 'submit',
      '#value' => $this
        ->t('Add State'),
      '#ajax' => [
        'callback' => '::addStateCallback',
        'wrapper' => 'states_table_wrapper',
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);

    /** @var \Drupal\workflow\Entity\WorkflowState $state */
    $state = $entity;

    /*
     * Allow modules to insert their own workflow operations to the list.
     */

    // This is what EntityListBuilder::getOperations() does:
    // $operations = $this->getDefaultOperations($entity);
    // $operations += $this->moduleHandler()->invokeAll('entity_operation', [$entity]);
    // $this->moduleHandler->alter('entity_operation', $operations, $entity);
    // In D8, the interface of below hook_workflow_operations has changed a bit.
    // @see EntityListBuilder::getOperations, workflow_operations, workflow.api.php.
    $operations += $this
      ->moduleHandler()
      ->invokeAll('workflow_operations', [
      'state',
      $state,
    ]);
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // @todo D8: enable WorkflowState machine_name as interactive element.
    foreach ($form_state
      ->getValue($this->entitiesKey) as $sid => $value) {

      /** @var \Drupal\workflow\Entity\WorkflowState $state */
      $state = isset($this->entities[$sid]) ? $this->entities[$sid] : NULL;

      // State is de-activated (reassigning current content).
      if ($state && $state
        ->isActive() && !$value['status']) {
        $args = [
          '%state' => $state
            ->label(),
        ];

        // Does that state have content in it?
        if (!$form['#last_mohican'] && $value['count'] > 0 && empty($value['reassign'])) {
          $message = 'The %state state has content; you must
              reassign the content to another state.';
          $form_state
            ->setErrorByName("states'][{$sid}]['reassign'", $this
            ->t($message, $args));
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   *
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if (!($workflow = workflow_url_get_workflow())) {
      return [];
    }

    // The default min_weight is -10. Work with it.
    $creation_weight = -11;
    $max_weight = -9;

    // The WorkflowState entities are always saved.
    foreach ($form_state
      ->getValue($this->entitiesKey) as $sid => $value) {
      if (!isset($this->entities[$sid])) {
        continue;
      }
      if (empty($value['label_new'])) {

        // No new state/state name entered, so skip it.
        continue;
      }

      /** @var \Drupal\workflow\Entity\WorkflowState $state */
      $state = $this->entities[$sid];
      if ($state && $state
        ->isActive() && !$value['status'] && $sid) {

        // State is deactivated, reassigning current content.
        $new_sid = $value['reassign'];
        $new_state = WorkflowState::load($new_sid);
        $args = [
          '%workflow' => $workflow
            ->label(),
          '%old_state' => $state
            ->label(),
          '%new_state' => isset($new_state) ? $new_state
            ->label() : '',
        ];
        if ($value['count'] > 0) {
          if ($form['#last_mohican']) {

            // Do not reassign to new state.
            $new_sid = NULL;
            $message = 'Removing workflow states from content in the %workflow.';
            $this
              ->messenger()
              ->addStatus($this
              ->t($message, $args));
            $message = 'Since you have deleted the last available
                workflow state in this workflow, all content items
                which with this %workflow workflow have their workflow state
                removed.';
            $this
              ->messenger()
              ->addWarning($this
              ->t($message, $args));
          }
          else {

            // Prepare the state delete function.
            $message = 'Reassigning content from %old_state to %new_state.';
            $this
              ->messenger()
              ->addStatus($this
              ->t($message, $args));
          }
        }

        // Delete old State without orphaning content by moving it to new State.
        $state
          ->deactivate($new_sid);
        $message = $this
          ->t('Deactivated workflow state %old_state in %workflow.', $args);
        \Drupal::logger('workflow')
          ->notice($message, []);
        $this
          ->messenger()
          ->addStatus($message);
      }
      $weight = $value['weight'];
      if ($value['sysid'] == WORKFLOW_CREATION_STATE) {

        // Assure Creation state is first in line.
        $weight = $creation_weight;
      }
      elseif ($sid === 'placeholder') {

        // Add a new State.
        $state
          ->set('id', $value['id']);

        // Set a proper weight to the new state, adding as last.
        $max_weight = max($max_weight, $state
          ->get($this->weightKey));
        $weight = $max_weight + 1;
      }
      $state
        ->set($this->weightKey, $weight);
      $state
        ->set('label', $value['label_new']);
      $state
        ->set('status', $value['status']);
      try {
        $state
          ->save();
      } catch (\Exception $e) {
        $args = [
          '%id' => $state
            ->id(),
        ];
        return $this
          ->messenger()
          ->addError($this
          ->t('ID %id already exists', $args));
      }
    }
    if ($form_state
      ->getTriggeringElement()['#name'] === 'add_state') {

      // Unset previous input in placeholder and rebuild the form.
      $input = $form_state
        ->getUserInput();
      unset($input['entities']['placeholder']['label_new']);
      $form_state
        ->setUserInput($input);
      $form_state
        ->setRebuild();
    }
    return $this
      ->messenger()
      ->addStatus($this
      ->t('The Workflow states have been updated.'));
  }

  /**
   * Button 'Add State' callback.
   *
   * @param array $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *
   * @return array
   */
  public function addStateCallback(array &$form, FormStateInterface $form_state) {
    return $form['entities'];
  }

  /**
   * Validate duplicate machine names.
   *
   * Function is registered in 'machine_name' form element.
   *
   * @param string $name
   * @param array $element
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *
   * @return bool
   */
  public function exists($name, array $element, FormStateInterface $form_state) {
    $state_names = [];
    foreach ($form_state
      ->getValue($this->entitiesKey) as $sid => $value) {
      $state_names[] = $value['id'];
    }
    $state_names = array_map('strtolower', $state_names);
    $result = array_unique(array_diff_assoc($state_names, array_unique($state_names)));
    if (in_array($name, $result)) {
      return TRUE;
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DraggableListBuilder::$entities	protected	property	The entities being listed.	1
DraggableListBuilder::$entitiesKey	protected	property	The key to use for the form element containing the entities.	3
DraggableListBuilder::$formBuilder	protected	property	The form builder.
DraggableListBuilder::$limit	protected	property	The number of entities to list per page, or FALSE to list all entities. Overrides EntityListBuilder::$limit
DraggableListBuilder::$weightKey	protected	property	Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilder::formBuilder	protected	function	Returns the form builder.
DraggableListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render	1
DraggableListBuilder::__construct	public	function	Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct	5
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	2
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	2
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityListBuilder::$entityType	protected	property	Information about the entity type.
EntityListBuilder::$entityTypeId	protected	property	The entity type ID.
EntityListBuilder::$storage	protected	property	The entity storage class.	1
EntityListBuilder::buildOperations	public	function	Builds a renderable list of operation links for the entity.	2
EntityListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance	20
EntityListBuilder::ensureDestination	protected	function	Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id.	4
EntityListBuilder::getLabel Deprecated	protected	function	Gets the label of an entity.
EntityListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations	2
EntityListBuilder::getStorage	public	function	Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle	protected	function	Gets the title of the page.	1
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
WorkflowStateListBuilder::addStateCallback	public	function	Button 'Add State' callback.
WorkflowStateListBuilder::buildForm	public	function	Form constructor. Overrides DraggableListBuilder::buildForm
WorkflowStateListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides DraggableListBuilder::buildHeader
WorkflowStateListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides DraggableListBuilder::buildRow
WorkflowStateListBuilder::exists	public	function	Validate duplicate machine names.
WorkflowStateListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
WorkflowStateListBuilder::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
WorkflowStateListBuilder::load	public	function	Load the Transitions, and filter for Workflow type. Overrides ConfigEntityListBuilder::load
WorkflowStateListBuilder::submitForm	public	function	Form submission handler. Overrides DraggableListBuilder::submitForm
WorkflowStateListBuilder::validateForm	public	function	Form validation handler. Overrides DraggableListBuilder::validateForm

You are here

class WorkflowStateListBuilder in Workflow 8

Hierarchy

See also

File

Namespace

Members

API Navigation