eZPublish  3.8
eZCollaborationItem Class Reference

The class eZCollaborationItem does. More...

+ Inheritance diagram for eZCollaborationItem:
+ Collaboration diagram for eZCollaborationItem:

Public Member Functions

content ()
 
contentAttribute ($attribute)
 
 create ($typeIdentifier, $creatorID, $status=EZ_COLLABORATION_STATUS_ACTIVE)
 
 createNotificationEvent ($subType=false)
 
creator ()
 
 definition ()
 
 eZCollaborationItem ($row)
 
 fetch ($id, $creatorID=false, $asObject=true)
 
 fetchList ($parameters=array())
 
 fetchListCount ($parameters=array())
 
fetchListTool ($parameters=array(), $asCount)
 
handler ()
 
 handleView ($viewMode)
 
 hasContentAttribute ($attribute)
 
isCreator ()
 
messageCount ()
 
participantList ()
 
 setLastRead ($userID=false, $timestamp=false)
 
title ()
 
unreadMessageCount ()
 
useMessages ()
 
userStatus ()
 
- Public Member Functions inherited from eZPersistentObject
attribute ($attr, $noFunction=false)
 
 attributes ()
 
 conditionText (&$conditions)
 
conditionTextByRow (&$conditions, &$row)
 
 definition ()
 
escapeArray (&$array)
 
 eZPersistentObject ($row)
 
 fetchObject (&$def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
 fetchObjectList (&$def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null)
 
 fill (&$row)
 
 getShortAttributeName (&$db, &$def, $attrName)
 
 handleRows (&$rows, $class_name, $asObject)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 newObjectOrder (&$def, $orderField, $conditions)
 
 remove ($conditions=null, $extraConditions=null)
 
 removeObject (&$def, $conditions=null, $extraConditions=null)
 
 reorderObject (&$def, $orderField, $conditions, $down=true)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 swapRow ($table, &$keys, &$order_id, &$rows, $id1, $id2)
 
 sync ($fieldFilters=null)
 
 updateObjectList ($parameters)
 

Static Public Member Functions

 cleanup ()
 
 setIsActive ($active, $userID=false)
 

Private Attributes

 $Created
 
 $CreatorID
 
 $DataFloat1
 
 $DataFloat2
 
 $DataFloat3
 
 $DataInt1
 
 $DataInt2
 
 $DataInt3
 
 $DataText1
 
 $DataText2
 
 $DataText3
 
 $ID
 
 $Modified
 
 $Status
 
 $TypeIdentifier
 

Detailed Description

The class eZCollaborationItem does.

Member Function Documentation

eZCollaborationItem::cleanup ( )
static

Removes all collaboration items by fetching them and calling remove on them.

Note
Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.
& eZCollaborationItem::content ( )
& eZCollaborationItem::contentAttribute (   $attribute)
eZCollaborationItem::create (   $typeIdentifier,
  $creatorID,
  $status = EZ_COLLABORATION_STATUS_ACTIVE 
)
eZCollaborationItem::createNotificationEvent (   $subType = false)

Creates a collaboration notification event and stores it. subType can be used to specify a sub type of this collaboration item.

& eZCollaborationItem::creator ( )
eZCollaborationItem::definition ( )

Referenced by fetch().

eZCollaborationItem::eZCollaborationItem (   $row)

Constructor

Referenced by create().

eZCollaborationItem::fetchList (   $parameters = array())
eZCollaborationItem::fetchListCount (   $parameters = array())
& eZCollaborationItem::fetchListTool (   $parameters = array(),
  $asCount 
)

Referenced by fetchList(), and fetchListCount().

eZCollaborationItem::handleView (   $viewMode)
eZCollaborationItem::hasContentAttribute (   $attribute)
& eZCollaborationItem::isCreator ( )
& eZCollaborationItem::messageCount ( )
Returns
the number of messages in this item.
Note
The message count is purely abstract and it's up to each handler to return a valid count.
& eZCollaborationItem::participantList ( )
eZCollaborationItem::setIsActive (   $active,
  $userID = false 
)
static
eZCollaborationItem::setLastRead (   $userID = false,
  $timestamp = false 
)
& eZCollaborationItem::title ( )
& eZCollaborationItem::unreadMessageCount ( )
Returns
the number of unread messages in this item.
Note
The message count is purely abstract and it's up to each handler to return a valid count. It's also up the handler to keep track of which messages are read or not.
& eZCollaborationItem::useMessages ( )
Returns
true if the item uses messages.
Note
It's up to each handler to control this.
& eZCollaborationItem::userStatus ( )

Member Data Documentation

eZCollaborationItem::$Created
private
eZCollaborationItem::$CreatorID
private

Referenced by isCreator().

eZCollaborationItem::$DataFloat1
private
eZCollaborationItem::$DataFloat2
private
eZCollaborationItem::$DataFloat3
private
eZCollaborationItem::$DataInt1
private
eZCollaborationItem::$DataInt2
private
eZCollaborationItem::$DataInt3
private
eZCollaborationItem::$DataText1
private
eZCollaborationItem::$DataText2
private
eZCollaborationItem::$DataText3
private
eZCollaborationItem::$ID
private
eZCollaborationItem::$Modified
private
eZCollaborationItem::$Status
private
eZCollaborationItem::$TypeIdentifier
private

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