class Action

Same name in this branch
  1. 10 core/modules/system/src/Plugin/migrate/source/Action.php \Drupal\system\Plugin\migrate\source\Action
  2. 10 core/lib/Drupal/Core/Action/Attribute/Action.php \Drupal\Core\Action\Attribute\Action
  3. 10 core/lib/Drupal/Core/Annotation/Action.php \Drupal\Core\Annotation\Action
Same name in other branches
  1. 9 core/modules/action/src/Plugin/migrate/source/Action.php \Drupal\action\Plugin\migrate\source\Action
  2. 9 core/modules/system/src/Entity/Action.php \Drupal\system\Entity\Action
  3. 9 core/modules/system/src/Plugin/migrate/source/Action.php \Drupal\system\Plugin\migrate\source\Action
  4. 9 core/lib/Drupal/Core/Annotation/Action.php \Drupal\Core\Annotation\Action
  5. 8.9.x core/modules/action/src/Plugin/migrate/source/Action.php \Drupal\action\Plugin\migrate\source\Action
  6. 8.9.x core/modules/system/src/Entity/Action.php \Drupal\system\Entity\Action
  7. 8.9.x core/lib/Drupal/Core/Annotation/Action.php \Drupal\Core\Annotation\Action
  8. 11.x core/modules/system/src/Entity/Action.php \Drupal\system\Entity\Action
  9. 11.x core/modules/system/src/Plugin/migrate/source/Action.php \Drupal\system\Plugin\migrate\source\Action
  10. 11.x core/lib/Drupal/Core/Action/Attribute/Action.php \Drupal\Core\Action\Attribute\Action
  11. 11.x core/lib/Drupal/Core/Annotation/Action.php \Drupal\Core\Annotation\Action

Defines the configured action entity.

Plugin annotation


@ConfigEntityType(
  id = "action",
  label = @Translation("Action"),
  label_collection = @Translation("Actions"),
  label_singular = @Translation("action"),
  label_plural = @Translation("actions"),
  label_count = @PluralTranslation(
    singular = "@count action",
    plural = "@count actions",
  ),
  admin_permission = "administer actions",
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  config_export = {
    "id",
    "label",
    "type",
    "plugin",
    "configuration",
  }
)

Hierarchy

Expanded class hierarchy of Action

23 files declare their use of Action
ActionFormAjaxTest.php in core/modules/action/tests/src/FunctionalJavascript/ActionFormAjaxTest.php
ActionResourceTestBase.php in core/modules/action/tests/src/Functional/Rest/ActionResourceTestBase.php
ActionResourceTestBase.php in core/modules/system/tests/src/Functional/Rest/ActionResourceTestBase.php
ActionTest.php in core/modules/action/tests/src/Functional/Jsonapi/ActionTest.php
ActionTest.php in core/modules/jsonapi/tests/src/Functional/ActionTest.php

... See full list

32 string references to 'Action'
action.routing.yml in core/modules/action/action.routing.yml
core/modules/action/action.routing.yml
ActionAdminManageForm::buildForm in core/modules/action/src/Form/ActionAdminManageForm.php
ActionAdminManageForm::submitForm in core/modules/action/src/Form/ActionAdminManageForm.php
ActionFormBase::create in core/modules/action/src/Form/ActionFormBase.php
ActionListTest::testEmptyActionList in core/modules/action/tests/src/Functional/ActionListTest.php
Tests the behavior when there are no actions to list in the admin page.

... See full list

File

core/modules/system/src/Entity/Action.php, line 41

Namespace

Drupal\system\Entity
View source
class Action extends ConfigEntityBase implements ActionConfigEntityInterface, EntityWithPluginCollectionInterface {
    
    /**
     * The name (plugin ID) of the action.
     *
     * @var string
     */
    protected $id;
    
    /**
     * The label of the action.
     *
     * @var string
     */
    protected $label;
    
    /**
     * The action type.
     *
     * @var string
     */
    protected $type;
    
    /**
     * The configuration of the action.
     *
     * @var array
     */
    protected $configuration = [];
    
    /**
     * The plugin ID of the action.
     *
     * @var string
     */
    protected $plugin;
    
    /**
     * The plugin collection that stores action plugins.
     *
     * @var \Drupal\Core\Action\ActionPluginCollection
     */
    protected $pluginCollection;
    
    /**
     * {@inheritdoc}
     */
    public static function create(array $values = []) {
        // When no label is specified for this action config entity, default to the
        // label of the used action plugin.
        if (!array_key_exists('label', $values) && array_key_exists('plugin', $values)) {
            try {
                $action_plugin_manager = \Drupal::service('plugin.manager.action');
                assert($action_plugin_manager instanceof PluginManagerInterface);
                $action_plugin_definition = $action_plugin_manager->getDefinition($values['plugin']);
                // @see \Drupal\Core\Annotation\Action::$label
                assert(array_key_exists('label', $action_plugin_definition));
                $values['label'] = $action_plugin_definition['label'];
            } catch (PluginNotFoundException) {
            }
        }
        return parent::create($values);
    }
    
    /**
     * Encapsulates the creation of the action's LazyPluginCollection.
     *
     * @return \Drupal\Component\Plugin\LazyPluginCollection
     *   The action's plugin collection.
     */
    protected function getPluginCollection() {
        if (!$this->pluginCollection) {
            $this->pluginCollection = new ActionPluginCollection(\Drupal::service('plugin.manager.action'), $this->plugin, $this->configuration);
        }
        return $this->pluginCollection;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getPluginCollections() {
        return [
            'configuration' => $this->getPluginCollection(),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getPlugin() {
        return $this->getPluginCollection()
            ->get($this->plugin);
    }
    
    /**
     * {@inheritdoc}
     */
    public function setPlugin($plugin_id) {
        $this->plugin = $plugin_id;
        $this->getPluginCollection()
            ->addInstanceId($plugin_id);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getPluginDefinition() {
        return $this->getPlugin()
            ->getPluginDefinition();
    }
    
    /**
     * {@inheritdoc}
     */
    public function execute(array $entities) {
        return $this->getPlugin()
            ->executeMultiple($entities);
    }
    
    /**
     * {@inheritdoc}
     */
    public function isConfigurable() {
        return $this->getPlugin() instanceof ConfigurableInterface;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getType() {
        return $this->type;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) {
        
        /** @var \Drupal\system\ActionConfigEntityInterface $a */
        
        /** @var \Drupal\system\ActionConfigEntityInterface $b */
        $a_type = $a->getType();
        $b_type = $b->getType();
        if ($a_type != $b_type) {
            return strnatcasecmp($a_type, $b_type);
        }
        return parent::sort($a, $b);
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
Action::$configuration protected property The configuration of the action.
Action::$id protected property The name (plugin ID) of the action.
Action::$label protected property The label of the action.
Action::$plugin protected property The plugin ID of the action.
Action::$pluginCollection protected property The plugin collection that stores action plugins.
Action::$type protected property The action type.
Action::create public static function Overrides EntityBase::create
Action::execute public function
Action::getPlugin public function Overrides ActionConfigEntityInterface::getPlugin
Action::getPluginCollection protected function Encapsulates the creation of the action's LazyPluginCollection.
Action::getPluginCollections public function
Action::getPluginDefinition public function
Action::getType public function Overrides ActionConfigEntityInterface::getType
Action::isConfigurable public function Overrides ActionConfigEntityInterface::isConfigurable
Action::setPlugin public function
Action::sort public static function Overrides ConfigEntityBase::sort
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 Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Overrides EntityBase::preSave 14
ConfigEntityBase::save public function Overrides EntityBase::save 2
ConfigEntityBase::set public function Overrides ConfigEntityInterface::set
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::status public function Overrides ConfigEntityInterface::status 4
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::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
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

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