Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Session/AccountInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Session\AccountInterface.
6	*/
7
8	namespace Drupal\Core\Session;
9
10	/**
11	* Defines an account interface which represents the current user.
12	*
13	* Defines an object that has a user id, roles and can have session data. The
14	* interface is implemented both by the global session and the user entity.
15	*
16	* @ingroup user_api
17	*/
18	interface AccountInterface {
19
20	/**
21	* Role ID for anonymous users.
22	*/
23	const ANONYMOUS_ROLE = 'anonymous';
24
25	/**
26	* Role ID for authenticated users.
27	*/
28	const AUTHENTICATED_ROLE = 'authenticated';
29
30	/**
31	* Returns the user ID or 0 for anonymous.
32	*
33	* @return int
34	* The user ID.
35	*/
36	public function id();
37
38	/**
39	* Returns a list of roles.
40	*
41	* @param bool $exclude_locked_roles
42	* (optional) If TRUE, locked roles (anonymous/authenticated) are not returned.
43	*
44	* @return array
45	* List of role IDs.
46	*/
47	public function getRoles($exclude_locked_roles = FALSE);
48
49	/**
50	* Checks whether a user has a certain permission.
51	*
52	* @param string $permission
53	* The permission string to check.
54	*
55	* @return bool
56	* TRUE if the user has the permission, FALSE otherwise.
57	*/
58	public function hasPermission($permission);
59
60	/**
61	* Returns TRUE if the account is authenticated.
62	*
63	* @return bool
64	* TRUE if the account is authenticated.
65	*/
66	public function isAuthenticated();
67
68	/**
69	* Returns TRUE if the account is anonymous.
70	*
71	* @return bool
72	* TRUE if the account is anonymous.
73	*/
74	public function isAnonymous();
75
76	/**
77	* Returns the preferred language code of the account.
78	*
79	* @param bool $fallback_to_default
80	* (optional) Whether the return value will fall back to the site default
81	* language if the user has no language preference.
82	*
83	* @return string
84	* The language code that is preferred by the account. If the preferred
85	* language is not set or is a language not configured anymore on the site,
86	* the site default is returned or an empty string is returned (if
87	* $fallback_to_default is FALSE).
88	*/
89	public function getPreferredLangcode($fallback_to_default = TRUE);
90
91	/**
92	* Returns the preferred administrative language code of the account.
93	*
94	* Defines which language is used on administrative pages.
95	*
96	* @param bool $fallback_to_default
97	* (optional) Whether the return value will fall back to the site default
98	* language if the user has no administration language preference.
99	*
100	* @return string
101	* The language code that is preferred by the account for administration
102	* pages. If the preferred language is not set or is a language not
103	* configured anymore on the site, the site default is returned or an empty
104	* string is returned (if $fallback_to_default is FALSE).
105	*/
106	public function getPreferredAdminLangcode($fallback_to_default = TRUE);
107
108	/**
109	* Returns the unaltered login name of this account.
110	*
111	* @return string
112	* An unsanitized plain-text string with the name of this account that is
113	* used to log in. Only display this name to admins and to the user who owns
114	* this account, and only in the context of the name used to login. For
115	* any other display purposes, use
116	* \Drupal\Core\Session\AccountInterface::getDisplayName() instead.
117	*
118	* @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0.
119	* Use \Drupal\Core\Session\AccountInterface::getAccountName() or
120	* \Drupal\user\UserInterface::getDisplayName() instead.
121	*/
122	public function getUsername();
123
124	/**
125	* Returns the unaltered login name of this account.
126	*
127	* @return string
128	* An unsanitized plain-text string with the name of this account that is
129	* used to log in. Only display this name to admins and to the user who owns
130	* this account, and only in the context of the name used to login. For
131	* any other display purposes, use
132	* \Drupal\Core\Session\AccountInterface::getDisplayName() instead.
133	*/
134	public function getAccountName();
135
136	/**
137	* Returns the display name of this account.
138	*
139	* By default, the passed-in object's 'name' property is used if it exists, or
140	* else, the site-defined value for the 'anonymous' variable. However, a
141	* module may override this by implementing
142	* hook_user_format_name_alter(&$name, $account).
143	*
144	* @see hook_user_format_name_alter()
145	*
146	* @return string\|\Drupal\Component\Render\MarkupInterface
147	* Either a string that will be auto-escaped on output or a
148	* MarkupInterface object that is already HTML escaped. Either is safe
149	* to be printed within HTML fragments.
150	*/
151	public function getDisplayName();
152
153	/**
154	* Returns the email address of this account.
155	*
156	* @return string
157	* The email address.
158	*/
159	public function getEmail();
160
161	/**
162	* Returns the timezone of this account.
163	*
164	* @return string
165	* Name of the timezone.
166	*/
167	public function getTimeZone();
168
169	/**
170	* The timestamp when the account last accessed the site.
171	*
172	* A value of 0 means the user has never accessed the site.
173	*
174	* @return int
175	* Timestamp of the last access.
176	*/
177	public function getLastAccessedTime();
178
179	}