interface EntityProcessorInterface in Feeds 8.3

Interface for Feeds entity processor plugins.

Hierarchy

• interface \Drupal\feeds\Plugin\Type\Processor\ProcessorInterface; interface \Drupal\feeds\Plugin\Type\ClearableInterface; interface \Drupal\feeds\Plugin\Type\CleanableInterface; interface \Drupal\feeds\Plugin\Type\LockableInterface
  • interface \Drupal\feeds\Plugin\Type\Processor\EntityProcessorInterface

4 files declare their use of EntityProcessorInterface

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

FieldTargetBase.php in src/Plugin/Type/Target/FieldTargetBase.php

ItemListController.php in src/Controller/ItemListController.php

UserRole.php in src/Feeds/Target/UserRole.php

File

src/Plugin/Type/Processor/EntityProcessorInterface.php, line 14

Namespace

Drupal\feeds\Plugin\Type\Processor

interface EntityProcessorInterface extends ProcessorInterface, ClearableInterface, CleanableInterface, LockableInterface {

  /**
   * Returns a translation of the given entity.
   *
   * If a translation of the requested language does not exist yet on the
   * entity, one is created.
   *
   * @param \Drupal\feeds\FeedInterface $feed
   *   The feed that controls the import.
   * @param \Drupal\Core\Entity\TranslatableInterface $entity
   *   A translatable entity.
   * @param string $langcode
   *   The language in which to get the translation.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   *   The translated entity.
   */
  public function getEntityTranslation(FeedInterface $feed, TranslatableInterface $entity, $langcode);

  /**
   * Returns the current language for entities.
   *
   * @return string
   *   The current language code.
   */
  public function entityLanguage();

}

Members

Name	Modifiers	Type	Description	Overrides
CleanableInterface::clean	public	function	Applies an action to an entity to 'clean' it.	1
ClearableInterface::clear	public	function	Removes all stored results for a feed.	2
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
EntityProcessorInterface::entityLanguage	public	function	Returns the current language for entities.	1
EntityProcessorInterface::getEntityTranslation	public	function	Returns a translation of the given entity.	1
FeedsPluginInterface::defaultFeedConfiguration	public	function	Returns default feed configuration.	1
FeedsPluginInterface::pluginType	public	function	Returns the type of plugin.	1
LockableInterface::isLocked	public	function	Returns whether or not this plugin is locked.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
ProcessorInterface::DELETE_NON_EXISTENT		constant	Delete items that no longer exist in the feed.
ProcessorInterface::expireItem	public	function	Deletes feed items older than REQUEST_TIME - $time.	1
ProcessorInterface::EXPIRE_NEVER		constant	Feed items should never be expired.
ProcessorInterface::expiryTime	public	function	Returns the age of items that should be removed.	1
ProcessorInterface::getExpiredIds	public	function	Returns feed item ID's to expire.	1
ProcessorInterface::getImportedItemIds	public	function	Returns a list of ID's of entities that were imported.	1
ProcessorInterface::getItemCount	public	function	Counts the number of items imported by this processor.	1
ProcessorInterface::getItemLabel	public	function	Returns the label for feed items created.	1
ProcessorInterface::getItemLabelPlural	public	function	Returns the plural label for feed items created.	1
ProcessorInterface::INSERT_NEW		constant	Create new items from Feed.
ProcessorInterface::KEEP_NON_EXISTENT		constant	Keep items that no longer exist in the feed.
ProcessorInterface::postProcess	public	function	Called after an import is completed.	1
ProcessorInterface::process	public	function	Processes the results from a parser.	1
ProcessorInterface::REPLACE_EXISTING		constant	Replace items that exist already.
ProcessorInterface::SKIP_EXISTING		constant	Skip items that exist already.
ProcessorInterface::SKIP_NEW		constant	Skip new items from feed.
ProcessorInterface::UPDATE_EXISTING		constant	Update items that exist already.