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

ProcessorInterface

interface ProcessorInterface (View source)

Defines an interface for aggregator processor implementations.

A processor acts on parsed feed data. Active processors are called at the third and last of the 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 that manipulate or store the data.

Methods

process(FeedInterface $feed)

Processes feed data.

postProcess(FeedInterface $feed)

Refreshes feed information.

delete(FeedInterface $feed)

Deletes stored feed data.

Details

at line 33
process(FeedInterface $feed)

Processes feed data.

Parameters

FeedInterface $feed

A feed object representing the resource to be processed. $feed->items contains an array of feed items downloaded and parsed at the parsing stage. See \Drupal\aggregator\Plugin\FetcherInterface::parse() for the basic format of a single item in the $feed->items array. For the exact format refer to the particular parser in use.

at line 46
postProcess(FeedInterface $feed)

Refreshes feed information.

Called after the processing of the feed is completed by all selected processors.

Parameters

FeedInterface $feed

Object describing feed.

See also

aggregator_refresh()

at line 57
delete(FeedInterface $feed)

Deletes stored feed data.

Called by aggregator if either a feed is deleted or a user clicks on "delete items".

Parameters

FeedInterface $feed

The $feed object whose items are being deleted.