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

Class: Principal

Source Location: /CORE/system/api/principal/Principal.php

Class Principal

Class Overview

This Interface represents a Principal.

You can fetch an instance for example by calling:

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

Located in /CORE/system/api/principal/Principal.php [line 42]

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: Principal.php,v 1.3 2007/12/27 21:38:59 kpapst Exp $
Copyright:	Copyright (C) 2002-2006 Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Descendants

Child Class	Description
DefaultPrincipal	This represents a Principal within the internal User Database.

[ Top ]

Method Summary

Principal	Principal()
String	getEmail()	Returns the Users email.
mixed	getID()	Returns the Principal ID.
mixed	getLanguageID()	Gets the Language ID for this Principal.
String	getName()	Gets the Principal name.
boolean	isActive()	Gets the Users status.
boolean	isAnonymous()	Returns whether the User is anonymous or not.
boolean	isSuperUser()	Returns whether the User is Super User or not.

[ Top ]

Methods

Constructor Principal [line 45]

Principal Principal(
)

[ Top ]

getEmail [line 112]

String getEmail(
)

Returns the Users email.

API Tags:

Return:

the Users email adress or null

Redefined in descendants as:

DefaultPrincipal::getEmail() : Returns the Users email adress.

[ Top ]

getID [line 85]

mixed getID(
)

Returns the Principal ID.

API Tags:

Return:

the unqiue ID identifying the Principal

Redefined in descendants as:

DefaultPrincipal::getID() : Gets the Users ID

[ Top ]

getLanguageID [line 103]

mixed getLanguageID(
)

Gets the Language ID for this Principal.

API Tags:

Return:

the language ID

Redefined in descendants as:

DefaultPrincipal::getLanguageID() : Gets the Language ID for this User.

[ Top ]

getName [line 94]

String getName(
)

Gets the Principal name.

API Tags:

Return:

the Principal Name

Redefined in descendants as:

DefaultPrincipal::getName() : Gets the User name.

[ Top ]

isActive [line 76]

boolean isActive(
)

Gets the Users status.

Returns if the Principal is active or not. Deactivated Principaly can not log in.

API Tags:

Return:

value for the Principal status.

Redefined in descendants as:

DefaultPrincipal::isActive() : Gets the Users status within BIGACE.

[ Top ]

isAnonymous [line 54]

boolean isAnonymous(
)

Returns whether the User is anonymous or not.

API Tags:

Return:

true if User is anonymous

Redefined in descendants as:

DefaultPrincipal::isAnonymous() : Gets the Information if user is anonymous.

[ Top ]

isSuperUser [line 65]

boolean isSuperUser(
)

Returns whether the User is Super User or not.

For a Super User Permissions will NOT be checked. A Super User therefor has even more rights than a normal Administrator.

API Tags:

Return:

true if the Principal is a Super User

Redefined in descendants as:

DefaultPrincipal::isSuperUser()

[ Top ]