/**
* Provides an interface for defining workflow entities.
- *
- * @internal
- * The workflow system is currently experimental and should only be leveraged
- * by experimental modules and development releases of contributed modules.
*/
interface WorkflowInterface extends ConfigEntityInterface {
- /**
- * Adds a state to the workflow.
- *
- * @param string $state_id
- * The state's ID.
- * @param string $label
- * The state's label.
- *
- * @return \Drupal\workflows\WorkflowInterface
- * The workflow entity.
- */
- public function addState($state_id, $label);
-
- /**
- * Determines if the workflow has a state with the provided ID.
- *
- * @param string $state_id
- * The state's ID.
- *
- * @return bool
- * TRUE if the workflow has a state with the provided ID, FALSE if not.
- */
- public function hasState($state_id);
-
- /**
- * Gets state objects for the provided state IDs.
- *
- * @param string[] $state_ids
- * A list of state IDs to get. If NULL then all states will be returned.
- *
- * @return \Drupal\workflows\StateInterface[]
- * An array of workflow states.
- *
- * @throws \InvalidArgumentException
- * Thrown if $state_ids contains a state ID that does not exist.
- */
- public function getStates($state_ids = NULL);
-
- /**
- * Gets a workflow state.
- *
- * @param string $state_id
- * The state's ID.
- *
- * @return \Drupal\workflows\StateInterface
- * The workflow state.
- *
- * @throws \InvalidArgumentException
- * Thrown if $state_id does not exist.
- */
- public function getState($state_id);
-
- /**
- * Sets a state's label.
- *
- * @param string $state_id
- * The state ID to set the label for.
- * @param string $label
- * The state's label.
- *
- * @return \Drupal\workflows\WorkflowInterface
- * The workflow entity.
- */
- public function setStateLabel($state_id, $label);
-
- /**
- * Sets a state's weight value.
- *
- * @param string $state_id
- * The state ID to set the weight for.
- * @param int $weight
- * The state's weight.
- *
- * @return \Drupal\workflows\WorkflowInterface
- * The workflow entity.
- */
- public function setStateWeight($state_id, $weight);
-
- /**
- * Deletes a state from the workflow.
- *
- * @param string $state_id
- * The state ID to delete.
- *
- * @return \Drupal\workflows\WorkflowInterface
- * The workflow entity.
- *
- * @throws \InvalidArgumentException
- * Thrown if $state_id does not exist.
- */
- public function deleteState($state_id);
-
- /**
- * Adds a transition to the workflow.
- *
- * @param string $id
- * The transition ID.
- * @param string $label
- * The transition's label.
- * @param array $from_state_ids
- * The state IDs to transition from.
- * @param string $to_state_id
- * The state ID to transition to.
- *
- * @return \Drupal\workflows\WorkflowInterface
- * The workflow entity.
- *
- * @throws \InvalidArgumentException
- * Thrown if either state does not exist.
- */
- public function addTransition($id, $label, array $from_state_ids, $to_state_id);
-
- /**
- * Gets a transition object for the provided transition ID.
- *
- * @param string $transition_id
- * A transition ID.
- *
- * @return \Drupal\workflows\TransitionInterface
- * The transition.
- *
- * @throws \InvalidArgumentException
- * Thrown if $transition_id does not exist.
- */
- public function getTransition($transition_id);
-
- /**
- * Determines if a transition exists.
- *
- * @param string $transition_id
- * The transition ID.
- *
- * @return bool
- * TRUE if the transition exists, FALSE if not.
- */
- public function hasTransition($transition_id);
-
- /**
- * Gets transition objects for the provided transition IDs.
- *
- * @param string[] $transition_ids
- * A list of transition IDs to get. If NULL then all transitions will be
- * returned.
- *
- * @return \Drupal\workflows\TransitionInterface[]
- * An array of transition objects.
- *
- * @throws \InvalidArgumentException
- * Thrown if $transition_ids contains a transition ID that does not exist.
- */
- public function getTransitions(array $transition_ids = NULL);
-
- /**
- * Gets the transition IDs for a state for the provided direction.
- *
- * @param $state_id
- * The state to get transitions for.
- * @param string $direction
- * (optional) The direction of the transition. Defaults to 'from'. Possible
- * values are: 'from' and 'to'.
- *
- * @return array
- * The transition IDs for a state for the provided direction.
- */
- public function getTransitionsForState($state_id, $direction = 'from');
-
- /**
- * Gets a transition from state to state.
- *
- * @param string $from_state_id
- * The state ID to transition from.
- * @param string $to_state_id
- * The state ID to transition to.
- *
- * @return \Drupal\workflows\TransitionInterface
- * The transitions.
- *
- * @throws \InvalidArgumentException
- * Thrown if the transition does not exist.
- */
- public function getTransitionFromStateToState($from_state_id, $to_state_id);
-
- /**
- * Determines if a transition from state to state exists.
- *
- * @param string $from_state_id
- * The state ID to transition from.
- * @param string $to_state_id
- * The state ID to transition to.
- *
- * @return bool
- * TRUE if the transition exists, FALSE if not.
- */
- public function hasTransitionFromStateToState($from_state_id, $to_state_id);
-
- /**
- * Sets a transition's label.
- *
- * @param string $transition_id
- * The transition ID.
- * @param string $label
- * The transition's label.
- *
- * @return \Drupal\workflows\WorkflowInterface
- * The workflow entity.
- *
- * @throws \InvalidArgumentException
- * Thrown if the transition does not exist.
- */
- public function setTransitionLabel($transition_id, $label);
-
- /**
- * Sets a transition's weight.
- *
- * @param string $transition_id
- * The transition ID.
- * @param int $weight
- * The transition's weight.
- *
- * @return \Drupal\workflows\WorkflowInterface
- * The workflow entity.
- *
- * @throws \InvalidArgumentException
- * Thrown if the transition does not exist.
- */
- public function setTransitionWeight($transition_id, $weight);
-
- /**
- * Sets a transition's from states.
- *
- * @param string $transition_id
- * The transition ID.
- * @param array $from_state_ids
- * The state IDs to transition from.
- *
- * @return \Drupal\workflows\WorkflowInterface
- * The workflow entity.
- *
- * @throws \InvalidArgumentException
- * Thrown if the transition does not exist or the states do not exist.
- */
- public function setTransitionFromStates($transition_id, array $from_state_ids);
-
- /**
- * Deletes a transition.
- *
- * @param string $transition_id
- * The transition ID.
- *
- * @return \Drupal\workflows\WorkflowInterface
- * The workflow entity.
- *
- * @throws \InvalidArgumentException
- * Thrown if the transition does not exist.
- */
- public function deleteTransition($transition_id);
-
/**
* Gets the workflow type plugin.
*
projects / yaffs-website / blobdiff