Docs For Class Principal

Description

This Interface represents a Principal.

You can fetch an instance for example by calling:

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

author: Kevin Papst
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

Direct descendents

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

Method Summary

Principal Principal ()

String getEmail ()

mixed getID ()

mixed getLanguageID ()

String getName ()

boolean isActive ()

boolean isAnonymous ()

boolean isSuperUser ()

Methods

Constructor Principal (line 45)

Principal Principal ()

getEmail (line 112)

Returns the Users email.

return: the Users email adress or null

String getEmail ()

Redefined in descendants as:

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

getID (line 85)

Returns the Principal ID.

return: the unqiue ID identifying the Principal

mixed getID ()

Redefined in descendants as:

DefaultPrincipal::getID() : Gets the Users ID

getLanguageID (line 103)

Gets the Language ID for this Principal.

return: the language ID

mixed getLanguageID ()

Redefined in descendants as:

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

getName (line 94)

Gets the Principal name.

return: the Principal Name

String getName ()

Redefined in descendants as:

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

isActive (line 76)

Gets the Users status.

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

return: value for the Principal status.

boolean isActive ()

Redefined in descendants as:

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

isAnonymous (line 54)

Returns whether the User is anonymous or not.

return: true if User is anonymous

boolean isAnonymous ()

Redefined in descendants as:

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

isSuperUser (line 65)

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.

return: true if the Principal is a Super User

boolean isSuperUser ()

Redefined in descendants as:

DefaultPrincipal::isSuperUser()