CWIS Developer Documentation
|
Factory which extracts all defined privileges from the database. More...
Setup/Initialization | |
__construct () | |
Object constructor. More... | |
Accessors | |
GetPrivileges ($IncludePredefined=TRUE, $ReturnObjects=TRUE) | |
Get all privileges. More... | |
GetPrivilegeWithName ($Name) | |
Get the Privilege object with the given name. More... | |
GetPrivilegeWithValue ($Value) | |
Get the Privilege object with the given value. More... | |
GetPredefinedPrivilegeConstants () | |
Get all predefined privilege constants and their values. More... | |
GetItemNames ($SqlCondition=NULL) | |
Retrieve human-readable privilege names. More... | |
Predicates | |
PrivilegeNameExists ($Name) | |
Determine if a privilege with the given name exists. More... | |
PrivilegeValueExists ($Value) | |
Determine if a privilege with the given value exists. More... | |
Additional Inherited Members | |
![]() | |
__construct ($ItemClassName, $ItemTableName, $ItemIdColumnName, $ItemNameColumnName=NULL, $OrderOpsAllowed=FALSE, $SqlCondition=NULL) | |
Class constructor. More... | |
GetItemClassName () | |
Get class name of items manipulated by factory. More... | |
CleanOutStaleTempItems ($MinutesUntilStale=10080) | |
Clear out (call the Delete() method) for any temp items more than specified number of minutes old. More... | |
GetNextItemId () | |
Retrieve next available (non-temp) item ID. More... | |
GetHighestItemId ($IgnoreSqlCondition=FALSE) | |
Retrieve highest item ID in use. More... | |
GetNextTempItemId () | |
Return next available temporary item ID. More... | |
GetItemCount ($Condition=NULL, $IncludeTempItems=FALSE) | |
Get count of items. More... | |
GetItemIds ($Condition=NULL, $IncludeTempItems=FALSE, $SortField=NULL, $SortAscending=TRUE) | |
Return array of item IDs. More... | |
GetLatestModificationDate ($Condition=NULL) | |
Get newest modification date (based on values in "DateLastModified" column in database table). More... | |
GetItem ($ItemId) | |
Retrieve item by item ID. More... | |
ItemExists ($ItemId, $IgnoreSqlCondition=FALSE) | |
Check that item exists with specified ID. More... | |
GetItemByName ($Name, $IgnoreCase=FALSE) | |
Retrieve item by name. More... | |
GetItemIdByName ($Name, $IgnoreCase=FALSE) | |
Retrieve item ID by name. More... | |
GetItemIdsByNames ($Names) | |
Look up IDs for specified names. More... | |
GetItemNames ($SqlCondition=NULL) | |
Retrieve item names. More... | |
GetItems ($SqlCondition=NULL) | |
Retrieve items. More... | |
GetItemsAsOptionList ($OptionListName, $SelectedItemId=NULL, $SqlCondition=NULL, $DisplaySize=1, $SubmitOnChange=FALSE, $Disabled=FALSE) | |
Retrieve items of specified type as HTML option list with item names as labels and item IDs as value attributes. More... | |
NameIsInUse ($Name, $IgnoreCase=FALSE) | |
Check whether item name is currently in use. More... | |
SearchForItemNames ($SearchString, $NumberOfResults=100, $IncludeVariants=FALSE, $UseBooleanMode=TRUE, $Offset=0, $IdExclusions=array(), $NameExclusions=array()) | |
Retrieve items with names matching search string. More... | |
GetCountForItemNames ($SearchString, $IncludeVariants=FALSE, $UseBooleanMode=TRUE, $IdExclusions=array(), $NameExclusions=array()) | |
Retrieve count of items with names matching search string. More... | |
ReindexByItemIds ($Array) | |
Reindex supplied associative array, by replacing item names with item IDs. More... | |
CachingEnabled ($NewValue=NULL) | |
Enable/disable caching of item information. More... | |
ClearCaches () | |
Clear item information caches. More... | |
SetOrderOpsCondition ($Condition) | |
Set SQL condition (added to WHERE clause) used to select items for ordering operations. More... | |
InsertBefore ($TargetItem, $NewItem) | |
Insert item into order before specified item. More... | |
InsertAfter ($TargetItem, $NewItem) | |
Insert item into order after specified item. More... | |
Prepend ($Item) | |
Add item to beginning of order. More... | |
Append ($Item) | |
Add item to end of order. More... | |
GetItemIdsInOrder () | |
Retrieve list of item IDs in order. More... | |
RemoveItemFromOrder ($ItemId) | |
Remove item from existing order. More... | |
![]() | |
$DB | |
Factory which extracts all defined privileges from the database.
Definition at line 14 of file PrivilegeFactory.php.
PrivilegeFactory::__construct | ( | ) |
Object constructor.
Definition at line 23 of file PrivilegeFactory.php.
PrivilegeFactory::GetItemNames | ( | $SqlCondition = NULL | ) |
Retrieve human-readable privilege names.
This method overloads the inherited version from ItemFactory to add in the predefined privileges. This will also filter out privs outside the recognized ranges for Standard/Custom/Pseudo privileges defined in CWUser.
string | $SqlCondition | SQL condition (w/o "WHERE") for name retrieval. (OPTIONAL) |
Definition at line 183 of file PrivilegeFactory.php.
Referenced by GetPrivileges().
PrivilegeFactory::GetPredefinedPrivilegeConstants | ( | ) |
Get all predefined privilege constants and their values.
Definition at line 168 of file PrivilegeFactory.php.
PrivilegeFactory::GetPrivileges | ( | $IncludePredefined = TRUE , |
|
$ReturnObjects = TRUE |
|||
) |
Get all privileges.
bool | $IncludePredefined | Whether to include predefined privileges. (OPTIONAL, defaults to TRUE) |
bool | $ReturnObjects | Whether to return Privilege objects, rather than privilege names. (OPTIONAL, defaults to TRUE) |
Definition at line 53 of file PrivilegeFactory.php.
References GetItemNames().
Referenced by GetPrivilegeWithName(), GetPrivilegeWithValue(), PrivilegeNameExists(), and PrivilegeValueExists().
PrivilegeFactory::GetPrivilegeWithName | ( | $Name | ) |
Get the Privilege object with the given name.
string | $Name | Privilege name. |
Definition at line 92 of file PrivilegeFactory.php.
References GetPrivileges().
PrivilegeFactory::GetPrivilegeWithValue | ( | $Value | ) |
Get the Privilege object with the given value.
int | $Value | Privilege value. |
Definition at line 136 of file PrivilegeFactory.php.
References GetPrivileges().
PrivilegeFactory::PrivilegeNameExists | ( | $Name | ) |
Determine if a privilege with the given name exists.
string | $Name | Privilege name. |
Definition at line 225 of file PrivilegeFactory.php.
References GetPrivileges().
PrivilegeFactory::PrivilegeValueExists | ( | $Value | ) |
Determine if a privilege with the given value exists.
int | $Value | Privilege value. |
Definition at line 257 of file PrivilegeFactory.php.
References GetPrivileges().