interface MigrateFieldInterface
Same name in other branches
- 9 core/modules/migrate_drupal/src/Plugin/MigrateFieldInterface.php \Drupal\migrate_drupal\Plugin\MigrateFieldInterface
- 8.9.x core/modules/migrate_drupal/src/Plugin/MigrateFieldInterface.php \Drupal\migrate_drupal\Plugin\MigrateFieldInterface
- 11.x core/modules/migrate_drupal/src/Plugin/MigrateFieldInterface.php \Drupal\migrate_drupal\Plugin\MigrateFieldInterface
Provides an interface for all field type plugins.
Hierarchy
- interface \Drupal\Component\Plugin\PluginInspectionInterface
- interface \Drupal\migrate_drupal\Plugin\MigrateFieldInterface extends \Drupal\Component\Plugin\PluginInspectionInterface
Expanded class hierarchy of MigrateFieldInterface
All classes that implement MigrateFieldInterface
2 files declare their use of MigrateFieldInterface
- FieldPluginBase.php in core/
modules/ migrate_drupal/ src/ Plugin/ migrate/ field/ FieldPluginBase.php - ProcessFieldTest.php in core/
modules/ field/ tests/ src/ Unit/ Plugin/ migrate/ process/ ProcessFieldTest.php
File
-
core/
modules/ migrate_drupal/ src/ Plugin/ MigrateFieldInterface.php, line 12
Namespace
Drupal\migrate_drupal\PluginView source
interface MigrateFieldInterface extends PluginInspectionInterface {
/**
* Apply any custom processing to the field migration.
*
* @param \Drupal\migrate\Plugin\MigrationInterface $migration
* The migration entity.
*/
public function alterFieldMigration(MigrationInterface $migration);
/**
* Apply any custom processing to the field instance migration.
*
* @param \Drupal\migrate\Plugin\MigrationInterface $migration
* The migration entity.
*/
public function alterFieldInstanceMigration(MigrationInterface $migration);
/**
* Apply any custom processing to the field widget migration.
*
* @param \Drupal\migrate\Plugin\MigrationInterface $migration
* The migration entity.
*/
public function alterFieldWidgetMigration(MigrationInterface $migration);
/**
* Apply any custom processing to the field formatter migration.
*
* @param \Drupal\migrate\Plugin\MigrationInterface $migration
* The migration entity.
*/
public function alterFieldFormatterMigration(MigrationInterface $migration);
/**
* Get the field formatter type from the source.
*
* @param \Drupal\migrate\Row $row
* The field being migrated.
*
* @return string
* The field formatter type.
*/
public function getFieldFormatterType(Row $row);
/**
* Get a map between D6 formatters and D8 formatters for this field type.
*
* This is used by static::alterFieldFormatterMigration() in the base class.
*
* @return array
* The keys are D6 formatters and the values are D8 formatters.
*/
public function getFieldFormatterMap();
/**
* Get the field widget type from the source.
*
* @param \Drupal\migrate\Row $row
* The field being migrated.
*
* @return string
* The field widget type.
*/
public function getFieldWidgetType(Row $row);
/**
* Get a map between D6 and D8 widgets for this field type.
*
* @return array
* The keys are D6 field widget types and the values D8 widgets.
*/
public function getFieldWidgetMap();
/**
* Apply any custom processing to the field bundle migrations.
*
* @param \Drupal\migrate\Plugin\MigrationInterface $migration
* The migration entity.
* @param string $field_name
* The field name we're processing the value for.
* @param array $data
* The array of field data from FieldValues::fieldData().
*/
public function defineValueProcessPipeline(MigrationInterface $migration, $field_name, $data);
/**
* Computes the destination type of a migrated field.
*
* @param \Drupal\migrate\Row $row
* The field being migrated.
*
* @return string
* The destination field type.
*/
public function getFieldType(Row $row);
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
MigrateFieldInterface::alterFieldFormatterMigration | public | function | Apply any custom processing to the field formatter migration. | 1 |
MigrateFieldInterface::alterFieldInstanceMigration | public | function | Apply any custom processing to the field instance migration. | 1 |
MigrateFieldInterface::alterFieldMigration | public | function | Apply any custom processing to the field migration. | 1 |
MigrateFieldInterface::alterFieldWidgetMigration | public | function | Apply any custom processing to the field widget migration. | 1 |
MigrateFieldInterface::defineValueProcessPipeline | public | function | Apply any custom processing to the field bundle migrations. | 1 |
MigrateFieldInterface::getFieldFormatterMap | public | function | Get a map between D6 formatters and D8 formatters for this field type. | 1 |
MigrateFieldInterface::getFieldFormatterType | public | function | Get the field formatter type from the source. | 1 |
MigrateFieldInterface::getFieldType | public | function | Computes the destination type of a migrated field. | 1 |
MigrateFieldInterface::getFieldWidgetMap | public | function | Get a map between D6 and D8 widgets for this field type. | 1 |
MigrateFieldInterface::getFieldWidgetType | public | function | Get the field widget type from the source. | 1 |
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 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.