cvs: pear /LiveUser LiveUser.php

lsmith Fri Nov 18 10:14:36 2005 EDT Modified files: /pear/LiveUser LiveUser.php Log: - tweaked config option phpdoc comments http://cvs.php.net/diff.php/pear/LiveUser/LiveUser.php?r1=1.125&r2=1.126&ty=u Index: pear/LiveUser/LiveUser.php diff -u pear/LiveUser/LiveUser.php:1.125 pear/LiveUser/LiveUser.php:1.126 --- pear/LiveUser/LiveUser.php:1.125 Thu Nov 17 16:48:14 2005 +++ pear/LiveUser/LiveUser.php Fri Nov 18 10:14:35 2005 @@ -40,7 +40,7 @@ * @author Bjoern Kraus <krausbn@php.net> * @copyright 2002-2005 Markus Wolff * @license http://www.gnu.org/licenses/lgpl.txt - * @version CVS: $Id: LiveUser.php,v 1.125 2005/11/17 21:48:14 arnaud Exp $ + * @version CVS: $Id: LiveUser.php,v 1.126 2005/11/18 15:14:35 lsmith Exp $ * @link http://pear.php.net/LiveUser */ @@ -399,32 +399,33 @@ * ), * 'authContainers' => array( * 'name' => array( - * 'type' => 'DB', - * 'loginTimeout' => 0, - * 'expireTime' => 3600, - * 'idleTime' => 1800, - * 'allowDuplicateHandles' => false, - * 'allowEmptyPasswords' => false, + * 'type' => 'auth container name', + * 'loginTimeout' => 'number of hours that must pass between two logins to be counted as a new login', + * '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' => &$_SERVER, - * 'keysToCheck' => array('HTTP_USER_AGENT') + * 'values' => 'reference to an array', + * 'keysToCheck' => 'array of keys to check in the array passed' * ), * ), * ), * 'permContainer' => array( - * 'type' => 'Complex', + * 'type' => 'perm container name', * 'storage' => array( - * 'MDB2' => array( - * 'dsn' => $dsn, - * 'prefix' => 'liveuser_' - * 'tables' => array(), - * 'fields' => array(), - * 'alias' => array(), - * 'force_seq' => true, + * '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', * ), * ), * ),