Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Session/UserSession.php \Drupal\Core\Session\UserSession
  2. 9 core/lib/Drupal/Core/Session/UserSession.php \Drupal\Core\Session\UserSession

Hierarchy

  • class \Drupal\Core\Session\UserSession implements \Drupal\Core\Session\AccountInterface

Expanded class hierarchy of UserSession

11 files declare their use of UserSession
AccountProxyTest.php in core/tests/Drupal/Tests/Core/Session/AccountProxyTest.php
AccountSwitcherTest.php in core/tests/Drupal/KernelTests/Core/Session/AccountSwitcherTest.php
ContentModerationAccessTest.php in core/modules/content_moderation/tests/src/Kernel/ContentModerationAccessTest.php
Cookie.php in core/modules/user/src/Authentication/Provider/Cookie.php
FormCacheTest.php in core/tests/Drupal/KernelTests/Core/Form/FormCacheTest.php

... See full list

File

core/lib/Drupal/Core/Session/UserSession.php, line 11

Namespace

Drupal\Core\Session
View source
class UserSession implements AccountInterface {

  /**
   * User ID.
   *
   * @var int
   */
  protected $uid = 0;

  /**
   * List of the roles this user has.
   *
   * Defaults to the anonymous role.
   *
   * @var array
   */
  protected $roles = [
    AccountInterface::ANONYMOUS_ROLE,
  ];

  /**
   * The Unix timestamp when the user last accessed the site.
   *
   * @var string
   */
  protected $access;

  /**
   * The name of this account.
   *
   * @var string
   */
  public $name = '';

  /**
   * The preferred language code of the account.
   *
   * @var string
   */
  protected $preferred_langcode;

  /**
   * The preferred administrative language code of the account.
   *
   * @var string
   */
  protected $preferred_admin_langcode;

  /**
   * The email address of this account.
   *
   * @var string
   */
  protected $mail;

  /**
   * The timezone of this account.
   *
   * @var string
   */
  protected $timezone;

  /**
   * Constructs a new user session.
   *
   * @param array $values
   *   Array of initial values for the user session.
   */
  public function __construct(array $values = []) {
    foreach ($values as $key => $value) {
      $this->{$key} = $value;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function id() {
    return $this->uid;
  }

  /**
   * {@inheritdoc}
   */
  public function getRoles($exclude_locked_roles = FALSE) {
    $roles = $this->roles;
    if ($exclude_locked_roles) {
      $roles = array_values(array_diff($roles, [
        AccountInterface::ANONYMOUS_ROLE,
        AccountInterface::AUTHENTICATED_ROLE,
      ]));
    }
    return $roles;
  }

  /**
   * Whether a user has a certain role.
   *
   * @param string $rid
   *   The role ID to check.
   *
   * @return bool
   *   Returns TRUE if the user has the role, otherwise FALSE.
   *
   * @todo in Drupal 11, add method to Drupal\Core\Session\AccountInterface.
   * @see https://www.drupal.org/node/3228209
   */
  public function hasRole(string $rid) : bool {
    return in_array($rid, $this
      ->getRoles(), TRUE);
  }

  /**
   * {@inheritdoc}
   */
  public function hasPermission($permission) {
    if (!is_string($permission)) {
      @trigger_error('Calling ' . __METHOD__ . '() with a $permission parameter of type other than string is deprecated in drupal:10.3.0 and will cause an error in drupal:11.0.0. See https://www.drupal.org/node/3411485', E_USER_DEPRECATED);
      return FALSE;
    }
    return \Drupal::service('permission_checker')
      ->hasPermission($permission, $this);
  }

  /**
   * {@inheritdoc}
   */
  public function isAuthenticated() {
    return $this->uid > 0;
  }

  /**
   * {@inheritdoc}
   */
  public function isAnonymous() {
    return $this->uid == 0;
  }

  /**
   * {@inheritdoc}
   */
  public function getPreferredLangcode($fallback_to_default = TRUE) {
    $language_list = \Drupal::languageManager()
      ->getLanguages();
    if (!empty($this->preferred_langcode) && isset($language_list[$this->preferred_langcode])) {
      return $language_list[$this->preferred_langcode]
        ->getId();
    }
    else {
      return $fallback_to_default ? \Drupal::languageManager()
        ->getDefaultLanguage()
        ->getId() : '';
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getPreferredAdminLangcode($fallback_to_default = TRUE) {
    $language_list = \Drupal::languageManager()
      ->getLanguages();
    if (!empty($this->preferred_admin_langcode) && isset($language_list[$this->preferred_admin_langcode])) {
      return $language_list[$this->preferred_admin_langcode]
        ->getId();
    }
    else {
      return $fallback_to_default ? \Drupal::languageManager()
        ->getDefaultLanguage()
        ->getId() : '';
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getAccountName() {
    return $this->name;
  }

  /**
   * {@inheritdoc}
   */
  public function getDisplayName() {
    $name = $this->name ?: \Drupal::config('user.settings')
      ->get('anonymous');
    \Drupal::moduleHandler()
      ->alter('user_format_name', $name, $this);
    return $name;
  }

  /**
   * {@inheritdoc}
   */
  public function getEmail() {
    return $this->mail;
  }

  /**
   * {@inheritdoc}
   */
  public function getTimeZone() {
    return $this->timezone;
  }

  /**
   * {@inheritdoc}
   */
  public function getLastAccessedTime() {
    return $this->access;
  }

  /**
   * Returns the role storage object.
   *
   * @return \Drupal\user\RoleStorageInterface
   *   The role storage object.
   */
  protected function getRoleStorage() {
    return \Drupal::entityTypeManager()
      ->getStorage('user_role');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
UserSession::$access protected property The Unix timestamp when the user last accessed the site.
UserSession::$mail protected property The email address of this account.
UserSession::$name public property The name of this account.
UserSession::$preferred_admin_langcode protected property The preferred administrative language code of the account.
UserSession::$preferred_langcode protected property The preferred language code of the account.
UserSession::$roles protected property List of the roles this user has.
UserSession::$timezone protected property The timezone of this account.
UserSession::$uid protected property User ID.
UserSession::getAccountName public function
UserSession::getDisplayName public function
UserSession::getEmail public function
UserSession::getLastAccessedTime public function
UserSession::getPreferredAdminLangcode public function
UserSession::getPreferredLangcode public function
UserSession::getRoles public function
UserSession::getRoleStorage protected function Returns the role storage object.
UserSession::getTimeZone public function
UserSession::hasPermission public function
UserSession::hasRole public function Whether a user has a certain role.
UserSession::id public function
UserSession::isAnonymous public function
UserSession::isAuthenticated public function
UserSession::__construct public function Constructs a new user session. 1