Manual

SDK

 
   

API Reference
 

Sections

Todo

eZCollaborationItemHandler Class Reference

The class eZCollaborationItemHandler does. More...

Inheritance diagram for eZCollaborationItemHandler:

eZApproveCollaborationHandler List of all members.

Public Methods

 eZCollaborationItemHandler ($typeIdentifier,$typeName,$parameters=array())
 hasAttribute ($attribute)
& attribute ($attribute)
 hasContentAttribute (&$collaborationItem,$attribute)
& contentAttribute (&$collaborationItem,$attribute)
 classes ()
 template ($viewMode)
 templateName ()
 title (&$collaborationItem)
 useMessages (&$collaborationItem)
 messageCount (&$collaborationItem)
 unreadMessageCount (&$collaborationItem)
 readItem (&$collaborationItem)
 participantTypeString ($participantType)
 participantRoleString ($participantRole)
 roleName ($collaborationID,$roleID)
 content (&$collaborationItem)
 handleCustomAction (&$module,&$collaborationItem)
 isCustomAction ($name)
 hasCustomInput ($name)
 customInput ($name)

Static Public Methods

& ini ()
 defaultRepositories ()
 extensionRepositories ()
 handlerRepositories ()
 activeHandlers ()
& instantiate ($handler,$repositories=false)
& fetchList ()

Public Attributes

 Info
 \privatesection

Detailed Description

The class eZCollaborationItemHandler does.

Definition at line ezcollaborationitemhandler.php.

Constructor & Destructor Documentation

eZCollaborationItemHandler::eZCollaborationItemHandler (  $    typeIdentifier,
$    typeName,
$    parameters = array()
) 
 

Initializes the handler with identifier and name. Optional parameters can be placed in $parameters.

Definition at line ezcollaborationitemhandler.php.

References Info.

Referenced by eZApproveCollaborationHandler::eZApproveCollaborationHandler().

Member Function Documentation

eZCollaborationItemHandler::activeHandlers (    )  [static]
 

Returns:
an array with handler identifiers that are considered active.

Definition at line ezcollaborationitemhandler.php.

References ini().

Referenced by fetchList().

& eZCollaborationItemHandler::attribute (  $    attribute ) 
 

Returns:
the attribute $attribute if it exists or null.

Definition at line ezcollaborationitemhandler.php.

References Info.

Referenced by hasContentAttribute().

eZCollaborationItemHandler::classes (    ) 
 

Returns:
a list of classes this handler supports.

Definition at line ezcollaborationitemhandler.php.

References Info.

Referenced by eZApproveCollaborationHandler::title().

eZCollaborationItemHandler::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 in eZApproveCollaborationHandler.

Definition at line ezcollaborationitemhandler.php.

Referenced by hasContentAttribute().

& eZCollaborationItemHandler::contentAttribute (  &$    collaborationItem,
$    attribute
) 
 

Returns:
the attribute $attribute if it exists in the content data or null.

Definition at line ezcollaborationitemhandler.php.

References content().

eZCollaborationItemHandler::customInput (  $    name ) 
 

Returns:
value of the custom input variable $name.

Definition at line ezcollaborationitemhandler.php.

References eZHTTPTool::instance().

Referenced by eZApproveCollaborationHandler::handleCustomAction().

eZCollaborationItemHandler::defaultRepositories (    )  [static]
 

Returns:
an array with directories which acts as default collaboration repositories.
See also:
handlerRepositories

Definition at line ezcollaborationitemhandler.php.

References ini().

Referenced by handlerRepositories().

eZCollaborationItemHandler::extensionRepositories (    )  [static]
 

Returns:
an array with directories which acts as collaboration extension repositories.
See also:
handlerRepositories

Definition at line ezcollaborationitemhandler.php.

References ini().

Referenced by handlerRepositories().

& eZCollaborationItemHandler::fetchList (    )  [static]
 

Returns:
a list of collaboration handler objects.
See also:
instantiate, activeHandlers

Definition at line ezcollaborationitemhandler.php.

References instantiate().

Referenced by instantiate().

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]
 

Returns:
an array with directories which acts as collaboration repositories.
See also:
defaultRepositories, extensionRepositories

Definition at line ezcollaborationitemhandler.php.

References eZDir::path().

Referenced by instantiate().

eZCollaborationItemHandler::hasAttribute (  $    attribute ) 
 

Returns:
true if the attribute $attribute exists.

Definition at line ezcollaborationitemhandler.php.

References attribute().

eZCollaborationItemHandler::hasContentAttribute (  &$    collaborationItem,
$    attribute
) 
 

Returns:
true if the attribute $attribute exists in the content data.

Definition at line ezcollaborationitemhandler.php.

References content().

eZCollaborationItemHandler::hasCustomInput (  $    name ) 
 

Returns:
true if the custom input variable $name exists.

Definition at line ezcollaborationitemhandler.php.

References eZHTTPTool::instance().

& eZCollaborationItemHandler::ini (    )  [static]
 

Returns:
the ini object which handles collaboration settings.

Definition at line ezcollaborationitemhandler.php.

References eZINI::instance().

Referenced by extensionRepositories().

& eZCollaborationItemHandler::instantiate (  $    handler,
$    repositories = false
)  [static]
 

Returns:
a unique instance of the handler for the identifier $handler. If $repositories is left out it will use the handlerRepositories.

Definition at line ezcollaborationitemhandler.php.

References eZDebug::writeWarning().

Referenced by fetchList().

eZCollaborationItemHandler::isCustomAction (  $    name ) 
 

Returns:
true if the current custom action is $name.

Definition at line ezcollaborationitemhandler.php.

References eZHTTPTool::instance().

Referenced by eZApproveCollaborationHandler::handleCustomAction().

eZCollaborationItemHandler::messageCount (  &$    collaborationItem ) 
 

Returns:
the number of 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::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 ) 
 

This is called whenever the item is considered to be read, it can be used by handlers to update when the item was last read.

Note:
Default implementation does nothing.

Reimplemented in eZApproveCollaborationHandler.

Definition at line ezcollaborationitemhandler.php.

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 ) 
 

Returns:
the template name for the viewmode $viewmode.

Definition at line ezcollaborationitemhandler.php.

References templateName().

eZCollaborationItemHandler::templateName (    ) 
 

Returns:
the name of the template file for this handler. Default is to append .tpl to the identifier.

Definition at line ezcollaborationitemhandler.php.

References Info.

Referenced by template().

eZCollaborationItemHandler::title (  &$    collaborationItem ) 
 

Returns:
the title of the collaboration item.

Reimplemented in eZApproveCollaborationHandler.

Definition at line ezcollaborationitemhandler.php.

References Info.

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:  

Exponential