[class tree: bigace-api] [index: bigace-api] [all elements]

Class: Authenticator

Source Location: /CORE/system/api/authentication/Authenticator.php

Class Authenticator

Class Overview

The Authenticator Interface defines methods that must be implemented to check Principals and perform the Login comand.

Receive an Authenticator instance by calling:

Author(s):

Information Tags:

Version:	$Id: Authenticator.php,v 1.3 2008/08/19 00:08:01 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

[ Top ]

Descendants

Child Class	Description
DefaultAuthenticator	The DefaultAuthenticator uses the internal User Management Database.

[ Top ]

Method Summary

Authenticator	Authenticator()
mixed	authenticate()	This performs an Authentication check.
string	createHash()	Creates a hash to be used as password.

[ Top ]

Methods

Constructor Authenticator [line 51]

Authenticator Authenticator(
)

[ Top ]

authenticate [line 65]

mixed authenticate(

$name, 
$password 
)

This performs an Authentication check.

This returns

if authentication was correct, otherwise one of the listed Flags will be returned.

The currently returned Flags are:

Parameters:

	$name:
	$password:

API Tags:

Return:

the Flag o a Principal is returned

Redefined in descendants as:

DefaultAuthenticator::authenticate() : Performs a Login against the internal User Database.

[ Top ]

createHash [line 76]

string createHash(
string
$password 
)

Creates a hash to be used as password.

Do not store or query plain text values, always use encrypted data!

Parameters:

string

$password:

API Tags:

Return:

the hashed password

[ Top ]