UserSession.php

<?php

namespace Drupal\Core\Session;


/**
 * An implementation of the user account interface for the global user.
 */
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
   */
  protected $name = '';
  
  /**
   * The preferred language code of the account.
   *
   * @var string
   */
  // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
  protected $preferred_langcode;
  
  /**
   * The preferred administrative language code of the account.
   *
   * @var string
   */
  // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
  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(string $permission) {
    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');
  }
  
  /**
   * Implements magic __get() method.
   */
  public function __get($name) : mixed {
    if ($name === 'name') {
      @trigger_error("Getting the name property is deprecated in drupal:11.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Session\\UserSession::getAccountName() instead. See https://www.drupal.org/node/3513856", E_USER_DEPRECATED);
      return $this->getAccountName();
    }
    $class = get_class($this);
    $properties = get_class_vars($class);
    if (\array_key_exists($name, $properties)) {
      throw new \LogicException("Cannot access protected property {$name} in " . $class);
    }
    return $this->{$name} ?? NULL;
  }
  
  /**
   * Implements magic __isset() method.
   */
  public function __isset($name) : bool {
    if ($name === 'name') {
      @trigger_error("Checking for the name property is deprecated in drupal:11.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Session\\UserSession::getAccountName() instead. See https://www.drupal.org/node/3513856", E_USER_DEPRECATED);
      return isset($this->name);
    }
    $class = get_class($this);
    $properties = get_class_vars($class);
    if (\array_key_exists($name, $properties)) {
      throw new \LogicException("Cannot access protected property {$name} in " . $class);
    }
    return isset($this->{$name});
  }
  
  /**
   * Implements magic __set() method.
   */
  public function __set($name, $value) : void {
    if ($name === 'name') {
      @trigger_error("Setting the name property is deprecated in drupal:11.3.0 and is removed from drupal:12.0.0. Set the name via the constructor when creating the UserSession instance. See https://www.drupal.org/node/3513856", E_USER_DEPRECATED);
      $this->name = $value;
      return;
    }
    $class = get_class($this);
    $properties = get_class_vars($class);
    if (\array_key_exists($name, $properties)) {
      throw new \LogicException("Cannot set protected property {$name} in " . $class);
    }
    $this->{$name} = $value;
  }

}