Docs For Class LiveUser

LiveUser LiveUser(
)

Constructor

[ Top ]

mixed arrayMergeClobber(
array
$a1, array
$a2)

Clobbers two arrays together

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 Returns &authFactory(
mixed
$conf)

creates an instance of an auth object

Return: an object of an auth container
Access: public

Parameters:

mixed $conf — Name of array containing the configuration.

[ Top ]

mixed checkRight(
mixed
$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:

mixed $rights — A right id or an array of rights.

[ Top ]

boolean checkRightLevel(
mixed
$rights, mixed
$owner_user_id, mixed
$owner_group_id)

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

Access: public

Parameters:

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

[ Top ]

void disconnect(
)

properly disconnect resources in the active container

Access: public

[ Top ]

string errorMessage(
int
$value)

Return a textual error message for a LiveUser error code.

Return: error message
Access: public

Parameters:

int $value — error code

[ Top ]

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

Checks the given file and returns an object of the LoginManager.

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'
  ),
  'login' => array(
      'method'   => 'request, get or post',
      'username' => 'Form input containing user handle',
      'password' => 'Form input containing password',
      'remember' => '(optional) Form checkbox containing <Remember Me> info',
      'function' => '(optional) Function to be called when accessing a page without logging in first',
      'force'    => 'Should the user be forced to login'
  ),
  'logout' => array(
      'method'   => 'request, get or post',
      'trigger'  => 'REQUEST, GET or POST var that triggers the logout process',
      'redirect' => 'Page path to be redirected to after logout',
      'function' => '(optional) Function to be called when accessing a page without logging in first',
      'destroy'  => 'Whether to destroy the session on logout' false, true or regenid
  ),
 // 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'
  ),
  'authContainers' => array(
      'name' => array(
            'type' => 'DB',
            'connection'    => 'db connection object, use this or dsn',
            'dsn'           => 'database dsn, use this or connection',
            'loginTimeout'  => 0,
            'expireTime'    => 3600,
            'idleTime'      => 1800,
            'allowDuplicateHandles' => 0,
            'authTable'     => 'liveuser_users',
            'authTableCols' => array('user_id'            => 'auth_user_id',
                                     'handle'             => 'handle',
                                     'passwd'             => 'passwd',
                                     'lastlogin'          => 'lastlogin'
                                     'owner_user_id'      => 'owner_user_id'
                                     'owner_group_id'     => 'owner_group_id'
            )
      )
  ),
  'permContainer' => array(
      'type'       => 'DB_Complex',
      'connection' => 'db connection object, use this or dsn',
      'dsn'        => 'database dsn, use this or connection',
      'prefix'     => 'liveuser_'
  )

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: an object of either LiveUser or PEAR_Error type
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 remember me is set
mixed	`$confName`	—	Name of array containing the configuration.

[ Top ]

void freeze(
)

store all properties in an array

Access: public

[ Top ]

mixed &getAuthContainer(
)

Get the Auth Container class instance of it exists

Return: object or PEAR Error
Access: public

[ Top ]

mixed getOption(
string
$option)

Returns the value of an option

Return: the option value
Access: public

Parameters:

string $option — option name

[ Top ]

mixed &getPermContainer(
)

Get the Perm Container class instance if it exists

Return: object or PEAR Error
Access: public

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

mixed getRights(
[boolean
$withLevels = false])

Returns a one-dimensional array with all rights assigned to this user.

Array format depends on the optional parameter: true:

array(intRight_ID => intRightLevel, ...)

false

array(intRight_ID, ...) [Default]

If no rights are available, false is returned.

Return: an array of rights or false
Access: public

Parameters:

boolean $withLevels — Return array with right_id's as key and level as value

[ Top ]

integer getStatus(
)

Get the current status.

Access: public

[ Top ]

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

Tries to retrieve auth object from session.

If this fails, the class attempts a login based on cookie or form information (depends on class settings). Returns true if a auth object was successfully retrieved or created. Otherwise, false is returned.

Return: true if init process well, false if something went wrong or an error object.
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 ]

bool isError(
mixed
$value)

Tell whether a result from a LiveUser method is an error.

Return: whether value is an error
Access: public

Parameters:

mixed $value — result code

[ 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 == Not active false == active

Access: public

[ Top ]

boolean isLoggedIn(
)

Checks if a user is logged in.

Access: public

[ Top ]

void logout(
)

This destroys the session object.

Access: public

[ Top ]

object Returns &permFactory(
mixed
$conf)

Creates an instance of an perm object

Return: an object of an perm container
Access: public

Parameters:

mixed $conf — Name of array containing the configuration.

[ Top ]

object a &raiseError(
[mixed
$code = null], [int
$mode = null], [mixed
$options = null], [string
$userinfo = null])

This method is used to communicate an error and invoke error callbacks etc. Basically a wrapper for PEAR::raiseError without the message string.

Return: PEAR error object
See: PEAR_Error

Parameters:

mixed	`$code`	—	integer error code, or a PEAR error object (all other parameters are ignored if this parameter is an object
int	`$mode`	—	error mode, see PEAR_Error docs
mixed	`$options`	—	If error mode is PEAR_ERROR_TRIGGER, this is the error level (E_USER_NOTICE etc). If error mode is PEAR_ERROR_CALLBACK, this is the callback function, either as a function name, or as an array of an object and method name. For other error modes this parameter is ignored.
string	`$userinfo`	—	Extra debug information. Defaults to the last query and native error code.

[ Top ]

mixed setLoginFunction(
string
$functionName)

Sets a callback login function.

The user can set a function that will be called if the user tries to access a page wihout logging in first. It will receive the liveuser object. If an empty string or a non-existent function is passed it deactivates the call.

Return: void or PEAR_Error
Access: public

Parameters:

string $functionName — The name of the function to be called.

[ Top ]

mixed setLogoutFunction(
string
$functionName)

Sets a callback logout function.

The user can set a function that will be called if the user wants to logout (by providing the appropriate GET-parameter). If an empty string or a non-existent function is passed it deactivates the call. Attention: Don't use a die() or exit() statement in your logout function. Otherwise the user can't be logged out properly.

Return: void or a PEAR_Error
See: LiveUser::_options
Access: public

Parameters:

string $functionName — The name of the function to be called.

[ Top ]

mixed setOption(
string
$option, mixed
$value)

Sets an option.

Return: true or PEAR Error
See: LiveUser::_options
Access: public

Parameters:

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

[ Top ]

object Returns &singleton(
mixed
$conf, [string
$handle = ''], [string
$passwd = ''], [boolean
$logout = false], [boolean
$remember = false], [mixed
$confName = 'liveuserConfig'])

Makes your instance global.

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: an object of either LiveUser or PEAR_Error type
See: LiveUser::factory
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 remember me is set
mixed	`$confName`	—	Name of array containing the configuration.

[ Top ]

Class: LiveUser

Class Overview

Author(s):

Version:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

LiveUser (Constructor) [line 212]

arrayMergeClobber [line 452]

Parameters:

authFactory [line 402]

Parameters:

checkRight [line 1189]

Parameters:

checkRightLevel [line 1228]

Parameters:

disconnect [line 963]

errorMessage [line 1519]

Parameters:

factory [line 341]

Parameters:

freeze [line 940]

getAuthContainer [line 634]

getOption [line 619]

Parameters:

getPermContainer [line 650]

getProperty [line 1362]

Parameters:

getRights [line 1388]

Parameters:

getStatus [line 1402]

init [line 675]

Parameters:

isError [line 1506]

Parameters:

isInactive [line 1287]

isLoggedIn [line 1263]

logout [line 1112]

permFactory [line 424]

Parameters:

raiseError [line 245]

Parameters:

setLoginFunction [line 1308]

Parameters:

setLogoutFunction [line 1338]

Parameters:

setOption [line 602]

Parameters:

singleton [line 382]

Parameters: