Peter M. Groen / knowledgetree

Commit 66b38e06a3a4e17350efc1145c8dd6d3587db8fb

Authored by Michael Joseph
1 parent 19488eb4

updated phpdocs 

- @author
- @package
- @params


git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@362 c91229c3-7414-0410-bfa2-8a42b809f60b
Inline Side-by-side
Showing 2 changed files with 12 additions and 20 deletions
lib/authentication/Authenticator.inc
  View file @66b38e0
1 1 <?php
2 2  
3   -//require_once("$default->owl_fs_root/lib/administration/UserManager.inc");
4   -
5 3 /**
6 4 * $Id$
7 5 *
... ... @@ -10,16 +8,16 @@
10 8 * Licensed under the GNU GPL. For full terms see the file COPYING.
11 9 *
12 10 * @version $Revision$
13   - * @author <a href="mailto:michael@jamwarehouse.com">Michael Joseph</a>, Jam Warehouse (Pty) Ltd, South Africa
14   - * @package dmslib
  11 + * @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
  12 + * @package lib.authentication
15 13 */
16 14 class Authenticator {
17 15  
18 16 /**
19 17 * Verifies the login credentials
20 18 *
21   - * @param userName the user name of the user logging in
22   - * @param password the user's password
  19 + * @param string the user name of the user logging in
  20 + * @param string the user's password
23 21 * @return array containing userID and authentication status code
24 22 */
25 23 function login($userName, $password) {
... ... @@ -71,10 +69,8 @@ class Authenticator {
71 69 /**
72 70 * Logs the user out of the application
73 71 *
74   - * @param userID
75   - * the ID of user logging out
76   - * @param sessionID
77   - * the user's sessionID
  72 + * @param int the ID of user logging out
  73 + * @param string the user's sessionID
78 74 */
79 75 function logout($userID, $sessionID) {
80 76 // remove session from db
... ... @@ -84,10 +80,8 @@ class Authenticator {
84 80 /**
85 81 * [Abstract] Checks the user's password
86 82 *
87   - * @param $userName
88   - * the name of the user to check
89   - * @param $password
90   - * the password to check
  83 + * @param string the name of the user to check
  84 + * @param string the password to check
91 85 * @return boolean true if the password is correct, else false
92 86 */
93 87 function checkPassword($userName, $password) {
... ...
lib/authentication/DBAuthenticator.inc
  View file @66b38e0
... ... @@ -8,8 +8,8 @@ require_once(&quot;$default-&gt;owl_fs_root/lib/authentication/Authenticator.inc&quot;);
8 8 * Perform authentication tasks against the database.
9 9 *
10 10 * @version $Revision$
11   - * @author <a href="mailto:michael@jamwarehouse.com">Michael Joseph</a>, Jam Warehouse (Pty) Ltd, South Africa
12   - * @package dmslib
  11 + * @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
  12 + * @package lib.authentication
13 13 */
14 14  
15 15 class DBAuthenticator extends Authenticator {
... ... @@ -17,10 +17,8 @@ class DBAuthenticator extends Authenticator {
17 17 /**
18 18 * Checks the user's password against the database
19 19 *
20   - * @param $userName
21   - * the name of the user to check
22   - * @param $password
23   - * the password to check
  20 + * @param string the name of the user to check
  21 + * @param string the password to check
24 22 * @return boolean true if the password is correct, else false
25 23 */
26 24 function checkPassword($userName, $password) {
... ...