diff core/modules/aggregator/src/ItemsImporterInterface.php @ 0:4c8ae668cc8c

Initial import (non-working)
author Chris Cannam
date Wed, 29 Nov 2017 16:09:58 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/core/modules/aggregator/src/ItemsImporterInterface.php	Wed Nov 29 16:09:58 2017 +0000
@@ -0,0 +1,32 @@
+<?php
+
+namespace Drupal\aggregator;
+
+/**
+ * Provides an interface defining an aggregator items importer.
+ */
+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);
+
+}