eZPublish  3.8
eZApproveCollaborationHandler Class Reference

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

+ Inheritance diagram for eZApproveCollaborationHandler:
+ Collaboration diagram for eZApproveCollaborationHandler:

Public Member Functions

content (&$collaborationItem)
 
 contentObjectVersion (&$collaborationItem)
 
 createApproval ($contentObjectID, $contentObjectVersion, $authorID, $approverIDArray)
 
 eZApproveCollaborationHandler ()
 
 handleCustomAction (&$module, &$collaborationItem)
 
 messageCount (&$collaborationItem)
 
 notificationParticipantTemplate ($participantRole)
 
 readItem (&$collaborationItem)
 
 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

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

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

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

Referenced by eZApproveType\execute().

eZApproveCollaborationHandler::checkApproval (   $approvalID)
static
Returns
the status of the approval collaboration item $approvalID.
& eZApproveCollaborationHandler::content ( $collaborationItem)
eZApproveCollaborationHandler::contentObjectVersion ( $collaborationItem)
Returns
the content object version object for the collaboration item $collaborationItem

Referenced by handleCustomAction().

eZApproveCollaborationHandler::createApproval (   $contentObjectID,
  $contentObjectVersion,
  $authorID,
  $approverIDArray 
)

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)

Updates the last_read for the participant link.

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

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