eZCollaborationGroup Class Reference

The class eZCollaborationGroup does. More...

Inheritance diagram for eZCollaborationGroup:

Collaboration diagram for eZCollaborationGroup:

List of all members.

Public Member Functions
	addChild ($group, $store=true)
	eZCollaborationGroup ($row)
	itemCount ($parameters=array())
	itemList ($parameters=array())
	parentGroup ()
	user ()
Static Public Member Functions
static	create ($userID, $title, $pathString= '', $depth=0, $parentGroupID=0, $isOpen=true)
static	definition ()
	Returns the definition for the object, the default implementation is to return an empty array.
static	fetch ($id, $userID=false, $asObject=true)
static	instantiate ($userID, $title, $parentGroupID=0, $isOpen=true)
static	subTree ($parameters=array())
Public Attributes
	$Created
	$ID
	$Modified
	$ParentGroupID
	$Title
	$UserID

---

Detailed Description

The class eZCollaborationGroup does.

Definition at line 17 of file ezcollaborationgroup.php.

---

Member Function Documentation

eZCollaborationGroup::addChild	(	$	group,
		$	store = true
	)

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 86 of file ezcollaborationgroup.php.

static eZCollaborationGroup::create	(	$	userID,
		$	title,
		$	pathString = '',
		$	depth = 0,
		$	parentGroupID = 0,
		$	isOpen = true
	)		[static]

Definition at line 132 of file ezcollaborationgroup.php.

Referenced by instantiate().

static eZCollaborationGroup::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: 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 ezcollaborationgroup.php.

Referenced by fetch().

eZCollaborationGroup::eZCollaborationGroup

(

$

row

)

Constructor

Definition at line 22 of file ezcollaborationgroup.php.

Referenced by create().

static eZCollaborationGroup::fetch	(	$	id,
		$	userID = false,
		$	asObject = true
	)		[static]

Definition at line 148 of file ezcollaborationgroup.php.

Referenced by instantiate(), parentGroup(), subTree(), and user().

static eZCollaborationGroup::instantiate	(	$	userID,
		$	title,
		$	parentGroupID = 0,
		$	isOpen = true
	)		[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 105 of file ezcollaborationgroup.php.

Referenced by eZCollaborationProfile\instance().

eZCollaborationGroup::itemCount

(

$

parameters = array()

)

Definition at line 290 of file ezcollaborationgroup.php.

eZCollaborationGroup::itemList

(

$

parameters = array()

)

Returns:

an array with collaboration items which are in this group.

Definition at line 162 of file ezcollaborationgroup.php.

eZCollaborationGroup::parentGroup

(

)

Definition at line 319 of file ezcollaborationgroup.php.

static eZCollaborationGroup::subTree

(

$

parameters = array()

)

[static]

Definition at line 168 of file ezcollaborationgroup.php.

Referenced by eZCollaborationFunctionCollection\fetchGroupTree().

eZCollaborationGroup::user

(

)

Definition at line 310 of file ezcollaborationgroup.php.

---

Member Data Documentation

eZCollaborationGroup::$Created

Definition at line 333 of file ezcollaborationgroup.php.

eZCollaborationGroup::$ID

Definition at line 329 of file ezcollaborationgroup.php.

eZCollaborationGroup::$Modified

Definition at line 334 of file ezcollaborationgroup.php.

eZCollaborationGroup::$ParentGroupID

Definition at line 330 of file ezcollaborationgroup.php.

eZCollaborationGroup::$Title

Definition at line 332 of file ezcollaborationgroup.php.

eZCollaborationGroup::$UserID

Definition at line 331 of file ezcollaborationgroup.php.

---

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

• ezcollaborationgroup.php