You are here

Home » API reference » Migrate File Entities to Media Entities 8 » MediaEntityGenerator.php

class MediaEntityGenerator in Migrate File Entities to Media Entities 8

Returns bare-bones information about every available file entity.

Plugin annotation


@MigrateSource(
  id = "media_entity_generator",
  source_module = "file",
)

Hierarchy

Expanded class hierarchy of MediaEntityGenerator

File

src/Plugin/migrate/source/MediaEntityGenerator.php, line 23

Namespace

Drupal\migrate_file_to_media\Plugin\migrate\source
View source 
class MediaEntityGenerator extends SourcePluginBase implements ContainerFactoryPluginInterface {

  /**
   * @var array
   */
  protected $sourceFields = [];

  /**
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  private $entityFieldManager;

  /**
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  private $entityTypeManager;

  /**
   * @var \Drupal\Core\Database\Connection
   */
  private $connection;

  /**
   * @var \Drupal\Core\Entity\Query\QueryFactory
   */
  private $entityQuery;

  /**
   * MediaEntityGenerator constructor.
   *
   * @param array $configuration
   * @param $plugin_id
   * @param $plugin_definition
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   * @param \Drupal\Core\Database\Connection $connection
   *
   * @throws \Drupal\migrate\MigrateException
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EntityFieldManagerInterface $entity_field_manager, EntityTypeManagerInterface $entity_type_manager, Connection $connection) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
    $this->entityFieldManager = $entity_field_manager;
    $this->entityTypeManager = $entity_type_manager;
    $this->connection = $connection;
    foreach ($this->configuration['field_names'] as $name) {
      $this->sourceFields[$name] = $name;
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {

    // Set source file.
    if (!empty($row
      ->getSource()['target_id'])) {

      /** @var \Drupal\file\Entity\File $file */
      $file = File::load($row
        ->getSource()['target_id']);
      if ($file) {
        $row
          ->setSourceProperty('file_path', $file
          ->getFileUri());
        $row
          ->setSourceProperty('file_name', $file
          ->getFilename());
        $row
          ->setSourceProperty('uid', $file
          ->getOwnerId());
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'target_id' => $this
        ->t('The file entity ID.'),
      'file_id' => $this
        ->t('The file entity ID.'),
      'file_path' => $this
        ->t('The file path.'),
      'file_name' => $this
        ->t('The file name.'),
      'file_alt' => $this
        ->t('The file arl.'),
      'file_title' => $this
        ->t('The file title.'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function __toString() {
    return '';
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    return [
      'target_id' => [
        'type' => 'integer',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function initializeIterator() {
    $entityDefinition = $this->entityTypeManager
      ->getDefinition($this->configuration['entity_type']);
    $bundleKey = $entityDefinition
      ->getKey('bundle');
    $files_found = [];
    foreach ($this->sourceFields as $name => $source_field) {
      $query = $this->entityTypeManager
        ->getStorage($this->configuration['entity_type'])
        ->getQuery();
      if (!empty($bundleKey)) {
        $query
          ->condition($bundleKey, $this->configuration['bundle']);
      }
      $query
        ->condition("{$name}.target_id", 0, '>', $this->configuration['langcode']);

      // Also migrate unpublished and restricted entities.
      $query
        ->accessCheck(FALSE);
      $results = $query
        ->execute();
      if ($results) {
        $entitites = $this->entityTypeManager
          ->getStorage($this->configuration['entity_type'])
          ->loadMultiple($results);
        foreach ($entitites as $entity) {
          $original_entity = NULL;
          if ($entity
            ->hasTranslation($this->configuration['langcode'])) {
            $original_entity = $entity
              ->createDuplicate();
            $entity = $entity
              ->getTranslation($this->configuration['langcode']);
          }
          foreach ($entity->{$name}
            ->getValue() as $reference) {
            $data = [
              'nid' => $entity
                ->id(),
              'target_id' => $reference['target_id'],
              'alt' => isset($reference['alt']) ? $reference['alt'] : NULL,
              'title' => isset($reference['title']) ? $reference['title'] : NULL,
              'display' => isset($reference['display']) ? $reference['display'] : NULL,
              'description' => isset($reference['description']) ? $reference['description'] : NULL,
              'langcode' => $this->configuration['langcode'],
              'entity' => $entity,
            ];
            if ($original_entity) {
              $original_ref = $original_entity->{$name}
                ->getValue()[0];
              $data['source_language_target_id'] = $original_ref['target_id'];
            }
            $files_found[] = $data;
          }
        }
      }
    }
    return new \ArrayIterator($files_found);
  }

}

Members

Namesort descending 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
MediaEntityGenerator::$connection private property
MediaEntityGenerator::$entityFieldManager private property
MediaEntityGenerator::$entityQuery private property
MediaEntityGenerator::$entityTypeManager private property
MediaEntityGenerator::$sourceFields protected property
MediaEntityGenerator::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
MediaEntityGenerator::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
MediaEntityGenerator::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
MediaEntityGenerator::initializeIterator protected function Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator
MediaEntityGenerator::prepareRow public function Adds additional data to the row. Overrides SourcePluginBase::prepareRow
MediaEntityGenerator::__construct public function MediaEntityGenerator constructor. Overrides SourcePluginBase::__construct
MediaEntityGenerator::__toString public function Allows class to decide how it will react when it is treated like a string. Overrides MigrateSourceInterface::__toString
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::$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::count public function Gets the source count. 4
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::getCache protected function Gets the cache object.
SourcePluginBase::getCurrentIds public function Gets the currentSourceIds data member.
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::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::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.
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.