class EntityContentBase in Multiversion 8

Migration destination class for content entities.

@todo: Implement derivatives for all content entity types and bundles.

Plugin annotation

@MigrateDestination(
  id = "multiversion"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements MigrateDestinationInterface, RequirementsInterface
      • class \Drupal\migrate\Plugin\migrate\destination\Entity implements DependentPluginInterface, ContainerFactoryPluginInterface uses DependencyTrait, EntityFieldDefinitionTrait
        • class \Drupal\migrate\Plugin\migrate\destination\EntityContentBase implements HighestIdInterface, MigrateValidatableEntityInterface uses DeprecatedServicePropertyTrait
          • class \Drupal\multiversion\Plugin\migrate\destination\EntityContentBase

File

src/Plugin/migrate/destination/EntityContentBase.php, line 25

Namespace

Drupal\multiversion\Plugin\migrate\destination

class EntityContentBase extends CoreEntityContentBase {

  /**
   * The password service class.
   *
   * @var \Drupal\Core\Password\PasswordInterface
   */
  protected $password;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
    list($entity_type_id) = explode('__', $migration
      ->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)), $container
      ->get('entity.manager'), $container
      ->get('plugin.manager.field.field_type'), $container
      ->get('password'));
  }

  /**
   * Builds an user entity destination.
   *
   * @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.
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager service.
   * @param \Drupal\Core\Password\PasswordInterface $password
   *   The password service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EntityStorageInterface $storage, array $bundles, EntityManagerInterface $entity_manager, FieldTypePluginManagerInterface $field_type_manager, PasswordInterface $password) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $storage, $bundles, $entity_manager, $field_type_manager);

    // Since password records from the earlier schema already was hashed we
    // disable hashing so that passwords stay intact.
    $this->password = $password;
    $this->storage
      ->resetCache();
  }

  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = []) {
    $this->rollbackAction = MigrateIdMapInterface::ROLLBACK_DELETE;
    $entity = $this
      ->getEntity($row, $old_destination_id_values);
    if (!$entity) {
      throw new MigrateException('Unable to get entity');
    }
    $ids = $this
      ->save($entity, $old_destination_id_values);
    if ($this
      ->isTranslationDestination()) {
      $ids[] = $entity
        ->language()
        ->getId();
    }
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefinitionFromEntity($key) {
    $entity_type_id = $this->storage
      ->getEntityTypeId();

    /** @var \Drupal\Core\Field\FieldStorageDefinitionInterface[] $definitions */
    $definitions = $this->entityManager
      ->getBaseFieldDefinitions($entity_type_id);
    $field_definition = $definitions[$key];
    return [
      'type' => $field_definition
        ->getType(),
    ] + $field_definition
      ->getSettings();
  }

}

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.
DeprecatedServicePropertyTrait::__get	public	function	Allows to access deprecated/removed properties.
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::getDestinationModule	public	function	Gets the destination module handling the destination data. Overrides MigrateDestinationInterface::getDestinationModule	1
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.
Entity::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
Entity::fields	public	function	Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
Entity::getBundle	public	function	Gets the bundle for the row taking into account the default.
Entity::getEntity	protected	function	Creates or loads an entity.	5
Entity::getEntityId	protected	function	Gets the entity ID of the row.	2
Entity::getKey	protected	function	Returns a specific entity key.
EntityContentBase::$deprecatedProperties	protected	property
EntityContentBase::$entityFieldManager	protected	property	Entity field manager.
EntityContentBase::$fieldTypeManager	protected	property	Field type plugin manager.
EntityContentBase::$password	protected	property	The password service class.
EntityContentBase::create	public static	function	Creates an instance of the plugin. Overrides EntityContentBase::create
EntityContentBase::getDefinitionFromEntity	protected	function	Gets the field definition from a specific entity base field. Overrides EntityFieldDefinitionTrait::getDefinitionFromEntity
EntityContentBase::getHighestId	public	function	Returns the highest ID tracked by the implementing plugin. Overrides HighestIdInterface::getHighestId	2
EntityContentBase::getIds	public	function	Gets the destination IDs. Overrides MigrateDestinationInterface::getIds	2
EntityContentBase::import	public	function	Import the row. Overrides EntityContentBase::import
EntityContentBase::isEntityValidationRequired	public	function	Returns a state of whether an entity needs to be validated before saving. Overrides MigrateValidatableEntityInterface::isEntityValidationRequired
EntityContentBase::isTranslationDestination	public	function
EntityContentBase::processStubRow	protected	function	Populates as much of the stub row as possible.	3
EntityContentBase::rollback	public	function	Delete the specified destination object from the target Drupal. Overrides Entity::rollback	1
EntityContentBase::save	protected	function	Saves the entity.	3
EntityContentBase::updateEntity	protected	function	Updates an entity with the new values from row.	3
EntityContentBase::validateEntity	public	function	Validates the entity. Overrides MigrateValidatableEntityInterface::validateEntity
EntityContentBase::__construct	public	function	Builds an user entity destination. Overrides EntityContentBase::__construct
EntityFieldDefinitionTrait::getEntityTypeId	protected static	function	Finds the entity type from configuration or plugin ID.	5
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::$pluginDefinition	protected	property	The plugin implementation definition.	1
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	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.
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.