Docs For Class mamboAuthenticator

Description

Authenticator class file for Mambo

author: Mambo Foundation Inc see README.php
copyright: Mambo Foundation Inc. See COPYRIGHT.php for copyright notices and details.
filesource: Source Code for this file
license: GNU/GPL, see LICENSE.php Mambo is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.

Located in /includes/authenticator.php (line 16)

Method Summary

void authenticateUser ( &$message, $username, $passwd, [ $remember = null], [ $session = null])

void clearSession ([ $session = null])

void &getInstance ()

void &loginAdmin ( $acl)

void loginUser ([ $username = null], [ $passwd = null], [ $remember = null])

void logoutUser ()

password mosMakePassword ()

Methods

authenticateUser (line 76)

User authentication function

Username and encoded password are checked against the database.

void authenticateUser ( &$message, $username, $passwd, [ $remember = null], [ $session = null])

&$message
$username
$passwd
$remember
$session

clearSession (line 124)

void clearSession ([ $session = null])

$session

getInstance (line 18)

void &getInstance ()

loginAdmin (line 158)

void &loginAdmin ( $acl)

$acl

loginUser (line 34)

Login management function

The current session is passed. Username and encoded password is authenticated. A successful authentication updates the current session record with the users details.

void loginUser ([ $username = null], [ $passwd = null], [ $remember = null])

$username
$passwd
$remember

logoutUser (line 147)

User logout

Reverts the current session record back to 'anonymous' parameters

void logoutUser ()

mosMakePassword (line 215)

Random password generator

password mosMakePassword ()