eZPublish  4.4
eZCollaborationItem Class Reference

The class eZCollaborationItem does. More...

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

Public Member Functions

 content ()
 
 contentAttribute ($attribute)
 
 createNotificationEvent ($subType=false)
 
 creator ()
 
 eZCollaborationItem ($row)
 
 handler ()
 
 handleView ($viewMode)
 
 hasContentAttribute ($attribute)
 
 isCreator ()
 
 messageCount ()
 
 participantList ()
 
 setIsActive ($active, $userID=false)
 
 setLastRead ($userID=false, $timestamp=false)
 
 title ()
 
 unreadMessageCount ()
 
 useMessages ()
 
 userStatus ()
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 
 attributes ()
 
 eZPersistentObject ($row)
 
 fill ($row)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 remove ($conditions=null, $extraConditions=null)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 sync ($fieldFilters=null)
 

Static Public Member Functions

static cleanup ()
 
static create ($typeIdentifier, $creatorID, $status=self::STATUS_ACTIVE)
 
static definition ()
 
static fetch ($id, $creatorID=false, $asObject=true)
 
static fetchList ($parameters=array())
 
static fetchListCount ($parameters=array())
 
static fetchListTool ($parameters=array(), $asCount)
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 
static conditionTextByRow ($conditions, $row)
 
static count ($def, $conds=null, $field=null)
 
static definition ()
 
static escapeArray ($array)
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
static fetchObjectList ($def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 
static getShortAttributeName ($db, $def, $attrName)
 
static handleRows ($rows, $class_name, $asObject)
 
static newObjectOrder ($def, $orderField, $conditions)
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 
static updateObjectList ($parameters)
 

Public Attributes

 $Created
 
 $CreatorID
 
 $DataFloat1
 
 $DataFloat2
 
 $DataFloat3
 
 $DataInt1
 
 $DataInt2
 
 $DataInt3
 
 $DataText1
 
 $DataText2
 
 $DataText3
 
 $ID
 
 $Modified
 
 $Status
 
 $TypeIdentifier
 
const STATUS_ACTIVE = 1
 
const STATUS_ARCHIVE = 3
 
const STATUS_INACTIVE = 2
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 Whether the data is dirty, ie needs to be stored, or not. More...
 

Detailed Description

The class eZCollaborationItem does.

Member Function Documentation

static 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)
static eZCollaborationItem::create (   $typeIdentifier,
  $creatorID,
  $status = self::STATUS_ACTIVE 
)
static
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 ( )
static eZCollaborationItem::definition ( )
static

Referenced by fetch().

eZCollaborationItem::eZCollaborationItem (   $row)

Constructor

Referenced by create().

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

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 
)
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
eZCollaborationItem::$CreatorID
eZCollaborationItem::$DataFloat1
eZCollaborationItem::$DataFloat2
eZCollaborationItem::$DataFloat3
eZCollaborationItem::$DataInt1
eZCollaborationItem::$DataInt2
eZCollaborationItem::$DataInt3
eZCollaborationItem::$DataText1
eZCollaborationItem::$DataText2
eZCollaborationItem::$DataText3
eZCollaborationItem::$ID
eZCollaborationItem::$Modified
eZCollaborationItem::$Status
eZCollaborationItem::$TypeIdentifier
const eZCollaborationItem::STATUS_ACTIVE = 1
const eZCollaborationItem::STATUS_ARCHIVE = 3
const eZCollaborationItem::STATUS_INACTIVE = 2

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