function StateInterface::getTransitionTo

Same name in other branches
  1. 9 core/modules/workflows/src/StateInterface.php \Drupal\workflows\StateInterface::getTransitionTo()
  2. 8.9.x core/modules/workflows/src/StateInterface.php \Drupal\workflows\StateInterface::getTransitionTo()
  3. 10 core/modules/workflows/src/StateInterface.php \Drupal\workflows\StateInterface::getTransitionTo()

Gets the Transition object for the provided state ID.

Parameters

$to_state_id: The state to transition to.

Return value

\Drupal\workflows\TransitionInterface The Transition object for the provided state ID.

Throws

\InvalidArgumentException Exception thrown when the provided state ID can not be transitioned to.

2 methods override StateInterface::getTransitionTo()
ContentModerationState::getTransitionTo in core/modules/content_moderation/src/ContentModerationState.php
Gets the Transition object for the provided state ID.
State::getTransitionTo in core/modules/workflows/src/State.php
Gets the Transition object for the provided state ID.

File

core/modules/workflows/src/StateInterface.php, line 66

Class

StateInterface
An interface for state value objects.

Namespace

Drupal\workflows

Code

public function getTransitionTo($to_state_id);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.