You are here

interface RulesActionHandlerInterface in Rules 7.2

Interface for implementing actions via classes.

In addition to the interface an execute() and a static getInfo() method must be implemented. The static getInfo() method has to return the info as returned by hook_rules_action_info() but including an additional 'name' key, specifying the plugin name. The execute method is the equivalent to the usual execution callback and gets the parameters passed as specified in the info array.

See RulesNodeConditionType for an example and rules_discover_plugins() for information about class discovery.

Hierarchy

Expanded class hierarchy of RulesActionHandlerInterface

All classes that implement RulesActionHandlerInterface

File

includes/rules.core.inc, line 2075
Rules base classes and interfaces needed for any rule evaluation.

View source
interface RulesActionHandlerInterface extends RulesPluginHandlerInterface {

}

Members

Namesort descending Modifiers Type Description Overrides
RulesPluginHandlerInterface::access public function Checks whether the user has access to configure this element. 1
RulesPluginHandlerInterface::assertions public function Returns an array of info assertions for the specified parameters. 1
RulesPluginHandlerInterface::dependencies public function Returns an array of required modules. 1
RulesPluginHandlerInterface::form_alter public function Alters the generated configuration form of the element. 1
RulesPluginHandlerInterface::info_alter public function Allows altering of the element's action/condition info. 1
RulesPluginHandlerInterface::process public function Processes settings independent from a form submission. 1
RulesPluginHandlerInterface::validate public function Validates $settings independent from a form submission. 1