Docs For Class UserAuthenticate

Description

DO NOT USE THIS CLASS ANY LONGER, IT WILL BE REMOVED IN ONE OF THE NEXT VERSIONS!

Use Authenticator instead:

 $services = ServiceFactory::get();
 $auth = $services->getAuthenticator();
 $principal = $auth->authenticate(name,password);

version: $Id: UserAuthenticate.php,v 1.5 2006/11/26 22:04:22 kpapst Exp $
copyright: Copyright (C) 2002-2006 Kevin Papst
author: Kevin Papst
license: GNU Public License
deprecated:

Method Summary

UserAuthenticate UserAuthenticate (String $username, String $pass)

int getID ()

int getLanguageID ()

boolean isActive ()

boolean isAnonymous ()

boolean isValidUser ()

Methods

Constructor UserAuthenticate (line 61)

Identifies a User in BIGACE by comapring Username/Password against the existing User Data.

This Object will treat the User as a anonymous (all+) User if name or password is empty, being sure that a User cannot have an empty password.

UserAuthenticate UserAuthenticate (String $username, String $pass)

String $username: the Username within BIGACE
String $pass: the Password for that User

getID (line 117)

Gets the User ID.

return: the User ID in BIGACE

int getID ()

getLanguageID (line 131)

Fetches the users language ID.

return: the language ID

int getLanguageID ()

isActive (line 102)

Gets the Users status within BIGACE, if false the User will not be able to LOG IN or handle any other thing in BIGACE. This is useful if you want to keep all Right Information and personal data but don't let the user work for now.

If User is not known it will return the same as

isValidUser()

.

return: the Users status for BIGACE

boolean isActive ()

isAnonymous (line 85)

Gets the Information if user is anonymous.

return: if User is anonymous

boolean isAnonymous ()

isValidUser (line 75)

Shows if the User is registered within BIGACE.

It returns true even if the Users status is inactive!

return: true if user is known, else false

boolean isValidUser ()