class User in Drupal 8

Drupal 7 user source from database.

Plugin annotation

@MigrateSource(
  id = "d7_user",
  source_module = "user"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements RollbackAwareInterface, MigrateSourceInterface
      • class \Drupal\migrate\Plugin\migrate\source\SqlBase implements ContainerFactoryPluginInterface, RequirementsInterface
        • class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements DependentPluginInterface, ContainerFactoryPluginInterface uses DeprecatedServicePropertyTrait, DependencyTrait
          • class \Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity
            • class \Drupal\user\Plugin\migrate\source\d7\User

24 string references to 'User'

BulkFormAccessTest::testUserEditAccess in core/modules/user/tests/src/Functional/Views/BulkFormAccessTest.php

Tests if users that may not be edited, can not be edited in bulk.

CategoryAutocompleteTest::providerTestAutocompleteSuggestions in core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php

Data provider for testAutocompleteSuggestions().

CategoryAutocompleteTest::setUp in core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php

contact_entity_extra_field_info in core/modules/contact/contact.module

Implements hook_entity_extra_field_info().

ContextPluginTest::testContext in core/tests/Drupal/KernelTests/Core/Plugin/ContextPluginTest.php

Tests basic context definition and value getters and setters.

... See full list

File

core/modules/user/src/Plugin/migrate/source/d7/User.php, line 16

Namespace

Drupal\user\Plugin\migrate\source\d7

class User extends FieldableEntity {

  /**
   * {@inheritdoc}
   */
  public function query() {
    return $this
      ->select('users', 'u')
      ->fields('u')
      ->condition('u.uid', 0, '>');
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    $fields = [
      'uid' => $this
        ->t('User ID'),
      'name' => $this
        ->t('Username'),
      'pass' => $this
        ->t('Password'),
      'mail' => $this
        ->t('Email address'),
      'signature' => $this
        ->t('Signature'),
      'signature_format' => $this
        ->t('Signature format'),
      'created' => $this
        ->t('Registered timestamp'),
      'access' => $this
        ->t('Last access timestamp'),
      'login' => $this
        ->t('Last login timestamp'),
      'status' => $this
        ->t('Status'),
      'timezone' => $this
        ->t('Timezone'),
      'language' => $this
        ->t('Language'),
      'picture' => $this
        ->t('Picture'),
      'init' => $this
        ->t('Init'),
      'data' => $this
        ->t('User data'),
      'roles' => $this
        ->t('Roles'),
    ];

    // Profile fields.
    if ($this
      ->moduleExists('profile')) {
      $fields += $this
        ->select('profile_fields', 'pf')
        ->fields('pf', [
        'name',
        'title',
      ])
        ->execute()
        ->fetchAllKeyed();
    }
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    $uid = $row
      ->getSourceProperty('uid');
    $roles = $this
      ->select('users_roles', 'ur')
      ->fields('ur', [
      'rid',
    ])
      ->condition('ur.uid', $uid)
      ->execute()
      ->fetchCol();
    $row
      ->setSourceProperty('roles', $roles);
    $row
      ->setSourceProperty('data', unserialize($row
      ->getSourceProperty('data')));

    // If this entity was translated using Entity Translation, we need to get
    // its source language to get the field values in the right language.
    // The translations will be migrated by the d7_user_entity_translation
    // migration.
    $entity_translatable = $this
      ->isEntityTranslatable('user');
    $source_language = $this
      ->getEntityTranslationSourceLanguage('user', $uid);
    $language = $entity_translatable && $source_language ? $source_language : $row
      ->getSourceProperty('language');
    $row
      ->setSourceProperty('entity_language', $language);

    // Get Field API field values.
    foreach ($this
      ->getFields('user') as $field_name => $field) {

      // Ensure we're using the right language if the entity and the field are
      // translatable.
      $field_language = $entity_translatable && $field['translatable'] ? $language : NULL;
      $row
        ->setSourceProperty($field_name, $this
        ->getFieldValues('user', $field_name, $uid, NULL, $field_language));
    }

    // Get profile field values. This code is lifted directly from the D6
    // ProfileFieldValues plugin.
    if ($this
      ->getDatabase()
      ->schema()
      ->tableExists('profile_value')) {
      $query = $this
        ->select('profile_value', 'pv')
        ->fields('pv', [
        'fid',
        'value',
      ]);
      $query
        ->leftJoin('profile_field', 'pf', 'pf.fid=pv.fid');
      $query
        ->fields('pf', [
        'name',
        'type',
      ]);
      $query
        ->condition('uid', $row
        ->getSourceProperty('uid'));
      $results = $query
        ->execute();
      foreach ($results as $profile_value) {
        if ($profile_value['type'] == 'date') {
          $date = unserialize($profile_value['value']);
          $date = date('Y-m-d', mktime(0, 0, 0, $date['month'], $date['day'], $date['year']));
          $row
            ->setSourceProperty($profile_value['name'], [
            'value' => $date,
          ]);
        }
        elseif ($profile_value['type'] == 'list') {

          // Explode by newline and comma.
          $row
            ->setSourceProperty($profile_value['name'], preg_split("/[\r\n,]+/", $profile_value['value']));
        }
        else {
          $row
            ->setSourceProperty($profile_value['name'], [
            $profile_value['value'],
          ]);
        }
      }
    }
    return parent::prepareRow($row);
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    return [
      'uid' => [
        'type' => 'integer',
        'alias' => 'u',
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
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.
DeprecatedServicePropertyTrait::__get	public	function	Allows to access deprecated/removed properties.
DrupalSqlBase::$deprecatedProperties	protected	property		1
DrupalSqlBase::$entityTypeManager	protected	property	The entity type manager.
DrupalSqlBase::$requirements	protected	property	If the source provider is missing.
DrupalSqlBase::$systemData	protected	property	The contents of the system table.
DrupalSqlBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	1
DrupalSqlBase::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides SqlBase::checkRequirements	2
DrupalSqlBase::create	public static	function	Creates an instance of the plugin. Overrides SqlBase::create	3
DrupalSqlBase::getModuleSchemaVersion	protected	function	Retrieves a module schema_version from the source Drupal database.
DrupalSqlBase::getSystemData	public	function	Retrieves all system data information from the source Drupal database.
DrupalSqlBase::moduleExists	protected	function	Checks if a given module is enabled in the source Drupal database.
DrupalSqlBase::variableGet	protected	function	Reads a variable from a source Drupal database.
DrupalSqlBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct	6
FieldableEntity::getEntityTranslationSourceLanguage	protected	function	Gets an entity source language from the 'entity_translation' table.
FieldableEntity::getFields	protected	function	Returns all non-deleted field instances attached to a specific entity type.
FieldableEntity::getFieldValues	protected	function	Retrieves field values for a single field of a single entity.
FieldableEntity::isEntityTranslatable	protected	function	Checks if an entity type uses Entity Translation.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.
SourcePluginBase::$cache	protected	property	The backend cache.
SourcePluginBase::$cacheCounts	protected	property	Whether this instance should cache the source count.	1
SourcePluginBase::$cacheKey	protected	property	Key to use for caching counts.
SourcePluginBase::$currentRow	protected	property	The current row from the query.
SourcePluginBase::$currentSourceIds	protected	property	The primary key of the current row.
SourcePluginBase::$highWaterProperty	protected	property	Information on the property used as the high-water mark.
SourcePluginBase::$highWaterStorage	protected	property	The key-value storage for the high-water value.
SourcePluginBase::$idMap	protected	property	The migration ID map.
SourcePluginBase::$iterator	protected	property	The iterator to iterate over the source rows.
SourcePluginBase::$mapRowAdded	protected	property	Flags whether source plugin will read the map row and add to data row.
SourcePluginBase::$migration	protected	property	The entity migration object.
SourcePluginBase::$moduleHandler	protected	property	The module handler service.	2
SourcePluginBase::$originalHighWater	protected	property	The high water mark at the beginning of the import operation.
SourcePluginBase::$skipCount	protected	property	Whether this instance should not attempt to count the source.	1
SourcePluginBase::$trackChanges	protected	property	Flags whether to track changes to incoming data.	1
SourcePluginBase::aboveHighwater	protected	function	Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::current	public	function
SourcePluginBase::doCount	protected	function	Gets the source count checking if the source is countable or using the iterator_count function.	1
SourcePluginBase::getCache	protected	function	Gets the cache object.
SourcePluginBase::getCurrentIds	public	function	Gets the currentSourceIds data member.
SourcePluginBase::getHighWater	protected	function	The current value of the high water mark.
SourcePluginBase::getHighWaterField	protected	function	Get the name of the field used as the high watermark.
SourcePluginBase::getHighWaterProperty	protected	function	Get information on the property used as the high watermark.
SourcePluginBase::getHighWaterStorage	protected	function	Get the high water storage object.	1
SourcePluginBase::getIterator	protected	function	Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getModuleHandler	protected	function	Gets the module handler.
SourcePluginBase::getSourceModule	public	function	Gets the source module providing the source data. Overrides MigrateSourceInterface::getSourceModule
SourcePluginBase::key	public	function	Gets the iterator key.
SourcePluginBase::next	public	function	The migration iterates over rows returned by the source plugin. This method determines the next row which will be processed and imported into the system.
SourcePluginBase::postRollback	public	function	Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::preRollback	public	function	Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rewind	public	function	Rewinds the iterator.
SourcePluginBase::rowChanged	protected	function	Checks if the incoming row has changed since our last import.
SourcePluginBase::saveHighWater	protected	function	Save the new high water mark.
SourcePluginBase::valid	public	function	Checks whether the iterator is currently valid.
SqlBase::$batch	protected	property	The count of the number of batches run.
SqlBase::$batchSize	protected	property	Number of records to fetch from the database during each batch.
SqlBase::$database	protected	property	The database object.	1
SqlBase::$query	protected	property	The query string.
SqlBase::$state	protected	property	State service for retrieving database info.
SqlBase::count	public	function	Gets the source count. Overrides SourcePluginBase::count	6
SqlBase::fetchNextBatch	protected	function	Prepares query for the next set of data from the source database.
SqlBase::fetchNextRow	protected	function	Position the iterator to the following row. Overrides SourcePluginBase::fetchNextRow
SqlBase::getDatabase	public	function	Gets the database connection object.	2
SqlBase::initializeIterator	protected	function	Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator	20
SqlBase::mapJoinable	protected	function	Checks if we can join against the map table.	1
SqlBase::prepareQuery	protected	function	Adds tags and metadata to the query.
SqlBase::select	protected	function	Wrapper for database select.
SqlBase::setUpDatabase	protected	function	Gets a connection to the referenced database.
SqlBase::__toString	public	function	Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
User::fields	public	function	Returns available fields on the source. Overrides MigrateSourceInterface::fields
User::getIds	public	function	Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
User::prepareRow	public	function	Adds additional data to the row. Overrides SourcePluginBase::prepareRow
User::query	public	function	Overrides SqlBase::query