Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\aggregator\Plugin;
Chris@0: 
Chris@0: use Drupal\aggregator\FeedInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines an interface for aggregator parser implementations.
Chris@0:  *
Chris@0:  * A parser converts feed item data to a common format. The parser is called
Chris@0:  * at the second of the three aggregation stages: first, data is downloaded
Chris@0:  * by the active fetcher; second, it is converted to a common format by the
Chris@0:  * active parser; and finally, it is passed to all active processors which
Chris@0:  * manipulate or store the data.
Chris@0:  *
Chris@0:  * @see \Drupal\aggregator\Annotation\AggregatorParser
Chris@0:  * @see \Drupal\aggregator\Plugin\AggregatorPluginSettingsBase
Chris@0:  * @see \Drupal\aggregator\Plugin\AggregatorPluginManager
Chris@0:  * @see plugin_api
Chris@0:  */
Chris@0: interface ParserInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Parses feed data.
Chris@0:    *
Chris@0:    * @param \Drupal\aggregator\FeedInterface $feed
Chris@0:    *   An object describing the resource to be parsed.
Chris@0:    *   $feed->source_string->value contains the raw feed data. Parse the data
Chris@0:    *   and add the following properties to the $feed object:
Chris@0:    *   - description: The human-readable description of the feed.
Chris@0:    *   - link: A full URL that directly relates to the feed.
Chris@0:    *   - image: An image URL used to display an image of the feed.
Chris@0:    *   - etag: An entity tag from the HTTP header used for cache validation to
Chris@0:    *     determine if the content has been changed.
Chris@0:    *   - modified: The UNIX timestamp when the feed was last modified.
Chris@0:    *   - items: An array of feed items. The common format for a single feed item
Chris@0:    *     is an associative array containing:
Chris@0:    *     - title: The human-readable title of the feed item.
Chris@0:    *     - description: The full body text of the item or a summary.
Chris@0:    *     - timestamp: The UNIX timestamp when the feed item was last published.
Chris@0:    *     - author: The author of the feed item.
Chris@0:    *     - guid: The global unique identifier (GUID) string that uniquely
Chris@0:    *       identifies the item. If not available, the link is used to identify
Chris@0:    *       the item.
Chris@0:    *     - link: A full URL to the individual feed item.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if parsing was successful, FALSE otherwise.
Chris@0:    */
Chris@0:   public function parse(FeedInterface $feed);
Chris@0: 
Chris@0: }