CWIS Developer Documentation
Public Member Functions | Protected Attributes | List of all members
ItemFactory Class Reference

Common factory class for item manipulation. More...

Inheritance diagram for ItemFactory:
Inheritance graph
[legend]

Public Member Functions

 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)
 

Protected Attributes

 $DB
 
 $FieldId
 

Detailed Description

Common factory class for item manipulation.

Not intended to be used directly, but rather as a parent for factory classes for specific item types. For a derived class to use the temp methods the item record in the database must include "DateLastModified" and "LastModifiedById" fields, and the item object must include a "Delete()" method.

Definition at line 18 of file ItemFactory.php.

Member Function Documentation

ItemFactory::AddItem (   $ItemName,
  $AdditionalValues = NULL 
)

Add new item.

Parameters
ItemNameValue to store in name field for new item.
AdditionalValuesAssociative array of additional values to set in the new item, with DB field names for the array index and values to set them to for the array values. (OPTIONAL)
Returns
ID of new item.

Definition at line 733 of file ItemFactory.php.

ItemFactory::AddItems (   $ItemNames,
  $Qualifier = NULL 
)

add items with specified names

Parameters
ItemNamesArray of item names. Leading or trailing whitespace is automatically trimmed off of the names.
QualifierQualifier object to associate with items being added.
Returns
Number of items added.
Note
Only items with new names will be added.
This method only works for item types where a new item can be created by calling the constructor with NULL, an item name, and a field ID (in that order) as parameters.

Definition at line 699 of file ItemFactory.php.

References GetItemByName().

ItemFactory::Append (   $ItemOrItemId)

Definition at line 828 of file ItemFactory.php.

ItemFactory::CleanOutStaleTempItems (   $MinutesUntilStale = 10080)

Clear out (call the Delete() method) for any temp items more than specified number of minutes old.

Parameters
MinutesUntilStaleNumber of minutes before items are considered stale. (OPTIONAL - defaults to 7 days)
Returns
Number of stale items deleted.

Definition at line 146 of file ItemFactory.php.

ItemFactory::ClearCurrentEditedItem ( )

Definition at line 124 of file ItemFactory.php.

References ClearCurrentEditedItemId(), and GetCurrentEditedItemId().

ItemFactory::ClearCurrentEditedItemId ( )

Definition at line 99 of file ItemFactory.php.

Referenced by ClearCurrentEditedItem().

Here is the caller graph for this function:

ItemFactory::DeleteItem (   $ItemId)

Delete item.

Parameters
ItemIdID of item to delete.

Definition at line 762 of file ItemFactory.php.

ItemFactory::GetCountForItemNames (   $SearchString,
  $IncludeVariants = FALSE,
  $UseBooleanMode = TRUE 
)

Definition at line 623 of file ItemFactory.php.

References $DB.

ItemFactory::GetCurrentEditedItemId ( )

Definition at line 55 of file ItemFactory.php.

References GetLastTempItemId().

Referenced by ClearCurrentEditedItem().

Here is the caller graph for this function:

ItemFactory::GetHighestItemId (   $Condition = NULL,
  $IncludeTempItems = FALSE 
)

Definition at line 205 of file ItemFactory.php.

Referenced by MetadataSchema\GetHighestFieldId(), and GetNextItemId().

Here is the caller graph for this function:

ItemFactory::GetItem (   $ItemId)

Definition at line 335 of file ItemFactory.php.

Referenced by GetItemByName(), GetItems(), OAIServer\ProcessGetRecord(), and OAIServer\ProcessListRecords().

Here is the caller graph for this function:

ItemFactory::GetItemByName (   $Name,
  $IgnoreCase = FALSE 
)

Definition at line 353 of file ItemFactory.php.

References GetItem().

Referenced by AddItems(), and QualifierFactory\GetQualifierByName().

Here is the caller graph for this function:

ItemFactory::GetItemCount (   $Condition = NULL,
  $IncludeTempItems = FALSE 
)

Definition at line 249 of file ItemFactory.php.

Referenced by FolderFactory\GetFolderCount(), and QualifierFactory\QualifierCount().

Here is the caller graph for this function:

ItemFactory::GetItemIds (   $Condition = NULL,
  $IncludeTempItems = FALSE 
)

Definition at line 299 of file ItemFactory.php.

Referenced by FolderFactory\GetFolders().

Here is the caller graph for this function:

ItemFactory::GetItemIdsInOrder (   $AddStrayItemsToOrder = TRUE)

Definition at line 843 of file ItemFactory.php.

ItemFactory::GetItemNames (   $SqlCondition = NULL)

Retrieve item names.

Parameters
SqlConditionSQL condition (w/o "WHERE") for name retrieval. (OPTIONAL)
Returns
Array with item names as values and item IDs as indexes.

Definition at line 396 of file ItemFactory.php.

Referenced by GetItems(), GetItemsAsOptionList(), and QualifierFactory\QualifierList().

Here is the caller graph for this function:

ItemFactory::GetItems (   $SqlCondition = NULL)

Retrieve items.

Parameters
SqlConditionSQL condition (w/o "WHERE") for name retrieval. (OPTIONAL)
Returns
Array with item objects as values and item IDs as indexes.

Definition at line 434 of file ItemFactory.php.

References $Items, GetItem(), and GetItemNames().

Referenced by OAIServer\ProcessListRecords().

Here is the caller graph for this function:

ItemFactory::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.

The first element on the list will have a label of "–" and an ID of -1 to indicate no item selected.

Parameters
OptionListNameValue of option list "name" attribute.
SelectedItemIdID of currently-selected item or array of IDs of currently-selected items. (OPTIONAL)
SqlConditionSQL condition (w/o "WHERE") for item retrieval. (OPTIONAL, defaults to NULL)
DisplaySizeDisplay length of option list. (OPTIONAL, defaults to 1)
SubmitOnChangeWhether to submit form when option list changes. (OPTIONAL, defaults to FALSE)
Returns
HTML for option list.

Definition at line 459 of file ItemFactory.php.

References GetItemNames().

ItemFactory::GetLastTempItemId ( )

Definition at line 169 of file ItemFactory.php.

Referenced by GetCurrentEditedItemId().

Here is the caller graph for this function:

ItemFactory::GetLatestModificationDate (   $Condition = NULL)

Definition at line 325 of file ItemFactory.php.

ItemFactory::GetNextItemId ( )

Definition at line 185 of file ItemFactory.php.

References GetHighestItemId().

ItemFactory::GetNextTempItemId ( )

Definition at line 230 of file ItemFactory.php.

ItemFactory::InsertAfter (   $SourceItemOrItemId,
  $TargetItemOrItemId 
)

Definition at line 798 of file ItemFactory.php.

ItemFactory::InsertBefore (   $SourceItemOrItemId,
  $TargetItemOrItemId 
)

Definition at line 783 of file ItemFactory.php.

ItemFactory::ItemExists (   $ItemId)

Check that item exists with specified ID.

Parameters
ItemIdID of item.

Definition at line 344 of file ItemFactory.php.

ItemFactory::ItemFactory (   $ItemClassName,
  $ItemTableName,
  $ItemIdFieldName,
  $ItemNameFieldName = NULL,
  $FieldId = NULL,
  $OrderOpsAllowed = FALSE 
)
ItemFactory::NameIsInUse (   $Name,
  $IgnoreCase = FALSE 
)

Check whether item name is currently in use.

Parameters
NameName to check.
IgnoreCaseIf TRUE, ignore case when checking. (Defaults to FALSE)
Returns
TRUE if name is in use, otherwise FALSE.

Definition at line 507 of file ItemFactory.php.

Referenced by MetadataSchema\FieldExists(), and QualifierFactory\QualifierNameIsInUse().

Here is the caller graph for this function:

ItemFactory::Prepend (   $ItemOrItemId)

Definition at line 813 of file ItemFactory.php.

ItemFactory::RemoveItemFromOrder (   $ItemId)

Definition at line 858 of file ItemFactory.php.

ItemFactory::SearchForItemNames (   $SearchString,
  $NumberOfResults = 100,
  $IncludeVariants = FALSE,
  $UseBooleanMode = TRUE,
  $Offset = 0 
)

Definition at line 520 of file ItemFactory.php.

References $DB.

ItemFactory::SetCurrentEditedItemId (   $NewId)

Definition at line 79 of file ItemFactory.php.

ItemFactory::SetOrderOpsCondition (   $Condition)

Definition at line 774 of file ItemFactory.php.

Referenced by FolderFactory\FolderFactory(), and ItemFactory().

Here is the caller graph for this function:

ItemFactory::Status ( )

Definition at line 52 of file ItemFactory.php.

Member Data Documentation

ItemFactory::$DB
protected
ItemFactory::$FieldId
protected

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