Newer
Older
<?php
/**
* @file
Alex Pott
committed
* Contains \Drupal\user\UserInterface.
*/
namespace Drupal\user;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Session\AccountInterface;
/**
* Provides an interface defining a user entity.
Angie Byron
committed
*
* @ingroup user_api
*/
interface UserInterface extends ContentEntityInterface, AccountInterface {
/**
* 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.
*/
public function hasRole($rid);
/**
* Add a role to a user.
*
* @param string $rid
* The role ID to add.
*/
public function addRole($rid);
/**
* Remove a role from a user.
*
* @param string $rid
* The role ID to remove.
*/
public function removeRole($rid);
/**
* Sets the username of this account.
*
* @param string $username
* The new user name.
*
* @return \Drupal\user\UserInterface
* The called user entity.
*/
public function setUsername($username);
/**
* Returns the hashed password.
*
* @return string
* The hashed password.
*/
public function getPassword();
/**
* Sets the user password.
*
* @param string $password
* The new unhashed password.
*
* @return \Drupal\user\UserInterface
* The called user entity.
*/
public function setPassword($password);
/**
* Sets the email address of the user.
*
* @param string $mail
* The new email address of the user.
*
* @return \Drupal\user\UserInterface
* The called user entity.
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
*/
public function setEmail($mail);
/**
* Returns the user signature.
*
* @todo: Convert this to a configurable field.
*
* @return string
* The signature text.
*/
public function getSignature();
/**
* Returns the signature format.
*
* @return string
* Name of the filter format.
*/
public function getSignatureFormat();
/**
* Returns the creation time of the user as a UNIX timestamp.
*
* @return int
* Timestamp of the creation date.
*/
public function getCreatedTime();
/**
* Sets the UNIX timestamp when the user last accessed the site..
*
* @param int $timestamp
* Timestamp of the last access.
*
* @return \Drupal\user\UserInterface
* The called user entity.
*/
public function setLastAccessTime($timestamp);
/**
* Returns the UNIX timestamp when the user last logged in.
*
* @return int
* Timestamp of the last login time.
*/
public function getLastLoginTime();
/**
* Sets the UNIX timestamp when the user last logged in.
*
* @param int $timestamp
* Timestamp of the last login time.
*
* @return \Drupal\user\UserInterface
* The called user entity.
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
*/
public function setLastLoginTime($timestamp);
/**
* Returns TRUE if the user is active.
*
* @return bool
* TRUE if the user is active, false otherwise.
*/
public function isActive();
/**
* Returns TRUE if the user is blocked.
*
* @return bool
* TRUE if the user is blocked, false otherwise.
*/
public function isBlocked();
/**
* Activates the user.
*
* @return \Drupal\user\UserInterface
* The called user entity.
*/
public function activate();
/**
* Blocks the user.
*
* @return \Drupal\user\UserInterface
* The called user entity.
*/
public function block();
/**
* Returns the email that was used when the user was registered.
*
* @return string
* Initial email address of the user.
*/
public function getInitialEmail();