class EntityFieldStorageConfig in Drupal 9

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

File

core/modules/migrate/src/Plugin/migrate/destination/EntityFieldStorageConfig.php, line 53

Namespace

Drupal\migrate\Plugin\migrate\destination

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::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
DestinationBase::$migration	protected	property	The migration.
DestinationBase::$rollbackAction	protected	property	The rollback action to be saved for the last imported item.
DestinationBase::$supportsRollback	protected	property	Indicates whether the destination can be rolled back.
DestinationBase::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DestinationBase::getDestinationModule	public	function	Gets the destination module handling the destination data. Overrides MigrateDestinationInterface::getDestinationModule	1
DestinationBase::rollbackAction	public	function	The rollback action for the last imported item. Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction	protected	function	For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback	public	function	Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface::supportsRollback
Entity::$bundles	protected	property	The list of the bundles of this entity type.
Entity::$storage	protected	property	The entity storage.
Entity::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
Entity::fields	public	function	Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
Entity::getBundle	public	function	Gets the bundle for the row taking into account the default.
Entity::getEntity	protected	function	Creates or loads an entity.	5
Entity::getEntityId	protected	function	Gets the entity ID of the row.	2
Entity::getKey	protected	function	Returns a specific entity key.
EntityConfigBase::$configFactory	protected	property	The configuration factory.
EntityConfigBase::$languageManager	protected	property	The language manager.
EntityConfigBase::create	public static	function	Creates an instance of the plugin. Overrides Entity::create	1
EntityConfigBase::generateId	protected	function	Generates an entity ID.
EntityConfigBase::import	public	function	Import the row. Overrides MigrateDestinationInterface::import	4
EntityConfigBase::isTranslationDestination	protected	function	Get whether this destination is for translations.
EntityConfigBase::updateEntity	protected	function	Updates an entity with the contents of a row.	1
EntityConfigBase::updateEntityProperty	protected	function	Updates a (possible nested) entity property with a value.	1
EntityConfigBase::__construct	public	function	Construct a new entity. Overrides Entity::__construct	1
EntityFieldDefinitionTrait::getDefinitionFromEntity	protected	function	Gets the field definition from a specific entity base field.
EntityFieldDefinitionTrait::getEntityTypeId	protected static	function	Finds the entity type from configuration or plugin ID.	3
EntityFieldStorageConfig::getIds	public	function	Gets the destination IDs. Overrides EntityConfigBase::getIds
EntityFieldStorageConfig::rollback	public	function	Delete the specified destination object from the target Drupal. Overrides EntityConfigBase::rollback
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.