1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Action
  7. \
  8. ActionInterface

ActionInterface

interface ActionInterface implements ExecutableInterface, PluginInspectionInterface (View source)

Provides an interface for an Action plugin.

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.

Methods

execute()

Executes the plugin.

from  ExecutableInterface
string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginInspectionInterface
array
getPluginDefinition()

Gets the definition of the plugin implementation.

from  PluginInspectionInterface
executeMultiple(array $objects)

Executes the plugin for an array of objects.

bool|AccessResultInterface
access(mixed $object, AccountInterface $account = NULL, bool $return_as_object = FALSE)

Checks object access.

Details

in ExecutableInterface at line 15
execute()

Executes the plugin.

in PluginInspectionInterface at line 21
string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

in PluginInspectionInterface at line 30
array getPluginDefinition()

Gets the definition of the plugin implementation.

Return Value

array

The plugin definition, as returned by the discovery object used by the plugin manager.

at line 39
executeMultiple(array $objects)

Executes the plugin for an array of objects.

Parameters

array $objects

An array of entities.

at line 59
bool|AccessResultInterface access(mixed $object, AccountInterface $account = NULL, bool $return_as_object = FALSE)

Checks object access.

Parameters

mixed $object

The object to execute the action on.
AccountInterface $account

(optional) The user for which to check access, or NULL to check access for the current user. Defaults to NULL.
bool $return_as_object

(optional) Defaults to FALSE.

Return Value

bool|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".