Docs For Class AuthorizationUser

Description

A user that might request access to resources

Implementations of this class represent users in the phpSATk authorization subsystem. Each AuthenticationBackend has to provide a implementation of this class.

abstract:

Located in /phpsatk-lib/global/org.eenterphace.sat.authorization/authorization.user.php (line 37)

Direct descendents

Class	Description
AuthorizationUserGuest	User object for not authenticated users
AuthorizationUserDummy	A dummy user which has access to everything
AuthorizationUserRDBMS	AuthorizationUser implementation for users stored in RDBMS
AuthorizationUserLDAP	AuthorizationUser implementation for users stored in LDAP

Variable Summary

array[int] $rolecache

string $uname

Method Summary

AuthorizationUser __construct (string $uname)

array[int] getPrimaryRoles ()

void getUID ()

string getUname ()

Variables

array[int] $rolecache (line 51)

Cache for primary role IDs

access: protected

string $uname (line 44)

Username

access: protected

Methods

Constructor __construct (line 63)

Initializes the user object using a username

The username will come from the AuthenticationFrontend used. You will have to extend this and provide a roleid if you want to use role based access control.

access: public

AuthorizationUser __construct (string $uname)

string $uname: Username

Redefined in descendants as:

AuthorizationUserGuest::__construct() : Initializes the user object
AuthorizationUserRDBMS::__construct() : Loads the user data from the database
AuthorizationUserLDAP::__construct() : Loads the user data from the database

getPrimaryRoles (line 91)

Fetches a AuthorizationRole object for the user's primary role

This objects is cached per request.

access: public

array[int] getPrimaryRoles ()

Redefined in descendants as:

AuthorizationUserGuest::getPrimaryRoles()

getUID (line 82)

Returns the users UID

The base implementation does not know about UIDs, backend specific implementatiosn have to handle this.

abstract:

void getUID ()

Redefined in descendants as:

AuthorizationUserGuest::getUID() : Will return a UID of -1
AuthorizationUserDummy::getUID() : Returns a UID of 0
AuthorizationUserRDBMS::getUID() : Gets this users uid
AuthorizationUserLDAP::getUID()

getUname (line 72)

Gets the users username

access: public

string getUname ()