eZCollaborationItem Class ReferenceThe class eZCollaborationItem does.
More...
Inheritance diagram for eZCollaborationItem:
TODO — Image not available in archive
Title: eZCollaborationItem Class Inheritance Diagram (Doxygen)
File: /doc/generated/html/classeZCollaborationItem.png
What this image shows:
Doxygen-generated class inheritance diagram for the eZCollaborationItem PHP class. Shows the inheritance hierarchy: which classes eZCollaborationItem 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 classeZCollaborationItem.png in the output. Or draw the inheritance tree manually from the API reference. Save as /doc/generated/html/classeZCollaborationItem.png
See /sdk/missing.html for the full list of missing images.
List of all members.
Detailed Description
The class eZCollaborationItem does.
Definition at line ezcollaborationitem.php.
Constructor & Destructor Documentation
| eZCollaborationItem::eZCollaborationItem |
( |
$ |
row |
) |
|
|
Member Function Documentation
| & eZCollaborationItem::attribute |
( |
$ |
attribute |
) |
|
|
| & eZCollaborationItem::definition |
( |
|
) |
|
|
|
|
- Returns:
-
the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.
The definition array is an associative array consists of these keys:
- fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
- keys - an array of fields which is used for uniquely identifying the object in the table.
- function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
- set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
- increment_key - the field which is incremented on table inserts.
- class_name - the classname which is used for instantiating new objecs when fetching from the database.
- sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either
asc or desc. - name - the name of the database table
Example: function definition()
{
return array( "fields" => array( "id" => "ID",
"version" => "Version",
"name" => "Name" ),
"keys" => array( "id", "version" ),
"function_attributes" => array( "current" => "currentVersion",
"class_name" => "className" ),
"increment_key" => "id",
"class_name" => "eZContentClass",
"sort" => array( "id" => "asc" ),
"name" => "ezcontentclass" );
}
Reimplemented from eZPersistentObject.
Definition at line ezcollaborationitem.php.
References ID. |
| eZCollaborationItem::hasAttribute |
( |
$ |
attribute |
) |
|
|
| eZCollaborationItem::messageCount |
( |
|
) |
|
|
|
|
- Returns:
-
the number of messages in this item.
- Note:
-
The message count is purely abstract and it's up to each handler to return a valid count.
Definition at line ezcollaborationitem.php.
Referenced by attribute(). |
| eZCollaborationItem::unreadMessageCount |
( |
|
) |
|
|
|
|
- Returns:
-
the number of unread messages in this item.
- Note:
-
The message count is purely abstract and it's up to each handler to return a valid count. It's also up the handler to keep track of which messages are read or not.
Definition at line ezcollaborationitem.php.
Referenced by attribute(). |
| eZCollaborationItem::useMessages |
( |
|
) |
|
|
The documentation for this class was generated from the following file:
|
