API Documentation
\

\Horde_Core_Auth_UsernameHook

The Horde_Core_Auth_UsernameHook class wraps another authentication driver but converts all user names through the user name hooks where necessary.

Summary

Methods
Properties
Constants
__construct()
authenticate()
validateAuth()
addUser()
lockUser()
unlockUser()
isLocked()
updateUser()
removeUser()
listUsers()
exists()
transparent()
resetPassword()
hasCapability()
getParam()
getCredential()
setCredential()
setError()
getError()
No public properties found
No constants found
_authenticate()
$_base
N/A
No private methods found
No private properties found
N/A

Properties

$_base

$_base : \Horde_Auth_Base

The wrapped authentication driver.

Type

\Horde_Auth_Base

Methods

__construct()

__construct(array  $params = array())

Constructor.

Parameters

array $params

Required parameters:

  • base: (Horde_Auth_Base) The base Horde_Auth driver.

Throws

\InvalidArgumentException

authenticate()

authenticate(  $userId,   $credentials,   $login = true)

Parameters

$userId
$credentials
$login

validateAuth()

validateAuth()

addUser()

addUser(  $userId,   $credentials)

Parameters

$userId
$credentials

lockUser()

lockUser(  $userId,   $time)

Parameters

$userId
$time

unlockUser()

unlockUser(  $userId,   $resetBadLogins = false)

Parameters

$userId
$resetBadLogins

isLocked()

isLocked(  $userId,   $show_details = false)

Parameters

$userId
$show_details

updateUser()

updateUser(  $oldID,   $newID,   $credentials)

Parameters

$oldID
$newID
$credentials

removeUser()

removeUser(  $userId)

Parameters

$userId

listUsers()

listUsers(  $sort = false)

Parameters

$sort

exists()

exists(  $userId)

Parameters

$userId

transparent()

transparent()

resetPassword()

resetPassword(  $userId)

Parameters

$userId

hasCapability()

hasCapability(  $capability)

Parameters

$capability

getParam()

getParam(  $param)

Parameters

$param

getCredential()

getCredential(  $name = null)

Parameters

$name

setCredential()

setCredential(  $type,   $value)

Parameters

$type
$value

setError()

setError(  $type,   $msg = null)

Parameters

$type
$msg

getError()

getError(  $msg = false)

Parameters

$msg

_authenticate()

_authenticate(  $userId,   $credentials)

Parameters

$userId
$credentials