User
class User
User authentication and authorization.
Constants
| deprecated MANUAL |
|
| deprecated INACTIVITY |
|
| LOGOUT_MANUAL |
Log-out reason |
| LOGOUT_INACTIVITY |
Log-out reason |
Properties
| $guestRole | default role for unauthenticated user |
||
| $authenticatedRole | default role for authenticated user without own identity |
||
| callable[] | $onLoggedIn | ||
| callable[] | $onLoggedOut |
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.
No description
Returns authentication handler.
Returns authentication handler.
Enables log out after inactivity (like '20 minutes').
Why was user logged out? Returns LOGOUT_MANUAL or LOGOUT_INACTIVITY.
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.
Returns current authorization handler.
Details
at line 67
__construct(UserStorage $storage, Authenticator|null $authenticator = null, Authorizator|null $authorizator = null)
No description
at line 79
final UserStorage
getStorage()
No description
at line 93
void
login(IIdentity $user, string|null $password = null)
Conducts the authentication process. Parameters are optional.
at line 117
final void
logout(bool $clearIdentity = false)
Logs out the user from the current session.
at line 134
final bool
isLoggedIn()
Is this user authenticated?
at line 147
final IIdentity|null
getIdentity()
Returns current user identity, if any.
at line 175
string|int|null
getId()
Returns current user ID, if any.
at line 182
final void
refreshStorage()
No description
at line 191
User
setAuthenticator(Authenticator $handler)
Sets authentication handler.
at line 201
final Authenticator
getAuthenticator()
Returns authentication handler.
at line 214
final Authenticator|null
getAuthenticatorIfExists()
Returns authentication handler.
at line 221
final bool
hasAuthenticator()
deprecated
deprecated
No description
at line 230
setExpiration(string|null $expire, bool $clearIdentity = false)
Enables log out after inactivity (like '20 minutes').
at line 240
final int|null
getLogoutReason()
Why was user logged out? Returns LOGOUT_MANUAL or LOGOUT_INACTIVITY.
at line 252
array
getRoles()
Returns a list of effective roles that a user has been granted.
at line 266
final bool
isInRole(string $role)
Is a user in the specified effective role?
at line 282
bool
isAllowed($resource = Authorizator::ALL, $privilege = Authorizator::ALL)
Has a user effective access to the Resource? If $resource is null, then the query applies to all resources.
at line 297
User
setAuthorizator(Authorizator $handler)
Sets authorization handler.
at line 307
final Authorizator
getAuthorizator()
Returns current authorization handler.
at line 320
final Authorizator|null
getAuthorizatorIfExists()
Returns current authorization handler.
at line 327
final bool
hasAuthorizator()
deprecated
deprecated
No description
Traits
Strict class for better experience.