interface ParserInterface

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

Defines an interface for aggregator parser implementations.

A parser converts feed item data to a common format. The parser is called at the second of the three aggregation stages: first, data is downloaded by the active fetcher; second, it is converted to a common format by the active parser; and finally, it is passed to all active processors which manipulate or store the data.

Hierarchy

Expanded class hierarchy of ParserInterface

All classes that implement ParserInterface

See also

\Drupal\aggregator\Annotation\AggregatorParser

\Drupal\aggregator\Plugin\AggregatorPluginSettingsBase

\Drupal\aggregator\Plugin\AggregatorPluginManager

Plugin API

2 files declare their use of ParserInterface
DefaultParser.php in core/modules/aggregator/src/Plugin/aggregator/parser/DefaultParser.php
TestParser.php in core/modules/aggregator/tests/modules/aggregator_test/src/Plugin/aggregator/parser/TestParser.php

File

core/modules/aggregator/src/Plugin/ParserInterface.php, line 21

Namespace

Drupal\aggregator\Plugin
View source 
interface ParserInterface {
    
    /**
     * Parses feed data.
     *
     * @param \Drupal\aggregator\FeedInterface $feed
     *   An object describing the resource to be parsed.
     *   $feed->source_string->value contains the raw feed data. Parse the data
     *   and add the following properties to the $feed object:
     *   - description: The human-readable description of the feed.
     *   - link: A full URL that directly relates to the feed.
     *   - image: An image URL used to display an image of the feed.
     *   - etag: An entity tag from the HTTP header used for cache validation to
     *     determine if the content has been changed.
     *   - modified: The UNIX timestamp when the feed was last modified.
     *   - items: An array of feed items. The common format for a single feed item
     *     is an associative array containing:
     *     - title: The human-readable title of the feed item.
     *     - description: The full body text of the item or a summary.
     *     - timestamp: The UNIX timestamp when the feed item was last published.
     *     - author: The author of the feed item.
     *     - guid: The global unique identifier (GUID) string that uniquely
     *       identifies the item. If not available, the link is used to identify
     *       the item.
     *     - link: A full URL to the individual feed item.
     *
     * @return bool
     *   TRUE if parsing was successful, FALSE otherwise.
     */
    public function parse(FeedInterface $feed);

}

Members

Title Modifiers Object type Summary Overrides
ParserInterface::parse public function Parses feed data. 1

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