Class: LiveUser

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);

Parameters:

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

Parameters:

In contrast to LiveUser::attachObserver() this can be used to add an object providing observer methods for some or all events. If you don't set parameter $methods it tries to find matching methods for each registered event and adds them as observer callback. You can use the $methods parameter to set what method should act as an observer for what event.

Parameters:

Parameters:

Parameters:

Parameters:

Parameters:

Parameters:

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',
  ),
  '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',
            '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(
                'required' => array(
                    'auth_user_id' => array('type' => 'text', 'name' => 'user_id'),
                    'handle'       => array('type' => 'text', 'name' => 'handle'),
                    'passwd'       => array('type' => 'text', 'name' => 'passwd')
                ),
                'optional' => array(
                    'owner_user_id'  => array('type' => 'integer', 'name' => 'owner_user_id'),
                    'owner_group_id' => array('type' => 'integer', 'name' => 'owner_group_id')
                    'lastlogin'    => array('type' => 'timestamp', 'name' => 'lastlogin'),
                    'is_active'    => array('type' => 'boolean', 'name' => 'is_active')
                ),
                'custom'   => array(
                    'myaliasforfield1' => array('type' => 'text', 'name' => 'myfield1')
                )
           ),
           'externalValues' => array(
                  'values'      => &$_SERVER,
                  'keysToCheck' => array('HTTP_USER_AGENT')
           ),
      ),
  ),
  'permContainer' => array(
      'type'       => 'Complex',
      'storage' => array(
          'DB' => array(
              'dsn' => $dsn,
              '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.

Parameters:

Parameters:

Parameters:

Parameters:

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.

Parameters:

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

Parameters:

Parameters:

Parameters:

Parameters:

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.

Parameters:

Parameters:

Parameters:

LiveUser object ($this) and $params are set as first and second parameters for each observer notification. $event is always set as 'event' field in $params, so this can not be used as a parameter but is useful if you want to use one single observer callback function for multiple events.

Parameters: