function ParserInterface::parse

Same name in other branches
  1. 8.9.x core/modules/aggregator/src/Plugin/ParserInterface.php \Drupal\aggregator\Plugin\ParserInterface::parse()

Parses feed data.

Parameters

\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 value

bool TRUE if parsing was successful, FALSE otherwise.

1 method overrides ParserInterface::parse()
DefaultParser::parse in core/modules/aggregator/src/Plugin/aggregator/parser/DefaultParser.php
Parses feed data.

File

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

Class

ParserInterface
Defines an interface for aggregator parser implementations.

Namespace

Drupal\aggregator\Plugin

Code

public function parse(FeedInterface $feed);

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