You are here

class DedupeEntity in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/migrate/src/Plugin/migrate/process/DedupeEntity.php \Drupal\migrate\Plugin\migrate\process\DedupeEntity

Ensures value is not duplicated against an entity field.

Plugin annotation


@MigrateProcessPlugin(
  id = "dedupe_entity"
)

Hierarchy

Expanded class hierarchy of DedupeEntity

1 file declares its use of DedupeEntity
DedupeEntityTest.php in core/modules/migrate/tests/src/Unit/process/DedupeEntityTest.php
Contains \Drupal\Tests\migrate\Unit\process\DedupeEntityTest.

File

core/modules/migrate/src/Plugin/migrate/process/DedupeEntity.php, line 22
Contains \Drupal\migrate\Plugin\migrate\process\DedupeEntity.

Namespace

Drupal\migrate\Plugin\migrate\process
View source
class DedupeEntity extends DedupeBase implements ContainerFactoryPluginInterface {

  /**
   * @var \Drupal\Core\Entity\Query\QueryFactoryInterface
   */
  protected $entityQueryFactory;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, QueryFactory $entity_query_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityQueryFactory = $entity_query_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
    return new static($configuration, $plugin_id, $plugin_definition, $migration, $container
      ->get('entity.query'));
  }

  /**
   * {@inheritdoc}
   */
  protected function exists($value) {

    // Plugins are cached so for every run we need a new query object.
    return $this->entityQueryFactory
      ->get($this->configuration['entity_type'], 'AND')
      ->condition($this->configuration['field'], $value)
      ->count()
      ->execute();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DedupeBase::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
DedupeEntity::$entityQueryFactory protected property
DedupeEntity::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DedupeEntity::exists protected function This is a query checking the existence of some value. Overrides DedupeBase::exists
DedupeEntity::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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
PluginBase::$configuration protected property Configuration information passed into the plugin. 2
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
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::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
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 2
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.