Docs For Class LiveUser

void LiveUser(

&$debug, bool|object 
$debug)

Constructor. Use the factory or singleton methods.

See: LiveUser::singleton
See: LiveUser::factory
Access: protected

Parameters:

bool\|object	`$debug`	—	Boolean that indicates if a log instance should be created or an instance of a class that implements the PEAR:Log interface.
	`&$debug`	—

[ Top ]

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

Clobbers two arrays together.

Function taken from the user notes of array_merge_recursive function used in LiveUser::readConfig() and 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
&$conf, string
$containerName, [string
$classprefix = 'LiveUser_'])

Creates an instance of an auth container class.

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

Parameters:

array	`&$conf`	—	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 ]

bool 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.

Use this method to determine if a user has a given right or set of rights.

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 ]

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

Wrapper method for the permission object's own checkRight and checkLevel methods

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 ]

Crypt_RC4 &cryptRC4Factory(
string
$secret)

Creates an instance of the PEAR::Crypt_Rc4 class.

Return: returns an instance of the Crypt_RC4 class
Access: public

Parameters:

string $secret — token to use to encrypt data

[ Top ]

bool deleteRememberCookie(
)

Deletes the rememberMe cookie.

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

[ Top ]

bool disconnect(
)

Properly disconnect resources in the active container.

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

[ Top ]

LiveUser &factory(
array
&$conf)

Returns an instance of the LiveUser class.

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

 array(

  'debug' => false/true or an instance of a class that implements the PEAR::Log interface
  '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 trailing slash (/) !
      'secure'   => 'Cookie send only over secure connections',
  ),
  'authContainers' => array(
      'name' => array(
            'type'            => 'auth container name',
            'expireTime'      => 'maximum lifetime of a session in seconds',
            'idleTime'        => 'maximum amount of time between two request',
            'allowDuplicateHandles' => 'if to allow duplicate handles',
            'allowEmptyPasswords'   => 'if empty passwords are allowed',
            'storage' => array(
                'connection' => 'db connection object, use this or dsn',
                'dsn'        => 'database dsn, use this or connection',
           ),
           'externalValues' => array(
                  'values'      => 'reference to an array',
                  'keysToCheck' => 'array of keys to check in the array passed'
           ),
      ),
  ),
  'permContainer' => array(
      'type'     => 'perm container name',
      'storage'  => array(
          'storage container name' => array(
              'connection' => 'db connection object, use this or dsn',
              'dsn'        => 'database dsn, use this or connection',
              'prefix'    => 'table prefix'
              'tables'    => 'array containing additional tables or fields in existing tables',
              'fields'    => 'array containing any additional or non-default field types',
              'alias'     => 'array containing any additional or non-default field alias',
              'force_seq' => 'if the use of (emulated) sequences should forced instead of using autoincrement where applicable',
          ),
      ),
  ),

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:

array &$conf — Config array to configure.

[ Top ]

bool 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 ]

array|bool getErrors(
)

Wrapper method to get errors from 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 from the configuration array.

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 scalarvalue, an object or an array.
Access: public

Parameters:

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

[ Top ]

int getStatus(
)

Get the current status.

Return: a LIVEUSER_STATUS_* constant
See: LIVEUSER_STATUS_* constants
Access: public

[ Top ]

bool init(
)

Tries to retrieve the auth object from session and checks possible timeouts.

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

[ Top ]

bool 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 ]

bool isLoggedIn(
)

Checks if a user is logged in.

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

[ Top ]

bool loadClass(
string
$classname, [bool
$supress_error = false])

Loads a PEAR class.

Return: true success or false on failure
Access: public

Parameters:

string	`$classname`	—	classname to load
bool	`$supress_error`	—	if errors should be supressed from the stacl

[ Top ]

bool login(
[string
$handle = ''], [string
$passwd = ''], [bool
$remember = false])

Tries to log the user in by trying all the Auth containers defined in the configuration file until there is a success or a failure.

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

Parameters:

string	`$handle`	—	handle of the user trying to authenticate
string	`$passwd`	—	password of the user trying to authenticate
bool	`$remember`	—	set if remember me is set, requires cookie otion

[ Top ]

bool logout(
[bool
$direct = true])

This logs the user out and destroys the session object if the configuration option is set.

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

Parameters:

bool $direct — set to false if no events should be fired b yhte logout

[ Top ]

log &PEARLogFactory(
bool|Log
&$log)

Determines if loading of PEAR::Log is necessary.

If an object is passed it is returned, otherwise Log is loaded and instantiated.

Return: instance of the given log class
Access: protected

Parameters:

bool|Log &$log — Boolean that indicates if a log instance should be created or an instance of a class that implements the PEAR:Log interface.

[ Top ]

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

Creates an instance of an perm container class.

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

Parameters:

array	`&$conf`	—	Array containing the configuration.
string	`$classprefix`	—	Prefix of the class that will be used.

[ Top ]

bool readConfig(
array|file
&$conf, string
1)

Reads the configuration array.

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

Parameters:

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

[ Top ]

bool readRememberCookie(
)

Handles the retrieval of the login data from the rememberMe cookie.

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

[ Top ]

bool setOption(
string
$option, mixed
$value)

Sets an option after the configuration array has been loaded.

You can override a specific option calling this method.

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 ]

bool setRememberCookie(
string
$handle, string
$passwd)

If cookies are allowed, this method checks if the user wanted a cookie to be set so he doesn't have to enter handle and password for his next login. If true, it will set the cookie.

Return: true if the cookie can be set, false otherwise
Access: public

Parameters:

string	`$handle`	—	handle of the user trying to authenticate
string	`$passwd`	—	password of the user trying to authenticate

[ Top ]

LiveUser &singleton(
array
&$conf, [string
$signature = null])

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	`&$conf`	—	Config array to configure.
string	`$signature`	—	Signature by which the given instance can be referenced later

[ 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 class.

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 ]

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

Updates the properties of the containers from the original source.

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

Parameters:

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

[ Top ]

Class: LiveUser

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$dispatcher = null

$log = null

Method Detail

LiveUser (Constructor) [line 343]

Parameters:

arrayMergeClobber [line 661]

Parameters:

authFactory [line 564]

Parameters:

checkGroup [line 1474]

Parameters:

checkRight [line 1416]

Parameters:

checkRightLevel [line 1456]

Parameters:

cryptRC4Factory [line 787]

Parameters:

deleteRememberCookie [line 1335]

disconnect [line 1166]

factory [line 455]

Parameters:

fileExists [line 684]

Parameters:

getErrors [line 517]

getOption [line 870]

Parameters:

getProperty [line 1541]

Parameters:

getStatus [line 1599]

init [line 930]

isInactive [line 1526]

isLoggedIn [line 1503]

loadClass [line 534]

Parameters:

login [line 986]

Parameters:

logout [line 1374]

Parameters:

PEARLogFactory [line 755]

Parameters:

permFactory [line 587]

Parameters:

readConfig [line 705]

Parameters:

readRememberCookie [line 1261]

setOption [line 851]

Parameters:

setRememberCookie [line 1196]

Parameters:

singleton [line 488]

Parameters:

statusMessage [line 1624]

Parameters:

storageFactory [line 611]

Parameters:

updateProperty [line 1565]

Parameters: