cvs: pear /Perm_LiveUser LoginManager.php /Perm_LiveUser/Auth Common.php /Perm_LiveUser/Auth/Container DB.php XML.php /Perm_LiveUser/Perm
Common.php /Perm_LiveUser/Perm/Container DB_Complex.php DB_Medium.php DB_Simple.php XML_Simple.php

From: Date: Sun, 23 Mar 2003 11:18:06 +0000
Subject: cvs: pear /Perm_LiveUser LoginManager.php /Perm_LiveUser/Auth Common.php /Perm_LiveUser/Auth/Container DB.php XML.php /Perm_LiveUser/Perm
Common.php /Perm_LiveUser/Perm/Container DB_Complex.php DB_Medium.php DB_Simple.php XML_Simple.php
Groups: php.pear.cvs 
Request: Send a blank email to pear-cvs+get-9576@lists.php.net to get a copy of this message
arnaud Sun Mar 23 06:18:06 2003 EDT Modified files: /pear/Perm_LiveUser LoginManager.php /pear/Perm_LiveUser/Auth Common.php /pear/Perm_LiveUser/Auth/Container DB.php XML.php /pear/Perm_LiveUser/Perm Common.php /pear/Perm_LiveUser/Perm/Container DB_Complex.php DB_Medium.php DB_Simple.php XML_Simple.php Log: * phpdoc changes for phpdocumentor

Index: pear/Perm_LiveUser/LoginManager.php diff -u pear/Perm_LiveUser/LoginManager.php:1.67 pear/Perm_LiveUser/LoginManager.php:1.68 --- pear/Perm_LiveUser/LoginManager.php:1.67 Sat Mar 15 10:29:32 2003 +++ pear/Perm_LiveUser/LoginManager.php Sun Mar 23 06:18:05 2003 @@ -64,7 +64,8 @@ * Bjoern Schotte, Kristian Koehntopp, Antonio Guerra * * @author Markus Wolff <wolff@21st.de> - * @version $Id: LoginManager.php,v 1.67 2003/03/15 15:29:32 krausbn Exp $ + * @version $Id: LoginManager.php,v 1.68 2003/03/23 11:18:05 arnaud Exp $ + * @package LiveUser */ class LoginManager extends PEAR { @@ -1010,7 +1011,9 @@ /** * Class LiveUser * - * This class only used for error handling. + * This class only used for error handling and factory method. + * + * @package LiveUser */ class LiveUser { Index: pear/Perm_LiveUser/Auth/Common.php diff -u pear/Perm_LiveUser/Auth/Common.php:1.17 pear/Perm_LiveUser/Auth/Common.php:1.18 --- pear/Perm_LiveUser/Auth/Common.php:1.17 Sat Mar 22 11:20:15 2003 +++ pear/Perm_LiveUser/Auth/Common.php Sun Mar 23 06:18:05 2003 @@ -32,13 +32,15 @@ * - LiveUser admin GUI for easy user administration and setup of * authorisation areas and rights * - * @author Markus Wolff <wolff@21st.de> - * @version $Id: Common.php,v 1.17 2003/03/22 16:20:15 krausbn Exp $ + * @author Markus Wolff <wolff@21st.de> + * @version $Id: Common.php,v 1.18 2003/03/23 11:18:05 arnaud Exp $ + * @package LiveUser */ class LiveUser_Auth_Common extends PEAR { /** * The handle (username) of the current user + * * @var string */ var $handle = ''; @@ -46,12 +48,14 @@ /** * The password of the current user as given to the * login() method. + * * @var string */ var $passwd = ''; /** * Current user's database record id + * * @var integer */ var $authUserId = 0; @@ -63,6 +67,7 @@ * useful when you want your users to be activated by an * administrator before they can actually use your application. * Default: FALSE + * * @var boolean * @see $logged_in */ @@ -71,6 +76,7 @@ /** * Has the current user successfully logged in? * Default: FALSE + * * @var boolean * @see $is_active */ @@ -78,12 +84,14 @@ /** * Timestamp of last login (previous to currentLogin) + * * @var integer */ var $lastLogin = 0; /** * Timestamp of current login (last to be written) + * * @var integer */ var $currentLogin = 0; @@ -92,6 +100,7 @@ * Number of hours that must pass between two logins * to be counted as a new login. Comes in handy in * some situations. Default: 12 + * * @var integer */ var $loginTimeout = 12; @@ -118,12 +127,14 @@ /** * Allow multiple users in the database to have the same * login handle. Default: FALSE. + * * @var boolean */ var $allowDuplicateHandles = false; /** * Set posible encryption modes. + * * $var array */ var $encryptionModes = array('MD5' => 'MD5', @@ -132,6 +143,7 @@ /** * Defines the algorhythm used for encrypting/decrypting * passwords. Default: "MD5". + * * @var string */ var $passwordEncryptionMode = 'MD5'; @@ -140,6 +152,7 @@ * Defines the array index number of the LoginManager´s "backends" property. * Only used by the LoginManager for unfreeze()ing the session object * with the right connection data. + * * @var integer */ var $backendArrayIndex = 0; @@ -182,7 +195,7 @@ * input. Uses the algorhythm defined in the passwordEncryptionMode * property. * - * @param string $encryptedPW + * @param string $encryptedPW * @return string The decrypted password */ function decryptPW($encryptedPW) Index: pear/Perm_LiveUser/Auth/Container/DB.php diff -u pear/Perm_LiveUser/Auth/Container/DB.php:1.22 pear/Perm_LiveUser/Auth/Container/DB.php:1.23 --- pear/Perm_LiveUser/Auth/Container/DB.php:1.22 Sat Mar 22 05:55:22 2003 +++ pear/Perm_LiveUser/Auth/Container/DB.php Sun Mar 23 06:18:05 2003 @@ -41,8 +41,9 @@ * 'loginTimeout' => 0, * 'allowDuplicateHandles' => 1); * - * @author Markus Wolff <wolff@21st.de> - * @version $Id: DB.php,v 1.22 2003/03/22 10:55:22 krausbn Exp $ + * @author Markus Wolff <wolff@21st.de> + * @version $Id: DB.php,v 1.23 2003/03/23 11:18:05 arnaud Exp $ + * @package LiveUser */ class LiveUser_Auth_Container_DB extends LiveUser_Auth_Common { Index: pear/Perm_LiveUser/Auth/Container/XML.php diff -u pear/Perm_LiveUser/Auth/Container/XML.php:1.1 pear/Perm_LiveUser/Auth/Container/XML.php:1.2 --- pear/Perm_LiveUser/Auth/Container/XML.php:1.1 Thu Mar 13 09:38:26 2003 +++ pear/Perm_LiveUser/Auth/Container/XML.php Sun Mar 23 06:18:05 2003 @@ -30,8 +30,9 @@ * Description: * This is a XML backend driver for the LiveUser class. * - * @author Björn Kraus <krausbn@php.net> - * @version $Id: XML.php,v 1.1 2003/03/13 14:38:26 krausbn Exp $ + * @author Björn Kraus <krausbn@php.net> + * @version $Id: XML.php,v 1.2 2003/03/23 11:18:05 arnaud Exp $ + * @package LiveUser */ class LiveUser_Auth_Container_XML extends LiveUser_Auth_Common { Index: pear/Perm_LiveUser/Perm/Common.php diff -u pear/Perm_LiveUser/Perm/Common.php:1.14 pear/Perm_LiveUser/Perm/Common.php:1.15 --- pear/Perm_LiveUser/Perm/Common.php:1.14 Thu Mar 6 14:02:30 2003 +++ pear/Perm_LiveUser/Perm/Common.php Sun Mar 23 06:18:05 2003 @@ -45,9 +45,10 @@ * permission management system on live websites. All authorisation * backends/containers must be extensions of this base class. * - * @author Markus Wolff <wolff@21st.de> - * @author Bjoern Kraus <krausbn@php.net> - * @version $Id: Common.php,v 1.14 2003/03/06 19:02:30 arnaud Exp $ + * @author Markus Wolff <wolff@21st.de> + * @author Bjoern Kraus <krausbn@php.net> + * @version $Id: Common.php,v 1.15 2003/03/23 11:18:05 arnaud Exp $ + * @package LiveUser */ class LiveUser_Perm_Common extends PEAR { Index: pear/Perm_LiveUser/Perm/Container/DB_Complex.php diff -u pear/Perm_LiveUser/Perm/Container/DB_Complex.php:1.23 pear/Perm_LiveUser/Perm/Container/DB_Complex.php:1.24 --- pear/Perm_LiveUser/Perm/Container/DB_Complex.php:1.23 Sat Mar 22 05:55:22 2003 +++ pear/Perm_LiveUser/Perm/Container/DB_Complex.php Sun Mar 23 06:18:05 2003 @@ -40,10 +40,11 @@ * OR * &$conn (PEAR::DB connection object) * - * @author Lukas Smith <smith@backendmedia.com> - * @author Bjoern Kraus <krausbn@php.net> - * @version $Id: DB_Complex.php,v 1.23 2003/03/22 10:55:22 krausbn Exp $ - **/ + * @author Lukas Smith <smith@backendmedia.com> + * @author Bjoern Kraus <krausbn@php.net> + * @version $Id: DB_Complex.php,v 1.24 2003/03/23 11:18:05 arnaud Exp $ + * @package LiveUser + */ class LiveUser_Perm_Container_DB_Complex extends LiveUser_Perm_Common { /** @@ -52,7 +53,7 @@ * * @var string * @access private - **/ + */ var $dsn = NULL; /** @@ -60,7 +61,7 @@ * * @var object * @access private - **/ + */ var $dbc = NULL; /** @@ -80,7 +81,7 @@ * * @var boolean * @access public - **/ + */ var $init_ok = false; /** @@ -90,7 +91,7 @@ * * @param mixed $connectOptions Array or PEAR::DB object. * @return void - **/ + */ function &LiveUser_Perm_Container_DB_Complex(&$connectOptions) { if (DB::isConnection($connectOptions)) { @@ -119,7 +120,7 @@ * @access public * @param string $uid User id in the auth container. * @return boolean TRUE if init process was successfull else false. - **/ + */ function init($uid) { $success = TRUE; @@ -171,7 +172,7 @@ * @param mixed $connectOptions Array or PEAR::DB object. * @access public * @return void - **/ + */ function unfreeze(&$connectOptions) { // Call constructor again to setup the proper connection $this->LiveUser_Perm_Container_DB_Complex($connectOptions); @@ -185,7 +186,7 @@ * * @access public * @return void - **/ + */ function freeze() { // Open new connection if ($this->dsn) { @@ -204,7 +205,7 @@ * @access private * @see readRights() * @return void - **/ + */ function readUserRights() { $query = ' @@ -296,7 +297,7 @@ * @access private * @see readRights() * @return void - **/ + */ function readGroupRights() { $allRights = array(); @@ -397,7 +398,7 @@ * @access private * @see readRights() * @return void - **/ + */ function readGroups() { $query = ' @@ -466,7 +467,7 @@ * * @access private * @return void - **/ + */ function readRights() { $this->readUserRights(); @@ -544,7 +545,7 @@ * @param integer $owner_group_id Id of the group of the ressource for * which the right is requested. * @return boolean true if the level is sufficient to grant access else false. - **/ + */ function checkLevel($level, $owner_user_id, $owner_group_id) { $hasright = false; @@ -586,7 +587,7 @@ * which the right is requested. * @param integer $area_id Id of the AuthArea to use. * @return boolean true if the level is sufficient to grant access else false. - **/ + */ function checkRightLevel($right_id, $owner_user_id, $owner_group_id, $area_id) { $level = $this->checkRight($right_id, $area_id); @@ -620,7 +621,5 @@ return false; } } - } - ?> Index: pear/Perm_LiveUser/Perm/Container/DB_Medium.php diff -u pear/Perm_LiveUser/Perm/Container/DB_Medium.php:1.12 pear/Perm_LiveUser/Perm/Container/DB_Medium.php:1.13 --- pear/Perm_LiveUser/Perm/Container/DB_Medium.php:1.12 Sat Mar 22 05:55:22 2003 +++ pear/Perm_LiveUser/Perm/Container/DB_Medium.php Sun Mar 23 06:18:05 2003 @@ -38,7 +38,8 @@ * - AuthAreas * * @author Arnaud Limbourg - * @version $Id: DB_Medium.php,v 1.12 2003/03/22 10:55:22 krausbn Exp $ + * @version $Id: DB_Medium.php,v 1.13 2003/03/23 11:18:05 arnaud Exp $ + * @package LiveUser */ class LiveUser_Perm_Container_DB_Medium extends LiveUser_Perm_Common { Index: pear/Perm_LiveUser/Perm/Container/DB_Simple.php diff -u pear/Perm_LiveUser/Perm/Container/DB_Simple.php:1.2 pear/Perm_LiveUser/Perm/Container/DB_Simple.php:1.3 --- pear/Perm_LiveUser/Perm/Container/DB_Simple.php:1.2 Sat Mar 22 05:55:22 2003 +++ pear/Perm_LiveUser/Perm/Container/DB_Simple.php Sun Mar 23 06:18:05 2003 @@ -36,7 +36,8 @@ * - AuthAreas * * @author Björn Kraus <krausbn@php.net> - * @version $Id: DB_Simple.php,v 1.2 2003/03/22 10:55:22 krausbn Exp $ + * @version $Id: DB_Simple.php,v 1.3 2003/03/23 11:18:05 arnaud Exp $ + * @package LiveUser */ class LiveUser_Perm_Container_DB_Simple extends LiveUser_Perm_Common { @@ -44,7 +45,7 @@ * The DSN that was used to connect to the database (set only if no * existing connection object has been reused). * - * @var string + * @var string * @access private **/ var $dsn = NULL; @@ -52,7 +53,7 @@ /** * PEAR::DB connection object. * - * @var object + * @var object * @access private **/ var $dbc = NULL; @@ -60,7 +61,8 @@ /** * Table prefix * Prefix for all db tables the container has. - * @var string + * + * @var string * @access public */ var $prefix = 'liveuser_'; @@ -72,7 +74,7 @@ * identifies the backend to be used) is not of the required * type. * - * @var boolean + * @var boolean * @access public **/ var $init_ok = false; Index: pear/Perm_LiveUser/Perm/Container/XML_Simple.php diff -u pear/Perm_LiveUser/Perm/Container/XML_Simple.php:1.1 pear/Perm_LiveUser/Perm/Container/XML_Simple.php:1.2 --- pear/Perm_LiveUser/Perm/Container/XML_Simple.php:1.1 Thu Mar 13 19:01:12 2003 +++ pear/Perm_LiveUser/Perm/Container/XML_Simple.php Sun Mar 23 06:18:05 2003 @@ -36,7 +36,8 @@ * - AuthAreas * * @author Björn Kraus <krausbn@php.net> - * @version $Id: XML_Simple.php,v 1.1 2003/03/14 00:01:12 krausbn Exp $ + * @version $Id: XML_Simple.php,v 1.2 2003/03/23 11:18:05 arnaud Exp $ + * @package LiveUser */ class LiveUser_Perm_Container_XML_Simple extends LiveUser_Perm_Common { @@ -49,16 +50,18 @@ /** * XML::Tree object. - * @var object + * + * @var object * @access private */ var $tree = null; /** * XML::Tree object of the user logged in. - * @var object - * @access privat - * @see readUserData() + * + * @var object + * @access private + * @see readUserData() */ var $userObj = null; @@ -69,7 +72,7 @@ * identifies the backend to be used) is not of the required * type. * - * @var boolean + * @var boolean * @access public **/ var $init_ok = false;
« previous php.pear.cvs (#9576) next »