CWIS Developer Documentation
Public Member Functions | List of all members
ControlledNameFactory Class Reference

Factory for manipulating ControlledName objects. More...

Inheritance diagram for ControlledNameFactory:
Inheritance graph
[legend]
Collaboration diagram for ControlledNameFactory:
Collaboration graph
[legend]

Public Member Functions

 ControlledNameFactory ($FieldId=NULL)
 
 GetUsageCount ()
 Determine how many resources have controlled names (associated with this metadata field) assigned to them.
 
- Public Member Functions inherited from ItemFactory
 ItemFactory ($ItemClassName, $ItemTableName, $ItemIdFieldName, $ItemNameFieldName=NULL, $FieldId=NULL, $OrderOpsAllowed=FALSE)
 
 Status ()
 
 GetCurrentEditedItemId ()
 
 SetCurrentEditedItemId ($NewId)
 
 ClearCurrentEditedItemId ()
 
 ClearCurrentEditedItem ()
 
 CleanOutStaleTempItems ($MinutesUntilStale=10080)
 Clear out (call the Delete() method) for any temp items more than specified number of minutes old.
 
 GetLastTempItemId ()
 
 GetNextItemId ()
 
 GetHighestItemId ($Condition=NULL, $IncludeTempItems=FALSE)
 
 GetNextTempItemId ()
 
 GetItemCount ($Condition=NULL, $IncludeTempItems=FALSE)
 
 GetItemIds ($Condition=NULL, $IncludeTempItems=FALSE)
 
 GetLatestModificationDate ($Condition=NULL)
 
 GetItem ($ItemId)
 
 ItemExists ($ItemId)
 Check that item exists with specified ID.
 
 GetItemByName ($Name, $IgnoreCase=FALSE)
 
 GetItemNames ($SqlCondition=NULL)
 Retrieve item names.
 
 GetItems ($SqlCondition=NULL)
 Retrieve items.
 
 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.
 
 NameIsInUse ($Name, $IgnoreCase=FALSE)
 Check whether item name is currently in use.
 
 SearchForItemNames ($SearchString, $NumberOfResults=100, $IncludeVariants=FALSE, $UseBooleanMode=TRUE, $Offset=0)
 
 GetCountForItemNames ($SearchString, $IncludeVariants=FALSE, $UseBooleanMode=TRUE)
 
 AddItems ($ItemNames, $Qualifier=NULL)
 add items with specified names
 
 AddItem ($ItemName, $AdditionalValues=NULL)
 Add new item.
 
 DeleteItem ($ItemId)
 Delete item.
 
 SetOrderOpsCondition ($Condition)
 
 InsertBefore ($SourceItemOrItemId, $TargetItemOrItemId)
 
 InsertAfter ($SourceItemOrItemId, $TargetItemOrItemId)
 
 Prepend ($ItemOrItemId)
 
 Append ($ItemOrItemId)
 
 GetItemIdsInOrder ($AddStrayItemsToOrder=TRUE)
 
 RemoveItemFromOrder ($ItemId)
 

Additional Inherited Members

- Protected Attributes inherited from ItemFactory
 $DB
 
 $FieldId
 

Detailed Description

Factory for manipulating ControlledName objects.

Definition at line 14 of file ControlledNameFactory.php.

Member Function Documentation

ControlledNameFactory::ControlledNameFactory (   $FieldId = NULL)

Definition at line 18 of file ControlledNameFactory.php.

References ItemFactory\$FieldId, and ItemFactory\ItemFactory().

ControlledNameFactory::GetUsageCount ( )

Determine how many resources have controlled names (associated with this metadata field) assigned to them.

Returns
Count of resources with names assigned.

Definition at line 29 of file ControlledNameFactory.php.


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