eZPublishCommunityProject(LegacyStack)  2013.6
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)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

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)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
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)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

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
 

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: