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

Factory object for Folder class, used to retrieve and manage Folders and groups of Folders. More...

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

Public Member Functions

 FolderFactory ($OwnerId=NULL)
 Constructor for FolderFactory.
 
 CreateFolder ($ItemType, $FolderName=NULL, $OwnerId=NULL)
 Create new folder that will contain only one type of item.
 
 CreateMixedFolder ($FolderName=NULL, $OwnerId=NULL)
 Create new folder that can contain multiple types of items.
 
 GetFolderCount ()
 Get total number of folders currently existing.
 
 GetFolderByNormalizedName ($NormalizedName, $OwnerId=NULL)
 
 GetFoldersContainingItem ($Item, $ItemType, $OwnerId=NULL, $SharedFoldersOnly=FALSE)
 Retrieve folders containing specified item.
 
 GetFolders ($ItemType=NULL, $OwnerId=NULL, $Name=NULL, $Offset=0, $Count=NULL)
 Retrieve folders with specified name, owner, or default content type.
 
- 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 object for Folder class, used to retrieve and manage Folders and groups of Folders.

Definition at line 15 of file FolderFactory.php.

Member Function Documentation

FolderFactory::CreateFolder (   $ItemType,
  $FolderName = NULL,
  $OwnerId = NULL 
)

Create new folder that will contain only one type of item.

Parameters
ItemTypeType of item that folder will contain.
FolderNameString containing name of folder. (OPTIONAL)
OwnerIdNumerical ID of folder owner. (OPTIONAL)
Returns
New folder (object).

Definition at line 45 of file FolderFactory.php.

References Folder\MIXEDCONTENT.

Referenced by CreateMixedFolder().

Here is the caller graph for this function:

FolderFactory::CreateMixedFolder (   $FolderName = NULL,
  $OwnerId = NULL 
)

Create new folder that can contain multiple types of items.

Parameters
FolderNameString containing name of folder. (OPTIONAL)
OwnerIdNumerical ID of folder owner. (OPTIONAL)
Returns
New folder (object).

Definition at line 74 of file FolderFactory.php.

References CreateFolder(), and Folder\MIXEDCONTENT.

FolderFactory::FolderFactory (   $OwnerId = NULL)

Constructor for FolderFactory.

Parameters
OwnerIdID of owner of folders to be manipulated by factory. If specified then all operations pertain only to folders with the specified owner. (OPTIONAL)

Definition at line 25 of file FolderFactory.php.

References ItemFactory\ItemFactory(), and ItemFactory\SetOrderOpsCondition().

FolderFactory::GetFolderByNormalizedName (   $NormalizedName,
  $OwnerId = NULL 
)

Definition at line 99 of file FolderFactory.php.

FolderFactory::GetFolderCount ( )

Get total number of folders currently existing.

Returns
Number of folders.

Definition at line 84 of file FolderFactory.php.

References ItemFactory\GetItemCount().

FolderFactory::GetFolders (   $ItemType = NULL,
  $OwnerId = NULL,
  $Name = NULL,
  $Offset = 0,
  $Count = NULL 
)

Retrieve folders with specified name, owner, or default content type.

If no parameters are specified, all existing folders are returned. If no owner ID parameter is supplied and an owner ID was specified for FolderFactory::FolderFactory(), then that owner ID is used.

Parameters
ItemTypeString containing type of item to search for as default content type of folder. To search for only mixed-content-type folders specify Folder::MIXEDCONTENT. (OPTIONAL, defaults to NULL)
OwnerIdNumerical ID of folder owner. (OPTIONAL, defaults to NULL)
NameString containing target folder name. (OPTIONAL, defaults to NULL)
OffsetZero-based offset into list of folders. (OPTIONAL)
CountNumber of folders to retrieve beginning at specified offset. (OPTIONAL)
Returns
Array of Folder objects that match specified parameters.

Definition at line 187 of file FolderFactory.php.

References ItemFactory\GetItemIds(), and Folder\MIXEDCONTENT.

FolderFactory::GetFoldersContainingItem (   $Item,
  $ItemType,
  $OwnerId = NULL,
  $SharedFoldersOnly = FALSE 
)

Retrieve folders containing specified item.

Parameters
ItemItem object (must have Id() method) or item ID.
int | string$ItemTypethe item type
int$OwnerIdoptional owner ID to restrict folders to
SharedFoldersOnlyWhether to only return shared folders.
Returns
Array of Folder objects that contain specified item.

Definition at line 133 of file FolderFactory.php.

References Folder\MIXEDCONTENT.


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