eZCollaborationItemHandler Class ReferenceThe class eZCollaborationItemHandler does.
More...
Inheritance diagram for eZCollaborationItemHandler:
TODO — Image not available in archive
Title: eZCollaborationItemHandler Class Inheritance Diagram (Doxygen)
File: /doc/generated/html/classeZCollaborationItemHandler.png
What this image shows:
Doxygen-generated class inheritance diagram for the eZCollaborationItemHandler PHP class. Shows the inheritance hierarchy: which classes eZCollaborationItemHandler 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 classeZCollaborationItemHandler.png in the output. Or draw the inheritance tree manually from the API reference. Save as /doc/generated/html/classeZCollaborationItemHandler.png
See /sdk/missing.html for the full list of missing images.
List of all members.
Detailed Description
The class eZCollaborationItemHandler does.
Definition at line ezcollaborationitemhandler.php.
Constructor & Destructor Documentation
| eZCollaborationItemHandler::eZCollaborationItemHandler |
( |
$ |
typeIdentifier, |
|
|
$ |
typeName, |
|
|
$ |
parameters = array() |
|
) |
|
|
Member Function Documentation
| eZCollaborationItemHandler::activeHandlers |
( |
|
) |
[static] |
|
| & eZCollaborationItemHandler::attribute |
( |
$ |
attribute |
) |
|
|
| eZCollaborationItemHandler::classes |
( |
|
) |
|
|
| eZCollaborationItemHandler::content |
( |
&$ |
collaborationItem |
) |
|
|
| & eZCollaborationItemHandler::contentAttribute |
( |
&$ |
collaborationItem, |
|
|
$ |
attribute |
|
) |
|
|
| eZCollaborationItemHandler::customInput |
( |
$ |
name |
) |
|
|
| eZCollaborationItemHandler::defaultRepositories |
( |
|
) |
[static] |
|
| eZCollaborationItemHandler::extensionRepositories |
( |
|
) |
[static] |
|
| & eZCollaborationItemHandler::fetchList |
( |
|
) |
[static] |
|
| eZCollaborationItemHandler::handleCustomAction |
( |
&$ |
module, |
|
|
&$ |
collaborationItem |
|
) |
|
|
|
|
This function is called when a custom action is executed for a specific collaboration item. The module object is available in $module and the item in $collaborationItem. - Note:
-
The default does nothing, the function must be reimplemented in real handlers.
- See also:
-
isCustomAction
Reimplemented in eZApproveCollaborationHandler.
Definition at line ezcollaborationitemhandler.php. |
| eZCollaborationItemHandler::handlerRepositories |
( |
|
) |
[static] |
|
| eZCollaborationItemHandler::hasAttribute |
( |
$ |
attribute |
) |
|
|
| eZCollaborationItemHandler::hasContentAttribute |
( |
&$ |
collaborationItem, |
|
|
$ |
attribute |
|
) |
|
|
| eZCollaborationItemHandler::hasCustomInput |
( |
$ |
name |
) |
|
|
| & eZCollaborationItemHandler::ini |
( |
|
) |
[static] |
|
| & eZCollaborationItemHandler::instantiate |
( |
$ |
handler, |
|
|
$ |
repositories = false |
|
) |
[static] |
|
| eZCollaborationItemHandler::isCustomAction |
( |
$ |
name |
) |
|
|
| eZCollaborationItemHandler::messageCount |
( |
&$ |
collaborationItem |
) |
|
|
| eZCollaborationItemHandler::participantRoleString |
( |
$ |
participantRole |
) |
|
|
|
|
- Returns:
-
a textual representation of the participant role id $participantRole
- Note:
-
It's up to the real handlers to implement this if they use custom participation roles.
Definition at line ezcollaborationitemhandler.php. |
| eZCollaborationItemHandler::participantTypeString |
( |
$ |
participantType |
) |
|
|
|
|
- Returns:
-
a textual representation of the participant type id $participantType
- Note:
-
It's up to the real handlers to implement this if they use custom participation types.
Definition at line ezcollaborationitemhandler.php. |
| eZCollaborationItemHandler::readItem |
( |
&$ |
collaborationItem |
) |
|
|
| eZCollaborationItemHandler::roleName |
( |
$ |
collaborationID, |
|
|
$ |
roleID |
|
) |
|
|
|
|
- Returns:
-
a description of the role id $roleID in the current language.
- Note:
-
It's up to the real handlers to implement this if they use custom participation roles.
Definition at line ezcollaborationitemhandler.php. |
| eZCollaborationItemHandler::template |
( |
$ |
viewMode |
) |
|
|
| eZCollaborationItemHandler::templateName |
( |
|
) |
|
|
| eZCollaborationItemHandler::title |
( |
&$ |
collaborationItem |
) |
|
|
| eZCollaborationItemHandler::unreadMessageCount |
( |
&$ |
collaborationItem |
) |
|
|
|
|
- Returns:
-
the number of unread messages for the collaboration item $collaborationItem.
- Note:
-
The default implementation returns 0, if you want real counts the handler must reimplement this function.
Reimplemented in eZApproveCollaborationHandler.
Definition at line ezcollaborationitemhandler.php. |
| eZCollaborationItemHandler::useMessages |
( |
&$ |
collaborationItem |
) |
|
|
|
|
- Returns:
-
true if the collaboration item $collaborationItem supports messages.
- Note:
-
The handler can either determine this by passing $useMessages to the constructor or by reimplementing this function to do it per item.
Definition at line ezcollaborationitemhandler.php.
References Info. |
The documentation for this class was generated from the following file:
|
