abstract class ConfigurableActionBase

Provides a base implementation for a configurable Action plugin.

Hierarchy

Expanded class hierarchy of ConfigurableActionBase

7 files declare their use of ConfigurableActionBase
AssignOwnerNode.php in drupal/core/modules/node/lib/Drupal/node/Plugin/Action/AssignOwnerNode.php
Contains \Drupal\node\Plugin\Action\AssignOwnerNode.
ChangeUserRoleBase.php in drupal/core/modules/user/lib/Drupal/user/Plugin/Action/ChangeUserRoleBase.php
Contains \Drupal\user\Plugin\Action\ChangeUserRoleBase.
EmailAction.php in drupal/core/modules/action/lib/Drupal/action/Plugin/Action/EmailAction.php
Contains \Drupal\action\Plugin\Action\EmailAction.
GotoAction.php in drupal/core/modules/action/lib/Drupal/action/Plugin/Action/GotoAction.php
Contains \Drupal\action\Plugin\Action\GotoAction.
MessageAction.php in drupal/core/modules/action/lib/Drupal/action/Plugin/Action/MessageAction.php
Contains \Drupal\action\Plugin\Action\MessageAction.

... See full list

File

drupal/core/lib/Drupal/Core/Action/ConfigurableActionBase.php, line 16
Contains \Drupal\Core\Action\ConfigurableActionBase.

Namespace

Drupal\Core\Action
View source
abstract class ConfigurableActionBase extends ActionBase implements ConfigurableActionInterface {

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->configuration += $this
      ->getDefaultConfiguration();
  }

  /**
   * Returns default configuration for this action.
   *
   * @return array
   */
  protected function getDefaultConfiguration() {
    return array();
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return $this->configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function validate(array &$form, array &$form_state) {
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ActionBase::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple 2
ConfigurableActionBase::getConfiguration public function Returns this plugin's configuration. Overrides ConfigurableActionInterface::getConfiguration
ConfigurableActionBase::getDefaultConfiguration protected function Returns default configuration for this action. 7
ConfigurableActionBase::validate public function Form validation handler. Overrides ConfigurableActionInterface::validate 2
ConfigurableActionBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 3
ConfigurableActionInterface::form public function Form constructor. 7
ConfigurableActionInterface::submit public function Form submission handler. 7
ContainerFactoryPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
ExecutableInterface::execute public function Executes the plugin. 25
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId