interface BusinessRulesVariablePluginInterface in Business Rules 2.x

Defines an interface for Business rules variable plugins.

Hierarchy

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

File

src/Plugin/BusinessRulesVariablePluginInterface.php, line 11

Namespace

Drupal\business_rules\Plugin

interface BusinessRulesVariablePluginInterface extends BusinessRulesItemPluginInterface {

  /**
   * Evaluate the variable.
   *
   * @param \Drupal\business_rules\Entity\Variable $variable
   *   The variable to be evaluated.
   * @param \Drupal\business_rules\Events\BusinessRulesEvent $event
   *   The dispatched event.
   *
   * @return \Drupal\business_rules\VariableObject|\Drupal\business_rules\VariablesSet
   *   The evaluated variables.
   */
  public function evaluate(Variable $variable, BusinessRulesEvent $event);

  /**
   * Change the variable details box.
   *
   * Give a chance to each variable plugin to change the variable details row on
   * Available Variables Box.
   *
   * @param \Drupal\business_rules\Entity\Variable $variable
   *   The variable.
   * @param array $row
   *   The row which contains the variable.
   */
  public function changeDetails(Variable $variable, array &$row);

}

Members

Name	Modifiers	Type	Description	Overrides
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
BusinessRulesVariablePluginInterface::changeDetails	public	function	Change the variable details box.	1
BusinessRulesVariablePluginInterface::evaluate	public	function	Evaluate the variable.	1
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