Docs For Class AuthorizationACLEntry

Description

An ACL Entry

This is the base class for acl entries. Each implementation of this class must provide a unique type and a table in the auth.rdbms.db database which contains the implementation specific data (and a aclid column). You will also want to add a xdo providing the virtual sat.aclentry.<type> for modifiying this information.

abstract:

Located in /phpsatk-lib/global/org.eenterphace.sat.authorization/authorization.acl.entry.php (line 39)

Direct descendents

Class	Description
AuthorizationACLEntryApplication	ACL type for Application resources
AuthorizationACLEntryDataObject	ACL Entry for dataobject access

Method Summary

AuthorizationACLEntry __construct (int $aclid, boolean $policy, int $gspec, string $type)

int getGlobalSpecificity ()

boolean getPolicy ()

mixed getProperty (string $name)

int getSpecificity ()

mixed __get (string $name)

Methods

Constructor __construct (line 87)

Initialized the acl entry

Fetches the acl entry implementation data. Each column in the database (for the given acl id) will be available as property.

access: public

AuthorizationACLEntry __construct (int $aclid, boolean $policy, int $gspec, string $type)

int $aclid: ACL ID
boolean $policy: Policy (Allow/Deny)
int $gspec: Global specificity
string $type: ACL entry type

getGlobalSpecificity (line 161)

Gets the global sepcificity of the rule.

Global specificity is calculated using the distance of the role this entry applies to and the actual role the user has. Is zero if its a per user acl entry.

A lower value means are more specific match.

access: public

int getGlobalSpecificity ()

getPolicy (line 172)

Gets the policy

Returns whether to allow or deny access when this entry is the best match.

access: public

boolean getPolicy ()

getProperty (line 133)

Get a implementation property

access: public

mixed getProperty (string $name)

string $name: Property name

getSpecificity (line 149)

Gets the (local) specificity of this rule.

This is used to determine which acl entries are possibly better/more specific. Must be higher for entries that are more specific and lower for entries less specific. The actual value does not matter.

access: public
abstract:

int getSpecificity ()

Redefined in descendants as:

AuthorizationACLEntryApplication::getSpecificity() : Calculates the specifity/quality of the entry
AuthorizationACLEntryDataObject::getSpecificity() : Gets the local specificity of the rule

__get (line 123)

Overloaded access to implementation properties

access: public

mixed __get (string $name)

string $name: Property name (same as fieldname in database)