CWIS Developer Documentation
List of all members
MessageFactory Class Reference

Factory for forum messages / resource comments. More...

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

Setup/Initialization

 MessageFactory ()
 Object constructor.
 

Accessors

 GetMessagesPostedByUser ($UserId, $Count=NULL)
 Get all messages posted by specified user, in reverse date order.
 

Additional Inherited Members

- 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)
 
- Protected Attributes inherited from ItemFactory
 $DB
 
 $FieldId
 

Detailed Description

Factory for forum messages / resource comments.

Definition at line 16 of file MessageFactory.php.

Member Function Documentation

MessageFactory::GetMessagesPostedByUser (   $UserId,
  $Count = NULL 
)

Get all messages posted by specified user, in reverse date order.

Parameters
UserIdID of user.
CountNumber of messages to retrieve. (OPTIONAL)
Returns
Array of messages.

Definition at line 40 of file MessageFactory.php.

MessageFactory::MessageFactory ( )

Object constructor.

Definition at line 24 of file MessageFactory.php.

References ItemFactory\ItemFactory().


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