Documentation

Horde_Core_Auth_UsernameHook extends Horde_Auth_Base
in package

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

Tags
author

Jan Schneider jan@horde.org

category

Horde

license

http://opensource.org/licenses/lgpl-2.1.php LGPL

Table of Contents

Properties

$_base  : Horde_Auth_Base
The wrapped authentication driver.

Methods

__construct()  : mixed
Constructor.
addUser()  : mixed
authenticate()  : mixed
exists()  : mixed
getCredential()  : mixed
getError()  : mixed
getParam()  : mixed
hasCapability()  : mixed
isLocked()  : mixed
listUsers()  : mixed
lockUser()  : mixed
removeUser()  : mixed
resetPassword()  : mixed
setCredential()  : mixed
setError()  : mixed
transparent()  : mixed
unlockUser()  : mixed
updateUser()  : mixed
validateAuth()  : mixed
_authenticate()  : mixed

Properties

$_base

The wrapped authentication driver.

protected Horde_Auth_Base $_base

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
$params : array<string|int, mixed> = array()

Required parameters:

  • base: (Horde_Auth_Base) The base Horde_Auth driver.
Tags
throws
InvalidArgumentException

addUser()

public addUser(mixed $userId, mixed $credentials) : mixed
Parameters
$userId : mixed
$credentials : mixed

authenticate()

public authenticate(mixed $userId, mixed $credentials[, mixed $login = true ]) : mixed
Parameters
$userId : mixed
$credentials : mixed
$login : mixed = true

exists()

public exists(mixed $userId) : mixed
Parameters
$userId : mixed

getCredential()

public getCredential([mixed $name = null ]) : mixed
Parameters
$name : mixed = null

getError()

public getError([mixed $msg = false ]) : mixed
Parameters
$msg : mixed = false

getParam()

public getParam(mixed $param) : mixed
Parameters
$param : mixed

hasCapability()

public hasCapability(mixed $capability) : mixed
Parameters
$capability : mixed

isLocked()

public isLocked(mixed $userId[, mixed $show_details = false ]) : mixed
Parameters
$userId : mixed
$show_details : mixed = false

listUsers()

public listUsers([mixed $sort = false ]) : mixed
Parameters
$sort : mixed = false

lockUser()

public lockUser(mixed $userId[, mixed $time = 0 ]) : mixed
Parameters
$userId : mixed
$time : mixed = 0

removeUser()

public removeUser(mixed $userId) : mixed
Parameters
$userId : mixed

resetPassword()

public resetPassword(mixed $userId) : mixed
Parameters
$userId : mixed

setCredential()

public setCredential(mixed $type, mixed $value) : mixed
Parameters
$type : mixed
$value : mixed

setError()

public setError(mixed $type[, mixed $msg = null ]) : mixed
Parameters
$type : mixed
$msg : mixed = null

unlockUser()

public unlockUser(mixed $userId[, mixed $resetBadLogins = false ]) : mixed
Parameters
$userId : mixed
$resetBadLogins : mixed = false

updateUser()

public updateUser(mixed $oldID, mixed $newID, mixed $credentials) : mixed
Parameters
$oldID : mixed
$newID : mixed
$credentials : mixed

_authenticate()

protected _authenticate(mixed $userId, mixed $credentials) : mixed
Parameters
$userId : mixed
$credentials : mixed

        
On this page

Search results