Mercurial > hg > isophonics-drupal-site
annotate core/modules/aggregator/src/ItemsImporterInterface.php @ 19:fa3358dc1485 tip
Add ndrum files
author | Chris Cannam |
---|---|
date | Wed, 28 Aug 2019 13:14:47 +0100 |
parents | 4c8ae668cc8c |
children |
rev | line source |
---|---|
Chris@0 | 1 <?php |
Chris@0 | 2 |
Chris@0 | 3 namespace Drupal\aggregator; |
Chris@0 | 4 |
Chris@0 | 5 /** |
Chris@0 | 6 * Provides an interface defining an aggregator items importer. |
Chris@0 | 7 */ |
Chris@0 | 8 interface ItemsImporterInterface { |
Chris@0 | 9 |
Chris@0 | 10 /** |
Chris@0 | 11 * Updates the feed items by triggering the import process. |
Chris@0 | 12 * |
Chris@0 | 13 * This process can be slow and lengthy because it relies on network |
Chris@0 | 14 * operations. Calling it on performance critical paths should be avoided. |
Chris@0 | 15 * |
Chris@0 | 16 * @param \Drupal\aggregator\FeedInterface $feed |
Chris@0 | 17 * The feed which items should be refreshed. |
Chris@0 | 18 * |
Chris@0 | 19 * @return bool |
Chris@0 | 20 * TRUE if there is new content for the feed FALSE otherwise. |
Chris@0 | 21 */ |
Chris@0 | 22 public function refresh(FeedInterface $feed); |
Chris@0 | 23 |
Chris@0 | 24 /** |
Chris@0 | 25 * Deletes all imported items from a feed. |
Chris@0 | 26 * |
Chris@0 | 27 * @param \Drupal\aggregator\FeedInterface $feed |
Chris@0 | 28 * The feed that associated items should be deleted from. |
Chris@0 | 29 */ |
Chris@0 | 30 public function delete(FeedInterface $feed); |
Chris@0 | 31 |
Chris@0 | 32 } |