Handles approval communication using the collaboration system. More...

Inheritance diagram for eZApproveCollaborationHandler:

Collaboration diagram for eZApproveCollaborationHandler:

Public Member Functions
	content ($collaborationItem)
	eZApproveCollaborationHandler ()
	handleCustomAction ($module, $collaborationItem)
	messageCount ($collaborationItem)
	notificationParticipantTemplate ($participantRole)
	readItem ($collaborationItem, $viewMode=false)
	title ($collaborationItem)
	unreadMessageCount ($collaborationItem)
Static Public Member Functions
static	activateApproval ($approvalID)
static	checkApproval ($approvalID)
static	contentObjectVersion ($collaborationItem)
static	createApproval ($contentObjectID, $contentObjectVersion, $authorID, $approverIDArray)
Public Attributes
const	MESSAGE_TYPE_APPROVE = 1
	Approval message type.
const	STATUS_ACCEPTED = 1
	The contentobject was approved and will be published.
const	STATUS_DEFERRED = 3
	The contentobject was deferred and will be a draft again for reediting.
const	STATUS_DENIED = 2
	The contentobject was denied and will be archived.
const	STATUS_WAITING = 0
	Default status, no approval decision has been made.

Detailed Description

Handles approval communication using the collaboration system.

The handler uses the fields data_int1, data_int2 and data_int3 to store information on the contentobject and the approval status.

data_int1 - The content object ID
data_int2 - The content object version
data_int3 - The status of the approval, see defines.

Definition at line 49 of file ezapprovecollaborationhandler.php.

Member Function Documentation

static eZApproveCollaborationHandler::activateApproval ( $ approvalID ) [static]

Returns:: makes sure the approval item is activated for all participants $approvalID.

Definition at line 161 of file ezapprovecollaborationhandler.php.

Referenced by eZApproveType\execute().

static eZApproveCollaborationHandler::checkApproval ( $ approvalID ) [static]

Returns:: the status of the approval collaboration item $approvalID.

Definition at line 147 of file ezapprovecollaborationhandler.php.

Referenced by eZApproveType\checkApproveCollaboration().

eZApproveCollaborationHandler::content ( $ collaborationItem )

Returns:: the content of the collaborationitem.

Note:: This is specific to the item type, some might return an array and others an object.

Reimplemented from eZCollaborationItemHandler.

Definition at line 83 of file ezapprovecollaborationhandler.php.

static eZApproveCollaborationHandler::contentObjectVersion ( $ collaborationItem ) [static]

Returns:: the content object version object for the collaboration item $collaborationItem

Definition at line 107 of file ezapprovecollaborationhandler.php.

Referenced by eZApproveType\checkApproveCollaboration(), and handleCustomAction().

static eZApproveCollaborationHandler::createApproval	(	$	contentObjectID,
		$	contentObjectVersion,
		$	authorID,
		$	approverIDArray
	)		`[static]`

Creates a new approval collaboration item which will approve the content object $contentObjectID with version $contentObjectVersion. The item will be added to the author $authorID and the approver array $approverIDArray.