Class: LiveUser_Admin_Auth_Common

Source Location: /LiveUser_Admin-0.3.3/Auth/Common.php

Class Overview

Base class for authentication backends.

Author(s):

Lukas Smith <smith at pooteeweet.org>

Version:

Release: @package_version@

Copyright:

2002-2005 Markus Wolff

Child classes:

LiveUser_Admin_Auth_MDB2: MDB2-based authentication admin container for LiveUser.

LiveUser_Admin_Auth_MDB: MDB-based authentication admin container for LiveUser.

LiveUser_Admin_Auth_DB: DB-based authentication admin container for LiveUser.

Inherited Variables

Inherited Methods

Class Details

[line 75]
Base class for authentication backends.

Author: Lukas Smith <smith@pooteeweet.org>
Version: Release: @package_version@
Copyright: 2002-2005 Markus Wolff
Link: http://pear.php.net/LiveUser_Admin
License: http://www.gnu.org/licenses/lgpl.txt

[ Top ]

Class Variables

$allowDuplicateHandles = false

[line 138]

Allow multiple users in the database to have the same login handle. Default: false.

Type:

boolean

[ Top ]

$allowEmptyPasswords = false

[line 145]

Allow empty passwords to be passed to LiveUser. Default: false.

Type:

boolean

[ Top ]

$containerName = null

[line 130]

The name associated with this auth container. The name is used when adding users from this container to the reference table in the permission container. This way it is possible to see from which auth container the user data is coming from.

Access: public

Type:

string

[ Top ]

$secret =

[line 119]

Defines the secret to use for encryption if needed

Access: protected

Type:

string

[ Top ]

Method Detail

LiveUser_Admin_Auth_Common (Constructor) [line 152]

LiveUser_Admin_Auth_Common LiveUser_Admin_Auth_Common(
)

Class constructor. Feel free to override in backend subclasses.

Access: protected

[ Top ]

addUser [line 270]

void addUser(
array
$data)

Add user

Access: public

Parameters:

array $data —

[ Top ]

decryptPW [line 202]

string decryptPW(
string
$encryptedPW)

Decrypts a password so that it can be compared with the user input. Uses the algorithm defined in the passwordEncryptionMode property.

Return: The decrypted password

Parameters:

string $encryptedPW — the encrypted password

[ Top ]

disconnect [line 345]

void disconnect(
)

properly disconnect from resources

Access: public

[ Top ]

encryptPW [line 234]

string encryptPW(
string
$plainPW)

Encrypts a password for storage in a backend container.

Uses the algorithm defined in the passwordEncryptionMode property.

Return: The encrypted password

Parameters:

string $plainPW — encryption type

[ Top ]

getUsers [line 325]

void getUsers(
[array
$params = array()])

Fetches users

Access: public

Parameters:

array $params —

[ Top ]

init [line 164]

boolean init(
mixed
&$conf, 
$containerName)

Load the storage container

Return: true on success or false on failure
Access: public

Parameters:

mixed	`&$conf`	—	Name of array containing the configuration.
	`$containerName`	—

[ Top ]

removeUser [line 310]

void removeUser(
array
$filters)

Remove user

Access: public

Parameters:

array $filters — Array containing the filters on what user(s) should be removed

[ Top ]

updateUser [line 290]

void updateUser(
array
$data, array
$filters)

Update usr

Access: public

Parameters:

array	`$data`	—
array	`$filters`	—

[ Top ]