WorkflowConfigTransition.php in Workflow 8

Namespace

Drupal\workflow\Entity

File

src/Entity/WorkflowConfigTransition.php

<?php

namespace Drupal\workflow\Entity;

use Drupal\Core\Config\Entity\ConfigEntityBase;
use Drupal\Core\Config\Entity\ConfigEntityInterface;
use Drupal\user\UserInterface;
use Drupal\workflow\WorkflowTypeAttributeTrait;
use Drupal\workflow\WorkflowURLRouteParametersTrait;

/**
 * Workflow configuration entity to persistently store configuration.
 *
 * @ConfigEntityType(
 *   id = "workflow_config_transition",
 *   label = @Translation("Workflow config transition"),
 *   label_singular = @Translation("Workflow config transition"),
 *   label_plural = @Translation("Workflow config transitions"),
 *   label_count = @PluralTranslation(
 *     singular = "@count Workflow config transition",
 *     plural = "@count Workflow config transitions",
 *   ),
 *   module = "workflow",
 *   translatable = FALSE,
 *   handlers = {
 *     "form" = {
 *        "delete" = "\Drupal\Core\Entity\EntityDeleteForm",
 *      }
 *   },
 *   admin_permission = "administer workflow",
 *   config_prefix = "transition",
 *   entity_keys = {
 *     "id" = "id",
 *     "label" = "label",
 *   },
 *   config_export = {
 *     "id",
 *     "label",
 *     "module",
 *     "from_sid",
 *     "to_sid",
 *     "roles",
 *   },
 *   links = {
 *     "collection" = "/admin/config/workflow/workflow/{workflow_type}/transitions",
 *   },
 * )
 */
class WorkflowConfigTransition extends ConfigEntityBase implements WorkflowConfigTransitionInterface {

  /*
   * Add variables and get/set methods for Workflow property.
   */
  use WorkflowTypeAttributeTrait;

  /*
   * Provide URL route parameters for entity links.
   */
  use WorkflowURLRouteParametersTrait;

  /**
   * Transition data.
   */
  public $id;
  public $from_sid;
  public $to_sid;
  public $roles = [];

  /**
   * The module implementing this object, for config_export.
   *
   * @var string
   */
  protected $module = 'workflow';

  /*
   * Entity class functions.
   */

  /**
   * {@inheritdoc}
   */
  public function __construct(array $values = [], $entityType = NULL) {

    // Please be aware that $entity_type and $entityType are different things!
    parent::__construct($values, $entity_type = 'workflow_config_transition');
    $state = WorkflowState::load($this->to_sid ? $this->to_sid : $this->from_sid);
    if ($state) {
      $this
        ->setWorkflow($state
        ->getWorkflow());
    }
  }

  /**
   * Helper function for __construct.
   *
   * Used for WorkflowTransition ánd WorkflowScheduledTransition.
   */
  public function setValues() {
    $state = WorkflowState::load($this->to_sid ? $this->to_sid : $this->from_sid);
    if ($state) {
      $this
        ->setWorkflow($state
        ->getWorkflow());
    }
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();
    $this
      ->addDependency('config', $this
      ->getFromState()
      ->getConfigDependencyName());
    $this
      ->addDependency('config', $this
      ->getToState()
      ->getConfigDependencyName());
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function save() {
    $workflow = $this
      ->getWorkflow();

    // To avoid double posting, check if this (new) transition already exist.
    if (empty($this
      ->id())) {
      if ($workflow) {
        $config_transitions = $workflow
          ->getTransitionsByStateId($this->from_sid, $this->to_sid);
        $config_transition = reset($config_transitions);
        if ($config_transition) {
          $this
            ->set('id', $config_transition
            ->id());
        }
      }
    }

    // Create the machine_name.
    // This can be used to rebuild/revert the Feature in a target system.
    if (empty($this
      ->id())) {
      $wid = $workflow
        ->id();
      $this
        ->set('id', implode('', [
        $wid,
        substr($this->from_sid, strlen($wid)),
        substr($this->to_sid, strlen($wid)),
      ]));
    }
    $status = parent::save();
    if ($status) {

      // Save in current workflow for the remainder of this page request.
      // Keep in sync with Workflow::getTransitions() !
      if ($workflow) {
        $workflow->transitions[$this
          ->id()] = $this;

        // $workflow->sortTransitions();
      }
    }
    return $status;
  }

  /**
   * {@inheritdoc}
   */
  public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) {

    // Sort the entities using the entity class's sort() method.
    // See \Drupal\Core\Config\Entity\ConfigEntityBase::sort().

    /** @var \Drupal\workflow\Entity\WorkflowTransitionInterface $a */

    /** @var \Drupal\workflow\Entity\WorkflowTransitionInterface $b */
    if (!$a
      ->getFromSid() || !$b
      ->getFromSid()) {
      return 0;
    }

    // First sort on From-State.
    $from_state_a = $a
      ->getFromState();
    $from_state_b = $b
      ->getFromState();
    if ($from_state_a->weight < $from_state_b->weight) {
      return -1;
    }
    if ($from_state_a->weight > $from_state_b->weight) {
      return +1;
    }

    // Then sort on To-State.
    $to_state_a = $a
      ->getToState();
    $to_state_b = $b
      ->getToState();
    if ($to_state_a->weight < $to_state_b->weight) {
      return -1;
    }
    if ($to_state_a->weight > $to_state_b->weight) {
      return +1;
    }
    return 0;
  }

  /**
   * Property functions.
   */

  /**
   * {@inheritdoc}
   */
  public function getFromState() {
    return WorkflowState::load($this->from_sid);
  }

  /**
   * {@inheritdoc}
   */
  public function getToState() {
    return WorkflowState::load($this->to_sid);
  }

  /**
   * {@inheritdoc}
   */
  public function getFromSid() {
    return $this->from_sid;
  }

  /**
   * {@inheritdoc}
   */
  public function getToSid() {
    return $this->to_sid;
  }

  /**
   * {@inheritdoc}
   */
  public function isAllowed(UserInterface $user, $force = FALSE) {
    $type_id = $this
      ->getWorkflowId();
    if ($user
      ->hasPermission("bypass {$type_id} workflow_transition access")) {

      // Superuser is special. And $force allows Rules to cause transition.
      return TRUE;
    }
    if ($force) {
      return TRUE;
    }
    if ($this
      ->getFromSid() == $this
      ->getToSid()) {

      // Anyone may save an entity without changing state.
      return TRUE;
    }
    return TRUE == array_intersect($user
      ->getRoles(), $this->roles);
  }

  /**
   * Determines if the State changes by this Transition.
   *
   * @return bool
   *   TRUE if this Transition changes the state value.
   */
  public function hasStateChange() {
    if ($this->from_sid == $this->to_sid) {
      return FALSE;
    }
    return TRUE;
  }

}

Classes

Name	Description
WorkflowConfigTransition	Workflow configuration entity to persistently store configuration.