ClearableInterface.php in Feeds 8.3
Namespace
Drupal\feeds\Plugin\TypeFile
src/Plugin/Type/ClearableInterface.phpView source
<?php
namespace Drupal\feeds\Plugin\Type;
use Drupal\feeds\FeedInterface;
use Drupal\feeds\StateInterface;
/**
* Interface for plugins that store information related to a feed.
*/
interface ClearableInterface {
/**
* Removes all stored results for a feed.
*
* This can be implemented by any plugin type and the method will be called
* when a feed is being cleared (having its items deleted.) This is useful
* if the plugin caches or stores information related to a feed.
*
* This operation supports batching in the same way that importing does. You
* can get the state object from the feed.
* @code
* $state = $feed->getState(StateInterface::CLEAR);
*
* $state->total = (int) find_total($feed->id());
*
* $state->progress($state->total, $state->total - $deleted);
* @endcode
*
* @param \Drupal\feeds\FeedInterface $feed
* The feed being cleared. Implementers should only delete items pertaining
* to this feed. The preferred way of determining whether an item pertains
* to a certain feed is by using $feed->id(). It is the plugins's
* responsibility to store the id of an imported item during importing.
* @param \Drupal\feeds\StateInterface $state
* The state object.
*/
public function clear(FeedInterface $feed, StateInterface $state);
}
Interfaces
Name![]() |
Description |
---|---|
ClearableInterface | Interface for plugins that store information related to a feed. |