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

Class: UserAuthenticate

Source Location: /CORE/system/classes/user/UserAuthenticate.php

Class UserAuthenticate

Class Overview

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);

Located in /CORE/system/classes/user/UserAuthenticate.php [line 46]

Author(s):

Kevin Papst

API Tags:

Deprecated:

Information Tags:

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

Methods

[ Top ]

Method Summary

UserAuthenticate	UserAuthenticate()	Identifies a User in BIGACE by comapring Username/Password against the existing User Data.
int	getID()	Gets the User ID.
int	getLanguageID()	Fetches the users language ID.
boolean	isActive()	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.
boolean	isAnonymous()	Gets the Information if user is anonymous.
boolean	isValidUser()	Shows if the User is registered within BIGACE.

[ Top ]

Methods

Constructor UserAuthenticate [line 61]

UserAuthenticate UserAuthenticate(
String
$username, String
$pass 
)

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.

Parameters:

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

[ Top ]

getID [line 117]

int getID(
)

Gets the User ID.

API Tags:

Return:

the User ID in BIGACE

[ Top ]

getLanguageID [line 131]

int getLanguageID(
)

Fetches the users language ID.

API Tags:

Return:

the language ID

[ Top ]

isActive [line 102]

boolean isActive(
)

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()

API Tags:

Return:

the Users status for BIGACE

[ Top ]

isAnonymous [line 85]

boolean isAnonymous(
)

Gets the Information if user is anonymous.

API Tags:

Return:

if User is anonymous

[ Top ]

isValidUser [line 75]

boolean isValidUser(
)

Shows if the User is registered within BIGACE.

It returns true even if the Users status is inactive!

API Tags:

Return:

true if user is known, else false

[ Top ]