class EntityFieldInstance

Same name in other branches
  1. 8.9.x core/modules/migrate/src/Plugin/migrate/destination/EntityFieldInstance.php \Drupal\migrate\Plugin\migrate\destination\EntityFieldInstance
  2. 10 core/modules/migrate/src/Plugin/migrate/destination/EntityFieldInstance.php \Drupal\migrate\Plugin\migrate\destination\EntityFieldInstance
  3. 11.x core/modules/migrate/src/Plugin/migrate/destination/EntityFieldInstance.php \Drupal\migrate\Plugin\migrate\destination\EntityFieldInstance

Provides destination plugin for field_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 adds an instance of 'field_text_example' to 'article' bundle (node content type). The example uses the EmptySource source plugin and constant source values for the sake of simplicity. For an example on how the FieldStorage 'field_text_example' can be migrated, refer to \Drupal\migrate\Plugin\migrate\destination\EntityFieldStorageConfig.


id: field_instance_example
label: Field instance example
source:
  plugin: empty
  constants:
    entity_type: node
    field_name: field_text_example
    bundle: article
    label: Text field example
    translatable: true
 process:
   entity_type: constants/entity_type
   field_name: constants/field_name
   bundle: constants/bundle
   label: constants/label
    translatable: constants/translatable
 destination:
   plugin: entity:field_config
 migration_dependencies:
   required:
     - field_storage_example

Plugin annotation


@MigrateDestination(
  id = "entity:field_config"
)

Hierarchy

Expanded class hierarchy of EntityFieldInstance

See also

\Drupal\field\Entity\FieldConfig

\Drupal\field\Entity\FieldConfigBase

File

core/modules/migrate/src/Plugin/migrate/destination/EntityFieldInstance.php, line 48

Namespace

Drupal\migrate\Plugin\migrate\destination
View source
class EntityFieldInstance extends EntityConfigBase {
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['entity_type']['type'] = 'string';
        $ids['bundle']['type'] = 'string';
        $ids['field_name']['type'] = 'string';
        if ($this->isTranslationDestination()) {
            $ids['langcode']['type'] = 'string';
        }
        return $ids;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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::$entityFieldManager protected property The entity field manager.
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 5
EntityConfigBase::isTranslationDestination protected function Get whether this destination is for translations.
EntityConfigBase::rollback public function Delete the specified destination object from the target Drupal. Overrides Entity::rollback 2
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
EntityFieldInstance::getIds public function Gets the destination IDs. Overrides EntityConfigBase::getIds
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.