interface ConfigurableActionInterface

Provides an interface for an Action plugin.

Hierarchy

Expanded class hierarchy of ConfigurableActionInterface

All classes that implement ConfigurableActionInterface

See also

\Drupal\Core\Annotation\Operation

\Drupal\Core\Action\OperationManager

4 files declare their use of ConfigurableActionInterface
Action.php in drupal/core/modules/system/lib/Drupal/system/Plugin/Core/Entity/Action.php
Contains \Drupal\system\Plugin\Core\Entity\Action.
ActionFormControllerBase.php in drupal/core/modules/action/lib/Drupal/action/ActionFormControllerBase.php
Contains Drupal\action\ActionEditFormController.
ActionStorageController.php in drupal/core/modules/system/lib/Drupal/system/ActionStorageController.php
Contains \Drupal\system\ActionStorageController.
ConfigurableActionBase.php in drupal/core/lib/Drupal/Core/Action/ConfigurableActionBase.php
Contains \Drupal\Core\Action\ConfigurableActionBase.

File

drupal/core/lib/Drupal/Core/Action/ConfigurableActionInterface.php, line 18
Contains \Drupal\Core\Action\ConfigurableActionInterface.

Namespace

Drupal\Core\Action
View source
interface ConfigurableActionInterface extends ActionInterface {

  /**
   * Returns this plugin's configuration.
   *
   * @return array
   *   An array of this action plugin's configuration.
   */
  public function getConfiguration();

  /**
   * Form constructor.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param array $form_state
   *   An associative array containing the current state of the form.
   *
   * @return array
   *   The form structure.
   */
  public function form(array $form, array &$form_state);

  /**
   * Form validation handler.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param array $form_state
   *   An associative array containing the current state of the form.
   */
  public function validate(array &$form, array &$form_state);

  /**
   * Form submission handler.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param array $form_state
   *   An associative array containing the current state of the form.
   */
  public function submit(array &$form, array &$form_state);

}

Members

Namesort descending Modifiers Type Description Overrides
ActionInterface::executeMultiple public function Executes the plugin for an array of objects. 1
ConfigurableActionInterface::form public function Form constructor. 7
ConfigurableActionInterface::getConfiguration public function Returns this plugin's configuration. 1
ConfigurableActionInterface::submit public function Form submission handler. 7
ConfigurableActionInterface::validate public function Form validation handler. 1
ExecutableInterface::execute public function Executes the plugin. 25