interface RulesActionInterface

Same name and namespace in other branches
  1. 7.x-2.x includes/rules.core.inc \RulesActionInterface

Extends the core ActionInterface to provide context.

Hierarchy

Expanded class hierarchy of RulesActionInterface

All classes that implement RulesActionInterface

File

src/Core/RulesActionInterface.php, line 13

Namespace

Drupal\rules\Core
View source 
interface RulesActionInterface extends ExecutableInterface, ContextAwarePluginInterface, ContextProviderInterface, ConfigurationAccessControlInterface {
  
  /**
   * Returns a list of context names that should be auto-saved after execution.
   *
   * @return array
   *   A subset of context names as specified in the context definition of this
   *   action.
   */
  public function autoSaveContext();
  
  /**
   * 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 Modifiers Object type Summary Overrides
ConfigurationAccessControlInterface::checkConfigurationAccess public function Check configuration access.
ContextAwarePluginInterface::assertMetadata public function Asserts additional metadata for the selected data. 2
ContextAwarePluginInterface::refineContextDefinitions public function Refines used and provided context definitions based upon context values. 2
ContextProviderInterface::getProvidedContext public function Gets a defined provided context.
ContextProviderInterface::getProvidedContextDefinition public function Gets a specific provided context definition of the plugin.
ContextProviderInterface::getProvidedContextDefinitions public function Gets the provided context definitions of the plugin.
ContextProviderInterface::setProvidedValue public function Sets the value for a provided context.
RulesActionInterface::access public function Checks object access. 1
RulesActionInterface::autoSaveContext public function Returns a list of context names that should be auto-saved after execution. 1