class User

Same name in this branch
  1. 11.x core/modules/user/src/Entity/User.php \Drupal\user\Entity\User
  2. 11.x core/modules/user/src/Plugin/views/argument_validator/User.php \Drupal\user\Plugin\views\argument_validator\User
  3. 11.x core/modules/user/src/Plugin/views/argument_default/User.php \Drupal\user\Plugin\views\argument_default\User
  4. 11.x core/modules/user/src/Plugin/migrate/source/d6/User.php \Drupal\user\Plugin\migrate\source\d6\User
  5. 11.x core/modules/user/src/Plugin/migrate/User.php \Drupal\user\Plugin\migrate\User
Same name and namespace in other branches
  1. 9 core/modules/user/src/Entity/User.php \Drupal\user\Entity\User
  2. 9 core/modules/user/src/Plugin/views/argument_validator/User.php \Drupal\user\Plugin\views\argument_validator\User
  3. 9 core/modules/user/src/Plugin/views/argument_default/User.php \Drupal\user\Plugin\views\argument_default\User
  4. 9 core/modules/user/src/Plugin/migrate/source/d6/User.php \Drupal\user\Plugin\migrate\source\d6\User
  5. 9 core/modules/user/src/Plugin/migrate/source/d7/User.php \Drupal\user\Plugin\migrate\source\d7\User
  6. 9 core/modules/user/src/Plugin/migrate/User.php \Drupal\user\Plugin\migrate\User
  7. 8.9.x core/modules/user/src/Entity/User.php \Drupal\user\Entity\User
  8. 8.9.x core/modules/user/src/Plugin/views/argument_validator/User.php \Drupal\user\Plugin\views\argument_validator\User
  9. 8.9.x core/modules/user/src/Plugin/views/argument_default/User.php \Drupal\user\Plugin\views\argument_default\User
  10. 8.9.x core/modules/user/src/Plugin/migrate/source/d6/User.php \Drupal\user\Plugin\migrate\source\d6\User
  11. 8.9.x core/modules/user/src/Plugin/migrate/source/d7/User.php \Drupal\user\Plugin\migrate\source\d7\User
  12. 8.9.x core/modules/user/src/Plugin/migrate/User.php \Drupal\user\Plugin\migrate\User
  13. 10 core/modules/user/src/Entity/User.php \Drupal\user\Entity\User
  14. 10 core/modules/user/src/Plugin/views/argument_validator/User.php \Drupal\user\Plugin\views\argument_validator\User
  15. 10 core/modules/user/src/Plugin/views/argument_default/User.php \Drupal\user\Plugin\views\argument_default\User
  16. 10 core/modules/user/src/Plugin/migrate/source/d6/User.php \Drupal\user\Plugin\migrate\source\d6\User
  17. 10 core/modules/user/src/Plugin/migrate/source/d7/User.php \Drupal\user\Plugin\migrate\source\d7\User
  18. 10 core/modules/user/src/Plugin/migrate/User.php \Drupal\user\Plugin\migrate\User

Drupal 7 user source from database.

For available configuration keys, refer to the parent classes.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of User

See also

\Drupal\migrate\Plugin\migrate\source\SqlBase

\Drupal\migrate\Plugin\migrate\source\SourcePluginBase

1006 string references to 'User'
2d3581c3-92c7-4600-8991-a0d4b3741198.yml in core/tests/fixtures/default_content/node/2d3581c3-92c7-4600-8991-a0d4b3741198.yml
core/tests/fixtures/default_content/node/2d3581c3-92c7-4600-8991-a0d4b3741198.yml
7f1dd75a-0be2-4d3b-be5d-9d1a868b9267.yml in core/tests/fixtures/default_content/node/7f1dd75a-0be2-4d3b-be5d-9d1a868b9267.yml
core/tests/fixtures/default_content/node/7f1dd75a-0be2-4d3b-be5d-9d1a868b9267.yml
94503467-be7f-406c-9795-fc25baa22203.yml in core/tests/fixtures/default_content/user/94503467-be7f-406c-9795-fc25baa22203.yml
core/tests/fixtures/default_content/user/94503467-be7f-406c-9795-fc25baa22203.yml
AccessPermissionTest::setUp in core/modules/user/tests/src/Kernel/Views/AccessPermissionTest.php
AccessPolicyProcessor::processAccessPolicies in core/lib/Drupal/Core/Session/AccessPolicyProcessor.php
Processes the access policies for an account within a given scope.

... See full list

File

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

Namespace

Drupal\user\Plugin\migrate\source\d7
View source
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

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.
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
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 2
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 Overrides SqlBase::__construct 5
FieldableEntity::$fieldInfo protected property Cached field and field instance definitions.
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.
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
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
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
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
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. 81
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
SqlBase::__toString public function Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
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.