eZ Publish  [trunk]
eZContentClassGroup Class Reference

! eZKernel The class eZContentClassGroup More...

+ Inheritance diagram for eZContentClassGroup:
+ Collaboration diagram for eZContentClassGroup:

List of all members.

Public Member Functions

 appendClass ($class, $version=false)
 creator ()
 eZContentClassGroup ($row)
 modifier ()

Static Public Member Functions

static create ($userID=false)
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array.
static fetch ($id, $user_id=false, $asObject=true)
static fetchByName ($name, $asObject=true)
static fetchList ($user_id=false, $asObject=true)
static removeSelected ($id)

Public Attributes

 $Created
 $CreatorID
 $ID
 $Modified
 $ModifierID
 $Name

Detailed Description

! eZKernel The class eZContentClassGroup

Definition at line 17 of file ezcontentclassgroup.php.


Member Function Documentation

eZContentClassGroup::appendClass ( class,
version = false 
)

Appends the class $class to this group.

Parameters:
$classCan either be an eZContentClass object or a class ID.
Returns:
the class group link object.
Note:
tranaction unsafe.

Definition at line 150 of file ezcontentclassgroup.php.

static eZContentClassGroup::create ( userID = false) [static]

Definition at line 65 of file ezcontentclassgroup.php.

Referenced by appendClass(), and eZContentClassPackageHandler\install().

Definition at line 89 of file ezcontentclassgroup.php.

static eZContentClassGroup::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 24 of file ezcontentclassgroup.php.

Referenced by fetch(), fetchByName(), fetchList(), and removeSelected().

Definition at line 19 of file ezcontentclassgroup.php.

Referenced by create().

static eZContentClassGroup::fetch ( id,
user_id = false,
asObject = true 
) [static]
static eZContentClassGroup::fetchByName ( name,
asObject = true 
) [static]

Fetch Class group by name, and return first result.

Parameters:
name
asObject

Definition at line 114 of file ezcontentclassgroup.php.

Referenced by eZContentClassPackageHandler\install().

static eZContentClassGroup::fetchList ( user_id = false,
asObject = true 
) [static]

Definition at line 134 of file ezcontentclassgroup.php.

Definition at line 80 of file ezcontentclassgroup.php.

static eZContentClassGroup::removeSelected ( 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 102 of file ezcontentclassgroup.php.


Member Data Documentation

eZContentClassGroup::$Created

Definition at line 173 of file ezcontentclassgroup.php.

eZContentClassGroup::$CreatorID

Definition at line 171 of file ezcontentclassgroup.php.

eZContentClassGroup::$ID

Definition at line 169 of file ezcontentclassgroup.php.

eZContentClassGroup::$Modified

Definition at line 174 of file ezcontentclassgroup.php.

eZContentClassGroup::$ModifierID

Definition at line 172 of file ezcontentclassgroup.php.

eZContentClassGroup::$Name

Definition at line 170 of file ezcontentclassgroup.php.


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