interface TransitionInterface in Drupal 9

A transition value object that describes the transition between two states.

@internal The TransitionInterface should only be used by Workflows and Content Moderation.

@todo Revisit the need for this in https://www.drupal.org/node/2902309.

Hierarchy

• interface \Drupal\workflows\TransitionInterface

3 files declare their use of TransitionInterface

WorkflowTransitionAddForm.php in core/modules/workflows/src/Form/WorkflowTransitionAddForm.php

WorkflowTransitionEditForm.php in core/modules/workflows/src/Form/WorkflowTransitionEditForm.php

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

File

core/modules/workflows/src/TransitionInterface.php, line 14

Namespace

Drupal\workflows

interface TransitionInterface {

  /**
   * The key of the transition plugin form.
   */
  const PLUGIN_FORM_KEY = 'transition';

  /**
   * The transition direction from.
   */
  const DIRECTION_FROM = 'from';

  /**
   * The transition direction to.
   */
  const DIRECTION_TO = 'to';

  /**
   * Gets the transition's ID.
   *
   * @return string
   *   The transition's ID.
   */
  public function id();

  /**
   * Gets the transition's label.
   *
   * @return string
   *   The transition's label.
   */
  public function label();

  /**
   * Gets the transition's from states.
   *
   * @return \Drupal\workflows\StateInterface[]
   *   The transition's from states.
   */
  public function from();

  /**
   * Gets the transition's to state.
   *
   * @return \Drupal\workflows\StateInterface
   *   The transition's to state.
   */
  public function to();

  /**
   * Gets the transition's weight.
   *
   * @return string
   *   The transition's weight.
   */
  public function weight();

}

Members

Name	Modifiers	Type	Description	Overrides
TransitionInterface::DIRECTION_FROM		constant	The transition direction from.
TransitionInterface::DIRECTION_TO		constant	The transition direction to.
TransitionInterface::from	public	function	Gets the transition's from states.	1
TransitionInterface::id	public	function	Gets the transition's ID.	1
TransitionInterface::label	public	function	Gets the transition's label.	1
TransitionInterface::PLUGIN_FORM_KEY		constant	The key of the transition plugin form.
TransitionInterface::to	public	function	Gets the transition's to state.	1
TransitionInterface::weight	public	function	Gets the transition's weight.	1