Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/user/src/UserInterface.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\user\UserInterface.
6	*/
7
8	namespace Drupal\user;
9
10	use Drupal\Core\Entity\EntityChangedInterface;
11	use Drupal\Core\Entity\ContentEntityInterface;
12	use Drupal\Core\Session\AccountInterface;
13
14	/**
15	* Provides an interface defining a user entity.
16	*
17	* @ingroup user_api
18	*/
19	interface UserInterface extends ContentEntityInterface, EntityChangedInterface, AccountInterface {
20
21	/**
22	* Whether a user has a certain role.
23	*
24	* @param string $rid
25	* The role ID to check.
26	*
27	* @return bool
28	* Returns TRUE if the user has the role, otherwise FALSE.
29	*/
30	public function hasRole($rid);
31
32	/**
33	* Add a role to a user.
34	*
35	* @param string $rid
36	* The role ID to add.
37	*/
38	public function addRole($rid);
39
40	/**
41	* Remove a role from a user.
42	*
43	* @param string $rid
44	* The role ID to remove.
45	*/
46	public function removeRole($rid);
47
48	/**
49	* Sets the username of this account.
50	*
51	* @param string $username
52	* The new user name.
53	*
54	* @return \Drupal\user\UserInterface
55	* The called user entity.
56	*/
57	public function setUsername($username);
58
59	/**
60	* Returns the hashed password.
61	*
62	* @return string
63	* The hashed password.
64	*/
65	public function getPassword();
66
67	/**
68	* Sets the user password.
69	*
70	* @param string $password
71	* The new unhashed password.
72	*
73	* @return \Drupal\user\UserInterface
74	* The called user entity.
75	*/
76	public function setPassword($password);
77
78	/**
79	* Sets the email address of the user.
80	*
81	* @param string $mail
82	* The new email address of the user.
83	*
84	* @return \Drupal\user\UserInterface
85	* The called user entity.
86	*/
87	public function setEmail($mail);
88
89	/**
90	* Returns the creation time of the user as a UNIX timestamp.
91	*
92	* @return int
93	* Timestamp of the creation date.
94	*/
95	public function getCreatedTime();
96
97	/**
98	* Sets the UNIX timestamp when the user last accessed the site..
99	*
100	* @param int $timestamp
101	* Timestamp of the last access.
102	*
103	* @return \Drupal\user\UserInterface
104	* The called user entity.
105	*/
106	public function setLastAccessTime($timestamp);
107
108	/**
109	* Returns the UNIX timestamp when the user last logged in.
110	*
111	* @return int
112	* Timestamp of the last login time.
113	*/
114	public function getLastLoginTime();
115
116	/**
117	* Sets the UNIX timestamp when the user last logged in.
118	*
119	* @param int $timestamp
120	* Timestamp of the last login time.
121	*
122	* @return \Drupal\user\UserInterface
123	* The called user entity.
124	*/
125	public function setLastLoginTime($timestamp);
126
127	/**
128	* Returns TRUE if the user is active.
129	*
130	* @return bool
131	* TRUE if the user is active, false otherwise.
132	*/
133	public function isActive();
134
135	/**
136	* Returns TRUE if the user is blocked.
137	*
138	* @return bool
139	* TRUE if the user is blocked, false otherwise.
140	*/
141	public function isBlocked();
142
143	/**
144	* Activates the user.
145	*
146	* @return \Drupal\user\UserInterface
147	* The called user entity.
148	*/
149	public function activate();
150
151	/**
152	* Blocks the user.
153	*
154	* @return \Drupal\user\UserInterface
155	* The called user entity.
156	*/
157	public function block();
158
159	/**
160	* Returns the email that was used when the user was registered.
161	*
162	* @return string
163	* Initial email address of the user.
164	*/
165	public function getInitialEmail();
166
167	/**
168	* Sets the existing plain text password.
169	*
170	* Required for validation when changing the password, name or email fields.
171	*
172	* @param string $password
173	* The existing plain text password of the user.
174	*
175	* @return $this
176	*/
177	public function setExistingPassword($password);
178
179	/**
180	* Checks the existing password if set.
181	*
182	* @param \Drupal\user\UserInterface $account_unchanged
183	* The unchanged user entity to compare against.
184	*
185	* @return bool
186	* TRUE if the correct existing password was provided.
187	*
188	* @see UserInterface::setExistingPassword().
189	*/
190	public function checkExistingPassword(UserInterface $account_unchanged);
191
192	}