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

Class: UserInfo

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

Class UserInfo

Class Overview

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

Use PrincipalService instead:

$services = ServiceFactory::get();
$principalService = $services->getPrincipalService();
$principal = $principalService->lookupByID($userID);

Located in /CORE/system/classes/user/UserInfo.php [line 44]

Author(s):

Kevin Papst

API Tags:

Deprecated:

Information Tags:

Version:	$Id: UserInfo.php,v 1.8 2007/04/24 16:35:53 kpapst Exp $
Copyright:	Copyright (C) 2002-2006 Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Method Summary

UserInfo	UserInfo()	Initializes the Object with the User by the given ID
int	getActiveStatusID()	Gets the Status ID as it is hold in the DB
int	getCID()	Fetches the users consumer ID.
void	getID()
int	getLanguageID()	Gets the Language ID for this User.
String	getName()	Gets the User name.
int	getUserID()	Gets the Users ID
boolean	isActive()	Gets the Users status within BIGACE.
boolean	isAnonymous()	Gets the Information if user is anonymous.
void	isSuperUser()
boolean	isValidUser()	This shows if the User is registered within BIGACE.

[ Top ]

Methods

Constructor UserInfo [line 60]

UserInfo UserInfo(
int
$id 
)

Initializes the Object with the User by the given ID

Parameters:

int

$id:

the User ID

[ Top ]

getActiveStatusID [line 131]

int getActiveStatusID(
)

Gets the Status ID as it is hold in the DB

API Tags:

Return:

the Status ID for the initialized User

[ Top ]

getCID [line 172]

int getCID(
)

Fetches the users consumer ID.

API Tags:

Return:

the consumer ID

[ Top ]

getID [line 145]

void getID(
)

[ Top ]

getLanguageID [line 163]

int getLanguageID(
)

Gets the Language ID for this User.

API Tags:

Return:

the language ID

[ Top ]

getName [line 154]

String getName(
)

Gets the User name.

API Tags:

Return:

the Username in BIGACE

[ Top ]

getUserID [line 141]

int getUserID(
)

Gets the Users ID

API Tags:

Return:

the Users ID

[ Top ]

isActive [line 116]

boolean isActive(
)

Gets the Users status within BIGACE.

If User is not known it will return the same as isValidUser().

API Tags:

Return:

value for the Users status.

[ Top ]

isAnonymous [line 95]

boolean isAnonymous(
)

Gets the Information if user is anonymous.

API Tags:

Return:

if User is anonymous

[ Top ]

isSuperUser [line 102]

void isSuperUser(
)

[ Top ]

isValidUser [line 85]

boolean isValidUser(
)

This 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

[ Top ]