class Workflow
Defines the workflow entity.
Plugin annotation
@ConfigEntityType(
  id = "workflow",
  label = @Translation("Workflow"),
  label_collection = @Translation("Workflows"),
  label_singular = @Translation("workflow"),
  label_plural = @Translation("workflows"),
  label_count = @PluralTranslation(
    singular = "@count workflow",
    plural = "@count workflows",
  ),
  handlers = {
    "access" = "Drupal\workflows\WorkflowAccessControlHandler",
    "list_builder" = "Drupal\workflows\WorkflowListBuilder",
    "form" = {
      "add" = "Drupal\workflows\Form\WorkflowAddForm",
      "edit" = "Drupal\workflows\Form\WorkflowEditForm",
      "delete" = "Drupal\workflows\Form\WorkflowDeleteForm",
      "add-state" = "Drupal\workflows\Form\WorkflowStateAddForm",
      "edit-state" = "Drupal\workflows\Form\WorkflowStateEditForm",
      "delete-state" = "Drupal\workflows\Form\WorkflowStateDeleteForm",
      "add-transition" = "Drupal\workflows\Form\WorkflowTransitionAddForm",
      "edit-transition" = "Drupal\workflows\Form\WorkflowTransitionEditForm",
      "delete-transition" = "Drupal\workflows\Form\WorkflowTransitionDeleteForm",
    },
    "route_provider" = {
      "html" = "Drupal\Core\Entity\Routing\AdminHtmlRouteProvider",
    },
  },
  config_prefix = "workflow",
  admin_permission = "administer workflows",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid",
  },
  links = {
    "add-form" = "/admin/config/workflow/workflows/add",
    "edit-form" = "/admin/config/workflow/workflows/manage/{workflow}",
    "delete-form" = "/admin/config/workflow/workflows/manage/{workflow}/delete",
    "add-state-form" = "/admin/config/workflow/workflows/manage/{workflow}/add_state",
    "add-transition-form" = "/admin/config/workflow/workflows/manage/{workflow}/add_transition",
    "collection" = "/admin/config/workflow/workflows",
  },
  config_export = {
    "id",
    "label",
    "type",
    "type_settings",
  },
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase- class \Drupal\workflows\Entity\Workflow implements \Drupal\workflows\WorkflowInterface, \Drupal\Core\Entity\EntityWithPluginCollectionInterface extends \Drupal\Core\Config\Entity\ConfigEntityBase
 
 
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
Expanded class hierarchy of Workflow
27 files declare their use of Workflow
- ComplexWorkflowTypeTest.php in core/modules/ workflows/ tests/ src/ Kernel/ ComplexWorkflowTypeTest.php 
- ContentModerationPermissionsTest.php in core/modules/ content_moderation/ tests/ src/ Kernel/ ContentModerationPermissionsTest.php 
- ContentModerationRouteSubscriber.php in core/modules/ content_moderation/ src/ Routing/ ContentModerationRouteSubscriber.php 
- ContentModerationStateTest.php in core/modules/ content_moderation/ tests/ src/ Kernel/ ContentModerationStateTest.php 
- ContentModerationTestTrait.php in core/modules/ content_moderation/ tests/ src/ Traits/ ContentModerationTestTrait.php 
59 string references to 'Workflow'
- ConfigImportSubscriber::getWorkflow in core/modules/ content_moderation/ src/ EventSubscriber/ ConfigImportSubscriber.php 
- Get the workflow entity object from the configuration name.
- ContentModerationPermissionsTest::setUp in core/modules/ content_moderation/ tests/ src/ Kernel/ ContentModerationPermissionsTest.php 
- ContentModerationStateStorageSchema::getEntitySchema in core/modules/ content_moderation/ src/ ContentModerationStateStorageSchema.php 
- Gets the entity schema for the specified entity type.
- ContentModerationSyncingTest::setUp in core/modules/ content_moderation/ tests/ src/ Kernel/ ContentModerationSyncingTest.php 
- content_moderation.views.schema.yml in core/modules/ content_moderation/ config/ schema/ content_moderation.views.schema.yml 
- core/modules/content_moderation/config/schema/content_moderation.views.schema.yml
File
- 
              core/modules/ workflows/ src/ Entity/ Workflow.php, line 66 
Namespace
Drupal\workflows\EntityView source
class Workflow extends ConfigEntityBase implements WorkflowInterface, EntityWithPluginCollectionInterface {
  
  /**
   * The Workflow ID.
   *
   * @var string
   */
  protected $id;
  
  /**
   * The workflow label.
   *
   * @var string
   */
  protected $label;
  
  /**
   * The workflow type plugin ID.
   *
   * @see \Drupal\workflows\WorkflowTypeManager
   *
   * @var string
   */
  protected $type;
  
  /**
   * The configuration for the workflow type plugin.
   *
   * @var array
   */
  protected $type_settings = [];
  
  /**
   * The workflow type plugin collection.
   *
   * @var \Drupal\Component\Plugin\LazyPluginCollection
   */
  protected $pluginCollection;
  
  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    $workflow_type = $this->getTypePlugin();
    $missing_states = array_diff($workflow_type->getRequiredStates(), array_keys($this->getTypePlugin()
      ->getStates()));
    if (!empty($missing_states)) {
      throw new RequiredStateMissingException(sprintf("Workflow type '{$workflow_type->label()}' requires states with the ID '%s' in workflow '{$this->id()}'", implode("', '", $missing_states)));
    }
    parent::preSave($storage);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getTypePlugin() {
    return $this->getPluginCollection()
      ->get($this->type);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getPluginCollections() {
    return [
      'type_settings' => $this->getPluginCollection(),
    ];
  }
  
  /**
   * Encapsulates the creation of the workflow's plugin collection.
   *
   * @return \Drupal\Core\Plugin\DefaultSingleLazyPluginCollection
   *   The workflow's plugin collection.
   */
  protected function getPluginCollection() {
    if (!$this->pluginCollection && $this->type) {
      $this->pluginCollection = new DefaultSingleLazyPluginCollection(\Drupal::service('plugin.manager.workflows.type'), $this->type, $this->type_settings);
    }
    return $this->pluginCollection;
  }
  
  /**
   * Loads all workflows of the provided type.
   *
   * @param string $type
   *   The workflow type to load all workflows for.
   *
   * @return static[]
   *   An array of workflow objects of the provided workflow type, indexed by
   *   their IDs.
   *
   *  @see \Drupal\workflows\Annotation\WorkflowType
   */
  public static function loadMultipleByType($type) {
    return self::loadMultiple(\Drupal::entityQuery('workflow')->condition('type', $type)
      ->execute());
  }
  
  /**
   * {@inheritdoc}
   */
  public function status() {
    // In order for a workflow to be usable it must have at least one state.
    return !empty($this->status) && !empty($this->getTypePlugin()
      ->getStates());
  }
  
  /**
   * {@inheritdoc}
   */
  public function onDependencyRemoval(array $dependencies) {
    // Give the parent method and the workflow type plugin a chance to react
    // to removed dependencies and report if either of these two made a change.
    $parent_changed_entity = parent::onDependencyRemoval($dependencies);
    $plugin_changed_entity = $this->getTypePlugin()
      ->onDependencyRemoval($dependencies);
    return $plugin_changed_entity || $parent_changed_entity;
  }
}Members
| Title Sort descending | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides | 
|---|---|---|---|---|---|---|
| CacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. | |||
| CacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. | |||
| CacheableDependencyTrait::$cacheTags | protected | property | Cache tags. | |||
| CacheableDependencyTrait::setCacheability | protected | function | Sets cacheability; useful for value object constructors. | |||
| ConfigEntityBase::$isUninstalling | private | property | Whether the config is being deleted by the uninstall process. | |||
| ConfigEntityBase::$langcode | protected | property | The language code of the entity's default language. | |||
| ConfigEntityBase::$originalId | protected | property | The original ID of the configuration entity. | |||
| ConfigEntityBase::$status | protected | property | The enabled/disabled status of the configuration entity. | 4 | ||
| ConfigEntityBase::$third_party_settings | protected | property | Third party entity settings. | |||
| ConfigEntityBase::$trustedData | protected | property | Trust supplied data and not use configuration schema on save. | |||
| ConfigEntityBase::$uuid | protected | property | The UUID for this entity. | |||
| ConfigEntityBase::$_core | protected | property | Information maintained by Drupal core about configuration. | |||
| ConfigEntityBase::addDependency | protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |||
| ConfigEntityBase::calculateDependencies | public | function | Calculates dependencies and stores them in the dependency property. | Overrides ConfigEntityInterface::calculateDependencies | 14 | |
| ConfigEntityBase::createDuplicate | public | function | Creates a duplicate of the entity. | Overrides EntityBase::createDuplicate | 1 | |
| ConfigEntityBase::disable | public | function | Disables the configuration entity. | Overrides ConfigEntityInterface::disable | 1 | |
| ConfigEntityBase::enable | public | function | Enables the configuration entity. | Overrides ConfigEntityInterface::enable | ||
| ConfigEntityBase::get | public | function | Returns the value of a property. | Overrides ConfigEntityInterface::get | ||
| ConfigEntityBase::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | Overrides EntityBase::getCacheTagsToInvalidate | 1 | |
| ConfigEntityBase::getConfigDependencyName | public | function | Gets the configuration dependency name. | Overrides EntityBase::getConfigDependencyName | ||
| ConfigEntityBase::getConfigManager | protected static | function | Gets the configuration manager. | |||
| ConfigEntityBase::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | Overrides EntityBase::getConfigTarget | ||
| ConfigEntityBase::getDependencies | public | function | Gets the configuration dependencies. | Overrides ConfigEntityInterface::getDependencies | ||
| ConfigEntityBase::getOriginalId | public | function | Gets the original ID. | Overrides EntityBase::getOriginalId | ||
| ConfigEntityBase::getThirdPartyProviders | public | function | Gets the list of third parties that store information. | Overrides ThirdPartySettingsInterface::getThirdPartyProviders | ||
| ConfigEntityBase::getThirdPartySetting | public | function | Gets the value of a third-party setting. | Overrides ThirdPartySettingsInterface::getThirdPartySetting | ||
| ConfigEntityBase::getThirdPartySettings | public | function | Gets all third-party settings of a given module. | Overrides ThirdPartySettingsInterface::getThirdPartySettings | ||
| ConfigEntityBase::getTypedConfig | protected | function | Gets the typed config manager. | |||
| ConfigEntityBase::hasTrustedData | public | function | Gets whether on not the data is trusted. | Overrides ConfigEntityInterface::hasTrustedData | ||
| ConfigEntityBase::invalidateTagsOnDelete | protected static | function | Override to never invalidate the individual entities' cache tags; the config system already invalidates them. | Overrides EntityBase::invalidateTagsOnDelete | ||
| ConfigEntityBase::invalidateTagsOnSave | protected | function | Override to never invalidate the entity's cache tag; the config system already invalidates it. | Overrides EntityBase::invalidateTagsOnSave | ||
| ConfigEntityBase::isInstallable | public | function | Checks whether this entity is installable. | Overrides ConfigEntityInterface::isInstallable | 2 | |
| ConfigEntityBase::isNew | public | function | Overrides Entity::isNew(). | Overrides EntityBase::isNew | ||
| ConfigEntityBase::isUninstalling | public | function | Returns whether this entity is being changed during the uninstall process. | Overrides ConfigEntityInterface::isUninstalling | ||
| ConfigEntityBase::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | Overrides EntityBase::preDelete | 8 | |
| ConfigEntityBase::save | public | function | Saves an entity permanently. | Overrides EntityBase::save | 1 | |
| ConfigEntityBase::set | public | function | Sets the value of a property. | Overrides ConfigEntityInterface::set | ||
| ConfigEntityBase::setOriginalId | public | function | Sets the original ID. | Overrides EntityBase::setOriginalId | ||
| ConfigEntityBase::setStatus | public | function | Sets the status of the configuration entity. | Overrides ConfigEntityInterface::setStatus | ||
| ConfigEntityBase::setThirdPartySetting | public | function | Sets the value of a third-party setting. | Overrides ThirdPartySettingsInterface::setThirdPartySetting | ||
| ConfigEntityBase::setUninstalling | public | function | ||||
| ConfigEntityBase::sort | public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 | ||
| ConfigEntityBase::toArray | public | function | Gets an array of all property values. | Overrides EntityBase::toArray | 2 | |
| ConfigEntityBase::toUrl | public | function | Gets the URL object for the entity. | Overrides EntityBase::toUrl | ||
| ConfigEntityBase::trustData | public | function | Sets that the data should be trusted. | Overrides ConfigEntityInterface::trustData | ||
| ConfigEntityBase::unsetThirdPartySetting | public | function | Unsets a third-party setting. | Overrides ThirdPartySettingsInterface::unsetThirdPartySetting | ||
| ConfigEntityBase::__construct | public | function | Constructs an Entity object. | Overrides EntityBase::__construct | 10 | |
| ConfigEntityBase::__sleep | public | function | Overrides EntityBase::__sleep | 4 | ||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
| DependencySerializationTrait::__sleep | public | function | Aliased as: traitSleep | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | ||
| DependencyTrait::$dependencies | protected | property | The object's dependencies. | |||
| DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | |||
| DependencyTrait::addDependency | protected | function | Adds a dependency. | Aliased as: addDependencyTrait | ||
| EntityBase::$enforceIsNew | protected | property | Boolean indicating whether the entity should be forced to be new. | |||
| EntityBase::$entityTypeId | protected | property | The entity type. | |||
| EntityBase::$typedData | protected | property | A typed data object wrapping this entity. | |||
| EntityBase::access | public | function | Checks data value access. | Overrides AccessibleInterface::access | 1 | |
| EntityBase::bundle | public | function | Gets the bundle of the entity. | Overrides EntityInterface::bundle | 1 | |
| EntityBase::create | public static | function | Constructs a new entity object, without permanently saving it. | Overrides EntityInterface::create | 1 | |
| EntityBase::delete | public | function | Deletes an entity permanently. | Overrides EntityInterface::delete | 1 | |
| EntityBase::enforceIsNew | public | function | Enforces an entity to be new. | Overrides EntityInterface::enforceIsNew | ||
| EntityBase::entityTypeBundleInfo | protected | function | Gets the entity type bundle info service. | |||
| EntityBase::entityTypeManager | protected | function | Gets the entity type manager. | |||
| EntityBase::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyTrait::getCacheContexts | ||
| EntityBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyTrait::getCacheMaxAge | ||
| EntityBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyTrait::getCacheTags | ||
| EntityBase::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | Overrides EntityInterface::getConfigDependencyKey | ||
| EntityBase::getEntityType | public | function | Gets the entity type definition. | Overrides EntityInterface::getEntityType | ||
| EntityBase::getEntityTypeId | public | function | Gets the ID of the type of the entity. | Overrides EntityInterface::getEntityTypeId | ||
| EntityBase::getListCacheTagsToInvalidate | protected | function | The list cache tags to invalidate for this entity. | |||
| EntityBase::getTypedData | public | function | Gets a typed data object for this entity object. | Overrides EntityInterface::getTypedData | ||
| EntityBase::getTypedDataClass | private | function | Returns the typed data class name for this entity. | |||
| EntityBase::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | Overrides EntityInterface::hasLinkTemplate | ||
| EntityBase::id | public | function | Gets the identifier. | Overrides EntityInterface::id | 11 | |
| EntityBase::label | public | function | Gets the label of the entity. | Overrides EntityInterface::label | 6 | |
| EntityBase::language | public | function | Gets the language of the entity. | Overrides EntityInterface::language | 1 | |
| EntityBase::languageManager | protected | function | Gets the language manager. | |||
| EntityBase::linkTemplates | protected | function | Gets an array link templates. | 1 | ||
| EntityBase::load | public static | function | Loads an entity. | Overrides EntityInterface::load | ||
| EntityBase::loadMultiple | public static | function | Loads one or more entities. | Overrides EntityInterface::loadMultiple | ||
| EntityBase::postCreate | public | function | Acts on a created entity before hooks are invoked. | Overrides EntityInterface::postCreate | 4 | |
| EntityBase::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | Overrides EntityInterface::postDelete | 19 | |
| EntityBase::postLoad | public static | function | Acts on loaded entities. | Overrides EntityInterface::postLoad | 3 | |
| EntityBase::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | Overrides EntityInterface::postSave | 14 | |
| EntityBase::preCreate | public static | function | Changes the values of an entity before it is created. | Overrides EntityInterface::preCreate | 7 | |
| EntityBase::referencedEntities | public | function | Gets a list of entities referenced by this entity. | Overrides EntityInterface::referencedEntities | 1 | |
| EntityBase::toLink | public | function | Generates the HTML for a link to this entity. | Overrides EntityInterface::toLink | ||
| EntityBase::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | Overrides EntityInterface::uriRelationships | ||
| EntityBase::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. | 2 | ||
| EntityBase::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | Overrides EntityInterface::uuid | 1 | |
| EntityBase::uuidGenerator | protected | function | Gets the UUID generator. | |||
| PluginDependencyTrait::calculatePluginDependencies | protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 | ||
| PluginDependencyTrait::getPluginDependencies | protected | function | Calculates and returns dependencies of a specific plugin instance. | |||
| PluginDependencyTrait::moduleHandler | protected | function | Wraps the module handler. | 1 | ||
| PluginDependencyTrait::themeHandler | protected | function | Wraps the theme handler. | 1 | ||
| RefinableCacheableDependencyTrait::addCacheableDependency | public | function | 1 | |||
| RefinableCacheableDependencyTrait::addCacheContexts | public | function | ||||
| RefinableCacheableDependencyTrait::addCacheTags | public | function | ||||
| RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | ||||
| SynchronizableEntityTrait::$isSyncing | protected | property | Is entity being created updated or deleted through synchronization process. | |||
| SynchronizableEntityTrait::isSyncing | public | function | ||||
| SynchronizableEntityTrait::setSyncing | public | function | ||||
| Workflow::$id | protected | property | The Workflow ID. | |||
| Workflow::$label | protected | property | The workflow label. | |||
| Workflow::$pluginCollection | protected | property | The workflow type plugin collection. | |||
| Workflow::$type | protected | property | The workflow type plugin ID. | |||
| Workflow::$type_settings | protected | property | The configuration for the workflow type plugin. | |||
| Workflow::getPluginCollection | protected | function | Encapsulates the creation of the workflow's plugin collection. | |||
| Workflow::getPluginCollections | public | function | Gets the plugin collections used by this object. | Overrides ObjectWithPluginCollectionInterface::getPluginCollections | ||
| Workflow::getTypePlugin | public | function | Gets the workflow type plugin. | Overrides WorkflowInterface::getTypePlugin | ||
| Workflow::loadMultipleByType | public static | function | Loads all workflows of the provided type. | |||
| Workflow::onDependencyRemoval | public | function | Informs the entity that entities it depends on will be deleted. | Overrides ConfigEntityBase::onDependencyRemoval | ||
| Workflow::preSave | public | function | Acts on an entity before the presave hook is invoked. | Overrides ConfigEntityBase::preSave | ||
| Workflow::status | public | function | Returns whether the configuration entity is enabled. | Overrides ConfigEntityBase::status | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
