eZ Publish  [trunk]
eZCollaborationItemParticipantLink Class Reference

The class eZCollaborationItemParticipantLink does. More...

+ Inheritance diagram for eZCollaborationItemParticipantLink:
+ Collaboration diagram for eZCollaborationItemParticipantLink:

List of all members.

Public Member Functions

 collaborationItem ()
 eZCollaborationItemParticipantLink ($row)
 isBuiltinRole ()
 isBuiltinType ()
 participant ()
 participantRoleString ()
 participantTypeString ()

Static Public Member Functions

static create ($collaborationID, $participantID, $participantRole=self::ROLE_STANDARD, $participantType=self::TYPE_USER)
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array.
static fetch ($collaborationID, $participantID, $asObject=true)
static fetchParticipantList ($parameters=array())
static fetchParticipantMap ($originalParameters=array())
static roleName ($collaborationID, $roleID)
static roleString ($participantRole)
static setLastRead ($collaborationID, $userID=false, $timestamp=false)
static typeString ($participantType)

Public Attributes

 $CollaborationID
 $Created
 $IsActive
 $IsRead
 $Modified
 $ParticipantID
 $ParticipantType
const ROLE_APPROVER = 4
const ROLE_AUTHOR = 5
const ROLE_CUSTOM = 1024
const ROLE_OBSERVER = 2
const ROLE_OWNER = 3
const ROLE_STANDARD = 1
const TYPE_CUSTOM = 1024
const TYPE_USER = 1
const TYPE_USERGROUP = 2

Detailed Description


Member Function Documentation

static eZCollaborationItemParticipantLink::create ( collaborationID,
participantID,
participantRole = self::ROLE_STANDARD,
participantType = self::TYPE_USER 
) [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: 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 42 of file ezcollaborationitemparticipantlink.php.

Referenced by fetch(), and fetchParticipantList().

static eZCollaborationItemParticipantLink::fetchParticipantMap ( originalParameters = array()) [static]

Definition at line 185 of file ezcollaborationitemparticipantlink.php.

static eZCollaborationItemParticipantLink::roleName ( collaborationID,
roleID 
) [static]

Definition at line 257 of file ezcollaborationitemparticipantlink.php.

Referenced by fetchParticipantMap().

static eZCollaborationItemParticipantLink::roleString ( participantRole) [static]

Definition at line 237 of file ezcollaborationitemparticipantlink.php.

Referenced by participantRoleString().

static eZCollaborationItemParticipantLink::setLastRead ( collaborationID,
userID = false,
timestamp = false 
) [static]
Note:
transaction unsafe

Definition at line 105 of file ezcollaborationitemparticipantlink.php.

static eZCollaborationItemParticipantLink::typeString ( participantType) [static]

Definition at line 223 of file ezcollaborationitemparticipantlink.php.

Referenced by participantTypeString().


Member Data Documentation

eZCollaborationItemParticipantLink::$CollaborationID

Definition at line 334 of file ezcollaborationitemparticipantlink.php.

eZCollaborationItemParticipantLink::$Created

Definition at line 339 of file ezcollaborationitemparticipantlink.php.

eZCollaborationItemParticipantLink::$IsActive

Definition at line 338 of file ezcollaborationitemparticipantlink.php.

eZCollaborationItemParticipantLink::$IsRead

Definition at line 337 of file ezcollaborationitemparticipantlink.php.

eZCollaborationItemParticipantLink::$Modified

Definition at line 340 of file ezcollaborationitemparticipantlink.php.

eZCollaborationItemParticipantLink::$ParticipantID

Definition at line 335 of file ezcollaborationitemparticipantlink.php.

eZCollaborationItemParticipantLink::$ParticipantType

Definition at line 336 of file ezcollaborationitemparticipantlink.php.


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