|
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... | |
Public Member Functions inherited from ItemFactory | |
| ItemFactory ($ItemClassName, $ItemTableName, $ItemIdFieldName, $ItemNameFieldName=NULL, $OrderOpsAllowed=FALSE, $SqlCondition=NULL) | |
| Class constructor. More... | |
| GetItemClassName () | |
| Get class name of items manipulated by factory. More... | |
| GetCurrentEditedItemId () | |
| Get ID of currently edited item. More... | |
| SetCurrentEditedItemId ($NewId) | |
| Set ID of currently edited item. More... | |
| ClearCurrentEditedItemId () | |
| Clear currently edited item ID. More... | |
| ClearCurrentEditedItem () | |
| Delete currently edited item and clear currently edited item ID. More... | |
| CleanOutStaleTempItems ($MinutesUntilStale=10080) | |
| Clear out (call the Delete() method) for any temp items more than specified number of minutes old. More... | |
| GetLastTempItemId () | |
| Retrieve most recent temp item ID for currently-logged-in user. 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... | |
| GetItemNames ($SqlCondition=NULL) | |
| Retrieve item names. More... | |
| GetItems ($SqlCondition=NULL) | |
| Retrieve items. More... | |
| GetItemsAsOptionList ($OptionListName, $SelectedItemId=NULL, $SqlCondition=NULL, $DisplaySize=1, $SubmitOnChange=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(), $ValueExclusions=array()) | |
| Retrieve items with names matching search string. More... | |
| GetCountForItemNames ($SearchString, $IncludeVariants=FALSE, $UseBooleanMode=TRUE, $IdExclusions=array(), $ValueExclusions=array()) | |
| Retrieve count of items with names matching search string. More... | |
| AddItem ($ItemName, $AdditionalValues=NULL) | |
| Add new item. More... | |
| DeleteItem ($ItemId) | |
| Delete item. 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 | |
Protected Attributes inherited from ItemFactory | |
| $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 21 of file ControlledNameFactory.php.
References ItemFactory\ItemFactory().
| 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 37 of file ControlledNameFactory.php.