Method | Description | |
---|---|---|
__construct ( array $params = [] ) | Constructor. | |
addUser ( string $userId, array $credentials ) | Add a set of authentication credentials. | |
exists ( string $userId ) : boolean | Checks if a userId exists in the system. | |
hasCapability ( string $capability ) : boolean | Query the current Auth object to find out if it supports the given capability. | |
listUsers ( boolean $sort = false ) : array | Lists all users in the system. | |
removeUser ( string $userId ) | Delete a set of authentication credentials. | |
resetPassword ( string $userId ) : string | Reset a user's password. Used for example when the user does not remember the existing password. | |
transparent ( ) : boolean | Automatic authentication. | |
updateUser ( string $oldID, string $newID, array $credentials ) | Update a set of authentication credentials. |
Method | Description | |
---|---|---|
_authenticate ( string $userId, array $credentials ) | Find out if a set of login credentials are valid. |
public __construct ( array $params = [] ) | ||
$params | array | Required parameters:
'admin_driver' - (Horde_Auth_Base) The admin driver. 'auth_driver' - (Horde_Auth_Base) The auth driver. |
protected _authenticate ( string $userId, array $credentials ) | ||
$userId | string | The userId to check. |
$credentials | array | The credentials to use. |
public hasCapability ( string $capability ) : boolean | ||
$capability | string | The capability to test for. |
return | boolean | Whether or not the capability is supported. |
public removeUser ( string $userId ) | ||
$userId | string | The userId to delete. |
public resetPassword ( string $userId ) : string | ||
$userId | string | The user id for which to reset the password. |
return | string | The new password on success. |
public transparent ( ) : boolean | ||
return | boolean | Whether or not the client is allowed. |