interface ItemsImporterInterface

Same name and namespace in other branches
  1. 8.9.x core/modules/aggregator/src/ItemsImporterInterface.php \Drupal\aggregator\ItemsImporterInterface

Provides an interface defining an aggregator items importer.

Hierarchy

Expanded class hierarchy of ItemsImporterInterface

All classes that implement ItemsImporterInterface

File

core/modules/aggregator/src/ItemsImporterInterface.php, line 8

Namespace

Drupal\aggregator
View source
interface ItemsImporterInterface {
  
  /**
   * Updates the feed items by triggering the import process.
   *
   * This process can be slow and lengthy because it relies on network
   * operations. Calling it on performance critical paths should be avoided.
   *
   * @param \Drupal\aggregator\FeedInterface $feed
   *   The feed which items should be refreshed.
   *
   * @return bool
   *   TRUE if there is new content for the feed FALSE otherwise.
   */
  public function refresh(FeedInterface $feed);
  
  /**
   * Deletes all imported items from a feed.
   *
   * @param \Drupal\aggregator\FeedInterface $feed
   *   The feed that associated items should be deleted from.
   */
  public function delete(FeedInterface $feed);

}

Members

Title Sort descending Modifiers Object type Summary Overrides
ItemsImporterInterface::delete public function Deletes all imported items from a feed. 1
ItemsImporterInterface::refresh public function Updates the feed items by triggering the import process. 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.