interface DataProcessorInterface

Interface for Rules data processor plugins.

Hierarchy

Expanded class hierarchy of DataProcessorInterface

All classes that implement DataProcessorInterface

3 files declare their use of DataProcessorInterface
ConditionExpressionTest.php in tests/src/Unit/ConditionExpressionTest.php
NumericOffset.php in src/Plugin/RulesDataProcessor/NumericOffset.php
TokenProcessor.php in src/Plugin/RulesDataProcessor/TokenProcessor.php

File

src/Context/DataProcessorInterface.php, line 8

Namespace

Drupal\rules\Context
View source 
interface DataProcessorInterface {
  
  /**
   * Process the given value.
   *
   * @param mixed $value
   *   The value to process.
   * @param \Drupal\rules\Context\ExecutionStateInterface $rules_state
   *   The current Rules execution state containing all context variables.
   *
   * @return mixed
   *   The processed value. Since the value can also be a primitive data type
   *   (a string for example) this function must return the value.
   *
   * @throws \Drupal\rules\Exception\EvaluationException
   *   Thrown when the data cannot be processed.
   */
  public function process($value, ExecutionStateInterface $rules_state);

}

Members

Title Modifiers Object type Summary Overrides
DataProcessorInterface::process public function Process the given value. 2