class ExpressionBase

Base class for rules expressions.

Hierarchy

Expanded class hierarchy of ExpressionBase

3 files declare their use of ExpressionBase
ActionExpression.php in src/Plugin/RulesExpression/ActionExpression.php
ConditionExpression.php in src/Plugin/RulesExpression/ConditionExpression.php
RuleExpression.php in src/Plugin/RulesExpression/RuleExpression.php

File

src/Engine/ExpressionBase.php, line 11

Namespace

Drupal\rules\Engine
View source 
abstract class ExpressionBase extends PluginBase implements ExpressionInterface {
  
  /**
   * The plugin configuration.
   *
   * @var array
   */
  protected $configuration;
  
  /**
   * The root expression if this object is nested.
   *
   * @var \Drupal\rules\Engine\ExpressionInterface
   */
  protected $root;
  
  /**
   * The config entity this expression is associated with, if any.
   *
   * @var string
   */
  protected $configEntityId;
  
  /**
   * The UUID of this expression.
   *
   * @var string
   */
  protected $uuid;
  
  /**
   * The weight (list order) of this expression.
   *
   * @var int
   */
  protected $weight = 0;
  
  /**
   * Constructor.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->setConfiguration($configuration);
  }
  
  /**
   * Executes a rules expression.
   */
  public function execute() {
    // If there is no state given, we have to assume no required context.
    $state = ExecutionState::create();
    $result = $this->executeWithState($state);
    // Save specifically registered variables in the end after execution.
    $state->autoSave();
    return $result;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return [
      'id' => $this->getPluginId(),
      'uuid' => $this->uuid,
      'weight' => $this->weight,
    ] + $this->configuration;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = $configuration + $this->defaultConfiguration();
    if (isset($configuration['uuid'])) {
      $this->uuid = $configuration['uuid'];
    }
    if (isset($configuration['weight'])) {
      $this->weight = $configuration['weight'];
    }
    return $this;
  }
  
  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }
  
  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }
  
  /**
   * {@inheritdoc}
   */
  public function getFormHandler() {
    if (isset($this->pluginDefinition['form_class'])) {
      $class_name = $this->pluginDefinition['form_class'];
      return new $class_name($this);
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function getRoot() {
    if (isset($this->root)) {
      // @todo This seems to be the parent, not root.
      return $this->root
        ->getRoot();
    }
    return $this;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setRoot(ExpressionInterface $root) {
    $this->root = $root;
    return $this;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    return $this->pluginDefinition['label'];
  }
  
  /**
   * {@inheritdoc}
   */
  public function getUuid() {
    return $this->uuid;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setUuid($uuid) {
    $this->uuid = $uuid;
    return $this;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getWeight() {
    return $this->weight;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setWeight($weight) {
    $this->weight = $weight;
    return $this;
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ExpressionBase::$configEntityId protected property The config entity this expression is associated with, if any.
ExpressionBase::$configuration protected property The plugin configuration.
ExpressionBase::$root protected property The root expression if this object is nested.
ExpressionBase::$uuid protected property The UUID of this expression.
ExpressionBase::$weight protected property The weight (list order) of this expression.
ExpressionBase::calculateDependencies public function
ExpressionBase::defaultConfiguration public function 2
ExpressionBase::execute public function Executes a rules expression.
ExpressionBase::getConfiguration public function 3
ExpressionBase::getFormHandler public function Returns the form handling class for this expression. Overrides ExpressionInterface::getFormHandler 2
ExpressionBase::getLabel public function The label of this expression element that can be shown in the UI. Overrides ExpressionInterface::getLabel 2
ExpressionBase::getRoot public function Returns the root expression if this expression is nested. Overrides ExpressionInterface::getRoot
ExpressionBase::getUuid public function Returns the UUID of this expression if it is nested in another expression. Overrides ExpressionInterface::getUuid
ExpressionBase::getWeight public function Returns the list order of this expression. Overrides ExpressionInterface::getWeight
ExpressionBase::setConfiguration public function 2
ExpressionBase::setRoot public function Set the root expression for this expression if it is nested. Overrides ExpressionInterface::setRoot
ExpressionBase::setUuid public function Sets the UUID of this expression in an expression tree. Overrides ExpressionInterface::setUuid
ExpressionBase::setWeight public function Sets the list order of this expression in an expression tree. Overrides ExpressionInterface::setWeight
ExpressionBase::__construct public function Constructor. 5
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::prepareExecutionMetadataState public function Prepares the execution metadata state by adding metadata to it. 4