Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/aggregator/src/Plugin/FetcherInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\aggregator\Plugin\FetcherInterface.
6	*/
7
8	namespace Drupal\aggregator\Plugin;
9
10	use Drupal\aggregator\FeedInterface;
11
12	/**
13	* Defines an interface for aggregator fetcher implementations.
14	*
15	* A fetcher downloads feed data to a Drupal site. The fetcher is called at the
16	* first of the three aggregation stages: first, data is downloaded by the
17	* active fetcher; second, it is converted to a common format by the active
18	* parser; and finally, it is passed to all active processors, which manipulate
19	* or store the data.
20	*
21	* @see \Drupal\aggregator\Annotation\AggregatorFetcher
22	* @see \Drupal\aggregator\Plugin\AggregatorPluginSettingsBase
23	* @see \Drupal\aggregator\Plugin\AggregatorPluginManager
24	* @see plugin_api
25	*/
26	interface FetcherInterface {
27
28	/**
29	* Downloads feed data.
30	*
31	* @param \Drupal\aggregator\FeedInterface $feed
32	* A feed object representing the resource to be downloaded.
33	* $feed->getUrl() contains the link to the feed.
34	* Download the data at the URL and expose it
35	* to other modules by attaching it to $feed->source_string.
36	*
37	* @return bool
38	* TRUE if fetching was successful, FALSE otherwise.
39	*/
40	public function fetch(FeedInterface $feed);
41
42	}