class AggregatorProcessor

Same name in other branches
  1. 8.9.x core/modules/aggregator/src/Annotation/AggregatorProcessor.php \Drupal\aggregator\Annotation\AggregatorProcessor

Defines a Plugin annotation object for aggregator processor plugins.

Plugin Namespace: Plugin\aggregator\processor

For a working example, see \Drupal\aggregator\Plugin\aggregator\processor\DefaultProcessor

Hierarchy

Expanded class hierarchy of AggregatorProcessor

See also

\Drupal\aggregator\Plugin\AggregatorPluginManager

\Drupal\aggregator\Plugin\ProcessorInterface

\Drupal\aggregator\Plugin\AggregatorPluginSettingsBase

Plugin API

Related topics

Annotations
Annotations for class discovery and metadata description.
2 classes are annotated with AggregatorProcessor
DefaultProcessor in core/modules/aggregator/src/Plugin/aggregator/processor/DefaultProcessor.php
Defines a default processor implementation.
TestProcessor in core/modules/aggregator/tests/modules/aggregator_test/src/Plugin/aggregator/processor/TestProcessor.php
Defines a default processor implementation.

File

core/modules/aggregator/src/Annotation/AggregatorProcessor.php, line 21

Namespace

Drupal\aggregator\Annotation
View source 
class AggregatorProcessor extends Plugin {
    
    /**
     * The plugin ID.
     *
     * @var string
     */
    public $id;
    
    /**
     * The title of the plugin.
     *
     * @var \Drupal\Core\Annotation\Translation
     *
     * @ingroup plugin_translatable
     */
    public $title;
    
    /**
     * The description of the plugin.
     *
     * @var \Drupal\Core\Annotation\Translation
     *
     * @ingroup plugin_translatable
     */
    public $description;

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
AggregatorProcessor::$description public property The description of the plugin.
AggregatorProcessor::$id public property The plugin ID.
AggregatorProcessor::$title public property The title of the plugin.
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 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
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 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass 1
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. 3

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.