class UserSession in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/lib/Drupal/Core/Session/UserSession.php \Drupal\Core\Session\UserSession
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
Expanded class hierarchy of UserSession
9 files declare their use of UserSession
- AccountSwitcherTest.php in core/
modules/ system/ src/ Tests/ Session/ AccountSwitcherTest.php - Contains \Drupal\system\Tests\Session\AccountSwitcherTest.
- BrowserTestBase.php in core/
modules/ simpletest/ src/ BrowserTestBase.php - Contains \Drupal\simpletest\BrowserTestBase.
- Cookie.php in core/
modules/ user/ src/ Authentication/ Provider/ Cookie.php - Contains \Drupal\user\Authentication\Provider\Cookie.
- FormCacheTest.php in core/
modules/ system/ src/ Tests/ Form/ FormCacheTest.php - Contains \Drupal\system\Tests\Form\FormCacheTest.
- FunctionsTest.php in core/
modules/ system/ src/ Tests/ Theme/ FunctionsTest.php - Contains \Drupal\system\Tests\Theme\FunctionsTest.
File
- core/
lib/ Drupal/ Core/ Session/ UserSession.php, line 15 - Contains \Drupal\Core\Session\UserSession.
Namespace
Drupal\Core\SessionView 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 = array(
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 = array()) {
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, array(
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}
*/
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}
*/
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() {
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::entityManager()
->getStorage('user_role');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccountInterface:: |
constant | Role ID for anonymous users. | ||
AccountInterface:: |
constant | Role ID for authenticated users. | ||
UserSession:: |
protected | property | The Unix timestamp when the user last accessed the site. | |
UserSession:: |
protected | property | The email address of this account. | |
UserSession:: |
public | property | The name of this account. | |
UserSession:: |
protected | property | The preferred administrative language code of the account. | |
UserSession:: |
protected | property | The preferred language code of the account. | |
UserSession:: |
protected | property | List of the roles this user has. | |
UserSession:: |
protected | property | The timezone of this account. | |
UserSession:: |
protected | property | User ID. | |
UserSession:: |
public | function |
Returns the unaltered login name of this account. Overrides AccountInterface:: |
|
UserSession:: |
public | function |
Returns the display name of this account. Overrides AccountInterface:: |
|
UserSession:: |
public | function |
Returns the email address of this account. Overrides AccountInterface:: |
|
UserSession:: |
public | function |
The timestamp when the account last accessed the site. Overrides AccountInterface:: |
|
UserSession:: |
function |
Returns the preferred administrative language code of the account. Overrides AccountInterface:: |
||
UserSession:: |
function |
Returns the preferred language code of the account. Overrides AccountInterface:: |
||
UserSession:: |
public | function |
Returns a list of roles. Overrides AccountInterface:: |
|
UserSession:: |
protected | function | Returns the role storage object. | |
UserSession:: |
public | function |
Returns the timezone of this account. Overrides AccountInterface:: |
|
UserSession:: |
public | function |
Returns the unaltered login name of this account. Overrides AccountInterface:: |
|
UserSession:: |
public | function |
Checks whether a user has a certain permission. Overrides AccountInterface:: |
|
UserSession:: |
public | function |
Returns the user ID or 0 for anonymous. Overrides AccountInterface:: |
|
UserSession:: |
public | function |
Returns TRUE if the account is anonymous. Overrides AccountInterface:: |
|
UserSession:: |
public | function |
Returns TRUE if the account is authenticated. Overrides AccountInterface:: |
|
UserSession:: |
public | function | Constructs a new user session. | 1 |