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

Class: DefaultPrincipal

Source Location: /CORE/system/classes/principal/DefaultPrincipal.php

Class DefaultPrincipal

Class Overview

This represents a Principal within the internal User Database.

Located in /CORE/system/classes/principal/DefaultPrincipal.php [line 37]

Principal
   |
   --DefaultPrincipal

Author(s):

Kevin Papst

Information Tags:

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

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Principal

Principal::Principal()

Principal::getEmail()

Returns the Users email.

Principal::getID()

Returns the Principal ID.

Principal::getLanguageID()

Gets the Language ID for this Principal.

Principal::getName()

Gets the Principal name.

Principal::isActive()

Gets the Users status.

Principal::isAnonymous()

Returns whether the User is anonymous or not.

Principal::isSuperUser()

Returns whether the User is Super User or not.

[ Top ]

Method Summary

DefaultPrincipal	DefaultPrincipal()	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.
String	getEmail()	Returns the Users email adress.
int	getID()	Gets the Users ID
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 DefaultPrincipal [line 53]

DefaultPrincipal DefaultPrincipal(
int
$id 
)

Initializes the Object with the User by the given ID

Parameters:

int

$id:

the User ID

[ Top ]

getActiveStatusID [line 123]

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 175]

int getCID(
)

Fetches the users consumer ID.

API Tags:

Return:

the consumer ID

[ Top ]

getEmail [line 132]

String getEmail(
)

Returns the Users email adress.

API Tags:

Return:

the users email

Redefinition of:

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

[ Top ]

getID [line 148]

int getID(
)

Gets the Users ID

API Tags:

Return:

the Users ID

Redefinition of:

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

[ Top ]

getLanguageID [line 166]

int getLanguageID(
)

Gets the Language ID for this User.

API Tags:

Return:

the language ID

Redefinition of:

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

[ Top ]

getName [line 157]

String getName(
)

Gets the User name.

API Tags:

Return:

the Username in BIGACE

Redefinition of:

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

[ Top ]

getUserID [line 140]

int getUserID(
)

Gets the Users ID

API Tags:

Return:

the Users ID

[ Top ]

isActive [line 108]

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.

Redefinition of:

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

[ Top ]

isAnonymous [line 87]

boolean isAnonymous(
)

Gets the Information if user is anonymous.

API Tags:

Return:

if User is anonymous

Redefinition of:

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

[ Top ]

isSuperUser [line 94]

void isSuperUser(
)

Redefinition of:

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

[ Top ]

isValidUser [line 77]

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 ]