eZ Publish  [4.2]
eZCollaborationItemMessageLink Class Reference

The class eZCollaborationItemMessageLink does. More...

+ Inheritance diagram for eZCollaborationItemMessageLink:
+ Collaboration diagram for eZCollaborationItemMessageLink:

List of all members.

Public Member Functions

 collaborationItem ()
 eZCollaborationItemMessageLink ($row)
 participant ()
 simpleMessage ()

Static Public Member Functions

static addMessage ($collaborationItem, $message, $messageType, $participantID=false)
static create ($collaborationID, $messageID, $messageType, $participantID)
static definition ()
static fetch ($id, $asObject=true)
static fetchItemCount ($parameters)
static fetchItemList ($parameters)

Public Attributes

 $CollaborationID
 $Created
 $MessageID
 $Modified
 $ParticipantID

Detailed Description

The class eZCollaborationItemMessageLink does.

Definition at line 40 of file ezcollaborationitemmessagelink.php.


Member Function Documentation

static eZCollaborationItemMessageLink::addMessage ( collaborationItem,
message,
messageType,
participantID = false 
) [static]
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.

Definition at line 115 of file ezcollaborationitemmessagelink.php.

Referenced by eZApproveCollaborationHandler\handleCustomAction().

eZCollaborationItemMessageLink::collaborationItem ( )

Definition at line 203 of file ezcollaborationitemmessagelink.php.

static eZCollaborationItemMessageLink::create ( collaborationID,
messageID,
messageType,
participantID 
) [static]

Definition at line 98 of file ezcollaborationitemmessagelink.php.

Referenced by addMessage().

static eZCollaborationItemMessageLink::definition ( ) [static]
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:

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

Reimplemented from eZPersistentObject.

Definition at line 50 of file ezcollaborationitemmessagelink.php.

Referenced by fetch(), fetchItemCount(), and fetchItemList().

eZCollaborationItemMessageLink::eZCollaborationItemMessageLink ( row)

Constructor

Definition at line 45 of file ezcollaborationitemmessagelink.php.

Referenced by create().

static eZCollaborationItemMessageLink::fetch ( id,
asObject = true 
) [static]
static eZCollaborationItemMessageLink::fetchItemCount ( parameters) [static]
static eZCollaborationItemMessageLink::fetchItemList ( parameters) [static]

Definition at line 176 of file ezcollaborationitemmessagelink.php.

eZCollaborationItemMessageLink::participant ( )

Definition at line 213 of file ezcollaborationitemmessagelink.php.

eZCollaborationItemMessageLink::simpleMessage ( )

Definition at line 218 of file ezcollaborationitemmessagelink.php.


Member Data Documentation

eZCollaborationItemMessageLink::$CollaborationID

Definition at line 229 of file ezcollaborationitemmessagelink.php.

eZCollaborationItemMessageLink::$Created

Definition at line 232 of file ezcollaborationitemmessagelink.php.

eZCollaborationItemMessageLink::$MessageID

Definition at line 230 of file ezcollaborationitemmessagelink.php.

eZCollaborationItemMessageLink::$Modified

Definition at line 233 of file ezcollaborationitemmessagelink.php.

eZCollaborationItemMessageLink::$ParticipantID

Definition at line 231 of file ezcollaborationitemmessagelink.php.


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