1. interface
  2. Drupal
  3. \
  4. aggregator
  5. \
  6. Plugin
  7. \
  8. FetcherInterface

FetcherInterface

interface FetcherInterface (View source)

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.

Methods

bool
fetch(FeedInterface $feed)

Downloads feed data.

Details

at line 35
bool fetch(FeedInterface $feed)

Downloads feed data.

Parameters

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 Value

bool

TRUE if fetching was successful, FALSE otherwise.