class Transition in Drupal 9

A transition value object that describes the transition between states.

Hierarchy

• class \Drupal\workflows\Transition implements TransitionInterface

5 files declare their use of Transition

EntityModerationForm.php in core/modules/content_moderation/src/Form/EntityModerationForm.php

StateTransitionValidation.php in core/modules/content_moderation/src/StateTransitionValidation.php

TransitionTest.php in core/modules/workflows/tests/src/Unit/TransitionTest.php

WorkflowTest.php in core/modules/workflows/tests/src/Unit/WorkflowTest.php

WorkflowTypeBase.php in core/modules/workflows/src/Plugin/WorkflowTypeBase.php

2 string references to 'Transition'

WorkflowStateEditForm::form in core/modules/workflows/src/Form/WorkflowStateEditForm.php

Gets the actual form array to be built.

workflows_help in core/modules/workflows/workflows.module

Implements hook_help().

File

core/modules/workflows/src/Transition.php, line 8

Namespace

Drupal\workflows

class Transition implements TransitionInterface {

  /**
   * The workflow that this transition is attached to.
   *
   * @var \Drupal\workflows\WorkflowTypeInterface
   */
  protected $workflow;

  /**
   * The transition's ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The transition's label.
   *
   * @var string
   */
  protected $label;

  /**
   * The transition's from state IDs.
   *
   * @var string[]
   */
  protected $fromStateIds;

  /**
   * The transition's to state ID.
   *
   * @var string
   */
  protected $toStateId;

  /**
   * The transition's weight.
   *
   * @var int
   */
  protected $weight;

  /**
   * Transition constructor.
   *
   * @param \Drupal\workflows\WorkflowTypeInterface $workflow
   *   The workflow the state is attached to.
   * @param string $id
   *   The transition's ID.
   * @param string $label
   *   The transition's label.
   * @param array $from_state_ids
   *   A list of from state IDs.
   * @param string $to_state_id
   *   The to state ID.
   * @param int $weight
   *   (optional) The transition's weight. Defaults to 0.
   */
  public function __construct(WorkflowTypeInterface $workflow, $id, $label, array $from_state_ids, $to_state_id, $weight = 0) {
    $this->workflow = $workflow;
    $this->id = $id;
    $this->label = $label;
    $this->fromStateIds = $from_state_ids;
    $this->toStateId = $to_state_id;
    $this->weight = $weight;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function from() {
    return $this->workflow
      ->getStates($this->fromStateIds);
  }

  /**
   * {@inheritdoc}
   */
  public function to() {
    return $this->workflow
      ->getState($this->toStateId);
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
Transition::$fromStateIds	protected	property	The transition's from state IDs.
Transition::$id	protected	property	The transition's ID.
Transition::$label	protected	property	The transition's label.
Transition::$toStateId	protected	property	The transition's to state ID.
Transition::$weight	protected	property	The transition's weight.
Transition::$workflow	protected	property	The workflow that this transition is attached to.
Transition::from	public	function	Gets the transition's from states. Overrides TransitionInterface::from
Transition::id	public	function	Gets the transition's ID. Overrides TransitionInterface::id
Transition::label	public	function	Gets the transition's label. Overrides TransitionInterface::label
Transition::to	public	function	Gets the transition's to state. Overrides TransitionInterface::to
Transition::weight	public	function	Gets the transition's weight. Overrides TransitionInterface::weight
Transition::__construct	public	function	Transition constructor.
TransitionInterface::DIRECTION_FROM		constant	The transition direction from.
TransitionInterface::DIRECTION_TO		constant	The transition direction to.
TransitionInterface::PLUGIN_FORM_KEY		constant	The key of the transition plugin form.