Class Horde_Auth_Composite

The Horde_Auth_Composite class provides a way to combine two separate drivers for admin vs. authentication purposes.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, http://www.horde.org/licenses/lgpl21

Horde_Auth_Base

Horde_Auth_Composite

Package: Auth
Category: Horde
License: LGPL-2.1
Author: Chuck Hagenbuch chuck@horde.org
Located at Horde/Auth/Composite.php

Methods summary
`public`	# `__construct( array $params = array() )` Constructor. Constructor. Parameters `$params` Required parameters: <pre><span class="php-quote">'admin_driver'</span> - (Horde_Auth_Base) The admin driver. <span class="php-quote">'auth_driver'</span> - (Horde_Auth_Base) The auth driver.</pre> Throws InvalidArgumentException Overrides `Horde_Auth_Base::__construct()`
`public boolean`	# `hasCapability( string $capability )` Query the current Auth object to find out if it supports the given capability. Query the current Auth object to find out if it supports the given capability. Parameters `$capability` The capability to test for. Returns `boolean` Whether or not the capability is supported. Overrides `Horde_Auth_Base::hasCapability()`
`public boolean`	# `transparent( )` Automatic authentication: Find out if the client matches an allowed IP block. Automatic authentication: Find out if the client matches an allowed IP block. Returns `boolean` Whether or not the client is allowed. Throws `Horde_Auth_Exception` Overrides `Horde_Auth_Base::transparent()`
`public`	# `addUser( string $userId, array $credentials )` Add a set of authentication credentials. Add a set of authentication credentials. Parameters `$userId` The userId to add. `$credentials` The credentials to use. Throws `Horde_Auth_Exception` Overrides `Horde_Auth_Base::addUser()`
`public`	# `updateUser( string $oldID, string $newID, array $credentials )` Update a set of authentication credentials. Update a set of authentication credentials. Parameters `$oldID` The old userId. `$newID` The new userId. `$credentials` The new credentials Throws `Horde_Auth_Exception` Overrides `Horde_Auth_Base::updateUser()`
`public string`	# `resetPassword( string $userId )` Reset a user's password. Used for example when the user does not remember the existing password. Reset a user's password. Used for example when the user does not remember the existing password. Parameters `$userId` The user id for which to reset the password. Returns `string` The new password on success. Throws `Horde_Auth_Exception` Overrides `Horde_Auth_Base::resetPassword()`
`public`	# `removeUser( string $userId )` Delete a set of authentication credentials. Delete a set of authentication credentials. Parameters `$userId` The userId to delete. Throws `Horde_Auth_Exception` Overrides `Horde_Auth_Base::removeUser()`
`public array`	# `listUsers( mixed $sort = false )` List all users in the system. List all users in the system. Returns `array` The array of userIds. Throws `Horde_Auth_Exception` Overrides `Horde_Auth_Base::listUsers()`
`public boolean`	# `exists( string $userId )` Checks if a userId exists in the system. Checks if a userId exists in the system. Parameters `$userId` User ID to check Returns `boolean` Whether or not the userId already exists. Overrides `Horde_Auth_Base::exists()`

Methods inherited from Horde_Auth_Base
`authenticate(), getCredential(), getError(), getParam(), isLocked(), lockUser(), setCredential(), setError(), unlockUser(), validateAuth()`

Packages

Classes

Class Horde_Auth_Composite

Parameters

Throws

Overrides

Parameters

Returns

Overrides

Returns

Throws

Overrides

Parameters

Throws

Overrides

Parameters

Throws

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Throws

Overrides

Returns

Throws

Overrides

Parameters

Returns

Overrides