Docs For Class Auth

Auth_Container (Constructor) [line 49]

Auth_Container Auth_Container(
)

Constructor

Has to be overwritten by each storage class

Access: public

[ Top ]

addUser [line 156]

boolean addUser(
string
$username, string
$password, [array
$additional = null])

Add a new user to the storage container

Overridden in child classes as:

Auth_Container_SMBPasswd::addUser(): Add a new user to the storage container

Auth_Container_File::addUser(): Add a new user to the storage container

Auth_Container_MDB::addUser(): Add user to the storage container

Auth_Container_DB::addUser(): Add user to the storage container

Parameters:

string	`$username`	—	Username
string	`$password`	—	Password
array	`$additional`	—	Additional information

[ Top ]

fetchData [line 63]

void fetchData(
)

Fetch data from storage container

Has to be overwritten by each storage class

Access: public

Overridden in child classes as:

Auth_Container_SMBPasswd::fetchData(): Get user information from pwfile

Auth_Container_LDAP::fetchData(): Fetch data from LDAP server

Auth_Container_POP3::fetchData(): Try to login to the POP3 server

Auth_Container_IMAP::fetchData(): Try to open a IMAP stream using $username / $password

Auth_Container_File::fetchData(): Authenticate an user

Auth_Container_vpopmail::fetchData(): Get user information from vpopmail

Auth_Container_MDB::fetchData(): Get user information from database

Auth_Container_RADIUS::fetchData(): Authenticate

Auth_Container_DB::fetchData(): Get user information from database

Auth_Container_SOAP::fetchData(): Fetch data from SOAP service

[ Top ]

getUser [line 129]

void getUser(
string
$username)

Returns a user assoc array

Containers which want should overide this

Parameters:

string $username — The username

[ Top ]

listUsers [line 117]

void listUsers(
)

List all users that are available from the storage container

Overridden in child classes as:

Auth_Container_SMBPasswd::listUsers()

Auth_Container_File::listUsers(): List all available users

Auth_Container_MDB::listUsers()

Auth_Container_DB::listUsers()

[ Top ]

removeUser [line 169]

void removeUser(
string
$username)

Remove user from the storage container

Overridden in child classes as:

Auth_Container_SMBPasswd::removeUser(): Remove user from the storage container

Auth_Container_File::removeUser(): Remove user from the storage container

Auth_Container_MDB::removeUser(): Remove user from the storage container

Auth_Container_DB::removeUser(): Remove user from the storage container

Parameters:

string $username — Username

[ Top ]

verifyPassword [line 81]

bool verifyPassword(
string
$password1, string
$password2, [string
$cryptType = "md5"])

Crypt and verfiy the entered password

Return: True, if the passwords match

Parameters:

string	`$password1`	—	Entered password
string	`$password2`	—	Password from the data container (usually this password is already encrypted.
string	`$cryptType`	—	Type of algorithm with which the password from the container has been crypted. (md5, crypt etc.) Defaults to "md5".

[ Top ]

Class: Auth_Container

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$activeUser = ""

Method Detail

Auth_Container (Constructor) [line 49]

addUser [line 156]

Parameters:

fetchData [line 63]

getUser [line 129]

Parameters:

listUsers [line 117]

removeUser [line 169]

Parameters:

verifyPassword [line 81]

Parameters: