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 fetcher implementations.
Chris@0:  *
Chris@0:  * A fetcher downloads feed data to a Drupal site. The fetcher is called at the
Chris@0:  * first of the three aggregation stages: first, data is downloaded by the
Chris@0:  * active fetcher; second, it is converted to a common format by the active
Chris@0:  * parser; and finally, it is passed to all active processors, which manipulate
Chris@0:  * or store the data.
Chris@0:  *
Chris@0:  * @see \Drupal\aggregator\Annotation\AggregatorFetcher
Chris@0:  * @see \Drupal\aggregator\Plugin\AggregatorPluginSettingsBase
Chris@0:  * @see \Drupal\aggregator\Plugin\AggregatorPluginManager
Chris@0:  * @see plugin_api
Chris@0:  */
Chris@0: interface FetcherInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Downloads feed data.
Chris@0:    *
Chris@0:    * @param \Drupal\aggregator\FeedInterface $feed
Chris@0:    *   A feed object representing the resource to be downloaded.
Chris@0:    *   $feed->getUrl() contains the link to the feed.
Chris@0:    *   Download the data at the URL and expose it
Chris@0:    *   to other modules by attaching it to $feed->source_string.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if fetching was successful, FALSE otherwise.
Chris@0:    */
Chris@0:   public function fetch(FeedInterface $feed);
Chris@0: 
Chris@0: }