public function ClearableInterface::clear in Feeds 8.3

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.

$state = $feed
  ->getState(StateInterface::CLEAR);
$state->total = (int) find_total($feed
  ->id());
$state
  ->progress($state->total, $state->total - $deleted);

Parameters

\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.

\Drupal\feeds\StateInterface $state: The state object.

2 methods override ClearableInterface::clear()

EntityProcessorBase::clear in src/Feeds/Processor/EntityProcessorBase.php

Removes all stored results for a feed.

HttpFetcher::clear in src/Feeds/Fetcher/HttpFetcher.php

Removes all stored results for a feed.

File

src/Plugin/Type/ClearableInterface.php, line 38

Class

ClearableInterface

Interface for plugins that store information related to a feed.

Namespace

Drupal\feeds\Plugin\Type

Code

public function clear(FeedInterface $feed, StateInterface $state);