CWIS Developer Documentation

- Home
- Main Page
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Public Attributes | List of all members
PrivilegeSet Class Reference

Set of privileges used to access resource information or other parts of the system. More...

## Public Member Functions
| __construct ($Data=NULL)
| Class constructor, used to create a new set or reload an existing set from previously-constructed data. More...
| Data ($NewValue=NULL)
| Get/set privilege set data, in the form of an opaque string. More...
| IsGreaterThan (PrivilegeSet $Set, $Resource=self::NO_RESOURCE)
| Check whether a privilege set is greater than or equal to another privilege set. More...
| IsLessThan (PrivilegeSet $Set, Resource $Resource=NULL)
| Check whether a privilege set is less than another privilege set. More...
| AddPrivilege ($Privilege)
| Add specified privilege to set. More...
| RemovePrivilege ($Privilege)
| Remove specified privilege from set. More...
| IncludesPrivilege ($Privilege)
| Check whether this privilege set includes the specified privilege. More...
| GetPrivilegeInfo ()
| Get privilege information as an array, with numerical indexes except for the logic, which is contained in a element with the index "Logic". More...
| GetPrivilegeList ()
| Get list of privileges. More...
| AddCondition ($Field, $Value=NULL, $Operator="==")
| Add condition to privilege set. More...
| RemoveCondition (MetadataField $Field, $Value=NULL, $Operator="==")
| Remove condition from privilege set. More...
| AddSet (PrivilegeSet $Set)
| Add subgroup of privileges/conditions to set. More...
| AllRequired ($NewValue=NULL)
| Get/set whether all privileges/conditions in set are required (i.e. More...
| AssociatedUserId ($NewValue=NULL)
| Get/set ID of user associated with privilege set. More...

## Public Attributes
const | NO_RESOURCE = "XXX NO RESOURCE XXX"

## Detailed Description

Set of privileges used to access resource information or other parts of the system.

A privilege set is a combination of privileges (integers), MetadataFields (to check against a specified value), and privilege/MetadataField combinations.

Definition at line 16 of file PrivilegeSet.php.

## Constructor & Destructor Documentation

PrivilegeSet::__construct | ( |  | $Data = `NULL` | ) |

Class constructor, used to create a new set or reload an existing set from previously-constructed data.

Parameters

  string | $Data | Existing privilege set data, previously retrieved with PrivilegeSet::Data(). (OPTIONAL)

See Also
  PrivilegeSet::Data()

Definition at line 25 of file PrivilegeSet.php.

## Member Function Documentation

PrivilegeSet::AddCondition | ( |  | $Field,
|  |  | $Value = `NULL`,
|  |  | $Operator = `"=="`
| ) |  |

Add condition to privilege set.

If the condition is already present in the set, no action is taken.

Parameters

  mixed | $Field | Metadata field object or ID to test against.
  mixed | $Value | Value to test against. (Specify NULL for User fields to test against current user and for Date/Timestamp fields to test against the current date and time.)
  string | $Operator | String containing operator to used for condition. (Standard PHP operators are used.) (OPTIONAL, defaults to "==")

Returns
  bool TRUE if condition was added, otherwise FALSE.

Definition at line 252 of file PrivilegeSet.php.

PrivilegeSet::AddPrivilege | ( |  | $Privilege | ) |

Add specified privilege to set.

If specified privilege is already part of the set, no action is taken.

Parameters

  mixed | $Privilege | Privilege ID or object to add.

See Also
  PrivilegeSet::RemovePrivilege()

Definition at line 164 of file PrivilegeSet.php.

References IncludesPrivilege().

PrivilegeSet::AddSet | ( | PrivilegeSet | $Set | ) |

Add subgroup of privileges/conditions to set.

Parameters

  PrivilegeSet | $Set | Subgroup to add.

Definition at line 306 of file PrivilegeSet.php.

PrivilegeSet::AllRequired | ( |  | $NewValue = `NULL` | ) |

Get/set whether all privileges/conditions in set are required (i.e.

"AND" logic), or only one privilege/condition needs to be met ("OR"). By default only one of the specified privilegs/conditions in a set is required.

Parameters

  bool | $NewValue | Specify TRUE if all privileges are required, otherwise FALSE if only one privilege required. (OPTIONAL)

Returns
  bool TRUE if all privileges required, otherwise FALSE.

Definition at line 325 of file PrivilegeSet.php.

PrivilegeSet::AssociatedUserId | ( |  | $NewValue = `NULL` | ) |

Get/set ID of user associated with privilege set.

Parameters

  int | $NewValue | ID of user to associate with set. (OPTIONAL)

Returns
  int ID of user currently associated with set, or NULL if no user currently associated.

Definition at line 340 of file PrivilegeSet.php.

PrivilegeSet::Data | ( |  | $NewValue = `NULL` | ) |

Get/set privilege set data, in the form of an opaque string.

This method can be used to retrieve an opaque string containing privilege set data, which can then be saved (e.g. to a database) and later used to reload a privilege set. (Use instead of serialize() to avoid future issues with internal class changes.)

Parameters

  string | $NewValue | New privilege set data. (OPTIONAL)

Returns
  string Current privilege set data (opaque value).

Definition at line 53 of file PrivilegeSet.php.

PrivilegeSet::GetPrivilegeInfo | ( |  | ) |

Get privilege information as an array, with numerical indexes except for the logic, which is contained in a element with the index "Logic".

Values are either an associative array with three elements, "FieldId", "Operator", and "Value", or a PrivilegeSet object (for subsets).

Returns
  array Array with privilege information.

Definition at line 211 of file PrivilegeSet.php.

PrivilegeSet::GetPrivilegeList | ( |  | ) |

Get list of privileges.

(Intended primarily for supporting legacy privilege operations – list contains privilege IDs only, and does not include conditions.)

Returns
  array Array of privilege IDs.

Definition at line 227 of file PrivilegeSet.php.

PrivilegeSet::IncludesPrivilege | ( |  | $Privilege | ) |

Check whether this privilege set includes the specified privilege.

Parameters

  mixed | $Privilege | Privilege ID or object to check.

Returns
  bool TRUE if privilege is included, otherwise FALSE.

Definition at line 196 of file PrivilegeSet.php.

Referenced by AddPrivilege(), IsGreaterThan(), and RemovePrivilege().

Here is the caller graph for this function:

PrivilegeSet::IsGreaterThan | ( | PrivilegeSet | $Set,
|  |  | $Resource = `self::NO_RESOURCE`
| ) |  |

Check whether a privilege set is greater than or equal to another privilege set.

Usually used to test whether a privilege set associated with a user is sufficient to meet a privilege set required for an operation or to access some particular piece of data.

Parameters

  object | $Set | Privilege set to compare against.
  object | $Resource | Resource object to used for comparison, for sets that include user conditions. (OPTIONAL)

Returns
  bool TRUE if privileges in set are greater than or equal to privileges in specified set, otherwise FALSE.

Definition at line 89 of file PrivilegeSet.php.

References IncludesPrivilege().

Referenced by IsLessThan().

Here is the caller graph for this function:

PrivilegeSet::IsLessThan | ( | PrivilegeSet | $Set,
|  | Resource | $Resource = `NULL`
| ) |  |

Check whether a privilege set is less than another privilege set.

Parameters

  object | $Set | Privilege set to compare against.
  object | $Resource | Resource object to used for comparison, for sets that include user conditions. (OPTIONAL)

Returns
  bool TRUE if privileges in set are less than privileges in specified set, otherwise FALSE.

Definition at line 152 of file PrivilegeSet.php.

References IsGreaterThan().

PrivilegeSet::RemoveCondition | ( | MetadataField | $Field,
|  |  | $Value = `NULL`,
|  |  | $Operator = `"=="`
| ) |  |

Remove condition from privilege set.

If condition was not present in privilege set, no action is taken.

Parameters

  mixed | $Field | Metadata field object or ID to test against.
  mixed | $Value | Value to test against. (Specify NULL for User fields to test against current user.)
  string | $Operator | String containing operator to used for condition. (Standard PHP operators are used.) (OPTIONAL, defaults to "==")

Returns
  bool TRUE if condition was removed, otherwise FALSE.

Definition at line 282 of file PrivilegeSet.php.

References MetadataField\Id().

PrivilegeSet::RemovePrivilege | ( |  | $Privilege | ) |

Remove specified privilege from set.

If specified privilege is not currently in the set, no action is taken.

Parameters

  mixed | $Privilege | Privilege ID or object to remove from set.

See Also
  PrivilegeSet::AddPrivilege()

Definition at line 180 of file PrivilegeSet.php.

References IncludesPrivilege().

## Member Data Documentation

const PrivilegeSet::NO_RESOURCE = "XXX NO RESOURCE XXX"

Definition at line 360 of file PrivilegeSet.php.

The documentation for this class was generated from the following file:

- objects/PrivilegeSet.php