interface MigrateFieldInterface implements PluginInspectionInterface (View source)

Provides an interface for all field type plugins.

Methods

string
getPluginId()

Gets the plugin_id of the plugin instance.

array
getPluginDefinition()

Gets the definition of the plugin implementation.

alterFieldMigration(MigrationInterface $migration)

Apply any custom processing to the field migration.

alterFieldInstanceMigration(MigrationInterface $migration)

Apply any custom processing to the field instance migration.

alterFieldWidgetMigration(MigrationInterface $migration)

Apply any custom processing to the field widget migration.

alterFieldFormatterMigration(MigrationInterface $migration)

Apply any custom processing to the field formatter migration.

string
getFieldFormatterType(Row $row)

Get the field formatter type from the source.

array
getFieldFormatterMap()

Get a map between D6 formatters and D8 formatters for this field type.

string
getFieldWidgetType(Row $row)

Get the field widget type from the source.

array
getFieldWidgetMap()

Get a map between D6 and D8 widgets for this field type.

defineValueProcessPipeline(MigrationInterface $migration, string $field_name, array $data)

Apply any custom processing to the field bundle migrations.

string
getFieldType(Row $row)

Computes the destination type of a migrated field.

Details

string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

array getPluginDefinition()

Gets the definition of the plugin implementation.

Return Value

array

The plugin definition, as returned by the discovery object used by the plugin manager.

alterFieldMigration(MigrationInterface $migration)

Apply any custom processing to the field migration.

Parameters

MigrationInterface $migration

The migration entity.

alterFieldInstanceMigration(MigrationInterface $migration)

Apply any custom processing to the field instance migration.

Parameters

MigrationInterface $migration

The migration entity.

alterFieldWidgetMigration(MigrationInterface $migration)

Apply any custom processing to the field widget migration.

Parameters

MigrationInterface $migration

The migration entity.

alterFieldFormatterMigration(MigrationInterface $migration)

Apply any custom processing to the field formatter migration.

Parameters

MigrationInterface $migration

The migration entity.

string getFieldFormatterType(Row $row)

Get the field formatter type from the source.

Parameters

Row $row

The field being migrated.

Return Value

string

The field formatter type.

array getFieldFormatterMap()

Get a map between D6 formatters and D8 formatters for this field type.

This is used by static::alterFieldFormatterMigration() in the base class.

Return Value

array

The keys are D6 formatters and the values are D8 formatters.

string getFieldWidgetType(Row $row)

Get the field widget type from the source.

Parameters

Row $row

The field being migrated.

Return Value

string

The field widget type.

array getFieldWidgetMap()

Get a map between D6 and D8 widgets for this field type.

Return Value

array

The keys are D6 field widget types and the values D8 widgets.

defineValueProcessPipeline(MigrationInterface $migration, string $field_name, array $data)

Apply any custom processing to the field bundle migrations.

Parameters

MigrationInterface $migration

The migration entity.

string $field_name

The field name we're processing the value for.

array $data

The array of field data from FieldValues::fieldData().

string getFieldType(Row $row)

Computes the destination type of a migrated field.

Parameters

Row $row

The field being migrated.

Return Value

string

The destination field type.