eZCollaborationProfile Class Reference

The class eZCollaborationProfile does. More...

Inheritance diagram for eZCollaborationProfile:

Collaboration diagram for eZCollaborationProfile:

List of all members.

Public Member Functions
	eZCollaborationProfile ($row)
Static Public Member Functions
static	create ($userID, $mainGroup=0)
static	definition ()
static	fetch ($id, $asObject=true)
static	fetchByUser ($userID, $asObject=true)
static	instance ($userID=false)
	Returns a shared instance of the eZCollaborationProfile class pr user id.

---

Detailed Description

The class eZCollaborationProfile does.

Definition at line 40 of file ezcollaborationprofile.php.

---

Member Function Documentation

static eZCollaborationProfile::create	(	$	userID,
		$	mainGroup = 0
	)		[static]

Definition at line 88 of file ezcollaborationprofile.php.

Referenced by instance().

static eZCollaborationProfile::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 ezcollaborationprofile.php.

Referenced by fetch(), and fetchByUser().

eZCollaborationProfile::eZCollaborationProfile

(

$

row

)

Constructor

Definition at line 45 of file ezcollaborationprofile.php.

Referenced by create().

static eZCollaborationProfile::fetch	(	$	id,
		$	asObject = true
	)		[static]

Definition at line 100 of file ezcollaborationprofile.php.

static eZCollaborationProfile::fetchByUser	(	$	userID,
		$	asObject = true
	)		[static]

Definition at line 109 of file ezcollaborationprofile.php.

Referenced by instance().

static eZCollaborationProfile::instance

(

$

userID = false

)

[static]

Returns a shared instance of the eZCollaborationProfile class pr user id.

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:

$userID

int|false Uses current user id if false.

Returns:

eZCollaborationProfile

Definition at line 127 of file ezcollaborationprofile.php.

Referenced by eZApproveCollaborationHandler\createApproval().

---

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

• ezcollaborationprofile.php