eZCollaborationItem Class Reference

Public Methods

Public Attributes

Constructor

Definition at line ezcollaborationitem.php.

References eZPersistentObject::eZPersistentObject().

Returns:

the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched.

Reimplemented from eZPersistentObject.

Definition at line ezcollaborationitem.php.

References useMessages().

Referenced by hasAttribute().

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.

• 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

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.

Returns:

true if the attribute $attr is part of the definition fields or function attributes.

Reimplemented from eZPersistentObject.

Definition at line ezcollaborationitem.php.

References eZPersistentObject::hasAttribute().

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().

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().

Returns:

true if the item uses messages.

Note:

It's up to each handler to control this.

Definition at line ezcollaborationitem.php.

Referenced by attribute().