CWIS Developer Documentation
|
Factory for manipulating ControlledName objects. More...
Public Member Functions | |
__construct ($FieldId=NULL) | |
Constructor for ControlledNameFactory class. More... | |
GetUsageCount () | |
Determine how many resources have controlled names (associated with this metadata field) assigned to them. More... | |
FindMatchingRecentlyUsedValues ($SearchString, $NumberOfResults=5, $IdExclusions=array(), $ValueExclusions=array()) | |
Retrieve recently used items matching a search string. More... | |
ControlledNameSearch ($SearchString) | |
Search for ControlledNames or variants that match a search string. More... | |
![]() | |
__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... | |
Additional Inherited Members | |
![]() | |
$DB | |
Factory for manipulating ControlledName objects.
Definition at line 13 of file ControlledNameFactory.php.
ControlledNameFactory::__construct | ( | $FieldId = NULL | ) |
Constructor for ControlledNameFactory class.
int | $FieldId | ID of Controlled Name metadata field. (OPTIONAL) |
Definition at line 22 of file ControlledNameFactory.php.
ControlledNameFactory::ControlledNameSearch | ( | $SearchString | ) |
Search for ControlledNames or variants that match a search string.
string | $SearchString | String to search for. Supports * as a wildcard character but no other special characters are allowed. |
Definition at line 103 of file ControlledNameFactory.php.
ControlledNameFactory::FindMatchingRecentlyUsedValues | ( | $SearchString, | |
$NumberOfResults = 5 , |
|||
$IdExclusions = array() , |
|||
$ValueExclusions = array() |
|||
) |
Retrieve recently used items matching a search string.
string | $SearchString | String to match |
int | $NumberOfResults | Number of results to return. (OPTIONAL, defaults to 5) |
array | $IdExclusions | List of IDs of items to exclude. |
array | $ValueExclusions | List of names of items to exclude. |
Definition at line 58 of file ControlledNameFactory.php.
ControlledNameFactory::GetUsageCount | ( | ) |
Determine how many resources have controlled names (associated with this metadata field) assigned to them.
Definition at line 38 of file ControlledNameFactory.php.