eZ Publish  [trunk]
eZCollaborationItemStatus Class Reference

The class eZCollaborationItemStatus does. More...

+ Inheritance diagram for eZCollaborationItemStatus:
+ Collaboration diagram for eZCollaborationItemStatus:

List of all members.

Public Member Functions

 eZCollaborationItemStatus ($row)
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it.
 updateCache ()

Static Public Member Functions

static create ($collaborationID, $userID=false)
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array.
static fetch ($collaborationID, $userID=false, $asObject=true)
static setLastRead ($collaborationID, $userID=false, $timestamp=false)
static updateFields ($collaborationID, $userID=false, $fields)

Detailed Description

The class eZCollaborationItemStatus does.

Definition at line 17 of file ezcollaborationitemstatus.php.


Member Function Documentation

static eZCollaborationItemStatus::create ( collaborationID,
userID = false 
) [static]

Definition at line 60 of file ezcollaborationitemstatus.php.

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: public static 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" ); }

Returns:
array

Reimplemented from eZPersistentObject.

Definition at line 27 of file ezcollaborationitemstatus.php.

Referenced by fetch(), and updateFields().

Constructor

Definition at line 22 of file ezcollaborationitemstatus.php.

Referenced by create().

static eZCollaborationItemStatus::fetch ( collaborationID,
userID = false,
asObject = true 
) [static]

Definition at line 87 of file ezcollaborationitemstatus.php.

static eZCollaborationItemStatus::setLastRead ( collaborationID,
userID = false,
timestamp = false 
) [static]

Definition at line 106 of file ezcollaborationitemstatus.php.

eZCollaborationItemStatus::store ( fieldFilters = null)

Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it.

Note: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Parameters:
array | null$fieldFilters
Returns:
void

Reimplemented from eZPersistentObject.

Definition at line 73 of file ezcollaborationitemstatus.php.

Definition at line 80 of file ezcollaborationitemstatus.php.

Referenced by store().

static eZCollaborationItemStatus::updateFields ( collaborationID,
userID = false,
fields 
) [static]

Definition at line 115 of file ezcollaborationitemstatus.php.

Referenced by eZCollaborationItem\setIsActive(), and setLastRead().


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