eZ Publish  [trunk]
eZContentClassClassGroup Class Reference

! eZKernel The class eZContentClassClassGroup More...

+ Inheritance diagram for eZContentClassClassGroup:
+ Collaboration diagram for eZContentClassClassGroup:

List of all members.

Public Member Functions

 eZContentClassClassGroup ($row)

Static Public Member Functions

static classInGroup ($contentclassID, $contentclassVersion, $groupID)
static create ($contentclass_id, $contentclass_version, $group_id, $group_name)
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array.
static fetch ($contentclass_id, $contentclass_version, $group_id, $asObject=true)
static fetchClassList ($contentclass_version, $group_id, $asObject=true, $orderByArray=array( 'name'))
static fetchClassListByGroups ($contentclassVersion, $groupIDList, $asObject=true)
static fetchGroupList ($contentclass_id, $contentclass_version, $asObject=true)
static removeClassMembers ($contentclass_id, $contentclass_version)
static removeGroup ($contentclass_id, $contentclass_version, $group_id)
static removeGroupMembers ($group_id)
static update ($contentclass_version, $group_id, $group_name)

Public Attributes

 $ContentClassID
 $ContentClassVersion
 $GroupID
 $GroupName

Detailed Description

! eZKernel The class eZContentClassClassGroup

Definition at line 17 of file ezcontentclassclassgroup.php.


Member Function Documentation

static eZContentClassClassGroup::classInGroup ( contentclassID,
contentclassVersion,
groupID 
) [static]

Definition at line 217 of file ezcontentclassclassgroup.php.

Referenced by eZContentClass\inGroup().

static eZContentClassClassGroup::create ( contentclass_id,
contentclass_version,
group_id,
group_name 
) [static]

Definition at line 52 of file ezcontentclassclassgroup.php.

Referenced by eZClassFunctions\addGroup().

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 24 of file ezcontentclassclassgroup.php.

Referenced by classInGroup(), fetch(), fetchClassListByGroups(), fetchGroupList(), removeClassMembers(), removeGroup(), removeGroupMembers(), and update().

Definition at line 19 of file ezcontentclassclassgroup.php.

Referenced by create().

static eZContentClassClassGroup::fetch ( contentclass_id,
contentclass_version,
group_id,
asObject = true 
) [static]

Definition at line 124 of file ezcontentclassclassgroup.php.

Referenced by fetchClassListByGroups().

static eZContentClassClassGroup::fetchClassList ( contentclass_version,
group_id,
asObject = true,
orderByArray = array( 'name' ) 
) [static]

Definition at line 134 of file ezcontentclassclassgroup.php.

Referenced by eZUser\fetchUserGroupClassNames().

static eZContentClassClassGroup::fetchClassListByGroups ( contentclassVersion,
groupIDList,
asObject = true 
) [static]

Definition at line 173 of file ezcontentclassclassgroup.php.

static eZContentClassClassGroup::fetchGroupList ( contentclass_id,
contentclass_version,
asObject = true 
) [static]
static eZContentClassClassGroup::removeClassMembers ( contentclass_id,
contentclass_version 
) [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 117 of file ezcontentclassclassgroup.php.

Referenced by eZContentClassOperations\remove(), and eZContentClass\storeVersioned().

static eZContentClassClassGroup::removeGroup ( contentclass_id,
contentclass_version,
group_id 
) [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 86 of file ezcontentclassclassgroup.php.

static eZContentClassClassGroup::removeGroupMembers ( group_id) [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 107 of file ezcontentclassclassgroup.php.

static eZContentClassClassGroup::update ( contentclass_version,
group_id,
group_name 
) [static]

Definition at line 65 of file ezcontentclassclassgroup.php.


Member Data Documentation

eZContentClassClassGroup::$ContentClassID

Definition at line 231 of file ezcontentclassclassgroup.php.

eZContentClassClassGroup::$ContentClassVersion

Definition at line 232 of file ezcontentclassclassgroup.php.

eZContentClassClassGroup::$GroupID

Definition at line 233 of file ezcontentclassclassgroup.php.

eZContentClassClassGroup::$GroupName

Definition at line 234 of file ezcontentclassclassgroup.php.


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