interface ActionInterface
Provides an interface for an Action plugin.
@todo WARNING: The action API is going to receive some additions before release. The following additions are likely to happen:
- The way configuration is handled and configuration forms are built is likely to change in order for the plugin to be of use for Rules.
- Actions are going to become context-aware in https://www.drupal.org/node/2011038, what will deprecated the 'type' annotation.
- Instead of action implementations saving entities, support for marking required context as to be saved by the execution manager will be added as part of https://www.drupal.org/node/2347017.
- Actions will receive a data processing API that allows for token replacements to happen outside of the action plugin implementations, see https://www.drupal.org/node/2347023.
Hierarchy
- interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Executable\ExecutableInterface
- interface \Drupal\Core\Action\ActionInterface extends \Drupal\Core\Executable\ExecutableInterface, \Drupal\Component\Plugin\PluginInspectionInterface
Expanded class hierarchy of ActionInterface
All classes that implement ActionInterface
See also
\Drupal\Core\Annotation\Action
\Drupal\Core\Action\ActionManager
\Drupal\Core\Action\ActionBase
1 file declares its use of ActionInterface
- ActionTest.php in core/
modules/ system/ tests/ src/ Kernel/ Action/ ActionTest.php
File
-
core/
lib/ Drupal/ Core/ Action/ ActionInterface.php, line 31
Namespace
Drupal\Core\ActionView source
interface ActionInterface extends ExecutableInterface, PluginInspectionInterface {
/**
* Executes the plugin for an array of objects.
*
* @param array $objects
* An array of entities.
*/
public function executeMultiple(array $objects);
/**
* Checks object access.
*
* @param mixed $object
* The object to execute the action on.
* @param \Drupal\Core\Session\AccountInterface $account
* (optional) The user for which to check access, or NULL to check access
* for the current user. Defaults to NULL.
* @param bool $return_as_object
* (optional) Defaults to FALSE.
*
* @return bool|\Drupal\Core\Access\AccessResultInterface
* The access result. Returns a boolean if $return_as_object is FALSE (this
* is the default) and otherwise an AccessResultInterface object.
* When a boolean is returned, the result of AccessInterface::isAllowed() is
* returned, i.e. TRUE means access is explicitly allowed, FALSE means
* access is either explicitly forbidden or "no opinion".
*/
public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE);
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overrides |
|---|---|---|---|---|
| ActionInterface::access | public | function | Checks object access. | 19 |
| ActionInterface::executeMultiple | public | function | Executes the plugin for an array of objects. | 1 |
| ExecutableInterface::execute | public | function | Executes the plugin. | 21 |
| PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 4 |
| PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.