User.php

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

Namespace

Drupal\user\Plugin\migrate\source\d7

File

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

View source
<?php

namespace Drupal\user\Plugin\migrate\source\d7;

use Drupal\migrate\Row;
use Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity;

/**
 * Drupal 7 user source from database.
 *
 * For available configuration keys, refer to the parent classes.
 *
 * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
 * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
 *
 * @MigrateSource(
 *   id = "d7_user",
 *   source_module = "user"
 * )
 */
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',
            ],
        ];
    }

}

Classes

Title Deprecated Summary
User Drupal 7 user source from database.

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