eZCollaborationItem Class Reference

The class eZCollaborationItem does. More...

Inheritance diagram for eZCollaborationItem:

Collaboration diagram for eZCollaborationItem:

List of all members.

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 ()
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)
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

---

Detailed Description

The class eZCollaborationItem does.

Definition at line 40 of file ezcollaborationitem.php.

---

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.

Definition at line 533 of file ezcollaborationitem.php.

eZCollaborationItem::content

(

)

Definition at line 254 of file ezcollaborationitem.php.

eZCollaborationItem::contentAttribute

(

$

attribute

)

Definition at line 285 of file ezcollaborationitem.php.

static eZCollaborationItem::create	(	$	typeIdentifier,
		$	creatorID,
		$	status = self::STATUS_ACTIVE
	)		[static]

Definition at line 136 of file ezcollaborationitem.php.

Referenced by eZApproveCollaborationHandler\createApproval(), createNotificationEvent(), and fetchListTool().

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.

Definition at line 153 of file ezcollaborationitem.php.

eZCollaborationItem::creator

(

)

Definition at line 177 of file ezcollaborationitem.php.

static eZCollaborationItem::definition

(

)

[static]

Returns:

the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

• fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
• keys - an array of fields which is used for uniquely identifying the object in the table.
• function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
• set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
• increment_key - the field which is incremented on table inserts.
• class_name - the classname which is used for instantiating new objecs when fetching from the database.
• sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
• name - the name of the database table

Example:

static function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line 54 of file ezcollaborationitem.php.

Referenced by fetch().

eZCollaborationItem::eZCollaborationItem

(

$

row

)

Constructor

Definition at line 49 of file ezcollaborationitem.php.

Referenced by create().

static eZCollaborationItem::fetch	(	$	id,
		$	creatorID = false,
		$	asObject = true
	)		[static]

Definition at line 166 of file ezcollaborationitem.php.

Referenced by eZApproveCollaborationHandler\activateApproval(), eZApproveCollaborationHandler\checkApproval(), eZApproveType\checkApproveCollaboration(), creator(), eZCollaborationEventType\eventContent(), and userStatus().

static eZCollaborationItem::fetchList

(

$

parameters = array()

)

[static]

Definition at line 362 of file ezcollaborationitem.php.

Referenced by eZCollaborationGroup\itemList().

static eZCollaborationItem::fetchListCount

(

$

parameters = array()

)

[static]

Definition at line 301 of file ezcollaborationitem.php.

static eZCollaborationItem::fetchListTool	(	$	parameters = array(),
		$	asCount
	)		[static]

Definition at line 367 of file ezcollaborationitem.php.

Referenced by fetchList(), and fetchListCount().

eZCollaborationItem::handler

(

)

Definition at line 206 of file ezcollaborationitem.php.

Referenced by content(), contentAttribute(), handleView(), hasContentAttribute(), messageCount(), title(), unreadMessageCount(), and useMessages().

eZCollaborationItem::handleView

(

$

viewMode

)

Definition at line 520 of file ezcollaborationitem.php.

eZCollaborationItem::hasContentAttribute

(

$

attribute

)

Definition at line 275 of file ezcollaborationitem.php.

eZCollaborationItem::isCreator

(

)

Definition at line 186 of file ezcollaborationitem.php.

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.

Definition at line 229 of file ezcollaborationitem.php.

eZCollaborationItem::participantList

(

)

Definition at line 195 of file ezcollaborationitem.php.

eZCollaborationItem::setIsActive	(	$	active,
		$	userID = false
	)

Definition at line 295 of file ezcollaborationitem.php.

eZCollaborationItem::setLastRead	(	$	userID = false,
		$	timestamp = false
	)

Definition at line 350 of file ezcollaborationitem.php.

eZCollaborationItem::title

(

)

Definition at line 264 of file ezcollaborationitem.php.

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.

Definition at line 244 of file ezcollaborationitem.php.

eZCollaborationItem::useMessages

(

)

Returns:

true if the item uses messages.

Note:

It's up to each handler to control this.

Definition at line 215 of file ezcollaborationitem.php.

eZCollaborationItem::userStatus

(

)

Definition at line 200 of file ezcollaborationitem.php.

---

Member Data Documentation

eZCollaborationItem::$Created

Definition at line 553 of file ezcollaborationitem.php.

eZCollaborationItem::$CreatorID

Definition at line 551 of file ezcollaborationitem.php.

eZCollaborationItem::$DataFloat1

Definition at line 561 of file ezcollaborationitem.php.

eZCollaborationItem::$DataFloat2

Definition at line 562 of file ezcollaborationitem.php.

eZCollaborationItem::$DataFloat3

Definition at line 563 of file ezcollaborationitem.php.

eZCollaborationItem::$DataInt1

Definition at line 558 of file ezcollaborationitem.php.

eZCollaborationItem::$DataInt2

Definition at line 559 of file ezcollaborationitem.php.

eZCollaborationItem::$DataInt3

Definition at line 560 of file ezcollaborationitem.php.

eZCollaborationItem::$DataText1

Definition at line 555 of file ezcollaborationitem.php.

eZCollaborationItem::$DataText2

Definition at line 556 of file ezcollaborationitem.php.

eZCollaborationItem::$DataText3

Definition at line 557 of file ezcollaborationitem.php.

eZCollaborationItem::$ID

Definition at line 549 of file ezcollaborationitem.php.

eZCollaborationItem::$Modified

Definition at line 554 of file ezcollaborationitem.php.

eZCollaborationItem::$Status

Definition at line 552 of file ezcollaborationitem.php.

eZCollaborationItem::$TypeIdentifier

Definition at line 550 of file ezcollaborationitem.php.

const eZCollaborationItem::STATUS_ACTIVE = 1

Definition at line 42 of file ezcollaborationitem.php.

Referenced by eZApproveCollaborationHandler\activateApproval().

const eZCollaborationItem::STATUS_ARCHIVE = 3

Definition at line 44 of file ezcollaborationitem.php.

const eZCollaborationItem::STATUS_INACTIVE = 2

Definition at line 43 of file ezcollaborationitem.php.

Referenced by eZApproveCollaborationHandler\handleCustomAction().

---

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

• ezcollaborationitem.php