1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Session
  7. \
  8. AccountProxyInterface

AccountProxyInterface

interface AccountProxyInterface implements AccountInterface (View source)

Defines an interface for a service which has the current account stored.

It is generally more useful to use \Drupal\Core\Session\AccountInterface unless one specifically needs the proxying features of this interface.

Methods

int
id()

Returns the user ID or 0 for anonymous.

from  AccountInterface
array
getRoles(bool $exclude_locked_roles = FALSE)

Returns a list of roles.

from  AccountInterface
bool
hasPermission(string $permission)

Checks whether a user has a certain permission.

from  AccountInterface
bool
isAuthenticated()

Returns TRUE if the account is authenticated.

from  AccountInterface
bool
isAnonymous()

Returns TRUE if the account is anonymous.

from  AccountInterface
string
getPreferredLangcode(bool $fallback_to_default = TRUE)

Returns the preferred language code of the account.

from  AccountInterface
string
getPreferredAdminLangcode(bool $fallback_to_default = TRUE)

Returns the preferred administrative language code of the account.

from  AccountInterface
string
getUsername() deprecated

Returns the unaltered login name of this account.

from  AccountInterface
string
getAccountName()

Returns the unaltered login name of this account.

from  AccountInterface
string|MarkupInterface
getDisplayName()

Returns the display name of this account.

from  AccountInterface
string|null
getEmail()

Returns the email address of this account.

from  AccountInterface
string
getTimeZone()

Returns the timezone of this account.

from  AccountInterface
int
getLastAccessedTime()

The timestamp when the account last accessed the site.

from  AccountInterface
setAccount(AccountInterface $account)

Sets the currently wrapped account.

AccountInterface
getAccount()

Gets the currently wrapped account.

setInitialAccountId(int $account_id)

Sets the id of the initial account.

Details

in AccountInterface at line 31
int id()

Returns the user ID or 0 for anonymous.

Return Value

int

The user ID.

in AccountInterface at line 42
array getRoles(bool $exclude_locked_roles = FALSE)

Returns a list of roles.

Parameters

bool $exclude_locked_roles

(optional) If TRUE, locked roles (anonymous/authenticated) are not returned.

Return Value

array

List of role IDs.

in AccountInterface at line 53
bool hasPermission(string $permission)

Checks whether a user has a certain permission.

Parameters

string $permission

The permission string to check.

Return Value

bool

TRUE if the user has the permission, FALSE otherwise.

in AccountInterface at line 61
bool isAuthenticated()

Returns TRUE if the account is authenticated.

Return Value

bool

TRUE if the account is authenticated.

in AccountInterface at line 69
bool isAnonymous()

Returns TRUE if the account is anonymous.

Return Value

bool

TRUE if the account is anonymous.

in AccountInterface at line 86
string getPreferredLangcode(bool $fallback_to_default = TRUE)

Returns the preferred language code of the account.

Parameters

bool $fallback_to_default

(optional) Whether the return value will fall back to the site default language if the user has no language preference.

Return Value

string

Returned language code depends upon following:

  • The user preferred language code is returned if set in the account.
  • If the user has no preferred language and $fallback_to_default is TRUE then the site default language code is returned.
  • If the user has no preferred language and $fallback_to_default is FALSE then empty string is returned.

in AccountInterface at line 103
string getPreferredAdminLangcode(bool $fallback_to_default = TRUE)

Returns the preferred administrative language code of the account.

Defines which language is used on administrative pages.

Parameters

bool $fallback_to_default

(optional) Whether the return value will fall back to the site default language if the user has no administration language preference.

Return Value

string

The language code that is preferred by the account for administration pages. If the preferred language is not set or is a language not configured anymore on the site, the site default is returned or an empty string is returned (if $fallback_to_default is FALSE).

in AccountInterface at line 121
string getUsername() deprecated

deprecated in drupal:8.0.0 and is removed from drupal:9.0.0. Use \Drupal\Core\Session\AccountInterface::getAccountName() or \Drupal\user\UserInterface::getDisplayName() instead.

Returns the unaltered login name of this account.

Return Value

string

An unsanitized plain-text string with the name of this account that is used to log in. Only display this name to admins and to the user who owns this account, and only in the context of the name used to log in. For any other display purposes, use \Drupal\Core\Session\AccountInterface::getDisplayName() instead.

See also

https://www.drupal.org/node/2572493

in AccountInterface at line 133
string getAccountName()

Returns the unaltered login name of this account.

Return Value

string

An unsanitized plain-text string with the name of this account that is used to log in. Only display this name to admins and to the user who owns this account, and only in the context of the name used to login. For any other display purposes, use \Drupal\Core\Session\AccountInterface::getDisplayName() instead.

in AccountInterface at line 150
string|MarkupInterface getDisplayName()

Returns the display name of this account.

By default, the passed-in object's 'name' property is used if it exists, or else, the site-defined value for the 'anonymous' variable. However, a module may override this by implementing hook_user_format_name_alter(&$name, $account).

Return Value

string|MarkupInterface

Either a string that will be auto-escaped on output or a MarkupInterface object that is already HTML escaped. Either is safe to be printed within HTML fragments.

See also

hook_user_format_name_alter()

in AccountInterface at line 159
string|null getEmail()

Returns the email address of this account.

Return Value

string|null

The email address, or NULL if the account is anonymous or the user does not have an email address.

in AccountInterface at line 167
string getTimeZone()

Returns the timezone of this account.

Return Value

string

Name of the timezone.

in AccountInterface at line 177
int getLastAccessedTime()

The timestamp when the account last accessed the site.

A value of 0 means the user has never accessed the site.

Return Value

int

Timestamp of the last access.

at line 30
setAccount(AccountInterface $account)

Sets the currently wrapped account.

Setting the current account is highly discouraged! Instead, make sure to inject the desired user object into the dependent code directly.

A preferable method of account impersonation is to use \Drupal\Core\Session\AccountSwitcherInterface::switchTo() and \Drupal\Core\Session\AccountSwitcherInterface::switchBack().

Parameters

AccountInterface $account

The current account.

at line 38
AccountInterface getAccount()

Gets the currently wrapped account.

Return Value

AccountInterface

The current account.

at line 49
setInitialAccountId(int $account_id)

Sets the id of the initial account.

Never use this method, its sole purpose is to work around weird effects during mid-request container rebuilds.

Parameters

int $account_id

The id of the initial account.