class Workflow

Same name in other branches
  1. 9 core/modules/workflows/src/Entity/Workflow.php \Drupal\workflows\Entity\Workflow
  2. 8.9.x core/modules/workflows/src/Entity/Workflow.php \Drupal\workflows\Entity\Workflow
  3. 10 core/modules/workflows/src/Entity/Workflow.php \Drupal\workflows\Entity\Workflow

Defines the workflow entity.

Hierarchy

  • class \Drupal\workflows\Entity\Workflow extends \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\workflows\WorkflowInterface, \Drupal\Core\Entity\EntityWithPluginCollectionInterface

Expanded class hierarchy of Workflow

32 files declare their use of Workflow
AddModerationConfigActionTest.php in core/modules/content_moderation/tests/src/Kernel/ConfigAction/AddModerationConfigActionTest.php
ComplexWorkflowTypeTest.php in core/modules/workflows/tests/src/Kernel/ComplexWorkflowTypeTest.php
ContentModerationHooks.php in core/modules/content_moderation/src/Hook/ContentModerationHooks.php
ContentModerationPermissionsTest.php in core/modules/content_moderation/tests/src/Kernel/ContentModerationPermissionsTest.php
ContentModerationRouteSubscriber.php in core/modules/content_moderation/src/Routing/ContentModerationRouteSubscriber.php

... See full list

57 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
ContentModerationSyncingTest::setUp in core/modules/content_moderation/tests/src/Kernel/ContentModerationSyncingTest.php
ModerationInformation::isModeratedEntityType in core/modules/content_moderation/src/ModerationInformation.php

... See full list

File

core/modules/workflows/src/Entity/Workflow.php, line 29

Namespace

Drupal\workflows\Entity
View 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.
     *
     * @var string
     *
     * @see \Drupal\workflows\WorkflowTypeManager
     */
    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
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
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function 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 Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides EntityBase::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::preDelete public static function Overrides EntityBase::preDelete 8
ConfigEntityBase::save public function Overrides EntityBase::save 2
ConfigEntityBase::set public function Overrides ConfigEntityInterface::set 1
ConfigEntityBase::setOriginalId public function Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function 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 Overrides EntityBase::toArray 3
ConfigEntityBase::toUrl public function Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct public function Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 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 Overrides AccessibleInterface::access 1
EntityBase::bundle public function Overrides EntityInterface::bundle 1
EntityBase::create public static function Overrides EntityInterface::create 2
EntityBase::delete public function Overrides EntityInterface::delete 1
EntityBase::enforceIsNew public function 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 Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Overrides EntityInterface::getEntityType 1
EntityBase::getEntityTypeId public function Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Overrides EntityInterface::getTypedData
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Overrides EntityInterface::id 10
EntityBase::label public function Overrides EntityInterface::label 6
EntityBase::language public function 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 Overrides EntityInterface::load
EntityBase::loadMultiple public static function Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Overrides EntityInterface::postCreate 5
EntityBase::postDelete public static function Overrides EntityInterface::postDelete 17
EntityBase::postLoad public static function Overrides EntityInterface::postLoad 3
EntityBase::postSave public function Overrides EntityInterface::postSave 13
EntityBase::preCreate public static function Overrides EntityInterface::preCreate 6
EntityBase::referencedEntities public function Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function 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
Workflow::getTypePlugin public function Overrides WorkflowInterface::getTypePlugin
Workflow::loadMultipleByType public static function Loads all workflows of the provided type.
Workflow::onDependencyRemoval public function Overrides ConfigEntityBase::onDependencyRemoval
Workflow::preSave public function Overrides ConfigEntityBase::preSave
Workflow::status public function Overrides ConfigEntityBase::status

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