class FieldFile

Same name in other branches
  1. 9 core/modules/file/src/Plugin/migrate/process/d6/FieldFile.php \Drupal\file\Plugin\migrate\process\d6\FieldFile
  2. 8.9.x core/modules/file/src/Plugin/migrate/process/d6/FieldFile.php \Drupal\file\Plugin\migrate\process\d6\FieldFile
  3. 10 core/modules/file/src/Plugin/migrate/process/d6/FieldFile.php \Drupal\file\Plugin\migrate\process\d6\FieldFile

Hierarchy

Expanded class hierarchy of FieldFile

1 file declares its use of FieldFile
FieldFileTest.php in core/modules/file/tests/src/Unit/Plugin/migrate/process/d6/FieldFileTest.php

File

core/modules/file/src/Plugin/migrate/process/d6/FieldFile.php, line 14

Namespace

Drupal\file\Plugin\migrate\process\d6
View source
class FieldFile extends ProcessPluginBase implements ContainerFactoryPluginInterface {
    
    /**
     * The current migration.
     */
    protected MigrationInterface $migration;
    
    /**
     * The migrate lookup service.
     *
     * @var \Drupal\migrate\MigrateLookupInterface
     */
    protected $migrateLookup;
    
    /**
     * Constructs a FieldFile plugin instance.
     *
     * @param array $configuration
     *   The plugin configuration.
     * @param string $plugin_id
     *   The plugin ID.
     * @param mixed $plugin_definition
     *   The plugin definition.
     * @param \Drupal\migrate\Plugin\MigrationInterface $migration
     *   The current migration.
     * @param \Drupal\migrate\MigrateLookupInterface $migrate_lookup
     *   The migrate lookup service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, MigrateLookupInterface $migrate_lookup) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->migration = $migration;
        $this->migrateLookup = $migrate_lookup;
    }
    
    /**
     * {@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('migrate.lookup'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        $options = unserialize($value['data']);
        // Try to look up the ID of the migrated file. If one cannot be found, it
        // means the file referenced by the current field item did not migrate for
        // some reason -- file migration is notoriously brittle -- and we do NOT
        // want to send invalid file references into the field system (it causes
        // fatal errors), so return an empty item instead.
        $lookup_result = $this->migrateLookup
            ->lookup('d6_file', [
            $value['fid'],
        ]);
        if ($lookup_result) {
            return [
                'target_id' => $lookup_result[0]['fid'],
                'display' => $value['list'],
                'description' => $options['description'] ?? '',
                'alt' => $options['alt'] ?? '',
                'title' => $options['title'] ?? '',
            ];
        }
        else {
            return [];
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
FieldFile::$migrateLookup protected property The migrate lookup service.
FieldFile::$migration protected property The current migration.
FieldFile::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldFile::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
FieldFile::__construct public function Constructs a FieldFile plugin instance.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
ProcessPluginBase::$stopPipeline protected property Determines if processing of the pipeline is stopped.
ProcessPluginBase::isPipelineStopped public function Determines if the pipeline should stop processing. Overrides MigrateProcessInterface::isPipelineStopped
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
ProcessPluginBase::reset public function Resets the internal data of a plugin. Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline protected function Stops pipeline processing after this plugin finishes.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.