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_Complex_Admin.php DB_Medium.php DB_Simple.php XML_Simple.php

From: Date: Sun, 20 Apr 2003 19:46:18 +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_Complex_Admin.php DB_Medium.php DB_Simple.php XML_Simple.php
Groups: php.pear.cvs 
Request: Send a blank email to pear-cvs+get-9995@lists.php.net to get a copy of this message
arnaud Sun Apr 20 15:46:18 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_Complex_Admin.php DB_Medium.php DB_Simple.php XML_Simple.php Log: * heavy phpdoc fixes for phpdocumentor peardoc converter # generates good output, have to run some tests

Index: pear/Perm_LiveUser/LoginManager.php diff -u pear/Perm_LiveUser/LoginManager.php:1.80 pear/Perm_LiveUser/LoginManager.php:1.81 --- pear/Perm_LiveUser/LoginManager.php:1.80 Mon Apr 14 19:21:35 2003 +++ pear/Perm_LiveUser/LoginManager.php Sun Apr 20 15:46:17 2003 @@ -36,6 +36,7 @@ /**#@+ * Error related constants definition + * * @var integer */ define('LIVEUSER_ERROR', -1); @@ -49,7 +50,7 @@ /**#@-*/ /**#@+ - * Status is the current user. + * Status of the current user. */ define('LIVEUSER_AUTH_IDLED', -1); define('LIVEUSER_AUTH_EXPIRED', -2); @@ -91,8 +92,9 @@ * Bjoern Schotte, Kristian Koehntopp, Antonio Guerra * * @author Markus Wolff <wolff@21st.de> - * @version $Id: LoginManager.php,v 1.80 2003/04/14 23:21:35 krausbn Exp $ + * @version $Id: LoginManager.php,v 1.81 2003/04/20 19:46:17 arnaud Exp $ * @package LiveUser + * @category authentication */ class LoginManager extends PEAR { @@ -1207,4 +1209,4 @@ return isset($errorMessages[$value]) ? $errorMessages[$value] : $errorMessages[LIVEUSER_ERROR]; } } -?> \ No newline at end of file +?> Index: pear/Perm_LiveUser/Auth/Common.php diff -u pear/Perm_LiveUser/Auth/Common.php:1.19 pear/Perm_LiveUser/Auth/Common.php:1.20 --- pear/Perm_LiveUser/Auth/Common.php:1.19 Sun Mar 23 12:41:08 2003 +++ pear/Perm_LiveUser/Auth/Common.php Sun Apr 20 15:46:17 2003 @@ -1,22 +1,20 @@ <?php -/****************************************************************************** -LiveUser: A framework for authentication and authorization in PHP applications -Copyright (C) 2002-2003 Markus Wolff - -This library is free software; you can redistribute it and/or -modify it under the terms of the GNU Lesser General Public -License as published by the Free Software Foundation; either -version 2.1 of the License, or (at your option) any later version. - -This library is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. - -You should have received a copy of the GNU Lesser General Public -License along with this library; if not, write to the Free Software -Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -******************************************************************************/ +// LiveUser: A framework for authentication and authorization in PHP applications +// Copyright (C) 2002-2003 Markus Wolff +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA /** * Class LiveUser_Auth_Common @@ -33,7 +31,7 @@ * authorisation areas and rights * * @author Markus Wolff <wolff@21st.de> - * @version $Id: Common.php,v 1.19 2003/03/23 17:41:08 arnaud Exp $ + * @version $Id: Common.php,v 1.20 2003/04/20 19:46:17 arnaud Exp $ * @package LiveUser * @category authentication */ @@ -434,4 +432,4 @@ return $that; } } -?> \ No newline at end of file +?> Index: pear/Perm_LiveUser/Auth/Container/DB.php diff -u pear/Perm_LiveUser/Auth/Container/DB.php:1.24 pear/Perm_LiveUser/Auth/Container/DB.php:1.25 --- pear/Perm_LiveUser/Auth/Container/DB.php:1.24 Wed Apr 16 09:33:43 2003 +++ pear/Perm_LiveUser/Auth/Container/DB.php Sun Apr 20 15:46:17 2003 @@ -1,22 +1,27 @@ <?php -/****************************************************************************** -LiveUser: A framework for authentication and authorization in PHP applications -Copyright (C) 2002-2003 Markus Wolff - -This library is free software; you can redistribute it and/or -modify it under the terms of the GNU Lesser General Public -License as published by the Free Software Foundation; either -version 2.1 of the License, or (at your option) any later version. - -This library is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. - -You should have received a copy of the GNU Lesser General Public -License along with this library; if not, write to the Free Software -Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -******************************************************************************/ +// LiveUser: A framework for authentication and authorization in PHP applications +// Copyright (C) 2002-2003 Markus Wolff +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +/** + * DB container for Authentication + * + * @package LiveUser + * @category authentication + */ /** * Require parent class definition and PEAR::DB class. @@ -42,8 +47,9 @@ * 'allowDuplicateHandles' => 1); * * @author Markus Wolff <wolff@21st.de> - * @version $Id: DB.php,v 1.24 2003/04/16 13:33:43 krausbn Exp $ + * @version $Id: DB.php,v 1.25 2003/04/20 19:46:17 arnaud Exp $ * @package LiveUser + * @category authentication */ class LiveUser_Auth_Container_DB extends LiveUser_Auth_Common { @@ -305,5 +311,4 @@ } } - -?> \ No newline at end of file +?> Index: pear/Perm_LiveUser/Auth/Container/XML.php diff -u pear/Perm_LiveUser/Auth/Container/XML.php:1.2 pear/Perm_LiveUser/Auth/Container/XML.php:1.3 --- pear/Perm_LiveUser/Auth/Container/XML.php:1.2 Sun Mar 23 06:18:05 2003 +++ pear/Perm_LiveUser/Auth/Container/XML.php Sun Apr 20 15:46:17 2003 @@ -1,22 +1,27 @@ <?php -/****************************************************************************** -LiveUser: A framework for authentication and authorization in PHP applications -Copyright (C) 2002-2003 Markus Wolff - -This library is free software; you can redistribute it and/or -modify it under the terms of the GNU Lesser General Public -License as published by the Free Software Foundation; either -version 2.1 of the License, or (at your option) any later version. - -This library is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. - -You should have received a copy of the GNU Lesser General Public -License along with this library; if not, write to the Free Software -Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -******************************************************************************/ +// LiveUser: A framework for authentication and authorization in PHP applications +// Copyright (C) 2002-2003 Markus Wolff +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +/** + * XML driver for authentication + * + * @package LiveUser + * @category authentication + */ /** * Require parent class definition and XML::Tree class. @@ -31,8 +36,9 @@ * This is a XML backend driver for the LiveUser class. * * @author Björn Kraus <krausbn@php.net> - * @version $Id: XML.php,v 1.2 2003/03/23 11:18:05 arnaud Exp $ + * @version $Id: XML.php,v 1.3 2003/04/20 19:46:17 arnaud Exp $ * @package LiveUser + * @category authentication */ class LiveUser_Auth_Container_XML extends LiveUser_Auth_Common { @@ -53,7 +59,7 @@ /** * XML::Tree object of the user logged in. * @var object - * @access privat + * @access private * @see readUserData() */ var $userObj = null; @@ -290,5 +296,4 @@ return $success; } } - -?> \ No newline at end of file +?> Index: pear/Perm_LiveUser/Perm/Common.php diff -u pear/Perm_LiveUser/Perm/Common.php:1.16 pear/Perm_LiveUser/Perm/Common.php:1.17 --- pear/Perm_LiveUser/Perm/Common.php:1.16 Sun Apr 13 14:50:05 2003 +++ pear/Perm_LiveUser/Perm/Common.php Sun Apr 20 15:46:18 2003 @@ -17,9 +17,17 @@ // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA /** - * Constants + * Base class for permission handling + * + * @package LiveUser + * @category authentication + */ + +/**#@+ + * Usertypes + * + * @var integer */ -// Usertypes // lowest user type id define('LIVEUSER_ANONYMOUS_TYPE_ID', 0); // higest user type id @@ -30,12 +38,11 @@ define('LIVEUSER_SUPERADMIN_TYPE_ID', 4); // higest admin type id define('LIVEUSER_MASTERADMIN_TYPE_ID', 5); - // The higest possible right level define('LIVEUSER_MAX_LEVEL', 3); - // Define error codes: define('LIVEUSER_ERROR_NOT_CAPABLE', 0); +/**#@-*/ /** * Class LiveUser_Perm_Common @@ -47,8 +54,9 @@ * * @author Markus Wolff <wolff@21st.de> * @author Bjoern Kraus <krausbn@php.net> - * @version $Id: Common.php,v 1.16 2003/04/13 18:50:05 arnaud Exp $ + * @version $Id: Common.php,v 1.17 2003/04/20 19:46:18 arnaud Exp $ * @package LiveUser + * @category authentication */ class LiveUser_Perm_Common extends PEAR { @@ -175,7 +183,7 @@ * @return object a PEAR error object * * @access public - * @see PEAR_Error + * @see PEAR_Error */ function &raiseError($code = LIVEUSER_ERROR, $mode = null, $options = null, $userinfo = null) @@ -204,7 +212,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) { return($this->raiseError(LIVEUSER_NOT_SUPPORTED)); @@ -226,7 +234,7 @@ * * Prepares the object for being stored in a session (properly * disconnect from the database, free up resources). - **/ + */ function freeze() { return($this->raiseError(LIVEUSER_NOT_SUPPORTED)); @@ -272,7 +280,7 @@ * area names as the key of the 1st dimension. * Group rights and invididual rights are being merged * in the process. - **/ + */ function readRights() { return($this->raiseError(LIVEUSER_NOT_SUPPORTED)); @@ -289,7 +297,7 @@ * @param integer $right_id Id of the right within the AuthArea to check for. * @param integer $area_id Id of the AuthArea to use. * @return integer Level of the right. - **/ + */ function checkRight($right_id, $area_id) { $hasright = false; @@ -397,4 +405,4 @@ return $that; } } -?> \ No newline at end of file +?> Index: pear/Perm_LiveUser/Perm/Container/DB_Complex.php diff -u pear/Perm_LiveUser/Perm/Container/DB_Complex.php:1.26 pear/Perm_LiveUser/Perm/Container/DB_Complex.php:1.27 --- pear/Perm_LiveUser/Perm/Container/DB_Complex.php:1.26 Wed Apr 16 09:33:43 2003 +++ pear/Perm_LiveUser/Perm/Container/DB_Complex.php Sun Apr 20 15:46:18 2003 @@ -17,6 +17,13 @@ // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA /** + * DB_Complex container for permission handling + * + * @package LiveUser + * @category authentication + */ + +/** * Require parent class definition and PEAR::DB class. */ require_once 'LiveUser/Perm/Common.php'; @@ -40,8 +47,9 @@ * * @author Lukas Smith <smith@backendmedia.com> * @author Bjoern Kraus <krausbn@php.net> - * @version $Id: DB_Complex.php,v 1.26 2003/04/16 13:33:43 krausbn Exp $ + * @version $Id: DB_Complex.php,v 1.27 2003/04/20 19:46:18 arnaud Exp $ * @package LiveUser + * @category authentication */ class LiveUser_Perm_Container_DB_Complex extends LiveUser_Perm_Common { @@ -620,4 +628,4 @@ } } } -?> \ No newline at end of file +?> Index: pear/Perm_LiveUser/Perm/Container/DB_Complex_Admin.php diff -u pear/Perm_LiveUser/Perm/Container/DB_Complex_Admin.php:1.2 pear/Perm_LiveUser/Perm/Container/DB_Complex_Admin.php:1.3 --- pear/Perm_LiveUser/Perm/Container/DB_Complex_Admin.php:1.2 Thu Feb 27 17:49:17 2003 +++ pear/Perm_LiveUser/Perm/Container/DB_Complex_Admin.php Sun Apr 20 15:46:18 2003 @@ -1,22 +1,27 @@ <?php -/****************************************************************************** -LiveUser: A framework for authentication and authorization in PHP applications -Copyright (C) 2002-2003 Markus Wolff +// LiveUser: A framework for authentication and authorization in PHP applications +// Copyright (C) 2002-2003 Markus Wolff +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -This library is free software; you can redistribute it and/or -modify it under the terms of the GNU Lesser General Public -License as published by the Free Software Foundation; either -version 2.1 of the License, or (at your option) any later version. - -This library is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. - -You should have received a copy of the GNU Lesser General Public -License along with this library; if not, write to the Free Software -Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -******************************************************************************/ +/** + * DB_Complex administration class + * + * @package LiveUser + * @category authentication + */ /** * Require the parent class definition @@ -37,10 +42,12 @@ * Example: array("server" => "localhost", "user" => "root", * "password" => "pwd", "database" => "AllMyPreciousData") * - * @author Christian Dickmann <dickmann@php.net> - * @author Markus Wolff <wolff@21st.de> - * @version $Id: DB_Complex_Admin.php,v 1.2 2003/02/27 22:49:17 krausbn Exp $ - **/ + * @author Christian Dickmann <dickmann@php.net> + * @author Markus Wolff <wolff@21st.de> + * @version $Id: DB_Complex_Admin.php,v 1.3 2003/04/20 19:46:18 arnaud Exp $ + * @package LiveUser + * @category authentication + */ class LiveUser_Perm_Container_DB_Complex_Admin extends LiveUser_Perm_Container_DB_Complex { /** @@ -60,7 +67,7 @@ * * @access public * @return integer id of new group - **/ + */ function addGroup($names, $comments = array(), $owner_user = NULL, $owner_group = NULL, $active = false) { @@ -2259,4 +2266,4 @@ } // end func checkArea } -?> \ No newline at end of file +?> Index: pear/Perm_LiveUser/Perm/Container/DB_Medium.php diff -u pear/Perm_LiveUser/Perm/Container/DB_Medium.php:1.15 pear/Perm_LiveUser/Perm/Container/DB_Medium.php:1.16 --- pear/Perm_LiveUser/Perm/Container/DB_Medium.php:1.15 Wed Apr 16 09:33:43 2003 +++ pear/Perm_LiveUser/Perm/Container/DB_Medium.php Sun Apr 20 15:46:18 2003 @@ -17,6 +17,13 @@ // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA /** + * DB_Medium container for permission handling + * + * @package LiveUser + * @category authentication + */ + +/** * Require parent class definition and PEAR::DB class. */ require_once 'LiveUser/Perm/Common.php'; @@ -36,8 +43,9 @@ * - AuthAreas * * @author Arnaud Limbourg - * @version $Id: DB_Medium.php,v 1.15 2003/04/16 13:33:43 krausbn Exp $ + * @version $Id: DB_Medium.php,v 1.16 2003/04/20 19:46:18 arnaud Exp $ * @package LiveUser + * @category authentication */ class LiveUser_Perm_Container_DB_Medium extends LiveUser_Perm_Common { @@ -327,4 +335,4 @@ $this->LiveUser_Perm_Container_DB_Medium($connectOptions); } // end func unfreeze } // end class LiveUser_Perm_Container_DB_Medium -?> \ No newline at end of file +?> Index: pear/Perm_LiveUser/Perm/Container/DB_Simple.php diff -u pear/Perm_LiveUser/Perm/Container/DB_Simple.php:1.4 pear/Perm_LiveUser/Perm/Container/DB_Simple.php:1.5 --- pear/Perm_LiveUser/Perm/Container/DB_Simple.php:1.4 Sun Apr 13 14:30:25 2003 +++ pear/Perm_LiveUser/Perm/Container/DB_Simple.php Sun Apr 20 15:46:18 2003 @@ -17,6 +17,13 @@ // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA /** + * DB_Simple container for permission handling + * + * @package LiveUser + * @category authentication + */ + +/** * Require parent class definition and PEAR::DB class. */ require_once 'LiveUser/Perm/Common.php'; @@ -33,8 +40,9 @@ * - userrights * * @author Björn Kraus <krausbn@php.net> - * @version $Id: DB_Simple.php,v 1.4 2003/04/13 18:30:25 arnaud Exp $ + * @version $Id: DB_Simple.php,v 1.5 2003/04/20 19:46:18 arnaud Exp $ * @package LiveUser + * @category authentication */ class LiveUser_Perm_Container_DB_Simple extends LiveUser_Perm_Common { @@ -44,7 +52,7 @@ * * @var string * @access private - **/ + */ var $dsn = NULL; /** @@ -52,7 +60,7 @@ * * @var object * @access private - **/ + */ var $dbc = NULL; /** @@ -73,7 +81,7 @@ * * @var boolean * @access public - **/ + */ var $init_ok = false; /** @@ -202,4 +210,4 @@ $this->LiveUser_Perm_Container_DB_Simple($connectOptions); } // end func unfreeze } // end class LiveUser_Perm_Container_DB_Medium -?> \ No newline at end of file +?> Index: pear/Perm_LiveUser/Perm/Container/XML_Simple.php diff -u pear/Perm_LiveUser/Perm/Container/XML_Simple.php:1.3 pear/Perm_LiveUser/Perm/Container/XML_Simple.php:1.4 --- pear/Perm_LiveUser/Perm/Container/XML_Simple.php:1.3 Sun Apr 13 14:50:05 2003 +++ pear/Perm_LiveUser/Perm/Container/XML_Simple.php Sun Apr 20 15:46:18 2003 @@ -17,6 +17,13 @@ // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA /** + * XML_Simple permission handling container + * + * @package LiveUser + * @category authentication + */ + +/** * Require parent class definition and XML::Tree class. */ require_once 'LiveUser/Perm/Common.php'; @@ -33,8 +40,9 @@ * - userrights * * @author Björn Kraus <krausbn@php.net> - * @version $Id: XML_Simple.php,v 1.3 2003/04/13 18:50:05 arnaud Exp $ + * @version $Id: XML_Simple.php,v 1.4 2003/04/20 19:46:18 arnaud Exp $ * @package LiveUser + * @category authentication */ class LiveUser_Perm_Container_XML_Simple extends LiveUser_Perm_Common { @@ -213,4 +221,4 @@ $this->LiveUser_Perm_Container_XML_Simple($connectOptions); } // end func unfreeze } // end class LiveUser_Perm_Container_XML_Simple -?> \ No newline at end of file +?>
« previous php.pear.cvs (#9995) next »