class AggregatorParser

Same name in other branches
  1. 9 core/modules/aggregator/src/Annotation/AggregatorParser.php \Drupal\aggregator\Annotation\AggregatorParser

Defines a Plugin annotation object for aggregator parser plugins.

Plugin Namespace: Plugin\aggregator\parser

For a working example, see \Drupal\aggregator\Plugin\aggregator\parser\DefaultParser

Hierarchy

Expanded class hierarchy of AggregatorParser

See also

\Drupal\aggregator\Plugin\AggregatorPluginManager

\Drupal\aggregator\Plugin\ParserInterface

\Drupal\aggregator\Plugin\AggregatorPluginSettingsBase

Plugin API

Related topics

Annotations
Annotations for class discovery and metadata description.
2 classes are annotated with AggregatorParser
DefaultParser in core/modules/aggregator/src/Plugin/aggregator/parser/DefaultParser.php
Defines a default parser implementation.
TestParser in core/modules/aggregator/tests/modules/aggregator_test/src/Plugin/aggregator/parser/TestParser.php
Defines a Test parser implementation.

File

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

Namespace

Drupal\aggregator\Annotation
View source 
class AggregatorParser 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
AggregatorParser::$description public property The description of the plugin.
AggregatorParser::$id public property The plugin ID.
AggregatorParser::$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 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 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
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

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