class Image in Media Migration 8

Same name in this branch

8 tests/modules/media_migration_test_dealer_plugins/src/Image.php \Drupal\media_migration_test_dealer_plugins\Image
8 src/Plugin/media_migration/file_entity/Image.php \Drupal\media_migration\Plugin\media_migration\file_entity\Image
8 src/Plugin/media_migration/file/Image.php \Drupal\media_migration\Plugin\media_migration\file\Image

Plugin for images.

Plugin annotation


@FileDealer(
  id = "image",
  mimes = {"image"},
  destination_media_source_plugin_id = "image",
  destination_media_type_id_base = "image"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\media_migration\MediaDealerBase implements ContainerFactoryPluginInterface
    class \Drupal\media_migration\FileDealerBase implements FileDealerPluginInterface
    class \Drupal\media_migration\Plugin\media_migration\file\Image

Expanded class hierarchy of Image

7 string references to 'Image'

FileEntityDealerTest::providerTestFileEntityDealer in tests/src/Kernel/Plugin/FileEntityDealerTest.php: Data provider for .
FileEntitySourceFieldInstanceTest::providerSource in tests/src/Kernel/Plugin/migrate/source/d7/FileEntitySourceFieldInstanceTest.php: The data provider.
MediaMigrationAssertionsForNonMediaSourceTrait::assertNonMediaToMediaImageMediaBundleSourceFieldProperties in tests/src/Traits/MediaMigrationAssertionsForNonMediaSourceTrait.php: Checks the properties of the image media type's source field config.
MediaMigrationNoImageAltFieldTest::testMediaConfigMigrationWithNoAltField in tests/src/Kernel/Migrate/MediaMigrationNoImageAltFieldTest.php: Tests media migration from a site without field_file_image_alt_text field.
MediaMigrationSourceDatabaseTrait::getFieldConfigInstanceTableData in tests/src/Traits/MediaMigrationSourceDatabaseTrait.php: Returns the values for the "field_config_instance" database table.

... See full list

File

src/Plugin/media_migration/file/Image.php, line 19

Namespace

Drupal\media_migration\Plugin\media_migration\file

View source

class Image extends FileDealerBase {

  /**
   * {@inheritdoc}
   */
  public function alterMediaEntityMigrationDefinition(array &$migration_definition, Connection $connection) : void {
    parent::alterMediaEntityMigrationDefinition($migration_definition, $connection);
    $source_field_name = $this
      ->getDestinationMediaSourceFieldName();
    $alt_property_process_pipeline = [
      'plugin' => 'null_coalesce',
      'source' => [
        'alt',
        'description',
      ],
    ];
    $migration_definition['process'][$source_field_name . '/alt'] = $alt_property_process_pipeline;
    $migration_definition['process'][$source_field_name . '/title'] = 'title';
    $migration_definition['process'][$source_field_name . '/width'] = 'width';
    $migration_definition['process'][$source_field_name . '/height'] = 'height';
    $migration_definition['process']['thumbnail/target_id'] = 'fid';
    $migration_definition['process']['thumbnail/alt'] = $alt_property_process_pipeline;
    $migration_definition['process']['thumbnail/title'] = 'title';
    $migration_definition['process']['thumbnail/width'] = 'width';
    $migration_definition['process']['thumbnail/height'] = 'height';
  }

  /**
   * {@inheritdoc}
   */
  public function prepareMediaSourceFieldFormatterRow(Row $row, Connection $connection) : void {
    parent::prepareMediaSourceFieldFormatterRow($row, $connection);
    $options = $row
      ->getSourceProperty('options') ?? [];
    $options['settings'] = [
      'image_style' => 'large',
    ];
    $row
      ->setSourceProperty('options', $options);
  }

  /**
   * {@inheritdoc}
   */
  public function prepareMediaEntityRow(Row $row, Connection $connection) : void {
    parent::prepareMediaEntityRow($row, $connection);
    $file_id = $row
      ->getSourceProperty('fid');
    foreach ($this
      ->getImageData($connection, $file_id) as $data_key => $data_value) {
      $row
        ->setSourceProperty($data_key, $data_value);
    }
    foreach ($this
      ->getFileData($connection, $file_id) as $data_key => $data_value) {
      $row
        ->setSourceProperty($data_key, $data_value);
    }
  }

}

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
FileDealerBase::getFileData	protected	function	Returns display and description properties of the specified file.
FileDealerBase::getFileFieldData	protected	function	Get the name of the file fields from the source database.
Image::alterMediaEntityMigrationDefinition	public	function	Alters the definition of the media entity migration. Overrides FileDealerBase::alterMediaEntityMigrationDefinition
Image::prepareMediaEntityRow	public	function	Overrides MediaDealerBase::prepareMediaEntityRow
Image::prepareMediaSourceFieldFormatterRow	public	function	Overrides MediaDealerBase::prepareMediaSourceFieldFormatterRow
MediaDealerBase::$entityTypeManager	protected	property	The entity type manager.
MediaDealerBase::$fieldTypeManager	protected	property	The field type plugin manager service.
MediaDealerBase::$mediaSourceManager	protected	property	The media source plugin manager.
MediaDealerBase::alterMediaFieldFormatterMigrationDefinition	public	function
MediaDealerBase::alterMediaSourceFieldInstanceMigrationDefinition	public	function
MediaDealerBase::alterMediaSourceFieldStorageMigrationDefinition	public	function
MediaDealerBase::alterMediaSourceFieldWidgetMigrationDefinition	public	function
MediaDealerBase::alterMediaTypeMigrationDefinition	public	function
MediaDealerBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
MediaDealerBase::getDestinationMediaSourceFieldName	public	function		4
MediaDealerBase::getDestinationMediaSourcePluginId	public	function		2
MediaDealerBase::getDestinationMediaTypeId	public	function		1
MediaDealerBase::getDestinationMediaTypeIdBase	public	function		3
MediaDealerBase::getDestinationMediaTypeLabel	public	function		3
MediaDealerBase::getDestinationMediaTypeSourceFieldLabel	public	function		4
MediaDealerBase::getImageData	protected	function	Returns alt, title, with and height properties of the specified file.
MediaDealerBase::getImageFieldData	protected	function	Get the names of the image type fields from the source database.
MediaDealerBase::getMediaSourceFieldInstance	protected	function	Returns a media source field instance.
MediaDealerBase::getMediaSourceFieldStorage	protected	function	Returns a media source field storage.
MediaDealerBase::prepareMediaSourceFieldInstanceRow	public	function		2
MediaDealerBase::prepareMediaSourceFieldStorageRow	public	function		1
MediaDealerBase::prepareMediaSourceFieldWidgetRow	public	function
MediaDealerBase::prepareMediaTypeRow	public	function
MediaDealerBase::__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 Image in Media Migration 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation