class RulesDataProcessor in Rules 8.3

Defines the RulesDataProcessor annotation class.

This annotation is used to identify plugins that want to alter variables before they are passed on during Rules execution.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\rules\Annotation\RulesDataProcessor

1 file declares its use of RulesDataProcessor

DataProcessorManager.php in src/Context/DataProcessorManager.php

2 classes are annotated with RulesDataProcessor

NumericOffset in src/Plugin/RulesDataProcessor/NumericOffset.php

A data processor for applying numerical offsets.

TokenProcessor in src/Plugin/RulesDataProcessor/TokenProcessor.php

A data processor for placeholder token replacements.

File

src/Annotation/RulesDataProcessor.php, line 15

Namespace

Drupal\rules\Annotation

class RulesDataProcessor extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the rules plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The data types this data processor can be applied to.
   *
   * @var array
   */
  public $types;

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
RulesDataProcessor::$id	public	property	The plugin ID.
RulesDataProcessor::$label	public	property	The human-readable name of the rules plugin.
RulesDataProcessor::$types	public	property	The data types this data processor can be applied to.