The Auth_composite class provides a wrapper around application-provided Horde authentication which fits inside the Horde Auth:: API.

Required parameters:

   None.

$Horde: framework/Auth/Auth/composite.php,v 1.26.10.15 2009/07/27 12:19:56 jan Exp $

Copyright 2002-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://opensource.org/licenses/lgpl-license.php.

• author: Chuck Hagenbuch <chuck@horde.org>
• since: Horde 3.0

Located in /Auth/Auth/composite.php (line 22)

Auth
   |
   --Auth_composite

array $_drivers = array() (line 29)

Hash containing any instantiated drivers.

Inherited Variables

Inherited from Auth

Auth::$capabilities
Auth::$_authCredentials
Auth::$_params

Constructor Auth_composite (line 36)

Constructs a new Composite authentication object.

Auth_composite Auth_composite ([array $params = array()])

• array $params: A hash containing connection parameters.

addUser (line 165)

Add a set of authentication credentials.

• return: True on success or a PEAR_Error object on failure.

mixed addUser (string $userId, array $credentials)

• string $userId: The userId to add.
• array $credentials: The credentials to use.

---

Redefinition of:

Auth::addUser()

Adds a set of authentication credentials.

exists (line 252)

Checks if a userId exists in the system.

• return: Whether or not the userId already exists.

boolean exists (string $userId)

• string $userId: User ID to check

---

Redefinition of:

Auth::exists()

Checks if $userId exists in the system.

getParam (line 48)

Return the named parameter for the current auth driver.

• return: The parameter's value.

string getParam (string $param)

• string $param: The parameter to fetch.

---

Redefinition of:

Auth::getParam()

Returns the named parameter for the current auth driver.

hasCapability (line 92)

Query the current Auth object to find out if it supports the given capability.

• return: Whether or not the capability is supported.

boolean hasCapability (string $capability)

• string $capability: The capability to test for.

---

Redefinition of:

Auth::hasCapability()

Queries the current Auth object to find out if it supports the given capability.

listUsers (line 235)

List all users in the system.

• return: The array of userIds, or a PEAR_Error object on failure.

mixed listUsers ()

---

Redefinition of:

Auth::listUsers()

Lists all users in the system.

removeUser (line 220)

Delete a set of authentication credentials.

• return: True on success or a PEAR_Error object on failure.

mixed removeUser (string $userId)

• string $userId: The userId to delete.

---

Redefinition of:

Auth::removeUser()

Deletes a set of authentication credentials.

resetPassword (line 203)

Reset a user's password. Used for example when the user does not remember the existing password.

• return: The new password on success or a PEAR_Error object on failure.

mixed resetPassword (string $userId)

• string $userId: The user id for which to reset the password.

transparent (line 127)

Automatic authentication: Find out if the client matches an allowed IP block.

• return: Whether or not the client is allowed.

boolean transparent ()

---

Redefinition of:

Auth::transparent()

Automatic authentication.

updateUser (line 184)

Update a set of authentication credentials.

• return: True on success or a PEAR_Error object on failure.

mixed updateUser (string $oldID, string $newID, array $credentials)

• string $oldID: The old userId.
• string $newID: The new userId.
• array $credentials: The new credentials

---

Redefinition of:

Auth::updateUser()

Updates a set of authentication credentials.

Inherited Methods

Inherited From Auth

Auth::addHook()
Auth::addLogoutParameters()
Auth::addUser()
Auth::authenticate()
Auth::clearAuth()
Auth::exists()
Auth::factory()
Auth::genRandomPassword()
Auth::getAuth()
Auth::getAuthDomain()
Auth::getBareAuth()
Auth::getCredential()
Auth::getCryptedPassword()
Auth::getDriver()
Auth::getLoginScreen()
Auth::getLogoutReason()
Auth::getLogoutReasonString()
Auth::getParam()
Auth::getProvider()
Auth::getSalt()
Auth::hasCapability()
Auth::isAdmin()
Auth::isAuthenticated()
Auth::isPasswordChangeRequested()
Auth::listUsers()
Auth::readSessionData()
Auth::removeHook()
Auth::removeUser()
Auth::removeUserData()
Auth::setAuth()
Auth::setCredential()
Auth::singleton()
Auth::transparent()
Auth::updateUser()
Auth::_authenticate()
Auth::_isAdmin()