interface BusinessRulesActionPluginInterface in Business Rules 2.x

Defines an interface for Business rules Action plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\business_rules\Plugin\BusinessRulesItemPluginInterface
    • interface \Drupal\business_rules\Plugin\BusinessRulesActionPluginInterface

File

src/Plugin/BusinessRulesActionPluginInterface.php, line 11

Namespace

Drupal\business_rules\Plugin

interface BusinessRulesActionPluginInterface extends BusinessRulesItemPluginInterface {

  /**
   * Execute the action.
   *
   * @param \Drupal\business_rules\ActionInterface $action
   *   The configured action.
   * @param \Drupal\business_rules\Events\BusinessRulesEvent $event
   *   The event that has triggered the action.
   *
   * @return array
   *   The render array to be showed on debug block.
   */
  public function execute(ActionInterface $action, BusinessRulesEvent $event);

}

Members

Name	Modifiers	Type	Description	Overrides
BusinessRulesActionPluginInterface::execute	public	function	Execute the action.	1
BusinessRulesItemPluginInterface::buildForm	public	function	Form constructor.	1
BusinessRulesItemPluginInterface::getDescription	public	function	Provide a description of the item.	1
BusinessRulesItemPluginInterface::getEditUrl	public	function	Get the redirect url for the item edit-form route.	1
BusinessRulesItemPluginInterface::getGroup	public	function	Provide the group of the item.	1
BusinessRulesItemPluginInterface::getRedirectUrl	public	function	Get the redirect url for the item collection route.	1
BusinessRulesItemPluginInterface::getSettingsForm	public	function	Return the form array.	1
BusinessRulesItemPluginInterface::getVariables	public	function	Return a variable set with all used variables on the item.	1
BusinessRulesItemPluginInterface::pregMatch	public	function	Extract the variables from the plugin settings.	1
BusinessRulesItemPluginInterface::processSettings	public	function	Process the item settings before it's saved.	1
BusinessRulesItemPluginInterface::processTokens	public	function	Process the tokens on the settings property for the item.	1
BusinessRulesItemPluginInterface::processVariables	public	function	Process the item replacing the variables by it's values.	2
BusinessRulesItemPluginInterface::validateForm	public	function	Plugin form validator.	1
BusinessRulesItemPluginInterface::VARIABLE_REGEX		constant
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