class FileEntity in Media Migration 8

Same name in this branch

8 src/Plugin/MediaWysiwyg/FileEntity.php \Drupal\media_migration\Plugin\MediaWysiwyg\FileEntity
8 src/Plugin/migrate/field/FileEntity.php \Drupal\media_migration\Plugin\migrate\field\FileEntity

Field Plugin for file_entity to media migrations.

Plugin annotation


@MigrateField(
  id = "file_entity",
  core = {7},
  type_map = {
    "file_entity" = "entity_reference",
  },
  source_module = "file",
  destination_module = "media",
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase implements MigrateFieldInterface
    class \Drupal\field\Plugin\migrate\field\d7\EntityReference
    class \Drupal\media_migration\Plugin\migrate\field\MediaMigrationFieldPluginBase implements ContainerFactoryPluginInterface
    class \Drupal\media_migration\Plugin\migrate\field\FileEntity

Expanded class hierarchy of FileEntity

File

src/Plugin/migrate/field/FileEntity.php, line 22

Namespace

Drupal\media_migration\Plugin\migrate\field

View source

class FileEntity extends MediaMigrationFieldPluginBase {

  /**
   * {@inheritdoc}
   */
  public function alterFieldMigration(MigrationInterface $migration) {
    $settings = [
      'file_entity' => [
        'plugin' => 'file_entity_field_settings',
      ],
    ];
    $migration
      ->mergeProcessOfProperty('settings', $settings);
    parent::alterFieldMigration($migration);
  }

  /**
   * {@inheritdoc}
   */
  public function alterFieldInstanceMigration(MigrationInterface $migration) {
    $settings = [
      'file_entity' => [
        'plugin' => 'file_entity_field_instance_settings',
      ],
    ];
    $migration
      ->mergeProcessOfProperty('settings', $settings);

    // @todo In Drupal 7, when no media types are explicitly enabled on this
    // field, that means that every media type is allowed. For handling these
    // cases we have to make this migration depend on the media type migrations.
    // @see \Drupal\media_migration\Plugin\migrate\process\FileEntityFieldInstanceSettings::transform()
    parent::alterFieldInstanceMigration($migration);
  }

  /**
   * {@inheritdoc}
   */
  public function defineValueProcessPipeline(MigrationInterface $migration, $field_name, $data) {

    // The "media_migration_delta_sort" plugin sorts field values for PostgreSQL
    // sources.
    // @see \Drupal\media_migration\Plugin\migrate\process\MediaMigrationDeltaSort
    // @todo remove when https://drupal.org/i/3164520 is fixed.
    $process = [
      [
        'plugin' => 'media_migration_delta_sort',
        'source' => $field_name,
      ],
    ];
    $process[] = [
      'plugin' => 'sub_process',
      'process' => [
        'target_id' => 'fid',
      ],
    ];
    $migration
      ->setProcessOfProperty($field_name, $process);

    // Add the needed media migrations as required dependencies.
    $this
      ->addRequiredMediaMigrationDependencies($migration, $data);
  }

  /**
   * {@inheritdoc}
   */
  public function alterFieldFormatterMigration(MigrationInterface $migration) {
    $settings = [
      'file_entity' => [
        'plugin' => 'file_entity_field_formatter_settings',
      ],
    ];
    $migration
      ->mergeProcessOfProperty('options/settings', $settings);
    parent::alterFieldFormatterMigration($migration);
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldWidgetMap() {
    $mapping = [];
    if ($this->moduleHandler
      ->moduleExists('media_library') && $this->fieldWidgetManager
      ->hasDefinition('media_library_widget')) {
      $mapping = [
        'file_generic' => 'media_library_widget',
        'media_generic' => 'media_library_widget',
      ];
    }
    return $mapping + parent::getFieldWidgetMap();
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldFormatterMap() {
    return [
      'file_image_picture' => 'media_responsive_thumbnail',
      'file_image_image' => 'media_thumbnail',
      'file_rendered' => 'entity_reference_entity_view',
      'file_download_link' => 'entity_reference_label',
      'file_audio' => 'entity_reference_entity_view',
      'file_video' => 'entity_reference_entity_view',
      'file_default' => 'entity_reference_entity_view',
      'file_table' => 'entity_reference_entity_view',
      'file_url_plain' => 'entity_reference_label',
    ] + parent::getFieldFormatterMap();
  }

  /**
   * Discovers the file type used in the field and adds their migration deps.
   *
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The actual fieldable entity migration where the field belongs to.
   * @param array $field_data
   *   The data (settings) of the field instance to check.
   */
  protected function addRequiredMediaMigrationDependencies(MigrationInterface $migration, array $field_data) : void {
    $source_plugin = $migration
      ->getSourcePlugin();
    if (!$source_plugin instanceof DrupalSqlBase) {

      // If the source database is not a legacy Drupal database, we cannot do
      // anything.
      return;
    }
    $source_db = $source_plugin
      ->getDatabase();
    $used_file_types = NULL;

    // Let's check whether we have a type column in the file_managed table.
    $type_column_exists = $source_db
      ->schema()
      ->fieldExists('file_managed', 'type');
    if ($type_column_exists) {
      $field_name = $field_data['field_name'];
      $file_types_query = $source_db
        ->select("field_revision_{$field_name}", 'frd')
        ->distinct()
        ->fields('fm', [
        'type',
      ])
        ->condition('frd.entity_type', $field_data['entity_type'])
        ->condition('frd.bundle', $field_data['bundle'])
        ->condition('fm.status', TRUE)
        ->condition('fm.uri', 'temporary://%', 'NOT LIKE');
      $file_types_query
        ->innerJoin('file_managed', 'fm', "fm.fid = frd.{$field_name}_fid");
      try {
        $used_file_types = $file_types_query
          ->execute()
          ->fetchAllKeyed(0, 0);
      } catch (DatabaseExceptionWrapper $exception) {
      }
    }
    $extra_dependencies = [];
    if (is_null($used_file_types) || in_array('undefined', $used_file_types)) {
      $extra_dependencies[] = 'd7_file_plain';
    }
    if ($type_column_exists && !empty($used_file_types)) {
      foreach ($used_file_types as $type) {
        if ($type === 'undefined') {
          continue;
        }
        $extra_dependencies[] = "d7_file_entity:{$type}";
      }
    }

    // No additional dependencies are required for migrating the given field's
    // values.
    if (empty($extra_dependencies)) {
      return;
    }
    $migration_dependencies = $migration
      ->getMigrationDependencies();
    $migration_dependencies['required'] = array_unique(array_merge(array_values($migration_dependencies['required']), $extra_dependencies));
    $migration
      ->set('migration_dependencies', $migration_dependencies);
  }

}

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
FieldPluginBase::alterFieldWidgetMigration	public	function	Apply any custom processing to the field widget migration. Overrides MigrateFieldInterface::alterFieldWidgetMigration
FieldPluginBase::getFieldFormatterType	public	function	Get the field formatter type from the source. Overrides MigrateFieldInterface::getFieldFormatterType	1
FieldPluginBase::getFieldType	public	function	Computes the destination type of a migrated field. Overrides MigrateFieldInterface::getFieldType	6
FieldPluginBase::getFieldWidgetType	public	function	Get the field widget type from the source. Overrides MigrateFieldInterface::getFieldWidgetType	1
FieldPluginBase::processField Deprecated	public	function	Alters the migration for field definitions.
FieldPluginBase::processFieldFormatter Deprecated	public	function	Alter field formatter migration.
FieldPluginBase::processFieldInstance Deprecated	public	function	Alert field instance migration.
FieldPluginBase::processFieldValues Deprecated	public	function	Defines the process pipeline for field values.
FieldPluginBase::processFieldWidget Deprecated	public	function	Alter field widget migration.
FileEntity::addRequiredMediaMigrationDependencies	protected	function	Discovers the file type used in the field and adds their migration deps.
FileEntity::alterFieldFormatterMigration	public	function	Apply any custom processing to the field formatter migration. Overrides FieldPluginBase::alterFieldFormatterMigration
FileEntity::alterFieldInstanceMigration	public	function	Apply any custom processing to the field instance migration. Overrides FieldPluginBase::alterFieldInstanceMigration
FileEntity::alterFieldMigration	public	function	Apply any custom processing to the field migration. Overrides FieldPluginBase::alterFieldMigration
FileEntity::defineValueProcessPipeline	public	function	Apply any custom processing to the field bundle migrations. Overrides FieldPluginBase::defineValueProcessPipeline
FileEntity::getFieldFormatterMap	public	function	Get a map between D6 formatters and D8 formatters for this field type. Overrides EntityReference::getFieldFormatterMap
FileEntity::getFieldWidgetMap	public	function	Get a map between D6 and D8 widgets for this field type. Overrides FieldPluginBase::getFieldWidgetMap
MediaMigrationFieldPluginBase::$fieldWidgetManager	protected	property	The field widget manager.
MediaMigrationFieldPluginBase::$moduleHandler	protected	property	The module handler.
MediaMigrationFieldPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
MediaMigrationFieldPluginBase::__construct	public	function	Constructs a new plugin instance. Overrides PluginBase::__construct
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.

You are here

class FileEntity in Media Migration 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation