class Entity

Same name in this branch
  1. 9 core/modules/views/src/Plugin/views/argument_validator/Entity.php \Drupal\views\Plugin\views\argument_validator\Entity
  2. 9 core/modules/views/src/Plugin/views/area/Entity.php \Drupal\views\Plugin\views\area\Entity
  3. 9 core/tests/Drupal/Tests/Component/Annotation/Doctrine/Ticket/DCOM58Test.php \Drupal\Tests\Component\Annotation\Doctrine\Ticket\Entity
  4. 9 core/tests/Drupal/Tests/Component/Annotation/Doctrine/Ticket/DCOM58Entity.php \Entity
Same name and namespace in other branches
  1. 11.x core/modules/views/src/Plugin/views/argument_validator/Entity.php \Drupal\views\Plugin\views\argument_validator\Entity
  2. 11.x core/modules/views/src/Plugin/views/area/Entity.php \Drupal\views\Plugin\views\area\Entity
  3. 11.x core/modules/migrate/src/Plugin/migrate/destination/Entity.php \Drupal\migrate\Plugin\migrate\destination\Entity
  4. 11.x core/tests/Drupal/Tests/Component/Annotation/Doctrine/Ticket/DCOM58Test.php \Drupal\Tests\Component\Annotation\Doctrine\Ticket\Entity
  5. 11.x core/tests/Drupal/Tests/Component/Annotation/Doctrine/Ticket/DCOM58Entity.php \Entity
  6. 10 core/modules/views/src/Plugin/views/argument_validator/Entity.php \Drupal\views\Plugin\views\argument_validator\Entity
  7. 10 core/modules/views/src/Plugin/views/area/Entity.php \Drupal\views\Plugin\views\area\Entity
  8. 10 core/modules/migrate/src/Plugin/migrate/destination/Entity.php \Drupal\migrate\Plugin\migrate\destination\Entity
  9. 10 core/tests/Drupal/Tests/Component/Annotation/Doctrine/Ticket/DCOM58Test.php \Drupal\Tests\Component\Annotation\Doctrine\Ticket\Entity
  10. 10 core/tests/Drupal/Tests/Component/Annotation/Doctrine/Ticket/DCOM58Entity.php \Entity
  11. 8.9.x core/modules/views/src/Plugin/views/argument_validator/Entity.php \Drupal\views\Plugin\views\argument_validator\Entity
  12. 8.9.x core/modules/views/src/Plugin/views/area/Entity.php \Drupal\views\Plugin\views\area\Entity
  13. 8.9.x core/modules/migrate/src/Plugin/migrate/destination/Entity.php \Drupal\migrate\Plugin\migrate\destination\Entity
  14. 8.9.x core/tests/Drupal/Tests/Component/Annotation/Doctrine/Ticket/DCOM58Entity.php \Entity
  15. 8.9.x core/tests/Drupal/Tests/Component/Annotation/Doctrine/Ticket/DCOM58Test.php \Drupal\Tests\Component\Annotation\Doctrine\Ticket\Entity
  16. 8.9.x core/lib/Drupal/Core/Entity/Entity.php \Drupal\Core\Entity\Entity

Provides a generic destination to import entities.

Available configuration keys:

  • default_bundle: (optional) The bundle to use for this row if 'bundle' is not defined on the row.

Examples:


source:
  plugin: d7_node
process:
  nid: tnid
  vid: vid
  langcode: language
  title: title
  ...
  revision_timestamp: timestamp
destination:
  plugin: entity:node

This will save the processed, migrated row as a node.


source:
  plugin: d7_node
process:
  nid: tnid
  vid: vid
  langcode: language
  title: title
  ...
  revision_timestamp: timestamp
destination:
  plugin: entity:node
  default_bundle: custom

This will save the processed, migrated row as a node of type 'custom'.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of Entity

68 string references to 'Entity'
CommentBreadcrumbBuilder::applies in core/modules/comment/src/CommentBreadcrumbBuilder.php
CommentBreadcrumbBuilder::build in core/modules/comment/src/CommentBreadcrumbBuilder.php
comment_tokens in core/modules/comment/comment.tokens.inc
Implements hook_tokens().
comment_token_info in core/modules/comment/comment.tokens.inc
Implements hook_token_info().
comment_token_info in core/modules/comment/comment.tokens.inc
Implements hook_token_info().

... See full list

File

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

Namespace

Drupal\migrate\Plugin\migrate\destination
View source
abstract class Entity extends DestinationBase implements ContainerFactoryPluginInterface, DependentPluginInterface {
  use DependencyTrait;
  use EntityFieldDefinitionTrait;
  
  /**
   * The entity storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $storage;
  
  /**
   * The entity field manager.
   */
  protected $entityFieldManager;
  
  /**
   * 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 \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration.
   * @param \Drupal\Core\Entity\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) {
    $plugin_definition += [
      'label' => $storage->getEntityType()
        ->getPluralLabel(),
    ];
    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_type.manager')
      ->getStorage($entity_type_id), array_keys($container->get('entity_type.bundle.info')
      ->getBundleInfo($entity_type_id)));
  }
  
  /**
   * Gets the bundle for the row taking into account the default.
   *
   * @param \Drupal\migrate\Row $row
   *   The current row we're importing.
   *
   * @return string
   *   The bundle for this row.
   */
  public function getBundle(Row $row) {
    $default_bundle = $this->configuration['default_bundle'] ?? '';
    $bundle_key = $this->getKey('bundle');
    return $row->getDestinationProperty($bundle_key) ?: $default_bundle;
  }
  
  /**
   * {@inheritdoc}
   */
  public function fields() {
    // 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 are importing into.
   */
  protected function getEntity(Row $row, array $old_destination_id_values) {
    $entity_id = reset($old_destination_id_values) ?: $this->getEntityId($row);
    if (!empty($entity_id) && $entity = $this->storage
      ->load($entity_id)) {
      // Allow updateEntity() to change the entity.
      $entity = $this->updateEntity($entity, $row) ?: $entity;
    }
    else {
      // Attempt to ensure we always have a bundle.
      if ($bundle = $this->getBundle($row)) {
        $row->setDestinationProperty($this->getKey('bundle'), $bundle);
      }
      // Stubs might need some required fields filled in.
      if ($row->isStub()) {
        $this->processStubRow($row);
      }
      $entity = $this->storage
        ->create($row->getDestination());
      $entity->enforceIsNew();
    }
    return $entity;
  }
  
  /**
   * Gets the entity ID of the row.
   *
   * @param \Drupal\migrate\Row $row
   *   The row of data.
   *
   * @return string
   *   The entity ID for the row that we are 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;
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.