Documentation TYPO3 par Ameos

Auth_Container_ADOdb Class Reference

List of all members.

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 40 of file ADOdb.php.


Member Function Documentation

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 72 of file ADOdb.php.

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

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 98 of file ADOdb.php.

References $dsn.

Referenced by _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 136 of file ADOdb.php.

References _connect().

Referenced by fetchData(), listUsers(), and 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 159 of file ADOdb.php.

References _prepare().

Referenced by addUser(), and removeUser().

Auth_Container_ADOdb::_setDefaults (  ) 

Set some default options

private

Returns:
void

Definition at line 177 of file ADOdb.php.

Referenced by Auth_Container_ADOdb().

Auth_Container_ADOdb::_parseOptions ( array  ) 

Parse options passed to the container class

private

Parameters:
array 

Definition at line 197 of file ADOdb.php.

Referenced by Auth_Container_ADOdb().

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 230 of file ADOdb.php.

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

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 336 of file ADOdb.php.

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

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 384 of file ADOdb.php.

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


The documentation for this class was generated from the following file:


Généré par L'expert TYPO3 avec  doxygen 1.4.6