interface FetcherInterface

Defines an interface for aggregator fetcher implementations.

A fetcher downloads feed data to a Drupal site. The fetcher is called at the first 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

• interface \Drupal\aggregator\Plugin\FetcherInterface

Expanded class hierarchy of FetcherInterface

All classes that implement FetcherInterface

See also

\Drupal\aggregator\Annotation\AggregatorFetcher

\Drupal\aggregator\Plugin\AggregatorPluginSettingsBase

\Drupal\aggregator\Plugin\AggregatorPluginManager

Plugin API

File

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

Namespace

interface FetcherInterface {
    
    /**
     * Downloads feed data.
     *
     * @param \Drupal\aggregator\FeedInterface $feed
     *   A feed object representing the resource to be downloaded.
     *   $feed->getUrl() contains the link to the feed.
     *   Download the data at the URL and expose it
     *   to other modules by attaching it to $feed->source_string.
     *
     * @return bool
     *   TRUE if fetching was successful, FALSE otherwise.
     */
    public function fetch(FeedInterface $feed);

}

Members