UserStorage.php

Same filename in other branches
  1. 9 core/modules/user/src/UserStorage.php
  2. 10 core/modules/user/src/UserStorage.php
  3. 11.x core/modules/user/src/UserStorage.php

Namespace

Drupal\user

File

core/modules/user/src/UserStorage.php

View source
<?php

namespace Drupal\user;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\Sql\SqlContentEntityStorage;
use Drupal\Core\Session\AccountInterface;

/**
 * Controller class for users.
 *
 * This extends the Drupal\Core\Entity\Sql\SqlContentEntityStorage class,
 * adding required special handling for user objects.
 */
class UserStorage extends SqlContentEntityStorage implements UserStorageInterface {
    
    /**
     * {@inheritdoc}
     */
    protected function doSaveFieldItems(ContentEntityInterface $entity, array $names = []) {
        // The anonymous user account is saved with the fixed user ID of 0.
        // Therefore we need to check for NULL explicitly.
        if ($entity->id() === NULL) {
            $entity->uid->value = $this->database
                ->nextId($this->database
                ->query('SELECT MAX(uid) FROM {' . $this->getBaseTable() . '}')
                ->fetchField());
            $entity->enforceIsNew();
        }
        return parent::doSaveFieldItems($entity, $names);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function isColumnSerial($table_name, $schema_name) {
        // User storage does not use a serial column for the user id.
        return $table_name == $this->revisionTable && $schema_name == $this->revisionKey;
    }
    
    /**
     * {@inheritdoc}
     */
    public function updateLastLoginTimestamp(UserInterface $account) {
        $this->database
            ->update($this->getDataTable())
            ->fields([
            'login' => $account->getLastLoginTime(),
        ])
            ->condition('uid', $account->id())
            ->execute();
        // Ensure that the entity cache is cleared.
        $this->resetCache([
            $account->id(),
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function updateLastAccessTimestamp(AccountInterface $account, $timestamp) {
        $this->database
            ->update($this->getDataTable())
            ->fields([
            'access' => $timestamp,
        ])
            ->condition('uid', $account->id())
            ->execute();
        // Ensure that the entity cache is cleared.
        $this->resetCache([
            $account->id(),
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function deleteRoleReferences(array $rids) {
        // Remove the role from all users.
        $this->database
            ->delete('user__roles')
            ->condition('roles_target_id', $rids)
            ->execute();
        $this->resetCache();
    }

}

Classes

Title Deprecated Summary
UserStorage Controller class for users.

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