Docs For Class LiveUser

void LiveUser(
)

Constructor

Access: protected

[ Top ]

boolean addErrorLog(
Log
&$log)

Adds an error logger to 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::singleton($conf);

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

Return: true on success or false on failure
Access: public

Parameters:

Log &$log — logger instance

[ Top ]

array|false arrayMergeClobber(
array
$a1, array
$a2)

Clobbers two arrays together.

Function taken from the user notes of array_merge_recursive used in LiveUser::readConfig() may be called statically

Return: array on success and false on error
Author: kc@hireability.com
Access: public

Parameters:

array	`$a1`	—	array that should be clobbered
array	`$a2`	—	array that should be clobbered

[ Top ]

object|false &authFactory(
array|file
&$conf, string
$containerName, [string
$classprefix = 'LiveUser_'])

Creates an instance of an auth object.

Return: Returns an instance of an auth container class or false on error
Access: public

Parameters:

array\|file	`&$conf`	—	Name of array containing the configuration.
string	`$containerName`	—	Name of the container we'll be using.
string	`$classprefix`	—	Prefix of the class that will be used.

[ Top ]

boolean checkGroup(
array|int
$groups)

Wrapper method for the permission object's own checkGroup method.

Return: true on success or false on failure
Access: public

Parameters:

array|int $groups — A group id or an array of groups.

[ Top ]

int|false checkRight(
array|int
$rights)

Wrapper method for the permission object's own checkRight method.

Return: level if the user has the right/rights false if not
Access: public

Parameters:

array|int $rights — A right id or an array of rights.

[ Top ]

boolean checkRightLevel(
array|int
$rights, array|int
$owner_user_id, array|int
$owner_group_id)

Wrapper method for the permission object's own checkRightLevel method.

Return: true on success or false on failure
Access: public

Parameters:

array\|int	`$rights`	—	A right id or an array of rights.
array\|int	`$owner_user_id`	—	Id or array of Ids of the owner of the
array\|int	`$owner_group_id`	—	Id or array of Ids of the group of the ressource for which the right is requested.

[ Top ]

object returns &cryptRC4Factory(
string
$secret)

Creates an instance of the PEAR::Crypt_Rc4 class.

Return: an instance of the Crypt_RC4 class
Access: public

Parameters:

string $secret — token to use to encrypt data

[ Top ]

boolean disconnect(
)

Properly disconnect resources in the active container

Return: true on success or false on failure
Access: public

[ Top ]

LiveUser|false &factory(
mixed
$conf, [string
$handle = ''], [string
$passwd = ''], [boolean
$logout = false], [boolean
$remember = false], [mixed
$confName = 'liveuserConfig'])

Returns an instance of the login manager class.

This array contains private options defined by the following associative keys:

 array(

  'autoInit' => false/true,
  'session'  => array(
      'name'    => 'liveuser session name',
      'varname' => 'liveuser session var name'
  ),
 // The session_save_handler options are optional. If they are specified,
 // session_set_save_handler() will be called with the parameters
  'session_save_handler' => array(
      'open'    => 'name of the open function/method',
      'close'   => 'name of the close function/method',
      'read'    => 'name of the read function/method',
      'write'   => 'name of the write function/method',
      'destroy' => 'name of the destroy function/method',
      'gc'      => 'name of the gc function/method',
  ),
 // The session_cookie_params options are optional. If they are specified,
 // session_set_cookie_params() will be called with the parameters
  'session_cookie_params' => array(
      'lifetime' => 'Cookie lifetime in days',
      'path'     => 'Cookie path',
      'domain'   => 'Cookie domain',
      'secure'   => 'Cookie send only over secure connections',
  ),
 'cache_perm' => if the permission data should be cached inside the session
  'login' => array(
      'force'    => 'Should the user be forced to login'
      'regenid'  => 'Should the session be regenerated on login'
  ),
  'logout' => array(
      'destroy'  => 'Whether to destroy the session on logout' false or true
  ),
 // The cookie options are optional. If they are specified, the Remember Me
 // feature is activated.
  'cookie' => array(
      'name'     => 'Name of Remember Me cookie',
      'lifetime' => 'Cookie lifetime in days',
      'path'     => 'Cookie path',
      'domain'   => 'Cookie domain',
      'secret'   => 'Secret key used for cookie value encryption',
      'savedir'  => '/absolute/path/to/writeable/directory' // No / at the end !
      'secure'   => 'Cookie send only over secure connections',
  ),
  'authContainers' => array(
      'name' => array(
            'type'            => 'DB',
            'loginTimeout'    => 0,
            'expireTime'      => 3600,
            'idleTime'        => 1800,
            'updateLastLogin' => true,
            'allowDuplicateHandles' => false,
            'allowEmptyPasswords'   => false,
            'storage' => array(
                'connection'      => 'db connection object, use this or dsn',
                'dsn'             => 'database dsn, use this or connection',
           ),
           'externalValues' => array(
                  'values'      => &$_SERVER,
                  'keysToCheck' => array('HTTP_USER_AGENT')
           ),
      ),
  ),
  'permContainer' => array(
      'type'     => 'Complex',
      'storage'  => array(
          'MDB2' => array(
              'dsn'       => $dsn,
              'prefix'    => 'liveuser_'
              'tables'    => array(),
              'fields'    => array(),
              'alias'     => array(),
              'force_seq' => true,
          ),
      ),
  ),

Other options in the configuration file relative to the Auth and Perm containers depend on what the containers expect. Refer to the Containers documentation. The examples for containers provided are just general do not reflect all the options for all containers.

Return: Returns an object of either LiveUser or false on error if so use LiveUser::getErrors() to get the errors
See: LiveUser::getErrors
Access: public

Parameters:

mixed	`$conf`	—	The config file or the config array to configure.
string	`$handle`	—	Handle of the user trying to authenticate
string	`$passwd`	—	Password of the user trying to authenticate
boolean	`$logout`	—	set to true if user wants to logout
boolean	`$remember`	—	set if you want to use the rememberMe feature
mixed	`$confName`	—	Name of array containing the configuration.

[ Top ]

boolean fileExists(
string
$file)

Checks if a file exists in the include path.

Return: true success and false on error
Access: public

Parameters:

string $file — filename

[ Top ]

boolean freeze(
)

Stores all properties in the session.

Return: true on sucess or false on failure
Access: public

[ Top ]

array getErrors(
)

Wrapper method to get the Error Stack

Return: an array of the errors or false if there are no errors
Access: public

[ Top ]

mixed getOption(
string
$option)

Returns the value of an option

Return: the option value or false on failure
Access: public

Parameters:

string $option — option name

[ Top ]

mixed getProperty(
string
$what, [string
$container = 'auth'])

Wrapper method to access properties from the auth and permission containers.

Return: a value or an array.
Access: public

Parameters:

string	`$what`	—	Name of the property to be returned.
string	`$container`	—	'auth' or 'perm'

[ Top ]

integer getStatus(
)

Get the current status.

See: LIVEUSER_STATUS_* constants
Access: public

[ Top ]

boolean init(
[string
$handle = ''], [string
$passwd = ''], [boolean
$logout = false], [boolean
$remember = false])

Tries to retrieve auth object from session.

If this fails, the method attempts a login based on the parameters or cookie data

Return: true if init process well, false if something went wrong.
Access: public

Parameters:

string	`$handle`	—	handle of the user trying to authenticate
string	`$passwd`	—	password of the user trying to authenticate
boolean	`$logout`	—	set to true if user wants to logout
boolean	`$remember`	—	set if remember me is set

[ Top ]

boolean isInactive(
)

Function that determines if the user exists but hasn't yet been declared "active" by an administrator.

Use this to check if this was the reason why a user was not able to login. true == user account is NOT active false == user account is active

Return: true if the user account is *not* active false if the user account *is* active
Access: public

[ Top ]

boolean isLoggedIn(
)

Checks if a user is logged in.

Return: true if user is logged in, false if not
Access: public

[ Top ]

boolean loadClass(
string
$classname)

Loads a PEAR class

Return: true success or false on failure
Access: public

Parameters:

string $classname — classname

[ Top ]

void loadPEARLog(
)

This method lazy loads PEAR::Log.

Access: protected

[ Top ]

object|false &permFactory(
array|file
&$conf, [string
$classprefix = 'LiveUser_'])

Creates an instance of an perm object.

Return: Returns an instance of a perm container class or false on error
Access: public

Parameters:

array\|file	`&$conf`	—	Name of array containing the configuration.
string	`$classprefix`	—	Prefix of the class that will be used.

[ Top ]

boolean readConfig(
array|file
$conf, string
$confName)

Reads the configuration.

Return: true on success or false on failure
Access: public

Parameters:

array\|file	`$conf`	—	Conf array or file path to configuration
string	`$confName`	—	Name of array containing the configuration

[ Top ]

boolean setOption(
string
$option, mixed
$value)

Sets an option.

Return: true on success or false on failure
See: LiveUser::_options
Access: public

Parameters:

string	`$option`	—	option name
mixed	`$value`	—	value for the option

[ Top ]

LiveUser|false &singleton(
[array|file
$conf = array()], [string
$handle = ''], [string
$passwd = ''], [boolean
$logout = false], [boolean
$remember = false], [string
$confName = 'liveuserConfig'])

This uses the singleton pattern, making sure you have one and only instance of the class.

In PHP4 you MUST call this method with the $var = &LiveUser::singleton() syntax. Without the ampersand (&) in front of the method name, you will not get a reference, you will get a copy.

Return: Returns an object of either LiveUser or false on failure
See: LiveUser::getErrors
See: LiveUser::factory
Access: public

Parameters:

array\|file	`$conf`	—	The config file or the config array to configure.
string	`$handle`	—	Handle of the user trying to authenticate
string	`$passwd`	—	Password of the user trying to authenticate
boolean	`$logout`	—	set to true if user wants to logout
boolean	`$remember`	—	set if remember me is set
string	`$confName`	—	Name of array containing the configuration.

[ Top ]

string statusMessage(
int
$value)

Return a textual status message for a LiveUser status code.

Return: error message
Access: public

Parameters:

int $value — status code

[ Top ]

object|false &storageFactory(
array
&$confArray, [string
$classprefix = 'LiveUser_Perm_'])

Returns an instance of a storage Container.

Return: will return an instance of a Storage container or false upon error
Access: protected

Parameters:

array	`&$confArray`	—	configuration array to pass to the storage container
string	`$classprefix`	—	Prefix of the class that will be used.

[ Top ]

boolean updateProperty(
boolean
$auth, [boolean
$perm = null])

updates the properties of the containers from the original source

Access: public

Parameters:

boolean	`$auth`	—	if the auth container should be updated
boolean	`$perm`	—	if the perm container should be updated

[ Top ]

string __toString(
)

Make a string representation of the object.

Return: returns a string representation of the class
Access: public

[ Top ]

Class: LiveUser

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$dispatcher = null

Method Detail

LiveUser (Constructor) [line 337]

addErrorLog [line 786]

Parameters:

arrayMergeClobber [line 655]

Parameters:

authFactory [line 571]

Parameters:

checkGroup [line 1482]

Parameters:

checkRight [line 1426]

Parameters:

checkRightLevel [line 1464]

Parameters:

cryptRC4Factory [line 802]

Parameters:

disconnect [line 1170]

factory [line 458]

Parameters:

fileExists [line 681]

Parameters:

freeze [line 1143]

getErrors [line 529]

getOption [line 883]

Parameters:

getProperty [line 1549]

Parameters:

getStatus [line 1607]

init [line 940]

Parameters:

isInactive [line 1534]

isLoggedIn [line 1511]

loadClass [line 545]

Parameters:

loadPEARLog [line 758]

permFactory [line 594]

Parameters:

readConfig [line 701]

Parameters:

setOption [line 864]

Parameters:

singleton [line 495]

Parameters:

statusMessage [line 1632]

Parameters:

storageFactory [line 617]

Parameters:

updateProperty [line 1573]

Parameters:

__toString [line 1619]