Defines an account interface which represents the current user.
Defines an object that has a user id, roles and can have session data. The interface is implemented both by the global session and the user entity.
Expanded class hierarchy of AccountInterface
All classes that implement AccountInterface
interface AccountInterface {
/**
* Returns the user ID or 0 for anonymous.
*
* @return int
* The user ID.
*/
public function id();
/**
* Returns a list of roles.
*
* @return array
* List of role IDs.
*/
public function getRoles();
/**
* Returns the session ID.
*
* @return string|NULL
* The session ID or NULL if this user does not have an active session.
*/
public function getSessionId();
/**
* Returns the secure session ID.
*
* @return string|NULL
* The session ID or NULL if this user does not have an active secure session.
*/
public function getSecureSessionId();
/**
* Returns the session data.
*
* @return array
* Array with the session data that belongs to this object.
*/
public function getSessionData();
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccountInterface:: |
public | function | Returns the session ID. | 3 |
AccountInterface:: |
public | function | Returns the secure session ID. | 3 |
AccountInterface:: |
public | function | Returns the session data. | 3 |
AccountInterface:: |
public | function | Returns a list of roles. | 2 |
AccountInterface:: |
public | function | Returns the user ID or 0 for anonymous. | 1 |