interface RuleExpressionInterface

Defines a rule.

Hierarchy

  • interface \Drupal\rules\Engine\ActionExpressionInterface extends \Drupal\rules\Engine\ExpressionInterface; interface \Drupal\rules\Engine\ExpressionContainerInterface extends \Drupal\rules\Engine\ExpressionInterface \Drupal\rules\Engine\IteratorAggregate
    • interface \Drupal\rules\Engine\RuleExpressionInterface extends \Drupal\rules\Engine\ExpressionContainerInterface \Drupal\rules\Engine\ActionExpressionInterface

Expanded class hierarchy of RuleExpressionInterface

All classes that implement RuleExpressionInterface

2 files declare their use of RuleExpressionInterface
RuleExpression.php in src/Plugin/RulesExpression/RuleExpression.php
RuleExpressionForm.php in src/Form/Expression/RuleExpressionForm.php

File

src/Engine/RuleExpressionInterface.php, line 10

Namespace

Drupal\rules\Engine
View source 
interface RuleExpressionInterface extends ExpressionContainerInterface, ActionExpressionInterface {
    
    /**
     * Creates a condition expression and adds it to the container.
     *
     * @param string $condition_id
     *   The condition plugin id.
     * @param \Drupal\rules\Context\ContextConfig $config
     *   (optional) The configuration for the specified plugin.
     *
     * @return \Drupal\rules\Core\RulesConditionInterface
     *   The created condition.
     */
    public function addCondition($condition_id, ContextConfig $config = NULL);
    
    /**
     * Returns the conditions container of this rule.
     *
     * @return \Drupal\rules\Engine\ConditionExpressionContainerInterface
     *   The condition container of this rule.
     */
    public function getConditions();
    
    /**
     * Sets the condition container.
     *
     * @param \Drupal\rules\Engine\ConditionExpressionContainerInterface $conditions
     *   The condition container to set.
     *
     * @return $this
     */
    public function setConditions(ConditionExpressionContainerInterface $conditions);
    
    /**
     * Creates an action expression and adds it to the container.
     *
     * @param string $action_id
     *   The action plugin id.
     * @param \Drupal\rules\Context\ContextConfig $config
     *   (optional) The configuration for the specified plugin.
     *
     * @return $this
     */
    public function addAction($action_id, ContextConfig $config = NULL);
    
    /**
     * Returns the actions of this rule.
     *
     * @return \Drupal\rules\Engine\ActionExpressionContainerInterface
     *   The action container of this rule.
     */
    public function getActions();
    
    /**
     * Sets the action container.
     *
     * @param \Drupal\rules\Engine\ActionExpressionContainerInterface $actions
     *   The action container to set.
     *
     * @return $this
     */
    public function setActions(ActionExpressionContainerInterface $actions);

}

Members

Title Modifiers Object type Summary Overrides
ConfigurableInterface::defaultConfiguration public function Gets default configuration for this plugin. 14
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 15
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 15
DependentPluginInterface::calculateDependencies public function Calculates dependencies for the configured plugin. 20
ExecutableInterface::execute public function Executes the plugin. 21
ExpressionContainerInterface::addExpression public function Creates and adds an expression. 2
ExpressionContainerInterface::addExpressionObject public function Adds an expression object. 3
ExpressionContainerInterface::deleteExpression public function Deletes an expression identified by the specified UUID in the container. 3
ExpressionContainerInterface::getExpression public function Looks up the expression by UUID in this container. 3
ExpressionContainerInterface::getIterator public function Returns an iterator for expressions in this container. 3
ExpressionInterface::checkIntegrity public function Verifies that this expression is configured correctly. 4
ExpressionInterface::executeWithState public function Execute the expression with a given Rules state. 6
ExpressionInterface::getFormHandler public function Returns the form handling class for this expression. 1
ExpressionInterface::getLabel public function The label of this expression element that can be shown in the UI. 1
ExpressionInterface::getRoot public function Returns the root expression if this expression is nested. 1
ExpressionInterface::getUuid public function Returns the UUID of this expression if it is nested in another expression. 1
ExpressionInterface::getWeight public function Returns the list order of this expression. 1
ExpressionInterface::prepareExecutionMetadataState public function Prepares the execution metadata state by adding metadata to it. 4
ExpressionInterface::setRoot public function Set the root expression for this expression if it is nested. 1
ExpressionInterface::setUuid public function Sets the UUID of this expression in an expression tree. 1
ExpressionInterface::setWeight public function Sets the list order of this expression in an expression tree. 1
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
RuleExpressionInterface::addAction public function Creates an action expression and adds it to the container. 1
RuleExpressionInterface::addCondition public function Creates a condition expression and adds it to the container. 1
RuleExpressionInterface::getActions public function Returns the actions of this rule. 1
RuleExpressionInterface::getConditions public function Returns the conditions container of this rule. 1
RuleExpressionInterface::setActions public function Sets the action container. 1
RuleExpressionInterface::setConditions public function Sets the condition container. 1