Docs For Class LiveUser_Admin_Auth_Container

void LiveUser_Admin_Auth_Container_DB(
array
&$connectOptions, [
$name = null])

Constructor

The second parameters expects an array containing the parameters for the given container.

This class expects only the array containing configuration options of the auth container you wish to administrate. This is done in case you have several DB based auth containers.

See PEAR::DB documentation for DSN specifications.

See: LiveUser::factory The configuration array is explained there
Access: protected

Parameters:

array	`&$connectOptions`	—	full liveuser conf array
	`$name`	—

[ Top ]

mixed addUser(
string
$handle, [string
$password = ''], [array
$optionalFields = array()], [array
$customFields = array()], [mixed
$authId = null])

Adds a new user to Auth/DB.

Return: Users auth ID on success, DB error if not, false if not initialized
Access: public

Overrides LiveUser_Admin_Auth_Common::addUser() (Adds a new user to Auth.)

Parameters:

string	`$handle`	—	Handle (username).
string	`$password`	—	Password.
array	`$optionalFields`	—	Array of optional fields values to be added array('alias' => ''value')
array	`$customFields`	—	Array of custom fields values to be added array('alias' => ''value')
mixed	`$authId`	—	If specificed no new ID will be automatically generated instead

[ Top ]

mixed getUsers(
[array
$filters = array()], [string
$order = null], [boolean
$rekey = false])

Gets all users with handle, passwd, auth_user_id lastlogin, is_active and individual rights.

The array will look like this:

 $userData[0]['auth_user_id'] = 'wujha433gawefawfwfiuj2ou9823r98h';

             ['handle']       = 'myLogin';
             ['passwd']       = 'd346gs2gwaeiuhaeiuuweijfjuwaefhj';
             ['lastlogin']    = 1254801292; (Unix timestamp)
             ['is_active']    = 1; (1 = yes, 0 = no)
             ['owner_user_id']    = 1;
             ['owner_group_id']   = 1;

Filters can be either complex or simple.

In their simple form you just need to pass an associative array with key/value, the key will be the table field name and value the value you are searching. It will consider that you want an do to do a field=value comparison, every additional filter will be appended with AND

The complicated form of filters is to pass an array such as

array( 'fieldname' => array('op' => '>', 'value' => 'dummy', 'cond' => ''), 'fieldname' => array('op' => '<', 'value' => 'dummy2', 'cond' => 'OR'), );

It can then build relatively complex queries. If you need joins or more complicated queries than that please consider using an alternative solution such as PEAR::DB_DataObject

Any aditional field will be returned. The array key will be of the same case it is given.

$cols = array('myField');

e.g.: getUsers(null, $cols) will return

 $userData[0]['auth_user_id'] = 'wujha433gawefawfwfiuj2ou9823r98h';

             ['handle']       = 'myLogin';
             ['passwd']       = 'd346gs2gwaeiuhaeiuuweijfjuwaefhj';
             ['myField']      = 'value';

Return: Array with user data or DB error.
Access: public

Overrides LiveUser_Admin_Auth_Common::getUsers() (Gets all users with handle, passwd, authId, lastlogin, is_active and individual rights.)

Parameters:

array	`$filters`	—	filters to apply to fetched data
string	`$order`	—	if not null 'ORDER BY $order' will be appended to the query
boolean	`$rekey`	—	will return an associative array with the auth_user_id as the key by using DB::getAssoc() instead of DB::getAll()

[ Top ]

mixed removeUser(
string
$authId)

Removes an existing user from Auth/DB.

Return: True on success, DB error if not.
Access: public

Overrides LiveUser_Admin_Auth_Common::removeUser() (Removes an existing user from Auth.)

Parameters:

string $authId — Auth user ID of the user that should be removed.

[ Top ]

mixed updateUser(
string
$authId, [string
$handle = ''], [string
$password = ''], [array
$optionalFields = array()], [array
$customFields = array()])

Changes user data in auth table.

Return: True on success, DB error if not.
Access: public

Overrides LiveUser_Admin_Auth_Common::updateUser() (Changes user data in auth table.)

Parameters:

string	`$authId`	—	Auth user ID.
string	`$handle`	—	Handle (username) (optional).
string	`$password`	—	Password (optional).
array	`$optionalFields`	—	Array of optional fields values to be added array('alias' => ''value')
array	`$customFields`	—	Array of custom fields values to be updated

[ Top ]

Class: LiveUser_Admin_Auth_Container_DB

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Class: LiveUser_Admin_Auth_Common

Inherited Methods

Class: LiveUser_Admin_Auth_Common

Class Details

Class Variables

$authTable = 'liveuser_users'

Method Detail

LiveUser_Admin_Auth_Container_DB (Constructor) [line 121]

Parameters:

addUser [line 156]

Parameters:

getUsers [line 374]

Parameters:

removeUser [line 227]

Parameters:

updateUser [line 260]

Parameters: