PHP Class Horde_Auth_Composite, horde

Author: Chuck Hagenbuch ([email protected])
Inheritance: extends Horde_Auth_Base
Afficher le fichier Open project: horde/horde

Méthodes publiques

Méthode 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.

Méthodes protégées

Méthode Description
_authenticate ( string $userId, array $credentials ) Find out if a set of login credentials are valid.

Method Details

__construct() public méthode

Constructor.
public __construct ( array $params = [] )
$params array Required parameters: 
'admin_driver' - (Horde_Auth_Base) The admin driver.
'auth_driver' - (Horde_Auth_Base) The auth driver.

_authenticate() protected méthode

Find out if a set of login credentials are valid.
protected _authenticate ( string $userId, array $credentials )
$userId string The userId to check.
$credentials array The credentials to use.

addUser() public méthode

Add a set of authentication credentials.
public addUser ( string $userId, array $credentials )
$userId string The userId to add.
$credentials array The credentials to use.

exists() public méthode

Checks if a userId exists in the system.
public exists ( string $userId ) : boolean
$userId string User ID to check
Résultat boolean Whether or not the userId already exists.

hasCapability() public méthode

Query the current Auth object to find out if it supports the given capability.
public hasCapability ( string $capability ) : boolean
$capability string The capability to test for.
Résultat boolean Whether or not the capability is supported.

listUsers() public méthode

Lists all users in the system.
public listUsers ( boolean $sort = false ) : array
$sort boolean Sort the users?
Résultat array The array of userIds.

removeUser() public méthode

Delete a set of authentication credentials.
public removeUser ( string $userId )
$userId string The userId to delete.

resetPassword() public méthode

Reset a user's password. Used for example when the user does not remember the existing password.
public resetPassword ( string $userId ) : string
$userId string The user id for which to reset the password.
Résultat string The new password on success.

transparent() public méthode

Automatic authentication.
public transparent ( ) : boolean
Résultat boolean Whether or not the client is allowed.

updateUser() public méthode

Update a set of authentication credentials.
public updateUser ( string $oldID, string $newID, array $credentials )
$oldID string The old userId.
$newID string The new userId.
$credentials array The new credentials