Detailed Description
Inheritance diagram for User:Public Member Functions | |
| getOID () | |
| setLogin ($login) | |
| getLogin () | |
| setPassword ($password) | |
| getPassword () | |
| verifyPassword ($password, $passwordHash) | |
| setConfig ($config) | |
| getConfig () | |
| hasRole ($roleName) | |
| getRoles () | |
Member Function Documentation
| getOID | ( | ) |
| setLogin | ( | $login | ) |
Set the login of the user.
- Parameters
-
$login The login of the user.
Implemented in AnonymousUser, and AbstractUser.
| getLogin | ( | ) |
Get the login of the user.
- Returns
- The login of the user.
Implemented in AbstractUser, and AnonymousUser.
| setPassword | ( | $password | ) |
Set the password of the user.
Implementations of User must hash the password before persisting it.
- Parameters
-
$password The plaintext password of the user.
Implemented in AbstractUser, and AnonymousUser.
| getPassword | ( | ) |
Get the password of the user.
The result is expected to be hashed, if the user was persisted already. If not persisted, the result may be the plaintext password.
- Returns
- The password of the user,
Implemented in AbstractUser, and AnonymousUser.
| verifyPassword | ( | $password, | |
| $passwordHash | |||
| ) |
Verify a password.
- Parameters
-
$password The plaintext password to verify $passwordHash The password hash to match
- Returns
- Boolean.
Implemented in AbstractUser, and AnonymousUser.
| setConfig | ( | $config | ) |
Set the configuration file of the user.
- Parameters
-
$config The configuration file of the user.
Implemented in AbstractUser, and AnonymousUser.
| getConfig | ( | ) |
Get the configuration file of the user.
- Returns
- The configuration file of the user.
Implemented in AbstractUser, and AnonymousUser.
| hasRole | ( | $roleName | ) |
Check for a certain role in the user roles.
- Parameters
-
$roleName The role name to check for. e.g. "administrators"
- Returns
- Boolean whether the user has the role
Implemented in AbstractUser, and AnonymousUser.
| getRoles | ( | ) |