class User
Drupal 6 user source from database.
For available configuration keys, refer to the parent classes.
Plugin annotation
@MigrateSource(
  id = "d6_user",
  source_module = "user"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements \Drupal\migrate\Plugin\MigrateSourceInterface, \Drupal\migrate\Event\RollbackAwareInterface extends \Drupal\Core\Plugin\PluginBase- class \Drupal\migrate\Plugin\migrate\source\SqlBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Plugin\RequirementsInterface extends \Drupal\migrate\Plugin\migrate\source\SourcePluginBase- class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait extends \Drupal\migrate\Plugin\migrate\source\SqlBase- class \Drupal\user\Plugin\migrate\source\d6\User extends \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase
 
 
- class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait extends \Drupal\migrate\Plugin\migrate\source\SqlBase
 
- class \Drupal\migrate\Plugin\migrate\source\SqlBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Plugin\RequirementsInterface extends \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
 
- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements \Drupal\migrate\Plugin\MigrateSourceInterface, \Drupal\migrate\Event\RollbackAwareInterface extends \Drupal\Core\Plugin\PluginBase
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of User
See also
\Drupal\migrate\Plugin\migrate\source\SqlBase
\Drupal\migrate\Plugin\migrate\source\SourcePluginBase
927 string references to 'User'
- AccessPermissionTest::setUp in core/modules/ user/ tests/ src/ Kernel/ Views/ AccessPermissionTest.php 
- AccessResult::cachePerUser in core/lib/ Drupal/ Core/ Access/ AccessResult.php 
- Convenience method, adds the "user" cache context.
- AccessResultTest::testCacheContexts in core/tests/ Drupal/ Tests/ Core/ Access/ AccessResultTest.php 
- @covers ::addCacheContexts[[api-linebreak]] @covers ::resetCacheContexts[[api-linebreak]] @covers ::getCacheContexts[[api-linebreak]] @covers ::cachePerPermissions[[api-linebreak]] @covers ::cachePerUser[[api-linebreak]] @covers…
- AccessResultTest::testCacheTags in core/tests/ Drupal/ Tests/ Core/ Access/ AccessResultTest.php 
- @covers ::addCacheTags[[api-linebreak]] @covers ::addCacheableDependency[[api-linebreak]] @covers ::getCacheTags[[api-linebreak]] @covers ::resetCacheTags[[api-linebreak]]
- AccessResultTest::testInheritCacheability in core/tests/ Drupal/ Tests/ Core/ Access/ AccessResultTest.php 
- @covers ::inheritCacheability[[api-linebreak]]
File
- 
              core/modules/ user/ src/ Plugin/ migrate/ source/ d6/ User.php, line 21 
Namespace
Drupal\user\Plugin\migrate\source\d6View source
class User extends DrupalSqlBase {
  
  /**
   * {@inheritdoc}
   */
  public function query() {
    return $this->select('users', 'u')
      ->fields('u', array_keys($this->baseFields()))
      ->condition('u.uid', 0, '>');
  }
  
  /**
   * {@inheritdoc}
   */
  public function fields() {
    $fields = $this->baseFields();
    // Add roles field.
    $fields['roles'] = $this->t('Roles');
    return $fields;
  }
  
  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    // User roles.
    $roles = $this->select('users_roles', 'ur')
      ->fields('ur', [
      'rid',
    ])
      ->condition('ur.uid', $row->getSourceProperty('uid'))
      ->execute()
      ->fetchCol();
    $row->setSourceProperty('roles', $roles);
    // We are adding here the Event contributed module column.
    // @see https://api.drupal.org/api/drupal/modules%21user%21user.install/function/user_update_7002/7
    if ($row->hasSourceProperty('timezone_id') && $row->getSourceProperty('timezone_id')) {
      if ($this->getDatabase()
        ->schema()
        ->tableExists('event_timezones')) {
        $event_timezone = $this->select('event_timezones', 'e')
          ->fields('e', [
          'name',
        ])
          ->condition('e.timezone', $row->getSourceProperty('timezone_id'))
          ->execute()
          ->fetchField();
        if ($event_timezone) {
          $row->setSourceProperty('event_timezone', $event_timezone);
        }
      }
    }
    // Unserialize Data.
    $data = $row->getSourceProperty('data');
    if ($data !== NULL) {
      $row->setSourceProperty('data', unserialize($row->getSourceProperty('data')));
    }
    return parent::prepareRow($row);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getIds() {
    return [
      'uid' => [
        'type' => 'integer',
        'alias' => 'u',
      ],
    ];
  }
  
  /**
   * Returns the user base fields to be migrated.
   *
   * @return array
   *   Associative array having field name as key and description as value.
   */
  protected function baseFields() {
    $fields = [
      'uid' => $this->t('User ID'),
      'name' => $this->t('Username'),
      'pass' => $this->t('Password'),
      'mail' => $this->t('Email address'),
      'theme' => $this->t('Theme'),
      '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'),
    ];
    // Possible field added by Date contributed module.
    // @see https://api.drupal.org/api/drupal/modules%21user%21user.install/function/user_update_7002/7
    if ($this->getDatabase()
      ->schema()
      ->fieldExists('users', 'timezone_name')) {
      $fields['timezone_name'] = $this->t('Timezone (Date)');
    }
    // Possible field added by Event contributed module.
    // @see https://api.drupal.org/api/drupal/modules%21user%21user.install/function/user_update_7002/7
    if ($this->getDatabase()
      ->schema()
      ->fieldExists('users', 'timezone_id')) {
      $fields['timezone_id'] = $this->t('Timezone (Event)');
    }
    return $fields;
  }
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| DependencyTrait::$dependencies | protected | property | The object's dependencies. | ||
| DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | ||
| DependencyTrait::addDependency | protected | function | Adds a dependency. | ||
| 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 | 4 | 
| 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 | 
| MessengerTrait::$messenger | protected | property | The messenger. | 27 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
| MigrateSourceInterface::NOT_COUNTABLE | constant | Indicates that the source is not countable. | |||
| 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. | ||
| 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::count | public | function | Gets the source count. | 2 | |
| SourcePluginBase::current | public | function | #[\ReturnTypeWillChange] | ||
| 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. | ||
| 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 | #[\ReturnTypeWillChange] | ||
| SourcePluginBase::postRollback | public | function | Performs post-rollback tasks. | Overrides RollbackAwareInterface::postRollback | |
| SourcePluginBase::preRollback | public | function | Performs pre-rollback tasks. | Overrides RollbackAwareInterface::preRollback | |
| 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. | 83 | |
| SqlBase::$state | protected | property | State service for retrieving database info. | ||
| SqlBase::doCount | protected | function | Gets the source count using countQuery(). | Overrides SourcePluginBase::doCount | 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 | 18 | 
| 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::rewind | public | function | Rewinds the iterator. | Overrides SourcePluginBase::rewind | |
| SqlBase::select | protected | function | Wrapper for database select. | ||
| SqlBase::setUpDatabase | protected | function | Gets a connection to the referenced database. | ||
| SqlBase::__sleep | public | function | Overrides DependencySerializationTrait::__sleep | ||
| 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. | 3 | |
| 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::baseFields | protected | function | Returns the user base fields to be migrated. | ||
| 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 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
