You are here

public function CleanableInterface::clean in Feeds 8.3

Applies an action to an entity to 'clean' it.

An action is applied on an entity for which the source item no longer exists in the feed.

An action can be:

  • Deleting the entity;
  • Unpublishing the entity;
  • Or any other action plugin that is applyable.

Parameters

\Drupal\feeds\FeedInterface $feed: The feed entity.

\Drupal\Core\Entity\EntityInterface $entity: The entity being cleaned.

\Drupal\feeds\Feeds\State\CleanStateInterface $state: The state object.

1 method overrides CleanableInterface::clean()
EntityProcessorBase::clean in src/Feeds/Processor/EntityProcessorBase.php
Applies an action to an entity to 'clean' it.

File

src/Plugin/Type/CleanableInterface.php, line 32

Class

CleanableInterface
Interface for plugins that need to perform cleanup tasks after processing.

Namespace

Drupal\feeds\Plugin\Type

Code

public function clean(FeedInterface $feed, EntityInterface $entity, CleanStateInterface $state);