UserReference.php

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

Namespace

Drupal\migrate_drupal\Plugin\migrate\field\d7

File

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

View source
<?php

namespace Drupal\migrate_drupal\Plugin\migrate\field\d7;

use Drupal\migrate\Plugin\MigrationInterface;
use Drupal\migrate_drupal\Plugin\migrate\field\ReferenceBase;

/**
 * MigrateField plugin for Drupal 7 user_reference fields.
 *
 * @MigrateField(
 *   id = "user_reference",
 *   type_map = {
 *     "user_reference" = "entity_reference",
 *   },
 *   core = {7},
 *   source_module = "user_reference",
 *   destination_module = "core"
 * )
 */
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);
    }

}

Classes

Title Deprecated Summary
UserReference MigrateField plugin for Drupal 7 user_reference fields.

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