Class Auth_gollem

Description

The Auth_gollem:: class provides a Gollem implementation of the Horde authentication system.

Required parameters:

   None.

Optional parameters:

   None.

$Horde: gollem/lib/Auth/gollem.php,v 1.18.2.7 2009/01/06 15:23:54 jan Exp $

Copyright 2004-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /lib/Auth/gollem.php (line 22)

Auth
   |
   --Auth_gollem
Method Summary
 boolean authenticate ([string $userID = null], [array $credentials = array()], [boolean $login = false])
 void gollemSetAuthErrorMsg (string $msg)
Methods
authenticate (line 36)

Find out if a set of login credentials are valid, and if requested, mark the user as logged in in the current session.

  • return: Whether or not the credentials are valid.
boolean authenticate ([string $userID = null], [array $credentials = array()], [boolean $login = false])
  • string $userID: The userID to check.
  • array $credentials: The credentials to check.
  • boolean $login: Whether to log the user in. If false, we'll only test the credentials and won't modify the current session.
gollemSetAuthErrorMsg (line 124)

Somewhat of a hack to allow Gollem to set an authentication error message that may occur outside of this file.

void gollemSetAuthErrorMsg (string $msg)
  • string $msg: The error message to set.

Documentation generated on Sun, 30 Jan 2011 05:24:44 +0000 by phpDocumentor 1.4.3