interface WorkflowManagerInterface in State Machine 8

Defines the interface for workflow plugin managers.

Hierarchy

• interface \Drupal\Component\Plugin\Discovery\DiscoveryInterface; interface \Drupal\Component\Plugin\Factory\FactoryInterface; interface \Drupal\Component\Plugin\Mapper\MapperInterface
  • interface \Drupal\Component\Plugin\PluginManagerInterface
    • interface \Drupal\state_machine\WorkflowManagerInterface

File

src/WorkflowManagerInterface.php, line 10

Namespace

Drupal\state_machine

interface WorkflowManagerInterface extends PluginManagerInterface {

  /**
   * Gets the grouped workflow labels.
   *
   * @param string $entity_type_id
   *   (optional) The entity type id to filter by. If provided, only workflows
   *   that belong to groups with the specified entity type will be returned.
   *
   * @return array
   *   Keys are group labels, and values are arrays of which the keys are
   *   workflow IDs and the values are workflow labels.
   */
  public function getGroupedLabels($entity_type_id = NULL);

}

Members

Name	Modifiers	Type	Description	Overrides
DiscoveryInterface::getDefinition	public	function	Gets a specific plugin definition.	4
DiscoveryInterface::getDefinitions	public	function	Gets the definition of all plugins for this type.	3
DiscoveryInterface::hasDefinition	public	function	Indicates if a specific plugin definition exists.	2
FactoryInterface::createInstance	public	function	Creates a pre-configured instance of a plugin.	7
MapperInterface::getInstance	public	function	Gets a preconfigured instance of a plugin.	4
WorkflowManagerInterface::getGroupedLabels	public	function	Gets the grouped workflow labels.	1