DataProcessorInterface.php in Rules 8.3

Namespace

Drupal\rules\Context

File

src/Context/DataProcessorInterface.php

<?php

namespace Drupal\rules\Context;


/**
 * Interface for Rules data processor plugins.
 */
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);

}

Interfaces

Name	Description
DataProcessorInterface	Interface for Rules data processor plugins.