User
class User
User authentication and authorization.
Constants
| deprecated MANUAL |
|
| deprecated INACTIVITY |
|
| deprecated BROWSER_CLOSED |
|
Properties
| string | $guestRole | ||
| string | $authenticatedRole | ||
| callable[] | $onLoggedIn | ||
| callable[] | $onLoggedOut | ||
| IAuthenticator | $authenticator | ||
| IAuthorizator | $authorizator | ||
| bool read-only | $loggedIn | ||
| IIdentity read-only | $identity | ||
| mixed read-only | $id | ||
| array read-only | $roles | ||
| int read-only | $logoutReason |
Methods
No description
No description
Conducts the authentication process. Parameters are optional.
Logs out the user from the current session.
Is this user authenticated?
Returns current user identity, if any.
Returns current user ID, if any.
Returns authentication handler.
Enables log out after inactivity.
Why was user logged out?
Returns a list of effective roles that a user has been granted.
Is a user in the specified effective role?
Has a user effective access to the Resource? If $resource is null, then the query applies to all resources.
Returns current authorization handler.
Details
at line 58
__construct(IUserStorage $storage, IAuthenticator $authenticator = null, IAuthorizator $authorizator = null)
No description
at line 69
IUserStorage
getStorage()
No description
at line 85
void
login($user, $password = null)
Conducts the authentication process. Parameters are optional.
at line 102
void
logout($clearIdentity = false)
Logs out the user from the current session.
at line 118
bool
isLoggedIn()
Is this user authenticated?
at line 128
IIdentity|null
getIdentity()
Returns current user identity, if any.
at line 138
mixed
getId()
Returns current user ID, if any.
at line 149
User
setAuthenticator(IAuthenticator $handler)
Sets authentication handler.
at line 160
IAuthenticator|null
getAuthenticator($throw = true)
Returns authentication handler.
at line 176
User
setExpiration($time, $flags = null, $clearIdentity = false)
Enables log out after inactivity.
at line 188
int|null
getLogoutReason()
Why was user logged out?
at line 201
array
getRoles()
Returns a list of effective roles that a user has been granted.
at line 217
bool
isInRole($role)
Is a user in the specified effective role?
at line 230
bool
isAllowed($resource = IAuthorizator::ALL, $privilege = IAuthorizator::ALL)
Has a user effective access to the Resource? If $resource is null, then the query applies to all resources.
at line 246
User
setAuthorizator(IAuthorizator $handler)
Sets authorization handler.
at line 257
IAuthorizator|null
getAuthorizator($throw = true)
Returns current authorization handler.