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:

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'
  ),
  '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'
      'regenid'  => 'Should the session be regenerated on 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 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 !
  ),
  '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')
                )
           )
      )
  ),
  'permContainer' => array(
      'type'       => 'DB_Complex',
      'connection' => 'db connection object, use this or dsn',
      'dsn'        => 'database dsn, use this or connection',
      'prefix'     => 'liveuser_',
      'groupTableCols' => array(
          'required' => array(
              'group_id' => array('type' => 'integer', 'name' => 'group_id')
              'group_define_name' => array('type' => 'text', 'name' => 'group_define_name')
          ),
          'optional' => array(
              'group_type'    => array('type' => 'integer', 'name' => 'group_type')
              'is_active'    => array('type' => 'boolean', 'name' => 'is_active')
              'owner_user_id'  => array('type' => 'integer', 'name' => 'owner_user_id'),
              'owner_group_id' => array('type' => 'integer', 'name' => 'owner_group_id')
          ),
          'custom'   => array(
              'myaliasforfield1' => array('type' => 'text', 'name' => 'myfield1')
          )
  )

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:

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:

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.

Parameters:

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.

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: