class EntityContentBase in Multiversion 8

Migration source class for content entities.

Plugin annotation

@MigrateSource(
  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\source\SourcePluginBase implements RollbackAwareInterface, MigrateSourceInterface
      • class \Drupal\multiversion\Plugin\migrate\source\SourcePluginBase implements ContainerFactoryPluginInterface
        • class \Drupal\multiversion\Plugin\migrate\source\EntityContentBase

File

src/Plugin/migrate/source/EntityContentBase.php, line 12

Namespace

Drupal\multiversion\Plugin\migrate\source

class EntityContentBase extends SourcePluginBase {

  /**
   * {@inheritdoc}
   */
  protected function initializeIterator() {

    // At this point Multiversion is obviously installed and the new storage
    // handler is already active. But since the new schema isn't applied yet
    // and the new handler doesn't know how to load from the old schema, we have
    // to initialize the previously installed storage handler and use that to
    // load the entities.
    $last_definition = $this->entityManager
      ->getLastInstalledDefinition($this->entityTypeId);
    $storage_class = $last_definition
      ->getStorageClass();
    $last_storage = $this->entityManager
      ->createHandlerInstance($storage_class, $last_definition);
    $entities = $last_storage
      ->loadMultiple();
    $results = [];
    foreach ($entities as $entity_id => $entity) {
      if (isset($entity->_deleted->value) && $entity->_deleted->value) {
        continue;
      }
      foreach ($entity
        ->getTranslationLanguages(TRUE) as $language) {
        $result = [];
        foreach ($entity
          ->getTranslation($language
          ->getId()) as $field_name => $field) {
          if (!$field
            ->isEmpty()) {

            /** @var \Drupal\Core\Field\FieldItemListInterface $field */
            $value = $field
              ->getValue();

            // If there is only one value in the field, unwrap it.
            if (count($value) == 1) {
              $value = reset($value);

              // If there's only one property in the field value, unwrap it.
              if (count($value) == 1 && empty($value['langcode'])) {
                $value = reset($value);
              }
            }
            $result[$field_name] = $value;
          }
        }
        $results[] = $result;
      }
    }
    return new \ArrayIterator(array_values($results));
  }

}

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
EntityContentBase::initializeIterator	protected	function	Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator
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.
SourcePluginBase::$cache	protected	property	The backend cache.
SourcePluginBase::$cacheCounts	protected	property	Whether this instance should cache the source count.	1
SourcePluginBase::$cacheKey	protected	property	Key to use for caching counts.
SourcePluginBase::$currentRow	protected	property	The current row from the query.
SourcePluginBase::$currentSourceIds	protected	property	The primary key of the current row.
SourcePluginBase::$entityIdKey	protected	property
SourcePluginBase::$entityLanguageKey	private	property
SourcePluginBase::$entityManager	protected	property
SourcePluginBase::$entityTypeId	protected	property
SourcePluginBase::$highWaterProperty	protected	property	Information on the property used as the high-water mark.
SourcePluginBase::$highWaterStorage	protected	property	The key-value storage for the high-water value.
SourcePluginBase::$idMap	protected	property	The migration ID map.
SourcePluginBase::$iterator	protected	property	The iterator to iterate over the source rows.
SourcePluginBase::$mapRowAdded	protected	property	Flags whether source plugin will read the map row and add to data row.
SourcePluginBase::$migration	protected	property	The entity migration object.
SourcePluginBase::$moduleHandler	protected	property	The module handler service.	2
SourcePluginBase::$originalHighWater	protected	property	The high water mark at the beginning of the import operation.
SourcePluginBase::$skipCount	protected	property	Whether this instance should not attempt to count the source.	1
SourcePluginBase::$trackChanges	protected	property	Flags whether to track changes to incoming data.	1
SourcePluginBase::aboveHighwater	protected	function	Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::bundleMigrationRequired	public	function
SourcePluginBase::count	public	function	Gets the source count.	4
SourcePluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
SourcePluginBase::current	public	function
SourcePluginBase::doCount	protected	function	Gets the source count checking if the source is countable or using the iterator_count function.	1
SourcePluginBase::fetchNextRow	protected	function	Position the iterator to the following row.	1
SourcePluginBase::fields	public	function	Returns available fields on the source. Overrides MigrateSourceInterface::fields
SourcePluginBase::getCache	protected	function	Gets the cache object.
SourcePluginBase::getCurrentIds	public	function	Gets the currentSourceIds data member.
SourcePluginBase::getDefinitionFromEntity	protected	function	Gets the field definition from a specific entity base field.
SourcePluginBase::getHighWater	protected	function	The current value of the high water mark.
SourcePluginBase::getHighWaterField	protected	function	Get the name of the field used as the high watermark.
SourcePluginBase::getHighWaterProperty	protected	function	Get information on the property used as the high watermark.
SourcePluginBase::getHighWaterStorage	protected	function	Get the high water storage object.	1
SourcePluginBase::getIds	public	function	Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
SourcePluginBase::getIterator	protected	function	Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getModuleHandler	protected	function	Gets the module handler.
SourcePluginBase::getSourceModule	public	function	Gets the source module providing the source data. Overrides MigrateSourceInterface::getSourceModule
SourcePluginBase::key	public	function	Gets the iterator key.
SourcePluginBase::next	public	function	The migration iterates over rows returned by the source plugin. This method determines the next row which will be processed and imported into the system.
SourcePluginBase::postRollback	public	function	Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::prepareRow	public	function	Adds additional data to the row. Overrides MigrateSourceInterface::prepareRow	50
SourcePluginBase::preRollback	public	function	Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rewind	public	function	Rewinds the iterator.
SourcePluginBase::rowChanged	protected	function	Checks if the incoming row has changed since our last import.
SourcePluginBase::saveHighWater	protected	function	Save the new high water mark.
SourcePluginBase::valid	public	function	Checks whether the iterator is currently valid.
SourcePluginBase::__construct	public	function	Constructor. Overrides SourcePluginBase::__construct	1
SourcePluginBase::__toString	public	function	Allows class to decide how it will react when it is treated like a string. Overrides MigrateSourceInterface::__toString
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.