class EntityFieldStorageConfig in Drupal 10
Same name and namespace in other branches
- 8 core/modules/migrate/src/Plugin/migrate/destination/EntityFieldStorageConfig.php \Drupal\migrate\Plugin\migrate\destination\EntityFieldStorageConfig
- 9 core/modules/migrate/src/Plugin/migrate/destination/EntityFieldStorageConfig.php \Drupal\migrate\Plugin\migrate\destination\EntityFieldStorageConfig
Provides destination plugin for field_storage_config configuration entities.
The Field API defines two primary data structures, FieldStorage and Field. A FieldStorage defines a particular type of data that can be attached to entities as a Field instance.
The example below creates a storage for a simple text field. The example uses the EmptySource source plugin and constant source values for the sake of simplicity.
id: field_storage_example
label: Field storage example
source:
plugin: empty
constants:
entity_type: node
id: node.field_text_example
field_name: field_text_example
type: string
cardinality: 1
settings:
max_length: 10
langcode: en
translatable: true
process:
entity_type: constants/entity_type
id: constants/id
field_name: constants/field_name
type: constants/type
cardinality: constants/cardinality
settings: constants/settings
langcode: constants/langcode
translatable: constants/translatable
destination:
plugin: entity:field_storage_config
For a full list of the properties of a FieldStorage configuration entity, refer to \Drupal\field\Entity\FieldStorageConfig.
For an example on how to migrate a Field instance of this FieldStorage, refer to \Drupal\migrate\Plugin\migrate\destination\EntityFieldInstance.
Plugin annotation
@MigrateDestination(
id = "entity:field_storage_config"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements MigrateDestinationInterface, RequirementsInterface
- class \Drupal\migrate\Plugin\migrate\destination\Entity implements DependentPluginInterface, ContainerFactoryPluginInterface uses DependencyTrait, EntityFieldDefinitionTrait
- class \Drupal\migrate\Plugin\migrate\destination\EntityConfigBase
- class \Drupal\migrate\Plugin\migrate\destination\EntityFieldStorageConfig
- class \Drupal\migrate\Plugin\migrate\destination\EntityConfigBase
- class \Drupal\migrate\Plugin\migrate\destination\Entity implements DependentPluginInterface, ContainerFactoryPluginInterface uses DependencyTrait, EntityFieldDefinitionTrait
- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements MigrateDestinationInterface, RequirementsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of EntityFieldStorageConfig
File
- core/
modules/ migrate/ src/ Plugin/ migrate/ destination/ EntityFieldStorageConfig.php, line 53
Namespace
Drupal\migrate\Plugin\migrate\destinationView source
class EntityFieldStorageConfig extends EntityConfigBase {
/**
* {@inheritdoc}
*/
public function getIds() {
$ids['entity_type']['type'] = 'string';
$ids['field_name']['type'] = 'string';
// @todo: Remove conditional. https://www.drupal.org/node/3004574
if ($this
->isTranslationDestination()) {
$ids['langcode']['type'] = 'string';
}
return $ids;
}
/**
* {@inheritdoc}
*/
public function rollback(array $destination_identifier) {
if ($this
->isTranslationDestination()) {
$language = $destination_identifier['langcode'];
unset($destination_identifier['langcode']);
$destination_identifier = [
implode('.', $destination_identifier),
'langcode' => $language,
];
}
else {
$destination_identifier = [
implode('.', $destination_identifier),
];
}
parent::rollback($destination_identifier);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. | |
DestinationBase:: |
protected | property | The migration. | |
DestinationBase:: |
protected | property | The rollback action to be saved for the last imported item. | |
DestinationBase:: |
protected | property | Indicates whether the destination can be rolled back. | |
DestinationBase:: |
public | function |
Checks if requirements for this plugin are OK. Overrides RequirementsInterface:: |
|
DestinationBase:: |
public | function |
Gets the destination module handling the destination data. Overrides MigrateDestinationInterface:: |
1 |
DestinationBase:: |
public | function |
The rollback action for the last imported item. Overrides MigrateDestinationInterface:: |
|
DestinationBase:: |
protected | function | For a destination item being updated, set the appropriate rollback action. | |
DestinationBase:: |
public | function |
Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface:: |
|
Entity:: |
protected | property | The list of the bundles of this entity type. | |
Entity:: |
protected | property | The entity storage. | |
Entity:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
Entity:: |
public | function |
Returns an array of destination fields. Overrides MigrateDestinationInterface:: |
|
Entity:: |
public | function | Gets the bundle for the row taking into account the default. | |
Entity:: |
protected | function | Creates or loads an entity. | 5 |
Entity:: |
protected | function | Gets the entity ID of the row. | 2 |
Entity:: |
protected | function | Returns a specific entity key. | |
EntityConfigBase:: |
protected | property | The configuration factory. | |
EntityConfigBase:: |
protected | property | The language manager. | |
EntityConfigBase:: |
public static | function |
Creates an instance of the plugin. Overrides Entity:: |
1 |
EntityConfigBase:: |
protected | function | Generates an entity ID. | |
EntityConfigBase:: |
public | function |
Import the row. Overrides MigrateDestinationInterface:: |
5 |
EntityConfigBase:: |
protected | function | Get whether this destination is for translations. | |
EntityConfigBase:: |
protected | function | Updates an entity with the contents of a row. | 1 |
EntityConfigBase:: |
protected | function | Updates a (possible nested) entity property with a value. | 1 |
EntityConfigBase:: |
public | function |
Construct a new entity. Overrides Entity:: |
1 |
EntityFieldDefinitionTrait:: |
protected | function | Gets the field definition from a specific entity base field. | |
EntityFieldDefinitionTrait:: |
protected static | function | Finds the entity type from configuration or plugin ID. | 3 |
EntityFieldStorageConfig:: |
public | function |
Gets the destination IDs. Overrides EntityConfigBase:: |
|
EntityFieldStorageConfig:: |
public | function |
Delete the specified destination object from the target Drupal. Overrides EntityConfigBase:: |
|
MessengerTrait:: |
protected | property | The messenger. | 18 |
MessengerTrait:: |
public | function | Gets the messenger. | 18 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
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 | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | 2 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
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. | 1 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |