Docs For Class DefaultPrincipal

Description

This represents a Principal within the internal User Database.

author: Kevin Papst
version: $Id: DefaultPrincipal.php,v 1.4 2007/12/27 21:39:51 kpapst Exp $
copyright: Copyright (C) 2002-2006 Kevin Papst
license: GNU Public License

Principal
   |
   --DefaultPrincipal

Method Summary

DefaultPrincipal DefaultPrincipal (int $id)

int getActiveStatusID ()

int getCID ()

String getEmail ()

int getID ()

int getLanguageID ()

String getName ()

int getUserID ()

boolean isActive ()

boolean isAnonymous ()

void isSuperUser ()

boolean isValidUser ()

Methods

Constructor DefaultPrincipal (line 53)

Initializes the Object with the User by the given ID

DefaultPrincipal DefaultPrincipal (int $id)

int $id: the User ID

getActiveStatusID (line 123)

Gets the Status ID as it is hold in the DB

return: the Status ID for the initialized User

int getActiveStatusID ()

getCID (line 175)

Fetches the users consumer ID.

return: the consumer ID

int getCID ()

getEmail (line 132)

Returns the Users email adress.

return: the users email

String getEmail ()

Redefinition of:

Principal::getEmail(): Returns the Users email.

getID (line 148)

Gets the Users ID

return: the Users ID

int getID ()

Redefinition of:

Principal::getID(): Returns the Principal ID.

getLanguageID (line 166)

Gets the Language ID for this User.

return: the language ID

int getLanguageID ()

Redefinition of:

Principal::getLanguageID(): Gets the Language ID for this Principal.

getName (line 157)

Gets the User name.

return: the Username in BIGACE

String getName ()

Redefinition of:

Principal::getName(): Gets the Principal name.

getUserID (line 140)

Gets the Users ID

return: the Users ID

int getUserID ()

isActive (line 108)

Gets the Users status within BIGACE.

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

return: value for the Users status.

boolean isActive ()

Redefinition of:

Principal::isActive(): Gets the Users status.

isAnonymous (line 87)

Gets the Information if user is anonymous.

return: if User is anonymous

boolean isAnonymous ()

Redefinition of:

Principal::isAnonymous(): Returns whether the User is anonymous or not.

isSuperUser (line 94)

void isSuperUser ()

Redefinition of:

Principal::isSuperUser(): Returns whether the User is Super User or not.

isValidUser (line 77)

This shows if the User is registered within BIGACE.

It returns true even if the Users status is inactive!

return: true if user is known

boolean isValidUser ()

Inherited Methods

Inherited From Principal

Principal::Principal()
Principal::getEmail()
Principal::getID()
Principal::getLanguageID()
Principal::getName()
Principal::isActive()
Principal::isAnonymous()
Principal::isSuperUser()