You are here

Home » API reference » State Machine 8 » WorkflowManager.php

class WorkflowManager in State Machine 8

Manages discovery and instantiation of workflow plugins.

Hierarchy

Expanded class hierarchy of WorkflowManager

See also

\Drupal\state_machine\Plugin\Workflow\WorkflowInterface

Plugin API

1 file declares its use of WorkflowManager
WorkflowManagerCacheTest.php in tests/src/Unit/WorkflowManagerCacheTest.php
1 string reference to 'WorkflowManager'
state_machine.services.yml in ./state_machine.services.yml
state_machine.services.yml
1 service uses WorkflowManager
plugin.manager.workflow in ./state_machine.services.yml
Drupal\state_machine\WorkflowManager

File

src/WorkflowManager.php, line 19

Namespace

Drupal\state_machine
View source 
class WorkflowManager extends DefaultPluginManager implements WorkflowManagerInterface {

  /**
   * The workflow group manager.
   *
   * @var \Drupal\state_machine\WorkflowGroupManagerInterface
   */
  protected $groupManager;

  /**
   * A cache of loaded workflows, keyed by workflow ID.
   *
   * @var \Drupal\state_machine\Plugin\Workflow\WorkflowInterface[]
   */
  protected $plugins;

  /**
   * Default values for each workflow plugin.
   *
   * @var array
   */
  protected $defaults = [
    'id' => '',
    'label' => '',
    'group' => '',
    'states' => [],
    'transitions' => [],
  ];

  /**
   * Constructs a new WorkflowManager object.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   The cache backend.
   * @param \Drupal\state_machine\WorkflowGroupManagerInterface $group_manager
   *   The workflow group manager.
   */
  public function __construct(ModuleHandlerInterface $module_handler, CacheBackendInterface $cache_backend, WorkflowGroupManagerInterface $group_manager) {
    $this->moduleHandler = $module_handler;
    $this
      ->setCacheBackend($cache_backend, 'workflow', [
      'workflow',
    ]);
    $this->groupManager = $group_manager;
    $this
      ->alterInfo('workflows');
  }

  /**
   * {@inheritdoc}
   */
  protected function getDiscovery() {
    if (!isset($this->discovery)) {
      $this->discovery = new YamlDiscovery('workflows', $this->moduleHandler
        ->getModuleDirectories());
      $this->discovery
        ->addTranslatableProperty('label', 'label_context');
      $this->discovery = new ContainerDerivativeDiscoveryDecorator($this->discovery);
    }
    return $this->discovery;
  }

  /**
   * {@inheritdoc}
   */
  public function createInstance($plugin_id, array $configuration = []) {
    if (empty($this->plugins[$plugin_id])) {
      $plugin_definition = $this
        ->getDefinition($plugin_id);
      if (empty($plugin_definition['group'])) {
        throw new PluginException(sprintf('The workflow %s must define the group property.', $plugin_id));
      }
      $group_definition = $this->groupManager
        ->getDefinition($plugin_definition['group']);
      $plugin_class = $group_definition['workflow_class'];
      if (is_subclass_of($plugin_class, ContainerFactoryPluginInterface::class)) {
        $this->plugins[$plugin_id] = $plugin_class::create(\Drupal::getContainer(), $configuration, $plugin_id, $plugin_definition);
      }
      else {
        $this->plugins[$plugin_id] = new $plugin_class($configuration, $plugin_id, $plugin_definition);
      }
    }
    return $this->plugins[$plugin_id];
  }

  /**
   * {@inheritdoc}
   */
  public function processDefinition(&$definition, $plugin_id) {
    parent::processDefinition($definition, $plugin_id);
    $definition['id'] = $plugin_id;
    foreach ([
      'label',
      'group',
      'states',
      'transitions',
    ] as $required_property) {
      if (empty($definition[$required_property])) {
        throw new PluginException(sprintf('The workflow %s must define the %s property.', $plugin_id, $required_property));
      }
    }
    foreach ($definition['states'] as $state_id => $state_definition) {
      if (empty($state_definition['label'])) {
        throw new PluginException(sprintf('The workflow state %s must define the label property.', $state_id));
      }
    }
    foreach ($definition['transitions'] as $transition_id => $transition_definition) {
      foreach ([
        'label',
        'from',
        'to',
      ] as $required_property) {
        if (empty($transition_definition[$required_property])) {
          throw new PluginException(sprintf('The workflow transition %s must define the %s property.', $transition_id, $required_property));
        }
      }

      // Validate the referenced "from" and "to" states.
      foreach ($transition_definition['from'] as $from_state) {
        if (!isset($definition['states'][$from_state])) {
          throw new PluginException(sprintf('The workflow transition %s specified an invalid "from" property: %s.', $transition_id, $from_state));
        }
      }
      $to_state = $transition_definition['to'];
      if (!isset($definition['states'][$to_state])) {
        throw new PluginException(sprintf('The workflow transition %s specified an invalid "to" property.', $transition_id));
      }

      // Don't allow transitions to the same state.
      foreach ($transition_definition['from'] as $from_state) {
        if ($from_state == $transition_definition['to']) {
          throw new PluginException(sprintf('Invalid workflow transition %s: the "from" and "to" properties cannot overlap.', $transition_id));
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getGroupedLabels($entity_type_id = NULL) {
    $definitions = $this
      ->getSortedDefinitions();
    $group_labels = $this
      ->getGroupLabels($entity_type_id);
    $grouped_definitions = [];
    foreach ($definitions as $id => $definition) {
      $group_id = $definition['group'];
      if (!isset($group_labels[$group_id])) {

        // Don't return workflows for groups ignored due to their entity type.
        continue;
      }
      $group_label = $group_labels[$group_id];
      $grouped_definitions[$group_label][$id] = $definition['label'];
    }
    return $grouped_definitions;
  }

  /**
   * Gets the sorted workflow plugin definitions.
   *
   * @return array
   *   The workflow plugin definitions, sorted by group and label.
   */
  protected function getSortedDefinitions() {

    // Sort the plugins first by group, then by label.
    $definitions = $this
      ->getDefinitions();
    uasort($definitions, function ($a, $b) {
      if ($a['group'] != $b['group']) {
        return strnatcasecmp($a['group'], $b['group']);
      }
      return strnatcasecmp($a['label'], $b['label']);
    });
    return $definitions;
  }

  /**
   * Gets a list of group labels for the given entity type ID.
   *
   * @param string $entity_type_id
   *   The entity type ID.
   *
   * @return array
   *   A list of groups labels keyed by ID.
   */
  protected function getGroupLabels($entity_type_id = NULL) {
    $group_definitions = $this->groupManager
      ->getDefinitionsByEntityType($entity_type_id);
    $group_labels = array_map(function ($group_definition) {
      return (string) $group_definition['label'];
    }, $group_definitions);
    natcasesort($group_labels);
    return $group_labels;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultPluginManager::$additionalAnnotationNamespaces protected property Additional namespaces the annotation discovery mechanism should scan for annotation definitions.
DefaultPluginManager::$alterHook protected property Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey protected property The cache key.
DefaultPluginManager::$cacheTags protected property An array of cache tags to use for the cached definitions.
DefaultPluginManager::$moduleHandler protected property The module handler to invoke the alter hook. 1
DefaultPluginManager::$namespaces protected property An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName protected property The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginInterface protected property The interface each plugin should implement. 1
DefaultPluginManager::$subdir protected property The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace.
DefaultPluginManager::alterDefinitions protected function Invokes the hook to alter the definitions if the alter hook is set. 1
DefaultPluginManager::alterInfo protected function Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions 5
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
DefaultPluginManager::fixContextAwareDefinitions private function Fix the definitions of context-aware plugins.
DefaultPluginManager::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions protected function Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions public function Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions 2
DefaultPluginManager::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::providerExists protected function Determines if the provider of a definition exists. 3
DefaultPluginManager::setCacheBackend public function Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions protected function Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches public function Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches 1
DiscoveryCachedTrait::$definitions protected property Cached definitions array. 1
DiscoveryCachedTrait::getDefinition public function Overrides DiscoveryTrait::getDefinition 3
DiscoveryTrait::doGetDefinition protected function Gets a specific plugin definition.
DiscoveryTrait::hasDefinition public function
PluginManagerBase::$discovery protected property The object that discovers plugins managed by this manager.
PluginManagerBase::$factory protected property The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper protected property The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::getInstance public function Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance 7
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
UseCacheBackendTrait::$cacheBackend protected property Cache backend instance.
UseCacheBackendTrait::$useCaches protected property Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet protected function Fetches from the cache backend, respecting the use caches flag. 1
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.
WorkflowManager::$defaults protected property Default values for each workflow plugin. Overrides DefaultPluginManager::$defaults
WorkflowManager::$groupManager protected property The workflow group manager.
WorkflowManager::$plugins protected property A cache of loaded workflows, keyed by workflow ID.
WorkflowManager::createInstance public function Creates a pre-configured instance of a plugin. Overrides PluginManagerBase::createInstance
WorkflowManager::getDiscovery protected function Gets the plugin discovery. Overrides DefaultPluginManager::getDiscovery
WorkflowManager::getGroupedLabels public function Gets the grouped workflow labels. Overrides WorkflowManagerInterface::getGroupedLabels
WorkflowManager::getGroupLabels protected function Gets a list of group labels for the given entity type ID.
WorkflowManager::getSortedDefinitions protected function Gets the sorted workflow plugin definitions.
WorkflowManager::processDefinition public function Performs extra processing on plugin definitions. Overrides DefaultPluginManager::processDefinition
WorkflowManager::__construct public function Constructs a new WorkflowManager object. Overrides DefaultPluginManager::__construct