class FieldMigration in Drupal 8
Same name and namespace in other branches
- 9 core/modules/migrate_drupal/src/Plugin/migrate/FieldMigration.php \Drupal\migrate_drupal\Plugin\migrate\FieldMigration
Migration plugin class for migrations dealing with field config and values.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\migrate\Plugin\Migration implements ContainerFactoryPluginInterface, MigrationInterface, RequirementsInterface
- class \Drupal\migrate_drupal\Plugin\migrate\FieldMigration implements ContainerFactoryPluginInterface
- class \Drupal\migrate\Plugin\Migration implements ContainerFactoryPluginInterface, MigrationInterface, RequirementsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of FieldMigration
2 files declare their use of FieldMigration
- D7Comment.php in core/
modules/ comment/ src/ Plugin/ migrate/ D7Comment.php - User.php in core/
modules/ user/ src/ Plugin/ migrate/ User.php
9 string references to 'FieldMigration'
- d6_field.yml in core/
modules/ field/ migrations/ d6_field.yml - core/modules/field/migrations/d6_field.yml
- d6_field_formatter_settings.yml in core/
modules/ field/ migrations/ d6_field_formatter_settings.yml - core/modules/field/migrations/d6_field_formatter_settings.yml
- d6_field_instance.yml in core/
modules/ field/ migrations/ d6_field_instance.yml - core/modules/field/migrations/d6_field_instance.yml
- d6_field_instance_widget_settings.yml in core/
modules/ field/ migrations/ d6_field_instance_widget_settings.yml - core/modules/field/migrations/d6_field_instance_widget_settings.yml
- d7_field.yml in core/
modules/ field/ migrations/ d7_field.yml - core/modules/field/migrations/d7_field.yml
File
- core/
modules/ migrate_drupal/ src/ Plugin/ migrate/ FieldMigration.php, line 16
Namespace
Drupal\migrate_drupal\Plugin\migrateView source
class FieldMigration extends Migration implements ContainerFactoryPluginInterface {
/**
* Defines which configuration option has the migration processing function.
*
* Default method is 'field_plugin_method'. For backwards compatibility,
* this constant is overridden in the CckMigration class, in order to
* fallback to the old 'cck_plugin_method'.
*
* @const string
* @deprecated in drupal:8.7.0 and is removed from drupal:9.0.0. Use the migrate_drupal.field_discovery service instead. See https://www.drupal.org/node/3006076.
*/
const PLUGIN_METHOD = 'field_plugin_method';
/**
* Flag indicating whether the field data has been filled already.
*
* @var bool
*/
protected $init = FALSE;
/**
* The migration field discovery service.
*
* @var \Drupal\migrate_drupal\FieldDiscoveryInterface
*/
protected $fieldDiscovery;
/**
* Constructs a FieldMigration.
*
* @param array $configuration
* Plugin configuration.
* @param string $plugin_id
* The plugin ID.
* @param mixed $plugin_definition
* The plugin definition.
* @param \Drupal\migrate\Plugin\MigrationPluginManagerInterface $migration_plugin_manager
* The migration plugin manager.
* @param \Drupal\migrate\Plugin\MigratePluginManager $source_plugin_manager
* The source migration plugin manager.
* @param \Drupal\migrate\Plugin\MigratePluginManager $process_plugin_manager
* The process migration plugin manager.
* @param \Drupal\migrate\Plugin\MigrateDestinationPluginManager $destination_plugin_manager
* The destination migration plugin manager.
* @param \Drupal\migrate\Plugin\MigratePluginManager $idmap_plugin_manager
* The ID map migration plugin manager.
* @param \Drupal\migrate_drupal\FieldDiscoveryInterface $field_discovery
* The migration field discovery service.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationPluginManagerInterface $migration_plugin_manager, MigratePluginManager $source_plugin_manager, MigratePluginManager $process_plugin_manager, MigrateDestinationPluginManager $destination_plugin_manager, MigratePluginManager $idmap_plugin_manager, FieldDiscoveryInterface $field_discovery) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $migration_plugin_manager, $source_plugin_manager, $process_plugin_manager, $destination_plugin_manager, $idmap_plugin_manager);
$this->fieldDiscovery = $field_discovery;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('plugin.manager.migration'), $container
->get('plugin.manager.migrate.source'), $container
->get('plugin.manager.migrate.process'), $container
->get('plugin.manager.migrate.destination'), $container
->get('plugin.manager.migrate.id_map'), $container
->get('migrate_drupal.field_discovery'));
}
/**
* {@inheritdoc}
*/
public function getProcess() {
if (!$this->init) {
$this->init = TRUE;
$this->fieldDiscovery
->addAllFieldProcesses($this);
}
return parent::getProcess();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FieldMigration:: |
protected | property | The migration field discovery service. | |
FieldMigration:: |
protected | property | Flag indicating whether the field data has been filled already. | |
FieldMigration:: |
public static | function |
Creates an instance of the plugin. Overrides Migration:: |
|
FieldMigration:: |
public | function |
Get the normalized process pipeline configuration describing the process
plugins. Overrides Migration:: |
2 |
FieldMigration:: |
constant | Defines which configuration option has the migration processing function. | 1 | |
FieldMigration:: |
public | function |
Constructs a FieldMigration. Overrides Migration:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
Migration:: |
protected | property | Whether the migration is auditable. | |
Migration:: |
protected | property | The migration's configuration dependencies. | |
Migration:: |
protected | property | The destination configuration, with at least a 'plugin' key. | |
Migration:: |
protected | property | The destination identifiers. | |
Migration:: |
protected | property | The destination plugin. | |
Migration:: |
protected | property | The destination plugin manager. | |
Migration:: |
protected | property | The migration ID (machine name). | 1 |
Migration:: |
protected | property | The identifier map data. | |
Migration:: |
protected | property | The identifier map. | |
Migration:: |
protected | property | The ID map plugin manager. | |
Migration:: |
protected | property | The human-readable label for the migration. | |
Migration:: |
protected | property | The migration plugin manager for loading other migration plugins. | |
Migration:: |
protected | property | These migrations, if run, must be executed before this migration. | |
Migration:: |
protected | property | An optional list of tags, used by the plugin manager for filtering. | |
Migration:: |
protected | property | The configuration describing the process plugins. | |
Migration:: |
protected | property | The process plugin manager. | |
Migration:: |
protected | property | The cached process plugins. | |
Migration:: |
protected | property | These migrations must be already executed before this migration can run. | |
Migration:: |
protected | property | The plugin ID for the row. | |
Migration:: |
protected | property | The source configuration, with at least a 'plugin' key. | |
Migration:: |
protected | property | The source identifiers. | |
Migration:: |
protected | property | The source plugin. | |
Migration:: |
protected | property | The source plugin manager. | |
Migration:: |
protected | property | Specify value of source_row_status for current map row. Usually set by MigrateFieldHandler implementations. | |
Migration:: |
protected | property | Labels corresponding to each defined status. | |
Migration:: |
protected | property | Track time of last import if TRUE. | |
Migration:: |
public | function |
Check if all source rows from this migration have been processed. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Checks if requirements for this plugin are OK. Overrides RequirementsInterface:: |
|
Migration:: |
public | function |
Clears the result to return upon interruption. Overrides MigrationInterface:: |
|
Migration:: |
protected | function | Find migration dependencies from migration_lookup and sub_process plugins. | |
Migration:: |
public | function | Gets any arbitrary property's value. | |
Migration:: |
public | function |
Get the destination configuration, with at least a 'plugin' key. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
The destination identifiers. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Returns the initialized destination plugin. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Returns the initialized id_map plugin. Overrides MigrationInterface:: |
|
Migration:: |
public | function | Retrieves the ID map plugin. | |
Migration:: |
public | function |
Get the result to return upon interruption. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Get the dependencies for this migration. Overrides MigrationInterface:: |
1 |
Migration:: |
protected | function | Gets the migration plugin manager. | |
Migration:: |
public | function |
The migration tags. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginBase:: |
|
Migration:: |
protected | function | Resolve shorthands into a list of plugin configurations. | |
Migration:: |
public | function |
Returns the process plugins. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Get the source configuration, with at least a 'plugin' key. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Returns the initialized source plugin. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Get the current migration status. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Retrieve a label for the current status. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
If true, track time of last import. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
An alias for getPluginId() for backwards compatibility reasons. Overrides MigrationInterface:: |
1 |
Migration:: |
public | function |
Signal that the migration should be interrupted with the specified result
code. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Indicates if the migration is auditable. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Checks if the migration should track time of last import. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Get the plugin label. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Merge the process pipeline configuration for a single property. Overrides MigrationInterface:: |
|
Migration:: |
public | function | 1 | |
Migration:: |
public | function |
Allows you to override the entire process configuration. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Set the process pipeline configuration for an individual destination field. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Set the current migration status. Overrides MigrationInterface:: |
|
Migration:: |
public | function |
Set if the migration should track time of last import. Overrides MigrationInterface:: |
|
MigrationInterface:: |
constant | Migration error. | ||
MigrationInterface:: |
constant | Migration info. | ||
MigrationInterface:: |
constant | Migration notice. | ||
MigrationInterface:: |
constant | Migration warning. | ||
MigrationInterface:: |
constant | All records have been processed. | ||
MigrationInterface:: |
constant | This migration is disabled, skipping. | ||
MigrationInterface:: |
constant | The process had a fatal error. | ||
MigrationInterface:: |
constant | The process has stopped itself (e.g., the memory limit is approaching). | ||
MigrationInterface:: |
constant | Dependencies are unfulfilled - skip the process. | ||
MigrationInterface:: |
constant | The process was stopped externally (e.g., via drush migrate-stop). | ||
MigrationInterface:: |
constant | The migration has been disabled. | ||
MigrationInterface:: |
constant | The migration is currently not running. | ||
MigrationInterface:: |
constant | The migration is currently importing. | ||
MigrationInterface:: |
constant | The migration is currently being rolled back. | ||
MigrationInterface:: |
constant | The migration is being stopped. | ||
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |