class TempStore in Multiversion 8

Same name in this branch

8 src/Plugin/migrate/source/TempStore.php \Drupal\multiversion\Plugin\migrate\source\TempStore
8 src/Plugin/migrate/destination/TempStore.php \Drupal\multiversion\Plugin\migrate\destination\TempStore

Plugin annotation


@MigrateDestination(
  id = "tempstore"
)

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\multiversion\Plugin\migrate\destination\TempStore implements ContainerFactoryPluginInterface

Expanded class hierarchy of TempStore

File

src/Plugin/migrate/destination/TempStore.php, line 19

Namespace

Drupal\multiversion\Plugin\migrate\destination

View source

class TempStore extends DestinationBase implements ContainerFactoryPluginInterface {

  /**
   * Time to live in seconds until the storage expire.
   *
   * @var int
   */
  protected $expire = 604800;

  /**
   * @var KeyValueStoreExpirableInterface
   */
  protected $tempStore;

  /**
   * @var string
   */
  protected $entityTypeId;

  /**
   * @var string
   */
  protected $entityIdKey;

  /**
   * @var string
   */
  private $entityLanguageKey;

  /** @var \Drupal\Core\Entity\EntityManagerInterface  */
  private $entityManager;

  /**
   * {@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.manager'), $container
      ->get('keyvalue.expirable'));
  }

  /**
   * Constructor.
   *
   * @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 EntityManagerInterface $entity_manager
   *   The entity manager.
   * @param KeyValueExpirableFactoryInterface $temp_store_factory
   *   The temp store factory.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EntityManagerInterface $entity_manager, KeyValueExpirableFactoryInterface $temp_store_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
    list($entity_type_id) = explode('__', $migration
      ->id());
    $this->entityManager = $entity_manager;
    $entity_type = $this->entityManager
      ->getDefinition($entity_type_id);
    $this->entityTypeId = $entity_type_id;
    $this->entityIdKey = $entity_type
      ->getKey('id');
    $this->entityLanguageKey = $entity_type
      ->getKey('langcode');
    $this->tempStore = $temp_store_factory
      ->get('multiversion_migration_' . $this->entityTypeId);
  }

  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = []) {
    $source = $row
      ->getSource();
    $temp_store_id = $source['uuid'];
    $return = [
      $this->entityIdKey => $source[$this->entityIdKey],
    ];
    if ($this->entityLanguageKey) {
      $return[$this->entityLanguageKey] = $source[$this->entityLanguageKey];
      $temp_store_id .= '.' . $source[$this->entityLanguageKey];
    }
    $this->tempStore
      ->setWithExpire($temp_store_id, $source, $this->expire);
    return $return;
  }

  /**
   * Get whether this destination is for translations.
   *
   * @return bool
   *   Whether this destination is for translations.
   */
  protected function isTranslationDestination() {
    return !empty($this->configuration['translations']);
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids[$this->entityIdKey] = $this
      ->getDefinitionFromEntity($this->entityIdKey);
    if ($this
      ->isTranslationDestination() && $this->entityLanguageKey) {
      $ids[$this->entityLanguageKey] = $this
        ->getDefinitionFromEntity($this->entityLanguageKey);
    }
    return $ids;
  }

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

  /**
   * Gets the field definition from a specific entity base field.
   *
   * The method takes the field ID as an argument and returns the field storage
   * definition to be used in getIds() by querying the destination entity base
   * field definition.
   *
   * @param string $key
   *   The field ID key.
   *
   * @return array
   *   An associative array with a structure that contains the field type, keyed
   *   as 'type', together with field storage settings as they are returned by
   *   FieldStorageDefinitionInterface::getSettings().
   *
   * @see \Drupal\Core\Field\FieldStorageDefinitionInterface::getSettings()
   */
  protected function getDefinitionFromEntity($key) {

    /** @var \Drupal\Core\Field\FieldStorageDefinitionInterface[] $definitions */
    $definitions = $this->entityManager
      ->getBaseFieldDefinitions($this->entityTypeId);
    $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
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::rollback	public	function	Delete the specified destination object from the target Drupal. Overrides MigrateDestinationInterface::rollback	2
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
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.
TempStore::$entityIdKey	protected	property
TempStore::$entityLanguageKey	private	property
TempStore::$entityManager	private	property	@var \Drupal\Core\Entity\EntityManagerInterface
TempStore::$entityTypeId	protected	property
TempStore::$expire	protected	property	Time to live in seconds until the storage expire.
TempStore::$tempStore	protected	property
TempStore::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TempStore::fields	public	function	Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
TempStore::getDefinitionFromEntity	protected	function	Gets the field definition from a specific entity base field.
TempStore::getIds	public	function	Gets the destination IDs. Overrides MigrateDestinationInterface::getIds
TempStore::import	public	function	Import the row. Overrides MigrateDestinationInterface::import
TempStore::isTranslationDestination	protected	function	Get whether this destination is for translations.
TempStore::__construct	public	function	Constructor. Overrides DestinationBase::__construct

You are here

class TempStore in Multiversion 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation