Class: LiveUser_Admin

LiveUser_Admin LiveUser_Admin( )

boolean addErrorLog( Log &$log)

Add error logger for use by Errorstack.

Be aware that if you need add a log at the beginning of your code if you want it to be effective. A log will only be taken into account after it's added.

Sample usage:

 $lu_object = &LiveUser_Admin::singleton($conf);

 $logger = &Log::factory('mail', 'bug@example.com',
      'myapp_debug_mail_log', array('from' => 'application_bug@example.com'));
 $lu_object->addErrorLog($logger);

Parameters:

mixed addUser( string $handle, string $password, [array $optionalFields = array()], [array $customFields = array()], [int $id = null], [integer $type = LIVEUSER_USER_TYPE_ID])

Tries to add a user to both containers.

If the optional $id parameter is passed it will be used for both containers.

In any case the auth and perm id will be equal when using this method.

If this behaviour doesn't suit your needs please consider using directly the concerned method. This method is just implement to simplify things a bit and should satisfy most user needs.

Note type is optional for DB, thus it's needed for MDB and MDB2, we recommend that you use type even though you use DB, so if you change to MDB[2], it will be no problem for you. usage example for addUser:

       $optional = array('is_active' => true);

       $user_id = $admin->addUser('johndoe', 'dummypass', $optional);

Untested: it most likely doesn't work.

Parameters:

object &factory( $conf)

Parameters:

array getErrors( )

Wrapper method to get the Error Stack

mixed getUser( mixed $permId, [ $permFilter = array()], [ $authFilter = array()], [ $permOptions = array()])

Finds and gets userinfo by his userID, customFields can also be gotten

Untested: it most likely doesn't work.

Parameters:

void loadPEARLog( )

This method lazy loads PEAR::Log

mixed removeUser( mixed $permId)

Removes user from both containers

Untested: it most likely doesn't work.

Parameters:

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

Searches users with given filters and returns all users found with their handle, passwd, auth_user_id lastlogin, is_active and the customFields if they are specified

Untested: it most likely doesn't work.

Parameters:

boolean setAdminAuthContainer( string $authName)

Sets the current auth container to the one with the given auth container name

Upon success it will return true. You can then access the auth backend container by using the auth property of this class.

e.g.: $admin->auth->addUser();

Parameters:

boolean setAdminContainers( [mixed $authId = null], [string $authName = null])

Tries to find a user in any of the auth container.

Upon success it will return true. You can then access the backend container by using the auth and perm properties of this class.

e.g.: $admin->perm->updateAuthUserId();

Parameters:

boolean setAdminPermContainer( )

Sets the perm container

Upon success it will return true. You can then access the perm backend container by using the perm properties of this class.

e.g.: $admin->perm->addUser();

boolean setConfArray( array $conf)

Merges the current configuration array with configuration array pases along with the method call.

Parameters:

object &singleton( $conf)

Parameters:

mixed updateUser( integer $permId, string $handle, string $password, [array $optionalFields = array()], [array $customFields = array()], [integer $type = LIVEUSER_USER_TYPE_ID])

Tried to changes user data for both containers.

Note type is optional for DB, thus it's needed for MDB and MDB2, we recommend that you use type even though you use DB, so if you change to MDB[2], it will be no problem for you. usage example for updateUser:

       $optional = array('is_active' => false);

       $admin->updateUser($user_id, 'johndoe', 'dummypass');

Untested: it most likely doesn't work.

Parameters: