📚 Looking for current Exponential documentation? This site contains legacy SDK & API reference docs (eZ Publish era). For up-to-date 2026 product documentation, visit doc.exponential.earth.

  class / eZApproveCollaborationHandler  

API Reference
 

Sections

Modules
Hierarchy
Annotated
Files
Functions
Related
  Todo

eZApproveCollaborationHandler Class Reference

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

Inheritance diagram for eZApproveCollaborationHandler: 

TODO — Image not available in archive

Title:   eZApproveCollaborationHandler Class Inheritance Diagram (Doxygen)
File:    /doc/generated/html/classeZApproveCollaborationHandler.png

What this image shows:
Doxygen-generated class inheritance diagram for the eZApproveCollaborationHandler PHP class. Shows the inheritance hierarchy: which classes eZApproveCollaborationHandler extends and which classes inherit from it, with links to parent and child class documentation. This diagram was auto-generated from the Exponential 3.1 PHP source code using Doxygen circa 2003.

Replacement instructions:
Run Doxygen on the Exponential 3.1 PHP source and locate the generated classeZApproveCollaborationHandler.png in the output. Or draw the inheritance tree manually from the API reference. Save as /doc/generated/html/classeZApproveCollaborationHandler.png

See /sdk/missing.html for the full list of missing images.
eZCollaborationItemHandler List of all members.

Public Methods

 eZApproveCollaborationHandler ()
 title (&$collaborationItem)
 content (&$collaborationItem)
& contentObjectVersion (&$collaborationItem)
 readItem (&$collaborationItem)
 messageCount (&$collaborationItem)
 unreadMessageCount (&$collaborationItem)
 createApproval ($contentObjectID,$contentObjectVersion,$authorID,$approverID)
 handleCustomAction (&$module,&$collaborationItem)

Static Public Methods

 checkApproval ($approvalID)
 activateApproval ($approvalID)

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 77 of file ezapprovecollaborationhandler.php.

Constructor & Destructor Documentation

eZApproveCollaborationHandler::eZApproveCollaborationHandler (    ) 
 

Initializes the handler

Definition at line 82 of file ezapprovecollaborationhandler.php.

References eZCollaborationItemHandler::classes(), and eZCollaborationItemHandler::eZCollaborationItemHandler().

Member Function Documentation

eZApproveCollaborationHandler::activateApproval (  $    approvalID )  [static]
 

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

Definition at line 169 of file ezapprovecollaborationhandler.php.

References eZDateTime::currentTimeStamp().

eZApproveCollaborationHandler::checkApproval (  $    approvalID )  [static]
 

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

Definition at line 155 of file ezapprovecollaborationhandler.php.

eZApproveCollaborationHandler::content (  &$    collaborationItem ) 
 

Reimplemented for internal reasons; the API is not affected.

Reimplemented from eZCollaborationItemHandler.

Definition at line 100 of file ezapprovecollaborationhandler.php.

& eZApproveCollaborationHandler::contentObjectVersion (  &$    collaborationItem ) 
 

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

Definition at line 110 of file ezapprovecollaborationhandler.php.

References contentObjectVersion().

Referenced by contentObjectVersion(), createApproval(), and handleCustomAction().

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

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 $approverID.

Returns:
the collaboration item.

Definition at line 197 of file ezapprovecollaborationhandler.php.

References contentObjectVersion().

eZApproveCollaborationHandler::handleCustomAction (  &$    module,
&$    collaborationItem
) 
 

Reimplemented for internal reasons; the API is not affected. Adds a new comment, approves the item or denies the item.

Reimplemented from eZCollaborationItemHandler.

Definition at line 230 of file ezapprovecollaborationhandler.php.

References contentObjectVersion(), eZDateTime::currentTimeStamp(), eZCollaborationItemHandler::customInput(), and eZCollaborationItemHandler::isCustomAction().

eZApproveCollaborationHandler::messageCount (  &$    collaborationItem ) 
 

Reimplemented for internal reasons; the API is not affected.

Returns:
the number of messages for the approve item.

Reimplemented from eZCollaborationItemHandler.

Definition at line 130 of file ezapprovecollaborationhandler.php.

eZApproveCollaborationHandler::readItem (  &$    collaborationItem ) 
 

Reimplemented for internal reasons; the API is not affected. Updates the last_read for the participant link.

Reimplemented from eZCollaborationItemHandler.

Definition at line 121 of file ezapprovecollaborationhandler.php.

eZApproveCollaborationHandler::title (  &$    collaborationItem ) 
 

Reimplemented for internal reasons; the API is not affected.

Reimplemented from eZCollaborationItemHandler.

Definition at line 92 of file ezapprovecollaborationhandler.php.

References eZCollaborationItemHandler::classes().

eZApproveCollaborationHandler::unreadMessageCount (  &$    collaborationItem ) 
 

Reimplemented for internal reasons; the API is not affected.

Returns:
the number of unread messages for the approve item.

Reimplemented from eZCollaborationItemHandler.

Definition at line 139 of file ezapprovecollaborationhandler.php.

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

Exponential Copyright © 1998 - 2026 7x