Search:

# CWIS Developers Documentation

- Main Page
- Classes
- Files

- Alphabetical List
- Class List
- Class Hierarchy
- Class Members

# ItemFactory Class Reference

Inheritance diagram for ItemFactory:

[legend]
List of all members.

## 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
| SetOrderOpsCondition ($Condition)
| InsertBefore ($SourceItemOrItemId, $TargetItemOrItemId)
| InsertAfter ($SourceItemOrItemId, $TargetItemOrItemId)
| Prepend ($ItemOrItemId)
| Append ($ItemOrItemId)
| GetItemIdsInOrder ($AddStrayItemsToOrder=TRUE)
| RemoveItemFromOrder ($ItemId)
## Protected Attributes
| $DB
| $FieldId

## Detailed Description

Definition at line 15 of file ItemFactory.php.

## Member Function Documentation

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

add items with specified names

Parameters:

  | ItemNames | Array of item names. Leading or trailing whitespace is automatically trimmed off of the names.
  | Qualifier | Qualifier 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 674 of file ItemFactory.php.

References GetItemByName().

ItemFactory::Append | ( | $ | ItemOrItemId | ) |

Definition at line 758 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:

  | MinutesUntilStale | Number of minutes before items are considered stale. (OPTIONAL - defaults to 7 days)

Returns:
  Number of stale items deleted.

Definition at line 143 of file ItemFactory.php.

ItemFactory::ClearCurrentEditedItem | ( |  | ) |

Definition at line 121 of file ItemFactory.php.

References ClearCurrentEditedItemId(), and GetCurrentEditedItemId().

ItemFactory::ClearCurrentEditedItemId | ( |  | ) |

Definition at line 96 of file ItemFactory.php.

Referenced by ClearCurrentEditedItem().

Here is the caller graph for this function:

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

Definition at line 608 of file ItemFactory.php.

References $DB.

ItemFactory::GetCurrentEditedItemId | ( |  | ) |

Definition at line 52 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 202 of file ItemFactory.php.

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

Here is the caller graph for this function:

ItemFactory::GetItem | ( | $ | ItemId | ) |

Definition at line 332 of file ItemFactory.php.

Referenced by GetItemByName(), and GetItems().

Here is the caller graph for this function:

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

Definition at line 350 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 246 of file ItemFactory.php.

Referenced by QualifierFactory::QualifierCount().

Here is the caller graph for this function:

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

Definition at line 296 of file ItemFactory.php.

ItemFactory::GetItemIdsInOrder | ( | $ | AddStrayItemsToOrder = `TRUE` | ) |

Definition at line 773 of file ItemFactory.php.

ItemFactory::GetItemNames | ( | $ | SqlCondition = `NULL` | ) |

Retrieve item names.

Parameters:

  | SqlCondition | SQL condition (w/o "WHERE") for name retrieval. (OPTIONAL)

Returns:
  Array with item names as values and item IDs as indexes.

Reimplemented in PrivilegeFactory.

Definition at line 393 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:

  | SqlCondition | SQL condition (w/o "WHERE") for name retrieval. (OPTIONAL)

Returns:
  Array with item objects as values and item IDs as indexes.

Definition at line 431 of file ItemFactory.php.

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

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:

  | OptionListName | Value of option list "name" attribute.
  | SelectedItemId | ID of currently-selected item or array of IDs of currently-selected items. (OPTIONAL)
  | SqlCondition | SQL condition (w/o "WHERE") for item retrieval. (OPTIONAL)
  | DisplaySize | Display length of option list. (OPTIONAL, defaults to 1)
  | SubmitOnChange | Whether to submit form when option list changes. (OPTIONAL, defaults to FALSE)

Returns:
  HTML for option list.

Definition at line 455 of file ItemFactory.php.

References GetItemNames().

ItemFactory::GetLastTempItemId | ( |  | ) |

Definition at line 166 of file ItemFactory.php.

Referenced by GetCurrentEditedItemId().

Here is the caller graph for this function:

ItemFactory::GetLatestModificationDate | ( | $ | Condition = `NULL` | ) |

Definition at line 322 of file ItemFactory.php.

ItemFactory::GetNextItemId | ( |  | ) |

Definition at line 182 of file ItemFactory.php.

References GetHighestItemId().

ItemFactory::GetNextTempItemId | ( |  | ) |

Definition at line 227 of file ItemFactory.php.

ItemFactory::InsertAfter | ( | $ | SourceItemOrItemId,
|  | $ | TargetItemOrItemId |
| ) |  |  |

Definition at line 728 of file ItemFactory.php.

ItemFactory::InsertBefore | ( | $ | SourceItemOrItemId,
|  | $ | TargetItemOrItemId |
| ) |  |  |

Definition at line 713 of file ItemFactory.php.

ItemFactory::ItemExists | ( | $ | ItemId | ) |

Check that item exists with specified ID.

Parameters:

  | ItemId | ID of item.

Definition at line 341 of file ItemFactory.php.

ItemFactory::ItemFactory | ( | $ | ItemClassName,
|  | $ | ItemTableName,
|  | $ | ItemIdFieldName,
|  | $ | ItemNameFieldName = `NULL`,
|  | $ | FieldId = `NULL`,
|  | $ | OrderOpsAllowed = `FALSE` |
| ) |  |  |

Definition at line 20 of file ItemFactory.php.

References $FieldId, and SetOrderOpsCondition().

Referenced by SavedSearchFactory::__construct(), ClassificationFactory::ClassificationFactory(), ControlledNameFactory::ControlledNameFactory(), FileFactory::FileFactory(), MessageFactory::MessageFactory(), MetadataSchema::MetadataSchema(), PrivilegeFactory::PrivilegeFactory(), QualifierFactory::QualifierFactory(), and ResourceFactory::ResourceFactory().

Here is the caller graph for this function:

ItemFactory::NameIsInUse | ( | $ | Name,
|  | $ | IgnoreCase = `FALSE` |
| ) |  |  |

Check whether item name is currently in use.

Parameters:

  | Name | Name to check.
  | IgnoreCase | If TRUE, ignore case when checking. (Defaults to FALSE)

Returns:
  TRUE if name is in use, otherwise FALSE.

Definition at line 503 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 743 of file ItemFactory.php.

ItemFactory::RemoveItemFromOrder | ( | $ | ItemId | ) |

Definition at line 788 of file ItemFactory.php.

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

Definition at line 516 of file ItemFactory.php.

References $DB.

ItemFactory::SetCurrentEditedItemId | ( | $ | NewId | ) |

Definition at line 76 of file ItemFactory.php.

ItemFactory::SetOrderOpsCondition | ( | $ | Condition | ) |

Definition at line 704 of file ItemFactory.php.

Referenced by ItemFactory().

Here is the caller graph for this function:

ItemFactory::Status | ( |  | ) |

Definition at line 49 of file ItemFactory.php.

Referenced by MetadataSchema::AddField(), MetadataSchema::AddFieldFromXml(), ResourceFactory::DuplicateResource(), and ResourceFactory::GetResourceCount().

Here is the caller graph for this function:

## Member Data Documentation

ItemFactory::$DB`[protected]`

Definition at line 805 of file ItemFactory.php.

Referenced by GetCountForItemNames(), MetadataSchema::GetFieldNames(), ResourceFactory::GetMatchingResources(), SearchForItemNames(), and ResourceFactory::UpdateResourceCountCallback().

ItemFactory::$FieldId`[protected]`

Definition at line 806 of file ItemFactory.php.

Referenced by ClassificationFactory::ClassificationFactory(), ControlledNameFactory::ControlledNameFactory(), MetadataSchema::DropField(), MetadataSchema::FieldToStdNameMapping(), FileFactory::FileFactory(), MetadataSchema::GetField(), MetadataSchema::GetFieldByLabel(), MetadataSchema::GetFieldByName(), MetadataSchema::GetFieldsAsOptionList(), ResourceFactory::GetMatchingResources(), MetadataSchema::GetOwnedFields(), ResourceFactory::GetResourceCount(), ItemFactory(), and MetadataSchema::StdNameToFieldMapping().

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

- ItemFactory.php