
| Current Path : /var/www/html/pallets_old/web/core/modules/aggregator/src/Plugin/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : /var/www/html/pallets_old/web/core/modules/aggregator/src/Plugin/FetcherInterface.php |
<?php
namespace Drupal\aggregator\Plugin;
use Drupal\aggregator\FeedInterface;
/**
* Defines an interface for aggregator fetcher implementations.
*
* A fetcher downloads feed data to a Drupal site. The fetcher is called at the
* first of the three aggregation stages: first, data is downloaded by the
* active fetcher; second, it is converted to a common format by the active
* parser; and finally, it is passed to all active processors, which manipulate
* or store the data.
*
* @see \Drupal\aggregator\Annotation\AggregatorFetcher
* @see \Drupal\aggregator\Plugin\AggregatorPluginSettingsBase
* @see \Drupal\aggregator\Plugin\AggregatorPluginManager
* @see plugin_api
*/
interface FetcherInterface {
/**
* Downloads feed data.
*
* @param \Drupal\aggregator\FeedInterface $feed
* A feed object representing the resource to be downloaded.
* $feed->getUrl() contains the link to the feed.
* Download the data at the URL and expose it
* to other modules by attaching it to $feed->source_string.
*
* @return bool
* TRUE if fetching was successful, FALSE otherwise.
*/
public function fetch(FeedInterface $feed);
}