class ConfigurableActionBase

Provides a base implementation for a configurable Action plugin.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
  - class \Drupal\Core\Action\ActionBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Action\ActionInterface
    - class \Drupal\Core\Action\ConfigurableActionBase extends \Drupal\Core\Action\ActionBase implements \Drupal\Component\Plugin\ConfigurableInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Plugin\PluginFormInterface

Expanded class hierarchy of ConfigurableActionBase

4 files declare their use of ConfigurableActionBase

ChangeUserRoleBase.php in core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php
EmailAction.php in core/lib/Drupal/Core/Action/Plugin/Action/EmailAction.php
GotoAction.php in core/lib/Drupal/Core/Action/Plugin/Action/GotoAction.php
MessageAction.php in core/lib/Drupal/Core/Action/Plugin/Action/MessageAction.php

File

core/lib/Drupal/Core/Action/ConfigurableActionBase.php, line 13

Namespace

Drupal\Core\Action

View source

abstract class ConfigurableActionBase extends ActionBase implements ConfigurableInterface, DependentPluginInterface, PluginFormInterface {
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->setConfiguration($configuration);
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfiguration() {
        return $this->configuration;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setConfiguration(array $configuration) {
        $this->configuration = $configuration + $this->defaultConfiguration();
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        return [];
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
ActionBase::executeMultiple	public	function	Executes the plugin for an array of objects.	Overrides ActionInterface::executeMultiple	2
ActionInterface::access	public	function	Checks object access.		12
ConfigurableActionBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	Overrides DependentPluginInterface::calculateDependencies	1
ConfigurableActionBase::defaultConfiguration	public	function	Gets default configuration for this plugin.	Overrides ConfigurableInterface::defaultConfiguration	4
ConfigurableActionBase::getConfiguration	public	function	Gets this plugin's configuration.	Overrides ConfigurableInterface::getConfiguration
ConfigurableActionBase::setConfiguration	public	function	Sets the configuration for this plugin instance.	Overrides ConfigurableInterface::setConfiguration
ConfigurableActionBase::validateConfigurationForm	public	function	Form validation handler.	Overrides PluginFormInterface::validateConfigurationForm	1
ConfigurableActionBase::__construct	public	function			4
ExecutableInterface::execute	public	function	Executes the plugin.		14
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.		20
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.		20
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.		5
PluginInspectionInterface::getPluginId	public	function	Gets the plugin ID of the plugin instance.		2