class UserReference

Same name in this branch
  1. 9 core/modules/migrate_drupal/src/Plugin/migrate/field/d6/UserReference.php \Drupal\migrate_drupal\Plugin\migrate\field\d6\UserReference
Same name in other branches
  1. 8.9.x core/modules/migrate_drupal/src/Plugin/migrate/field/UserReference.php \Drupal\migrate_drupal\Plugin\migrate\field\UserReference
  2. 10 core/modules/migrate_drupal/src/Plugin/migrate/field/d6/UserReference.php \Drupal\migrate_drupal\Plugin\migrate\field\d6\UserReference
  3. 10 core/modules/migrate_drupal/src/Plugin/migrate/field/d7/UserReference.php \Drupal\migrate_drupal\Plugin\migrate\field\d7\UserReference
  4. 11.x core/modules/migrate_drupal/src/Plugin/migrate/field/d6/UserReference.php \Drupal\migrate_drupal\Plugin\migrate\field\d6\UserReference
  5. 11.x core/modules/migrate_drupal/src/Plugin/migrate/field/d7/UserReference.php \Drupal\migrate_drupal\Plugin\migrate\field\d7\UserReference

MigrateField plugin for Drupal 7 user_reference fields.

Plugin annotation


@MigrateField(
  id = "user_reference",
  type_map = {
    "user_reference" = "entity_reference",
  },
  core = {7},
  source_module = "user_reference",
  destination_module = "core"
)

Hierarchy

Expanded class hierarchy of UserReference

2 string references to 'UserReference'
FieldSettings::getSettings in core/modules/field/src/Plugin/migrate/process/d6/FieldSettings.php
Merge the default D8 and specified D6 settings.
MigrationProvidersExistTest::testFieldProvidersExist in core/modules/migrate/tests/src/Kernel/Plugin/MigrationProvidersExistTest.php
Tests that modules exist for all field plugins.

File

core/modules/migrate_drupal/src/Plugin/migrate/field/d7/UserReference.php, line 21

Namespace

Drupal\migrate_drupal\Plugin\migrate\field\d7
View source 
class UserReference extends ReferenceBase {
    
    /**
     * The plugin ID for the reference type migration.
     *
     * @var string
     */
    protected $userTypeMigration = 'd7_user_role';
    
    /**
     * {@inheritdoc}
     */
    protected function getEntityTypeMigrationId() {
        return $this->userTypeMigration;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function entityId() {
        return 'uid';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFieldFormatterMap() {
        return [
            'user_reference_default' => 'entity_reference_label',
            'user_reference_plain' => 'entity_reference_label',
            'user_reference_uid' => 'entity_reference_entity_id',
            'user_reference_user' => 'entity_reference_entity_view',
            'user_reference_path' => 'entity_reference_label',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function defineValueProcessPipeline(MigrationInterface $migration, $field_name, $data) {
        $process = [
            'plugin' => 'sub_process',
            'source' => $field_name,
            'process' => [
                'target_id' => [
                    'plugin' => 'migration_lookup',
                    'migration' => 'd7_user',
                    'source' => 'uid',
                ],
            ],
        ];
        $migration->setProcessOfProperty($field_name, $process);
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
FieldPluginBase::alterFieldFormatterMigration public function Apply any custom processing to the field formatter migration. Overrides MigrateFieldInterface::alterFieldFormatterMigration
FieldPluginBase::alterFieldMigration public function Apply any custom processing to the field migration. Overrides MigrateFieldInterface::alterFieldMigration
FieldPluginBase::alterFieldWidgetMigration public function Apply any custom processing to the field widget migration. Overrides MigrateFieldInterface::alterFieldWidgetMigration
FieldPluginBase::getFieldFormatterType public function Get the field formatter type from the source. Overrides MigrateFieldInterface::getFieldFormatterType 1
FieldPluginBase::getFieldType public function Computes the destination type of a migrated field. Overrides MigrateFieldInterface::getFieldType 4
FieldPluginBase::getFieldWidgetType public function Get the field widget type from the source. Overrides MigrateFieldInterface::getFieldWidgetType 1
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
ReferenceBase::alterFieldInstanceMigration public function Apply any custom processing to the field instance migration. Overrides FieldPluginBase::alterFieldInstanceMigration
ReferenceBase::getFieldWidgetMap public function Get a map between D6 and D8 widgets for this field type. Overrides FieldPluginBase::getFieldWidgetMap
UserReference::$userTypeMigration protected property The plugin ID for the reference type migration.
UserReference::defineValueProcessPipeline public function Apply any custom processing to the field bundle migrations. Overrides ReferenceBase::defineValueProcessPipeline
UserReference::entityId protected function Gets the name of the field property which holds the entity ID. Overrides ReferenceBase::entityId
UserReference::getEntityTypeMigrationId protected function Gets the plugin ID for the reference type migration. Overrides ReferenceBase::getEntityTypeMigrationId
UserReference::getFieldFormatterMap public function Get a map between D6 formatters and D8 formatters for this field type. Overrides FieldPluginBase::getFieldFormatterMap

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.