class FieldType

Same name in this branch
  1. 11.x core/lib/Drupal/Core/Field/Annotation/FieldType.php \Drupal\Core\Field\Annotation\FieldType
  2. 11.x core/lib/Drupal/Core/Field/Attribute/FieldType.php \Drupal\Core\Field\Attribute\FieldType
Same name in other branches
  1. 9 core/modules/field/src/Plugin/migrate/process/FieldType.php \Drupal\field\Plugin\migrate\process\FieldType
  2. 9 core/lib/Drupal/Core/Field/Annotation/FieldType.php \Drupal\Core\Field\Annotation\FieldType
  3. 8.9.x core/modules/field/src/Plugin/migrate/process/FieldType.php \Drupal\field\Plugin\migrate\process\FieldType
  4. 8.9.x core/lib/Drupal/Core/Field/Annotation/FieldType.php \Drupal\Core\Field\Annotation\FieldType
  5. 10 core/modules/field/src/Plugin/migrate/process/FieldType.php \Drupal\field\Plugin\migrate\process\FieldType
  6. 10 core/lib/Drupal/Core/Field/Annotation/FieldType.php \Drupal\Core\Field\Annotation\FieldType
  7. 10 core/lib/Drupal/Core/Field/Attribute/FieldType.php \Drupal\Core\Field\Attribute\FieldType

Hierarchy

Expanded class hierarchy of FieldType

File

core/modules/field/src/Plugin/migrate/process/FieldType.php, line 15

Namespace

Drupal\field\Plugin\migrate\process
View source
class FieldType extends StaticMap implements ContainerFactoryPluginInterface {
    
    /**
     * The field plugin manager.
     *
     * @var \Drupal\migrate_drupal\Plugin\MigrateFieldPluginManagerInterface
     */
    protected $fieldPluginManager;
    
    /**
     * The migration object.
     *
     * @var \Drupal\migrate\Plugin\MigrationInterface
     */
    protected $migration;
    
    /**
     * Constructs a FieldType plugin.
     *
     * @param array $configuration
     *   The plugin configuration.
     * @param string $plugin_id
     *   The plugin ID.
     * @param mixed $plugin_definition
     *   The plugin definition.
     * @param \Drupal\migrate_drupal\Plugin\MigrateFieldPluginManagerInterface $field_plugin_manager
     *   The field plugin manager.
     * @param \Drupal\migrate\Plugin\MigrationInterface $migration
     *   The migration being run.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrateFieldPluginManagerInterface $field_plugin_manager, ?MigrationInterface $migration = NULL) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->fieldPluginManager = $field_plugin_manager;
        $this->migration = $migration;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, ?MigrationInterface $migration = NULL) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('plugin.manager.migrate.field'), $migration);
    }
    
    /**
     * {@inheritdoc}
     */
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        $field_type = is_array($value) ? $value[0] : $value;
        try {
            $plugin_id = $this->fieldPluginManager
                ->getPluginIdFromFieldType($field_type, [], $this->migration);
            return $this->fieldPluginManager
                ->createInstance($plugin_id, [], $this->migration)
                ->getFieldType($row);
        } catch (PluginNotFoundException) {
            return parent::transform($value, $migrate_executable, $row, $destination_property);
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
FieldType::$fieldPluginManager protected property The field plugin manager.
FieldType::$migration protected property The migration object.
FieldType::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldType::transform public function Performs the associated process. Overrides StaticMap::transform
FieldType::__construct public function Constructs a FieldType plugin.
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.