class UserSession in Drupal 8

An implementation of the user account interface for the global user.

@todo: Change all properties to protected.

Hierarchy

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

11 files declare their use of UserSession

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

FunctionalTestSetupTrait.php in core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php

... See full list

File

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

Namespace

Drupal\Core\Session

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;
  }

  /**
   * {@inheritdoc}
   */
  public function hasPermission($permission) {

    // User #1 has all privileges.
    if ((int) $this
      ->id() === 1) {
      return TRUE;
    }
    return $this
      ->getRoleStorage()
      ->isPermissionInRoles($permission, $this
      ->getRoles());
  }

  /**
   * {@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 getUsername() {
    @trigger_error('\\Drupal\\Core\\Session\\AccountInterface::getUsername() is deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0. Use \\Drupal\\Core\\Session\\AccountInterface::getAccountName() or \\Drupal\\user\\UserInterface::getDisplayName() instead. See https://www.drupal.org/node/2572493', E_USER_DEPRECATED);
    return $this
      ->getAccountName();
  }

  /**
   * {@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

Name	Modifiers	Type	Description	Overrides
AccountInterface::ANONYMOUS_ROLE		constant	Role ID for anonymous users.
AccountInterface::AUTHENTICATED_ROLE		constant	Role ID for authenticated users.
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	Returns the unaltered login name of this account. Overrides AccountInterface::getAccountName
UserSession::getDisplayName	public	function	Returns the display name of this account. Overrides AccountInterface::getDisplayName
UserSession::getEmail	public	function	Returns the email address of this account. Overrides AccountInterface::getEmail
UserSession::getLastAccessedTime	public	function	The timestamp when the account last accessed the site. Overrides AccountInterface::getLastAccessedTime
UserSession::getPreferredAdminLangcode	public	function	Returns the preferred administrative language code of the account. Overrides AccountInterface::getPreferredAdminLangcode
UserSession::getPreferredLangcode	public	function	Returns the preferred language code of the account. Overrides AccountInterface::getPreferredLangcode
UserSession::getRoles	public	function	Returns a list of roles. Overrides AccountInterface::getRoles
UserSession::getRoleStorage	protected	function	Returns the role storage object.
UserSession::getTimeZone	public	function	Returns the timezone of this account. Overrides AccountInterface::getTimeZone
UserSession::getUsername	public	function	Returns the unaltered login name of this account. Overrides AccountInterface::getUsername
UserSession::hasPermission	public	function	Checks whether a user has a certain permission. Overrides AccountInterface::hasPermission
UserSession::id	public	function	Returns the user ID or 0 for anonymous. Overrides AccountInterface::id
UserSession::isAnonymous	public	function	Returns TRUE if the account is anonymous. Overrides AccountInterface::isAnonymous
UserSession::isAuthenticated	public	function	Returns TRUE if the account is authenticated. Overrides AccountInterface::isAuthenticated
UserSession::__construct	public	function	Constructs a new user session.	1