abstract class Entity in Zircon Profile 8

Plugin annotation

@MigrateDestination(
  id = "entity",
  deriver = "Drupal\migrate\Plugin\Derivative\MigrateEntity"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements MigrateDestinationInterface, RequirementsInterface
      • class \Drupal\migrate\Plugin\migrate\destination\Entity implements DependentPluginInterface, ContainerFactoryPluginInterface uses DependencyTrait

23 string references to 'Entity'

Abstract2Dot5ApiTest::testGroupSequenceIncludesReferences in vendor/symfony/validator/Tests/Validator/Abstract2Dot5ApiTest.php

AbstractValidatorTest::testPropagateDefaultGroupToReferenceWhenReplacingDefaultGroup in vendor/symfony/validator/Tests/Validator/AbstractValidatorTest.php

AbstractValidatorTest::testReplaceDefaultGroupByGroupSequenceArray in vendor/symfony/validator/Tests/Validator/AbstractValidatorTest.php

AbstractValidatorTest::testReplaceDefaultGroupByGroupSequenceObject in vendor/symfony/validator/Tests/Validator/AbstractValidatorTest.php

AbstractValidatorTest::testReplaceDefaultGroupWithArrayFromGroupSequenceProvider in vendor/symfony/validator/Tests/Validator/AbstractValidatorTest.php

... See full list

File

core/modules/migrate/src/Plugin/migrate/destination/Entity.php, line 24

Contains \Drupal\migrate\Plugin\migrate\destination\Entity.

Namespace

Drupal\migrate\Plugin\migrate\destination

abstract class Entity extends DestinationBase implements ContainerFactoryPluginInterface, DependentPluginInterface {
  use DependencyTrait;

  /**
   * The entity storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $storage;

  /**
   * The list of the bundles of this entity type.
   *
   * @var array
   */
  protected $bundles;

  /**
   * Construct a new entity.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param MigrationInterface $migration
   *   The migration.
   * @param EntityStorageInterface $storage
   *   The storage for this entity type.
   * @param array $bundles
   *   The list of bundles this entity type has.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EntityStorageInterface $storage, array $bundles) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
    $this->storage = $storage;
    $this->bundles = $bundles;
    $this->supportsRollback = TRUE;
  }

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

  /**
   * Finds the entity type from configuration or plugin id.
   *
   * @param string $plugin_id
   *   The plugin id.
   *
   * @return string
   *   The entity type.
   */
  protected static function getEntityTypeId($plugin_id) {

    // Remove "entity:"
    return substr($plugin_id, 7);
  }

  /**
   * {@inheritdoc}
   */
  public function fields(MigrationInterface $migration = NULL) {

    // TODO: Implement fields() method.
  }

  /**
   * Creates or loads an entity.
   *
   * @param \Drupal\migrate\Row $row
   *   The row object.
   * @param array $old_destination_id_values
   *   The old destination ids.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   *   The entity we're importing into.
   */
  protected function getEntity(Row $row, array $old_destination_id_values) {
    $entity_id = $old_destination_id_values ? reset($old_destination_id_values) : $this
      ->getEntityId($row);
    if (!empty($entity_id) && ($entity = $this->storage
      ->load($entity_id))) {
      $this
        ->updateEntity($entity, $row);
    }
    else {

      // Stubs might need some required fields filled in.
      if ($row
        ->isStub()) {
        $this
          ->processStubRow($row);
      }
      $entity = $this->storage
        ->create($row
        ->getDestination());
      $entity
        ->enforceIsNew();
    }
    return $entity;
  }

  /**
   * Get the entity id of the row.
   *
   * @param \Drupal\migrate\Row $row
   *   The row of data.
   * @return string
   *   The entity id for the row we're importing.
   */
  protected function getEntityId(Row $row) {
    return $row
      ->getDestinationProperty($this
      ->getKey('id'));
  }

  /**
   * Returns a specific entity key.
   *
   * @param string $key
   *   The name of the entity key to return.
   *
   * @return string|bool
   *   The entity key, or FALSE if it does not exist.
   *
   * @see \Drupal\Core\Entity\EntityTypeInterface::getKeys()
   */
  protected function getKey($key) {
    return $this->storage
      ->getEntityType()
      ->getKey($key);
  }

  /**
   * {@inheritdoc}
   */
  public function rollback(array $destination_identifier) {

    // Delete the specified entity from Drupal if it exists.
    $entity = $this->storage
      ->load(reset($destination_identifier));
    if ($entity) {
      $entity
        ->delete();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $this
      ->addDependency('module', $this->storage
      ->getEntityType()
      ->getProvider());
    return $this->dependencies;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.	1
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
DestinationBase::$migration	protected	property	The migration.
DestinationBase::$rollbackAction	protected	property	The rollback action to be saved for the last imported item.
DestinationBase::$supportsRollback	protected	property	Indicates whether the destination can be rolled back.
DestinationBase::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DestinationBase::rollbackAction	public	function	The rollback action for the last imported item. Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction	protected	function	For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback	public	function	Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface::supportsRollback
Entity::$bundles	protected	property	The list of the bundles of this entity type.
Entity::$storage	protected	property	The entity storage.	1
Entity::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
Entity::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
Entity::fields	public	function	Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
Entity::getEntity	protected	function	Creates or loads an entity.	5
Entity::getEntityId	protected	function	Get the entity id of the row.	2
Entity::getEntityTypeId	protected static	function	Finds the entity type from configuration or plugin id.	3
Entity::getKey	protected	function	Returns a specific entity key.
Entity::rollback	public	function	Delete the specified destination object from the target Drupal. Overrides DestinationBase::rollback
Entity::__construct	public	function	Construct a new entity. Overrides DestinationBase::__construct
MigrateDestinationInterface::getIds	public	function	Get the destination ids.	10
MigrateDestinationInterface::import	public	function	Import the row.	10
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
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.