interface ProcessorInterface in Zircon Profile 8

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.

Hierarchy

• interface \Drupal\aggregator\Plugin\ProcessorInterface

See also

\Drupal\aggregator\Annotation\AggregatorProcessor

\Drupal\aggregator\Plugin\AggregatorPluginSettingsBase

\Drupal\aggregator\Plugin\AggregatorPluginManager

Plugin API

2 files declare their use of ProcessorInterface

DefaultProcessor.php in core/modules/aggregator/src/Plugin/aggregator/processor/DefaultProcessor.php

Contains \Drupal\aggregator\Plugin\aggregator\processor\DefaultProcessor.

TestProcessor.php in core/modules/aggregator/tests/modules/aggregator_test/src/Plugin/aggregator/processor/TestProcessor.php

Contains \Drupal\aggregator_test\Plugin\aggregator\processor\TestProcessor.

File

core/modules/aggregator/src/Plugin/ProcessorInterface.php, line 26

Contains \Drupal\aggregator\Plugin\ProcessorInterface.

Namespace

Drupal\aggregator\Plugin

interface ProcessorInterface {

  /**
   * Processes feed data.
   *
   * @param \Drupal\aggregator\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.
   */
  public function process(FeedInterface $feed);

  /**
   * Refreshes feed information.
   *
   * Called after the processing of the feed is completed by all selected
   * processors.
   *
   * @param \Drupal\aggregator\FeedInterface $feed
   *   Object describing feed.
   *
   * @see aggregator_refresh()
   */
  public function postProcess(FeedInterface $feed);

  /**
   * Deletes stored feed data.
   *
   * Called by aggregator if either a feed is deleted or a user clicks on
   * "delete items".
   *
   * @param \Drupal\aggregator\FeedInterface $feed
   *   The $feed object whose items are being deleted.
   */
  public function delete(FeedInterface $feed);

}

Members

Name	Modifiers	Type	Description	Overrides
ProcessorInterface::delete	public	function	Deletes stored feed data.	2
ProcessorInterface::postProcess	public	function	Refreshes feed information.	2
ProcessorInterface::process	public	function	Processes feed data.	2