yaffs.net Git - yaffs-website/blob - web/core/modules/aggregator/src/ItemsImporterInterface.php

   1 <?php
   2
   3 namespace Drupal\aggregator;
   4
   5 /**
   6  * Provides an interface defining an aggregator items importer.
   7  */
   8 interface ItemsImporterInterface {
   9
  10   /**
  11    * Updates the feed items by triggering the import process.
  12    *
  13    * This process can be slow and lengthy because it relies on network
  14    * operations. Calling it on performance critical paths should be avoided.
  15    *
  16    * @param \Drupal\aggregator\FeedInterface $feed
  17    *   The feed which items should be refreshed.
  18    *
  19    * @return bool
  20    *   TRUE if there is new content for the feed FALSE otherwise.
  21    */
  22   public function refresh(FeedInterface $feed);
  23
  24   /**
  25    * Deletes all imported items from a feed.
  26    *
  27    * @param \Drupal\aggregator\FeedInterface $feed
  28    *   The feed that associated items should be deleted from.
  29    */
  30   public function delete(FeedInterface $feed);
  31
  32 }