abstract class ProcessorBase in Feeds 8.3

Defines a base processor plugin class.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\feeds\Plugin\Type\PluginBase implements FeedsPluginInterface uses DependencyTrait
      • class \Drupal\feeds\Feeds\Processor\ProcessorBase implements ProcessorInterface

File

src/Feeds/Processor/ProcessorBase.php, line 13

Namespace

Drupal\feeds\Feeds\Processor

abstract class ProcessorBase extends PluginBase implements ProcessorInterface {

  /**
   * {@inheritdoc}
   */
  public function postProcess(FeedInterface $feed, StateInterface $state) {
    $tokens = [
      '@feed' => $feed
        ->label(),
      '@item' => $this
        ->getItemLabel(),
      '@items' => $this
        ->getItemLabelPlural(),
    ];
    if ($state->created) {
      $state
        ->setMessage($this
        ->formatPlural($state->created, '@feed: Created @count @item.', '@feed: Created @count @items.', $tokens));
    }
    if ($state->updated) {
      $state
        ->setMessage($this
        ->formatPlural($state->updated, '@feed: Updated @count @item.', '@feed: Updated @count @items.', $tokens));
    }
    if ($state->failed) {
      $state
        ->setMessage($this
        ->formatPlural($state->failed, '@feed: Failed importing @count @item.', '@feed: Failed importing @count @items.', $tokens), 'error');
    }
    if (!$state->created && !$state->updated && !$state->failed) {
      $state
        ->setMessage($this
        ->t('@feed: There are no new @items.', $tokens));
    }

    // Find out how many items were cleaned.
    $clean_state = $feed
      ->getState(StateInterface::CLEAN);
    if ($clean_state->updated) {
      $clean_state
        ->setMessage($this
        ->formatPlural($clean_state->updated, '@feed: Cleaned @count @item.', '@feed: Cleaned @count @items.', $tokens));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function postClear(FeedInterface $feed, StateInterface $state) {
    $tokens = [
      '@item' => $this
        ->getItemLabel(),
      '@items' => $this
        ->getItemLabelPlural(),
      '%title' => $feed
        ->label(),
    ];
    if ($state->deleted) {
      $state
        ->setMessage($this
        ->formatPlural($state->deleted, 'Deleted @count @item from %title.', 'Deleted @count @items from %title.', $tokens));
    }
    else {
      $state
        ->setMessage($this
        ->t('There are no @items to delete.', $tokens));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$feedType	protected	property	The importer this plugin is working for.
PluginBase::$linkGenerator	protected	property	The link generator.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$urlGenerator	protected	property	The url generator.
PluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	2
PluginBase::container	private	function	Returns the service container.
PluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	7
PluginBase::defaultFeedConfiguration	public	function	Returns default feed configuration. Overrides FeedsPluginInterface::defaultFeedConfiguration	3
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::l	protected	function	Renders a link to a route given a route name and its parameters.
PluginBase::linkGenerator	protected	function	Returns the link generator service.
PluginBase::onFeedDeleteMultiple	public	function	A feed is being deleted.	3
PluginBase::onFeedSave	public	function	A feed is being saved.
PluginBase::onFeedTypeDelete	public	function	The feed type is being deleted.	1
PluginBase::onFeedTypeSave	public	function	The feed type is being saved.	1
PluginBase::pluginType	public	function	Returns the type of plugin. Overrides FeedsPluginInterface::pluginType
PluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	1
PluginBase::url	protected	function	Generates a URL or path for a specific route based on the given parameters.
PluginBase::urlGenerator	protected	function	Returns the URL generator service.
PluginBase::__construct	public	function	Constructs a PluginBase object. Overrides PluginBase::__construct	4
ProcessorBase::postClear	public	function
ProcessorBase::postProcess	public	function	Called after an import is completed. Overrides ProcessorInterface::postProcess
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::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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.