Class Auth_application

Description

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

Required parameters:

   'app'  The application which is providing authentication.

$Horde: framework/Auth/Auth/application.php,v 1.27.10.18 2009/02/13 05:45:36 chuck 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.

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

Auth
   |
   --Auth_application
Variable Summary
Method Summary
 Auth_application Auth_application ([array $params = array()])
 mixed addUser (string $userId, array $credentials)
 boolean exists (string $userId)
 boolean hasCapability (string $capability)
 mixed listUsers ()
 mixed removeUser (string $userId)
 mixed updateUser (string $oldID, string $newID, array $credentials)
Variables
array $capabilities = array('add' => false,
'update' => false,
'resetpassword' => false,
'remove' => false,
'exists' => false,
'list' => false,
'transparent' => false)
(line 30)

An array of capabilities, so that the driver can report which operations it supports and which it doesn't.


Redefinition of:
Auth::$capabilities
An array of capabilities, so that the driver can report which operations it supports and which it doesn't.

Inherited Variables

Inherited from Auth

Auth::$_authCredentials
Auth::$_params
Methods
Constructor Auth_application (line 43)

Constructs a new Application authentication object.

Auth_application Auth_application ([array $params = array()])
  • array $params: A hash containing connection parameters.
addUser (line 183)

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 166)

Checks if $userId exists in the system.

  • return: Whether or not $userId already exists.
boolean exists (string $userId)
  • string $userId: User ID for which to check

Redefinition of:
Auth::exists()
Checks if $userId exists in the system.
hasCapability (line 56)

Queries 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 150)

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 217)

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.
updateUser (line 201)

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()

Documentation generated on Sun, 30 Jan 2011 05:15:11 +0000 by phpDocumentor 1.4.3