class EntityRevision in Zircon Profile 8

Plugin annotation

@MigrateDestination(
  id = "entity_revision",
  deriver = "Drupal\migrate\Plugin\Derivative\MigrateEntityRevision"
)

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
        • class \Drupal\migrate\Plugin\migrate\destination\EntityContentBase
          • class \Drupal\migrate\Plugin\migrate\destination\EntityRevision

1 file declares its use of EntityRevision

EntityRevisionTest.php in core/modules/migrate/tests/src/Unit/destination/EntityRevisionTest.php

Contains \Drupal\Tests\migrate\Unit\destination\EntityRevisionTest.

File

core/modules/migrate/src/Plugin/migrate/destination/EntityRevision.php, line 20

Contains \Drupal\migrate\Plugin\migrate\destination\EntityRevision.

Namespace

Drupal\migrate\Plugin\migrate\destination

class EntityRevision extends EntityContentBase {

  /**
   * {@inheritdoc}
   */
  protected static function getEntityTypeId($plugin_id) {

    // Remove entity_revision:
    return substr($plugin_id, 16);
  }

  /**
   * Get the entity.
   *
   * @param \Drupal\migrate\Row $row
   *   The row object.
   * @param array $old_destination_id_values
   *   The old destination ids.
   *
   * @return \Drupal\Core\Entity\EntityInterface|false
   *   The entity or false if it can not be created.
   */
  protected function getEntity(Row $row, array $old_destination_id_values) {
    $revision_id = $old_destination_id_values ? reset($old_destination_id_values) : $row
      ->getDestinationProperty($this
      ->getKey('revision'));
    if (!empty($revision_id) && ($entity = $this->storage
      ->loadRevision($revision_id))) {
      $entity
        ->setNewRevision(FALSE);
    }
    else {
      $entity_id = $row
        ->getDestinationProperty($this
        ->getKey('id'));
      $entity = $this->storage
        ->load($entity_id);

      // If we fail to load the original entity something is wrong and we need
      // to return immediately.
      if (!$entity) {
        return FALSE;
      }
      $entity
        ->enforceIsNew(FALSE);
      $entity
        ->setNewRevision(TRUE);
    }
    $this
      ->updateEntity($entity, $row);
    $entity
      ->isDefaultRevision(FALSE);
    return $entity;
  }

  /**
   * {@inheritdoc}
   */
  protected function save(ContentEntityInterface $entity, array $old_destination_id_values = array()) {
    $entity
      ->save();
    return array(
      $entity
        ->getRevisionId(),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    if ($key = $this
      ->getKey('revision')) {
      $ids[$key]['type'] = 'integer';
      return $ids;
    }
    throw new MigrateException('This entity type does not support revisions.');
  }

}

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::fields	public	function	Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
Entity::getEntityId	protected	function	Get the entity id of the row.	2
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
EntityContentBase::$entityManager	protected	property	Entity manager.
EntityContentBase::$fieldTypeManager	protected	property	Field type plugin manager.
EntityContentBase::create	public static	function	Creates an instance of the plugin. Overrides Entity::create	3
EntityContentBase::import	public	function	Import the row. Overrides MigrateDestinationInterface::import	3
EntityContentBase::processStubRow	protected	function	Do as much population of the stub row as we can.	3
EntityContentBase::updateEntity	protected	function	Update an entity with the new values from row.	2
EntityContentBase::__construct	public	function	Constructs a content entity. Overrides Entity::__construct	3
EntityRevision::getEntity	protected	function	Get the entity. Overrides Entity::getEntity	1
EntityRevision::getEntityTypeId	protected static	function	Finds the entity type from configuration or plugin id. Overrides Entity::getEntityTypeId
EntityRevision::getIds	public	function	Get the destination ids. Overrides EntityContentBase::getIds
EntityRevision::save	protected	function	Save the entity. Overrides EntityContentBase::save	1
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.