You are here

Home » API reference » Media Migration 8 » FilePlainConfigSourceBase.php

abstract class FilePlainConfigSourceBase in Media Migration 8

Base class for config migrate source plugins of plain file migrations.

Hierarchy

Expanded class hierarchy of FilePlainConfigSourceBase

File

src/Plugin/migrate/source/d7/FilePlainConfigSourceBase.php, line 14

Namespace

Drupal\media_migration\Plugin\migrate\source\d7
View source 
abstract class FilePlainConfigSourceBase extends ConfigSourceBase {

  /**
   * Whether the source has (fieldable) file entities or not.
   *
   * @var bool
   */
  protected $sourceHasFileEntities;

  /**
   * The file dealer plugin manager.
   *
   * @var \Drupal\media_migration\FileDealerManagerInterface
   */
  protected $fileDealerManager;

  /**
   * Constructs a plugin instance.
   *
   * @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 \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The current migration.
   * @param \Drupal\Core\State\StateInterface $state
   *   The state service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\media_migration\FileDealerManagerInterface $file_dealer_manager
   *   The file entity dealer plugin manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, StateInterface $state, EntityTypeManagerInterface $entity_type_manager, FileDealerManagerInterface $file_dealer_manager) {
    $configuration += [
      'mimes' => NULL,
      'schemes' => NULL,
    ];
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $state, $entity_type_manager);
    $this->fileDealerManager = $file_dealer_manager;
    $this->sourceHasFileEntities = $this
      ->getDatabase()
      ->schema()
      ->fieldExists('file_managed', 'type');
  }

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

  /**
   * {@inheritdoc}
   */
  public function query() {
    [
      'mimes' => $mimes,
      'schemes' => $schemes,
    ] = $this->configuration;
    $query = $this
      ->getFilePlainBaseQuery();
    if ($this->sourceHasFileEntities) {
      $query
        ->condition('fm.type', [
        'undefined',
        '',
      ], 'IN');
    }
    if ($mimes) {
      $query
        ->where("{$this->getMainMimeTypeExpression()} IN (:mimes[])", [
        ':mimes[]' => explode(static::MULTIPLE_SEPARATOR, $mimes),
      ]);
    }
    if ($schemes) {
      $query
        ->where("{$this->getSchemeExpression()} IN (:schemes[])", [
        ':schemes[]' => explode(static::MULTIPLE_SEPARATOR, $schemes),
      ]);
    }
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareQuery() {
    parent::prepareQuery();
    $this->query
      ->addTag('migrate__media_migration');
    $this->query
      ->addTag('migrate__media_migration__file_plain');
    $this->query
      ->addTag('migrate__media_migration__media_configuration');
    $this->query
      ->addTag("migrate__media_migration__source__{$this->pluginId}");
    return $this->query;
  }

  /**
   * {@inheritdoc}
   */
  protected function initializeIterator() {
    $results = $this
      ->prepareQuery()
      ->execute()
      ->fetchAll();

    // Add the array of all instances using the same media type to each row.
    $rows = [];
    foreach ($results as $result) {
      [
        'mime' => $mime,
        'scheme' => $scheme,
      ] = $result;
      if (!($dealer_plugin = $this->fileDealerManager
        ->createInstanceFromSchemeAndMime($scheme, $mime))) {
        continue;
      }
      $destination_media_type_id = $dealer_plugin
        ->getDestinationMediaTypeId();
      $source_values = $rows[$destination_media_type_id] ?? $result + [
        'mimes' => $mime,
        'schemes' => $scheme,
      ];
      $source_values['mimes'] = implode(static::MULTIPLE_SEPARATOR, array_unique(array_merge(explode(static::MULTIPLE_SEPARATOR, $source_values['mimes']), [
        $mime,
      ])));
      $source_values['schemes'] = implode(static::MULTIPLE_SEPARATOR, array_unique(array_merge(explode(static::MULTIPLE_SEPARATOR, $source_values['schemes']), [
        $scheme,
      ])));
      $source_values['bundle'] = $destination_media_type_id;
      $source_values['bundle_label'] = $dealer_plugin
        ->getDestinationMediaTypeLabel();
      $source_values['source_plugin_id'] = $dealer_plugin
        ->getDestinationMediaSourcePluginId();
      $source_values['source_field_name'] = $dealer_plugin
        ->getDestinationMediaSourceFieldName();
      $source_values['source_field_label'] = $dealer_plugin
        ->getDestinationMediaTypeSourceFieldLabel();
      unset($source_values['mime']);
      unset($source_values['scheme']);
      $rows[$destination_media_type_id] = $source_values;
    }
    return new \ArrayIterator($rows);
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'mimes' => $this
        ->t('List of the files main MIME type (before the slash), separated by "::"'),
      'schemes' => $this
        ->t('List of the files uri scheme (the ID of the stream wrapper), separated by "::"'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['mimes']['type'] = 'string';
    $ids['schemes']['type'] = 'string';
    return $ids;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigSourceBase::MULTIPLE_SEPARATOR constant
FilePlainConfigSourceBase::$fileDealerManager protected property The file dealer plugin manager.
FilePlainConfigSourceBase::$sourceHasFileEntities protected property Whether the source has (fieldable) file entities or not.
FilePlainConfigSourceBase::create public static function
FilePlainConfigSourceBase::fields public function 3
FilePlainConfigSourceBase::getIds public function 1
FilePlainConfigSourceBase::initializeIterator protected function 2
FilePlainConfigSourceBase::prepareQuery protected function
FilePlainConfigSourceBase::query public function 1
FilePlainConfigSourceBase::__construct public function Constructs a plugin instance.
MediaMigrationDatabaseTrait::getExtensionExpression protected function Returns the file extension expression for the current DB.
MediaMigrationDatabaseTrait::getFileEntityBaseQuery protected function Returns a base query for file entity types.
MediaMigrationDatabaseTrait::getFilePlainBaseQuery protected function Returns a base query for plain files.
MediaMigrationDatabaseTrait::getMainMimeTypeExpression protected function Returns the main MIME type's expression for the current DB.
MediaMigrationDatabaseTrait::getSchemeExpression protected function Returns the expression for the DB for getting the URI scheme.
MediaMigrationDatabaseTrait::getUserPictureOnlyFidsQuery protected function Returns the subquery for the user picture-only file IDs.
MediaMigrationDatabaseTrait::getWebformOrUserPictureOnlyFidsQuery protected function Subquery for FIDs used only in webform submissions and/or by user entities.