public function D7FileConfigDeriver::getDerivativeDefinitions in Media Migration 8

Gets the definition of all derivatives of a base plugin.

Parameters

array $base_plugin_definition: The definition array of the base plugin.

Return value

array An array of full derivative definitions keyed on derivative id.

Overrides DeriverBase::getDerivativeDefinitions

See also

getDerivativeDefinition()

1 method overrides D7FileConfigDeriver::getDerivativeDefinitions()

D7FileDeriver::getDerivativeDefinitions in src/Plugin/migrate/D7FileDeriver.php

Gets the definition of all derivatives of a base plugin.

File

src/Plugin/migrate/D7FileConfigDeriver.php, line 64

Class

D7FileConfigDeriver

Deriver class for plain file to media config migrations.

Namespace

Drupal\media_migration\Plugin\migrate

Code

public function getDerivativeDefinitions($base_plugin_definition) {
  $plain_file_types = static::getSourcePlugin('d7_file_plain_type');
  try {
    $plain_file_types
      ->checkRequirements();
  } catch (RequirementsException $e) {

    // The requirements of the "d7_file_plain_type" source plugin can fail if:
    // - The source database is not configured.
    // - The File module is not enabled on the source Drupal instance.
    // - The source database is not a Drupal 7 database.
    return $this->derivatives;
  }
  assert($plain_file_types instanceof DrupalSqlBase);
  try {
    foreach ($plain_file_types as $plain_file_type_row) {
      assert($plain_file_type_row instanceof Row);
      [
        'mimes' => $mimes,
        'schemes' => $schemes,
      ] = $plain_file_type_row
        ->getSource();
      $mime = explode(ConfigSourceBase::MULTIPLE_SEPARATOR, $mimes)[0];
      $scheme = explode(ConfigSourceBase::MULTIPLE_SEPARATOR, $schemes)[0];

      // The "fallback" plugin has to be instantiated for any kind of
      // combination.
      if (!($dealer_plugin = $this->fileDealerManager
        ->createInstanceFromSchemeAndMime($scheme, $mime))) {
        throw new \LogicException(sprintf('No FileDealer plugin applies for files with scheme "%s" and with mime type "%s/*"', $scheme, $mime));
      }
      $destination_media_type_id = $dealer_plugin
        ->getDestinationMediaTypeId();
      $source_plugin_id = $base_plugin_definition['source']['plugin'];
      $derivative_definition = $base_plugin_definition;

      // Create the migration derivative.
      $derivative_definition['migration_tags'][] = MediaMigration::MIGRATION_TAG_MAIN;
      $derivative_definition['migration_tags'][] = MediaMigration::MIGRATION_TAG_CONFIG;
      $derivative_definition['source']['mimes'] = $mimes;
      $derivative_definition['source']['schemes'] = $schemes;
      $derivative_definition['source']['destination_media_type_id'] = $destination_media_type_id;
      $derivative_definition['label'] = $this
        ->t('@label (@type)', [
        '@label' => $base_plugin_definition['label'],
        '@type' => $dealer_plugin
          ->getDestinationMediaTypeLabel(),
      ]);

      // Post-process migration dependencies: instead of depending on
      // migrations based on their base plugin ID, it is better to use the
      // corresponding derivatives where possible.
      $derived_migration_ids = [
        'd7_file_plain_type',
        'd7_file_plain_source_field',
        'd7_file_plain_source_field_config',
        'd7_file_plain_widget',
        'd7_file_plain_formatter',
      ];
      foreach ($derived_migration_ids as $derived_migration_base_id) {
        $required_dependencies = !empty($derivative_definition['migration_dependencies']['required']) ? $derivative_definition['migration_dependencies']['required'] : [];
        $dependency_key = array_search($derived_migration_base_id, $required_dependencies, TRUE);
        if ($dependency_key !== FALSE) {
          $derivative_definition['migration_dependencies']['required'][$dependency_key] .= PluginBase::DERIVATIVE_SEPARATOR . $destination_media_type_id;
        }
      }
      switch ($source_plugin_id) {
        case 'd7_file_plain_type':
          $dealer_plugin
            ->alterMediaTypeMigrationDefinition($derivative_definition, $plain_file_types
            ->getDatabase());
          break;
        case 'd7_file_plain_source_field_storage':
          $dealer_plugin
            ->alterMediaSourceFieldStorageMigrationDefinition($derivative_definition, $plain_file_types
            ->getDatabase());
          break;
        case 'd7_file_plain_source_field_instance':
          $dealer_plugin
            ->alterMediaSourceFieldInstanceMigrationDefinition($derivative_definition, $plain_file_types
            ->getDatabase());
          break;
        case 'd7_file_plain_field_widget':
          $dealer_plugin
            ->alterMediaSourceFieldWidgetMigrationDefinition($derivative_definition, $plain_file_types
            ->getDatabase());
          break;
        case 'd7_file_plain_field_formatter':
          $dealer_plugin
            ->alterMediaFieldFormatterMigrationDefinition($derivative_definition, $plain_file_types
            ->getDatabase());
          break;
      }
      $this->derivatives[$destination_media_type_id] = $derivative_definition;
    }
  } catch (DatabaseExceptionWrapper $e) {

    // Once we begin iterating the source plugin it is possible that the
    // source tables will not exist. This can happen when the
    // MigrationPluginManager gathers up the migration definitions but we do
    // not actually have a Drupal 7 source database.
  }
  return $this->derivatives;
}