Auth_Container_ADOdb Class Reference

Inheritance diagram for Auth_Container_ADOdb:

Public Member Functions
	Auth_Container_ADOdb ($dsn)
	_connect ($dsn)
	_prepare ()
	query ($query)
	_setDefaults ()
	_parseOptions ($array)
	fetchData ($username, $password)
	listUsers ()
	addUser ($username, $password, $additional="")
	removeUser ($username)

Public Attributes
	$options = array()
	$db = null
	$dsn = ''
	$activeUser = ''

Detailed Description

Definition at line 32 of file ADOdb.php.

Member Function Documentation

_connect()

Auth_Container_ADOdb::_connect

(

$dsn

)

Connect to database by using the given DSN string

private

Parameters

string

DSN string

Returns

mixed Object on error, otherwise bool

Definition at line 90 of file ADOdb.php.

Referenced by _prepare().

_parseOptions()

Auth_Container_ADOdb::_parseOptions

(

$array

)

Parse options passed to the container class

private

Parameters

array

Definition at line 189 of file ADOdb.php.

Referenced by Auth_Container_ADOdb().

_prepare()

Auth_Container_ADOdb::_prepare

(

)

Prepare database connection

This function checks if we have already opened a connection to the database. If that's not the case, a new connection is opened.

private

Returns

mixed True or a DB error object.

Definition at line 128 of file ADOdb.php.

References _connect().

Referenced by fetchData(), listUsers(), and query().

_setDefaults()

Auth_Container_ADOdb::_setDefaults

(

)

Set some default options

private

Returns

void

Definition at line 169 of file ADOdb.php.

Referenced by Auth_Container_ADOdb().

addUser()

Auth_Container_ADOdb::addUser	(		$username,
			$password,
			$additional = ""
	)

Add user to the storage container

public

Parameters

string	Username
string	Password
mixed	Additional information that are stored in the DB

Returns

mixed True on success, otherwise error object

Definition at line 328 of file ADOdb.php.

References DB\isError(), and query().

Auth_Container_ADOdb()

Auth_Container_ADOdb::Auth_Container_ADOdb

(

$dsn

)

Constructor of the container class

Initate connection to the database via PEAR::ADOdb

Parameters

string

Connection data or DB object

Returns

object Returns an error object if something went wrong

Definition at line 64 of file ADOdb.php.

References $dsn, _parseOptions(), and _setDefaults().

fetchData()

Auth_Container_ADOdb::fetchData	(		$username,
			$password
	)

Get user information from database

This function uses the given username to fetch the corresponding login data from the database table. If an account that matches the passed username and password is found, the function returns true. Otherwise it returns false.

Parameters

string	Username
string	Password

Returns

mixed Error object or boolean

Definition at line 222 of file ADOdb.php.

References _prepare(), and DB\isError().

listUsers()

Auth_Container_ADOdb::listUsers

(

)

Definition at line 281 of file ADOdb.php.

References _prepare(), and DB\isError().

query()

Auth_Container_ADOdb::query

(

$query

)

Prepare query to the database

This function checks if we have already opened a connection to the database. If that's not the case, a new connection is opened. After that the query is passed to the database.

public

Parameters

string

Query string

Returns

mixed a DB_result object or DB_OK on success, a DB or PEAR error on failure

Definition at line 151 of file ADOdb.php.

References _prepare().

Referenced by addUser(), and removeUser().

removeUser()

Auth_Container_ADOdb::removeUser

(

$username

)

Remove user from the storage container

public

Parameters

string

Username

Returns

mixed True on success, otherwise error object

Definition at line 376 of file ADOdb.php.

References DB\isError(), and query().

Member Data Documentation

$activeUser

Auth_Container_ADOdb::$activeUser = ''

Definition at line 52 of file ADOdb.php.

$db

Auth_Container_ADOdb::$db = null

Definition at line 45 of file ADOdb.php.

$dsn

Auth_Container_ADOdb::$dsn = ''

Definition at line 46 of file ADOdb.php.

Referenced by Auth_Container_ADOdb().

$options

Auth_Container_ADOdb::$options = array()

Definition at line 39 of file ADOdb.php.