interface ItemsImporterInterface in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/aggregator/src/ItemsImporterInterface.php \Drupal\aggregator\ItemsImporterInterface
Provides an interface defining an aggregator items importer.
Hierarchy
- interface \Drupal\aggregator\ItemsImporterInterface
Expanded class hierarchy of ItemsImporterInterface
All classes that implement ItemsImporterInterface
File
- core/
modules/ aggregator/ src/ ItemsImporterInterface.php, line 13 - Contains \Drupal\aggregator\ItemsImporterInterface.
Namespace
Drupal\aggregatorView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ItemsImporterInterface:: |
public | function | Deletes all imported items from a feed. | 1 |
ItemsImporterInterface:: |
public | function | Updates the feed items by triggering the import process. | 1 |