eZPublish  4.7
eZApproveCollaborationHandler Class Reference

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)
 
- Public Member Functions inherited from eZCollaborationItemHandler
 attribute ($attribute)
 
 attributes ()
 
 classes ()
 
 content ($collaborationItem)
 
 contentAttribute ($collaborationItem, $attribute)
 
 customInput ($name)
 
 eZCollaborationItemHandler ($typeIdentifier, $typeName, $parameters=array())
 
 handleCustomAction ($module, $collaborationItem)
 
 hasAttribute ($attr)
 
 hasContentAttribute ($collaborationItem, $attribute)
 
 hasCustomInput ($name)
 
 isCustomAction ($name)
 
 messageCount ($collaborationItem)
 
 notificationCollectionHandling ()
 
 notificationParticipantTemplate ($participantRole)
 
 notificationTypes ()
 
 participantRoleString ($participantRole)
 
 participantTypeString ($participantType)
 
 readItem ($collaborationItem, $viewMode=false)
 
 removeItem ($collaborationItem)
 
 roleName ($collaborationID, $roleID)
 
 template ($viewMode)
 
 templateName ()
 
 title ($collaborationItem)
 
 unreadMessageCount ($collaborationItem)
 
 useMessages ($collaborationItem)
 

Static Public Member Functions

static activateApproval ($approvalID)
 
static checkApproval ($approvalID)
 
static contentObjectVersion ($collaborationItem)
 
static createApproval ($contentObjectID, $contentObjectVersion, $authorID, $approverIDArray)
 
- Static Public Member Functions inherited from eZCollaborationItemHandler
static activeHandlers ()
 
static defaultRepositories ()
 
static extensionRepositories ()
 
static fetchList ()
 
static handleCollaborationEvent ($event, $item, &$parameters)
 
static handlerRepositories ()
 
static ini ()
 
static instantiate ($handler, $repositories=false)
 

Public Attributes

const MESSAGE_TYPE_APPROVE = 1
 Approval message type. More...
 
const STATUS_ACCEPTED = 1
 The contentobject was approved and will be published. More...
 
const STATUS_DEFERRED = 3
 The contentobject was deferred and will be a draft again for reediting. More...
 
const STATUS_DENIED = 2
 The contentobject was denied and will be archived. More...
 
const STATUS_WAITING = 0
 Default status, no approval decision has been made. More...
 
- Public Attributes inherited from eZCollaborationItemHandler
 $Info
 
const NOTIFICATION_COLLECTION_ONE_FOR_ALL = 1
 
const NOTIFICATION_COLLECTION_PER_PARTICIPATION_ROLE = 3
 
const NOTIFICATION_COLLECTION_PER_USER = 2
 

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.

Member Function Documentation

static eZApproveCollaborationHandler::activateApproval (   $approvalID)
static
Returns
makes sure the approval item is activated for all participants $approvalID.

Referenced by eZApproveType\execute().

static eZApproveCollaborationHandler::checkApproval (   $approvalID)
static
Returns
the status of the approval collaboration item $approvalID.

Referenced by eZApproveType\checkApproveCollaboration().

eZApproveCollaborationHandler::content (   $collaborationItem)
static eZApproveCollaborationHandler::contentObjectVersion (   $collaborationItem)
static
Returns
the content object version object for the collaboration item $collaborationItem

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.

Returns
the collaboration item.

Referenced by eZApproveType\createApproveCollaboration().

eZApproveCollaborationHandler::eZApproveCollaborationHandler ( )

Initializes the handler

eZApproveCollaborationHandler::handleCustomAction (   $module,
  $collaborationItem 
)

Adds a new comment, approves the item or denies the item.

eZApproveCollaborationHandler::messageCount (   $collaborationItem)
Returns
the number of messages for the approve item.
eZApproveCollaborationHandler::notificationParticipantTemplate (   $participantRole)
eZApproveCollaborationHandler::readItem (   $collaborationItem,
  $viewMode = false 
)

Updates the last_read for the participant link.

eZApproveCollaborationHandler::title (   $collaborationItem)
eZApproveCollaborationHandler::unreadMessageCount (   $collaborationItem)
Returns
the number of unread messages for the approve item.

Member Data Documentation

const eZApproveCollaborationHandler::MESSAGE_TYPE_APPROVE = 1

Approval message type.

const eZApproveCollaborationHandler::STATUS_ACCEPTED = 1

The contentobject was approved and will be published.

Referenced by eZApproveType\checkApproveCollaboration().

const eZApproveCollaborationHandler::STATUS_DEFERRED = 3

The contentobject was deferred and will be a draft again for reediting.

Referenced by eZApproveType\checkApproveCollaboration().

const eZApproveCollaborationHandler::STATUS_DENIED = 2

The contentobject was denied and will be archived.

Referenced by eZApproveType\checkApproveCollaboration().

const eZApproveCollaborationHandler::STATUS_WAITING = 0

Default status, no approval decision has been made.

Referenced by eZApproveType\checkApproveCollaboration().


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