rules_conditional.plugin.inc in Conditional Rules 8

Rules plugin implementation.

File

includes/rules_conditional.plugin.inc

<?php

/**
 * @file
 * Rules plugin implementation.
 */

// Load new file to avoid registry rebuild problems.
// TODO Remove this after a while.
if (!class_exists('RulesConditionalContainer')) {
  module_load_include('inc', 'rules_conditional', 'includes/rules_conditional.core');
}

/**
 * Default if-else conditional statement.
 *
 * @method RulesConditional if() if($predicate, array $settings = array()) Adds an "if" statement.
 * @method RulesConditional elseIf() elseIf($predicate, array $settings = array()) Adds an "else if" statement. This is an alias for self::if().
 * @method RulesConditional else() else() Adds an "else" statement.
 * @method RulesConditional action() action($name, array $settings = array()) Adds an action to the currently active statement. Pass arguments as rules_action() would need.
 */
class RulesConditional extends RulesConditionalContainer {
  protected $itemName = 'conditional';

  /**
   * Intercepts calls to "if" and "else".
   * @var array
   */
  protected $interceptMethods = array(
    'if',
    'elseIf',
    'else',
  );
  public function __construct() {
    parent::__construct();
  }

  /**
   * Adds an "if" statement, for use with magic call.
   */
  protected function call_if($predicate, array $settings = array()) {
    $this->fluentElement = $element = rules_conditional_if($predicate, $settings);
    $element
      ->setParent($this);
    return $this;
  }

  /**
   * Adds an "if" as an "else if" statement, for use with magic call.
   */
  protected function call_elseIf($predicate, array $settings = array()) {
    return $this
      ->call_if($predicate, $settings);
  }

  /**
   * Adds an "else" statement, for use with magic call.
   */
  protected function call_else() {
    $this->fluentElement = $element = rules_conditional_else();
    $element
      ->setParent($this);
    return $this;
  }

  /**
   * Selects the branches to evaluate for this conditional.
   *
   * @param RulesState $state
   *   Rules state to use.
   * @return RulesConditionalElement[]
   *   An array of branches to evaluate.
   */
  protected function selectBranches(RulesState $state) {

    /** @var $branch RulesConditionalElement */
    foreach ($this->children as $branch) {

      // Select the first matched branch.
      if ($branch
        ->canEvaluate($state)) {
        return array(
          $branch,
        );
      }
    }

    // Return no branch if none matched.
    return array();
  }
  protected function exportFlat() {
    return TRUE;
  }

}

/**
 * The "if" clause.
 */
class RulesConditionalIf extends RulesConditionalPredicateElement {
  protected $itemName = 'if';
  public function pluginLabel() {
    $previous = $this
      ->getPreviousSibling();
    if ($previous && $previous instanceof RulesConditionalIf) {
      return t('(Else) If', array(), array(
        'context' => 'conditional rules',
      ));
    }
    else {
      return parent::pluginLabel();
    }
  }

  /**
   * Imports predicate.
   */
  protected function importPredicate($export, $key = NULL) {
    $plugin = strtoupper($this
      ->plugin());
    $pluginInfo = $this
      ->pluginInfo();
    $keys = !empty($pluginInfo['import keys']) ? $pluginInfo['import keys'] : array(
      $plugin,
    );
    foreach ($keys as $key) {
      if (isset($export[$key])) {
        parent::importPredicate($export, $key);
        break;
      }
    }
  }

  /**
   * Exports predicate.
   */
  protected function exportPredicate($key = NULL) {
    if ($this
      ->getPreviousSibling()) {
      $key = 'ELSE IF';
    }
    return parent::exportPredicate($key);
  }

}

/**
 * The "else" clause.
 */
class RulesConditionalElse extends RulesConditionalElement {
  protected $itemName = 'else';
  public function __construct() {
    parent::__construct();
  }
  public function isDefault() {
    return TRUE;
  }
  protected function importChildren($export, $key = NULL) {
    RulesContainerPlugin::importChildren($export);
  }
  protected function exportChildren($key = NULL) {
    return RulesContainerPlugin::exportChildren();
  }
  protected function exportFlat() {
    return TRUE;
  }

}

/**
 * Switch conditional container.
 *
 * @method RulesConditionalSwitch case() case($value, $fallThrough = FALSE, $valueIsSelector = FALSE) Adds a "case" statement.
 * @method RulesConditionalSwitch defaultCase() defaultCase() Adds a "default case" statement.
 * @method RulesConditionalSwitch action() action($name, array $settings = array()) Adds an action to the currently active statement. Pass arguments as rules_action() would need.
 */
class RulesConditionalSwitch extends RulesConditionalContainer {
  protected $itemName = 'switch';

  /**
   * Intercepts calls to "case" and "defaultCase".
   * @var array
   */
  protected $interceptMethods = array(
    'case',
    'defaultCase',
  );
  public function __construct($dataSelector = NULL) {
    parent::__construct();
    if (isset($dataSelector)) {
      $this->settings['data:select'] = $dataSelector;
    }
  }

  /**
   * Adds a "case" statement, for use with magic call.
   */
  protected function call_case($settings = array(), $fallThrough = FALSE) {
    $this->fluentElement = $element = rules_conditional_case($settings, $fallThrough);
    $element
      ->setParent($this);
    return $this;
  }

  /**
   * Adds a "defaultCase" statement, for use with magic call.
   */
  protected function call_defaultCase() {
    $this->fluentElement = $element = rules_conditional_default_case();
    $element
      ->setParent($this);
    return $this;
  }
  public function pluginParameterInfo() {
    $parameterInfo = array(
      'data' => array(
        'type' => '*',
        'label' => t('Data to match cases against'),
        'description' => t('The data to be compared, specified by using a data selector, e.g. "node:author:name".'),
        'restriction' => 'selector',
        'allow null' => TRUE,
      ),
    );
    return $parameterInfo;
  }

  /**
   * Selects the branches to evaluate for this conditional.
   *
   * @param RulesState $state
   *   Rules state to use.
   * @return RulesConditionalElement[]
   *   An array of branches to evaluate.
   */
  protected function selectBranches(RulesState $state) {
    $branches = array();

    // Collect all cases to be evaluated.
    $fallThrough = FALSE;
    foreach ($this->children as $case) {

      /** @var $case RulesConditionalCase */
      if ($case
        ->canEvaluate($state)) {
        $branches[] = $case;
      }
    }
    return $branches;
  }
  protected function importChildren($export, $key = NULL) {
    parent::importChildren($export, 'DO');
  }
  protected function exportChildren($key = NULL) {
    return parent::exportChildren('DO');
  }

}

/**
 * Switch case.
 */
class RulesConditionalCase extends RulesConditionalElement {
  protected $itemName = 'case';

  /**
   * @var RulesPlugin
   */
  protected $condition;

  /**
   * Evaluated condition results.
   * @var array
   */
  protected $conditionResultCache = array();
  public function __construct($settings = array(), $fallThrough = FALSE) {
    parent::__construct();
    if (isset($settings['value'])) {
      $this->settings['value'] = $settings['value'];
    }
    elseif (isset($settings['value:select'])) {
      $this->settings['value:select'] = $settings['value:select'];
    }
    $this->settings += array(
      'fall_through' => $fallThrough,
    );
  }
  public function __destruct() {
    unset($this->condition);
    unset($this->conditionResultCache);
  }
  public function forceSetUp() {
    parent::forceSetUp();
    $this
      ->setUpCondition();
  }
  public function pluginParameterInfo() {
    $parameterInfo = array(
      'value' => array(
        'type' => '*',
        'label' => t('Data value'),
        'description' => t('The value to compare the data with.'),
        'allow null' => TRUE,
      ),
      'fall_through' => array(
        'type' => 'boolean',
        'label' => t('Fall through'),
        'description' => t('Fall through to next case when complete. If this option is checked, the next case is automatically executed (regardless of the case value) when this case is finished. If not, the switch will terminate when the case is finished.'),
        'optional' => TRUE,
        'default value' => FALSE,
        'restriction' => 'input',
      ),
    );

    // Derive parameter info from switch variable selector.
    $dataSelector = isset($this->parent->settings['data:select']) ? $this->parent->settings['data:select'] : NULL;
    if ($wrapper = $this
      ->applyDataSelector($dataSelector)) {
      $parameterInfo['value']['type'] = $wrapper
        ->type();
    }
    return $parameterInfo;
  }
  public function stateVariables($element = NULL) {
    $this
      ->forceSetUp();
    if (!isset($element) || $element === $this->condition) {
      return parent::stateVariables();
    }
    else {

      // Add assertions from the condition.
      $variables = parent::stateVariables($element);
      if (isset($this->condition) && ($assertions = $this->condition
        ->call('variableInfoAssertions'))) {
        $variables = RulesData::addMetadataAssertions($variables, $assertions);
      }
      return $variables;
    }
  }
  protected function setUpCondition() {
    if (!isset($this->condition) && isset($this->parent)) {

      // Prepare settings for 'data_is' condition.
      $settings = array(
        'data:select' => $this->parent->settings['data:select'],
        'op' => '==',
      );
      if (isset($this->settings['value:select'])) {
        $settings['value:select'] = $this->settings['value:select'];
      }
      elseif (isset($this->settings['value'])) {
        $settings['value'] = $this->settings['value'];
      }
      else {

        // Abort if settings are incomplete.
        return;
      }

      // Set up 'data_is'.
      $this->condition = rules_condition('data_is', $settings);
      $this->condition->parent = $this;
      $this->condition
        ->processSettings();
    }
  }

  /**
   * Returns whether this case should fall through.
   */
  public function fallThrough() {
    return !empty($this->settings['fall_through']);
  }

  /**
   * Determines whether this branch can be evaluated.
   */
  public function canEvaluate(RulesState $state) {
    $this
      ->forceSetUp();

    // Check if this element has fallen through.
    if ($previous = $this
      ->getPreviousSibling()) {

      /** @var $previous self */
      if ($previous instanceof self && $previous
        ->fallThrough() && $previous
        ->canEvaluate($state)) {
        return TRUE;
      }
    }

    // Evaluate condition for the given state once.
    $this->conditionResultCache += array(
      'state' => array(),
      'result' => array(),
    );
    if (empty($this->conditionResultCache['state']) || !($cacheKey = array_search($state, $this->conditionResultCache['state'], TRUE))) {
      $cacheKey = count($this->conditionResultCache['state']);
      $this->conditionResultCache['state'][$cacheKey] = $state;
      $this->conditionResultCache['result'][$cacheKey] = $this->condition
        ->evaluate($state);
    }
    return !empty($this->conditionResultCache['result'][$cacheKey]);
  }
  public function resetInternalCache() {
    parent::resetInternalCache();
    $this->condition = NULL;
    $this->conditionResultCache = array();
  }

}

/**
 * Switch default case.
 */
class RulesConditionalDefaultCase extends RulesConditionalElement {
  protected $itemName = 'default case';
  public function __construct() {
    parent::__construct();
  }
  public function canEvaluate(RulesState $state) {

    // Check if this element has fallen through.
    if ($previous = $this
      ->getPreviousSibling()) {

      /** @var $previous self */
      if ($previous
        ->fallThrough() && $previous
        ->canEvaluate($state)) {
        return $this
          ->isDefault();
      }
    }
    $siblings = $this
      ->getAllSibling();
    $sibling_can_evaluate = FALSE;
    foreach ($siblings as $sibling) {
      if ($sibling
        ->canEvaluate($state)) {
        $sibling_can_evaluate = TRUE;
      }
    }
    return $sibling_can_evaluate ? FALSE : $this
      ->isDefault();
  }
  public function isDefault() {
    return TRUE;
  }
  protected function importChildren($export, $key = NULL) {
    RulesContainerPlugin::importChildren($export);
  }
  protected function exportChildren($key = NULL) {
    return RulesContainerPlugin::exportChildren();
  }
  protected function exportFlat() {
    return TRUE;
  }

}

/**
 * While loop.
 */
class RulesConditionalWhile extends RulesConditionalPredicateElement {
  protected $itemName = 'while';
  public function providesVariables() {
    return array();
  }
  public function evaluate(RulesState $state) {
    $iteration = 0;
    $maxIterations = variable_get('rules_conditional_max_iterations', RULES_CONDITIONAL_MAX_ITERATIONS);
    while ($iteration < $maxIterations && $this
      ->canEvaluate($state)) {

      // Use a separate state so variables are available in the loop only.
      $clonedState = clone $state;
      parent::evaluate($clonedState);
      $iteration++;

      // Retrieve variables.
      foreach ($state->variables as $key => &$value) {
        if (array_key_exists($key, $clonedState->variables)) {
          $value = $clonedState->variables[$key];
        }
      }
    }
  }

  /**
   * Deletes the element and its children.
   */
  public function delete($keep_children = TRUE) {
    parent::delete($keep_children);
  }

}

/**
 * Rule as condition set.
 *
 * A rule condition set evaluates a set of actions before evaluating the result
 * condition on the new state.
 */
class RuleConditionSet extends RulesAnd {
  protected $itemName = 'rule condition set';

  /** @var RulesActionSet */
  protected $actions = NULL;
  public function __construct($variables = array()) {
    parent::__construct($variables);
    if (!isset($this->actions)) {
      $this->actions = rules_action_set();
      $this->actions->parent = $this;
    }
  }
  public function __sleep() {
    return parent::__sleep() + drupal_map_assoc(array(
      'actions',
    ));
  }

  /**
   * Get an iterator over all contained actions.
   * @return RulesRecursiveElementIterator
   */
  public function actions() {
    return $this->actions
      ->getIterator();
  }

  /**
   * Returns the contained action set to evaluate the result for.
   */
  public function actionContainer() {
    return $this->actions;
  }

  /**
   * Adds an action to the rule condition. Pass either an instance of the
   * RulesActionInterface or the arguments as needed by rules_action().
   *
   * This method can be chained.
   */
  public function action($name, $settings = array()) {
    $this->actions
      ->action($name, $settings);
    return $this;
  }

  /**
   * Returns a recursive iterator for result conditions.
   * @return RulesRecursiveElementIterator
   */
  public function conditions() {
    return parent::getIterator();
  }
  public function evaluate(RulesState $state) {
    rules_log('Evaluating actions of rule condition set %label.', array(
      '%label' => $this
        ->label(),
    ), RulesLog::INFO, $this);
    $this->actions
      ->evaluate($state);
    rules_log('Evaluating result conditions of rule condition set %label.', array(
      '%label' => $this
        ->label(),
    ), RulesLog::INFO, $this);
    return parent::evaluate($state);
  }
  public function integrityCheck() {
    parent::integrityCheck();
    $this->actions
      ->integrityCheck();
    return $this;
  }
  public function access() {
    return $this->actions
      ->access() && parent::access();
  }
  public function dependencies() {
    $modules = array(
      'rules_conditional' => 1,
    );
    $modules += array_flip($this->actions
      ->dependencies());
    $modules += array_flip(parent::dependencies());
    return array_keys($modules);
  }
  public function destroy() {
    $this->actions
      ->destroy();
    parent::destroy();
  }

  /**
   * @return RulesRecursiveElementIterator
   */
  public function getIterator() {
    $array = array_merge(array(
      $this->actions,
    ), $this->children);
    return new RulesRecursiveElementIterator($array);
  }
  protected function stateVariables($element = NULL) {
    $vars = $this
      ->availableVariables();
    if (isset($element) && $element !== $this->actions) {

      // Provide action variables for conditions.
      foreach ($this->actions->children as $child) {
        $vars += $child
          ->providesVariables();
      }

      // Provide condition state variables.
      foreach ($this->children as $child) {
        if ($child === $element) {
          break;
        }
        $vars += $child
          ->providesVariables();

        // Assert variable info from child conditions.
        if (!$child
          ->isNegated() && ($assertions = $child
          ->variableInfoAssertions())) {
          $vars = RulesData::addMetadataAssertions($vars, $assertions);
        }
      }
    }
    return $vars;
  }
  protected function exportChildren($key = NULL) {
    $export = array();
    if ($this->actions->children) {
      $export += $this->actions
        ->exportChildren('DO');
    }
    $export += parent::exportChildren('RESULT');
    return $export;
  }
  protected function importChildren($export, $key = NULL) {
    if (!empty($export['DO'])) {
      $this->actions
        ->importChildren($export, 'DO');
    }
    parent::importChildren($export, 'RESULT');
  }
  public function __clone() {
    parent::__clone();
    $this->actions = clone $this->actions;
    $this->actions->parent = $this;
  }

  /**
   * Deletes nested elements by default.
   */
  public function delete($keep_children = FALSE) {
    parent::delete($keep_children);
  }
  public function resetInternalCache() {
    parent::resetInternalCache();
    $this->actions
      ->resetInternalCache();
  }

}

Classes

Name	Description
RuleConditionSet	Rule as condition set.
RulesConditional	Default if-else conditional statement.
RulesConditionalCase	Switch case.
RulesConditionalDefaultCase	Switch default case.
RulesConditionalElse	The "else" clause.
RulesConditionalIf	The "if" clause.
RulesConditionalSwitch	Switch conditional container.
RulesConditionalWhile	While loop.