eZ Publish  [trunk]
eZContentClassName Class Reference
+ Inheritance diagram for eZContentClassName:
+ Collaboration diagram for eZContentClassName:

List of all members.

Public Member Functions

 eZContentClassName ($row)

Static Public Member Functions

static definition ()
 Returns the definition for the object, the default implementation is to return an empty array.
static fetchList ($classID, $classVersion, $languageLocaleList, $asObjects=true, $fields=null, $sorts=null, $limit=null)
static removeClassName ($contentClassID, $contentClassVersion)
static sqlAppendFilter ($languageTable= 'ezcontentclass')
static sqlEmptyFilter ()
static sqlFilter ($languageTable= 'ezcontentclass')

Detailed Description

Definition at line 11 of file ezcontentclassname.php.


Member Function Documentation

static eZContentClassName::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 18 of file ezcontentclassname.php.

Referenced by fetchList(), sqlAppendFilter(), and sqlFilter().

Definition at line 13 of file ezcontentclassname.php.

static eZContentClassName::fetchList ( classID,
classVersion,
languageLocaleList,
asObjects = true,
fields = null,
sorts = null,
limit = null 
) [static]

Definition at line 55 of file ezcontentclassname.php.

Referenced by eZContentClassNameList\store().

static eZContentClassName::removeClassName ( contentClassID,
contentClassVersion 
) [static]

Definition at line 122 of file ezcontentclassname.php.

Referenced by eZContentClassNameList\remove().

static eZContentClassName::sqlAppendFilter ( languageTable = 'ezcontentclass') [static]

The same as 'sqlFilter' but adds symbol ',' to 'nameField' and 'from' parts

Definition at line 97 of file ezcontentclassname.php.

Referenced by eZContentClassClassGroup\fetchClassList().

The same as 'sqlFilter' but all fields are empty

Definition at line 114 of file ezcontentclassname.php.

Referenced by eZContentClassClassGroup\fetchClassList().

static eZContentClassName::sqlFilter ( languageTable = 'ezcontentclass') [static]
Returns:
the SQL where-condition for selecting the rows (with class names) in the correct language, i. e. in the most prioritized language from those in which an object exists.
Parameters:
languageTableName of the table containing the attribute with bitmaps, e.g. ezcontentclass
languageListTableName of the table containing the attribute with language id.

Definition at line 80 of file ezcontentclassname.php.

Referenced by eZSearchEngine\buildSortSQL(), eZContentObject\canCreateClassList(), eZContentObjectTreeNode\canCreateClassList(), eZContentClass\canInstantiateClassList(), eZContentObjectTreeNode\createAttributeFilterSQLStrings(), eZContentObjectTreeNode\createSortingSQLStrings(), eZContentClass\fetchAllClasses(), eZClassFunctionCollection\fetchClassListByGroups(), and eZContentClass\fetchList().


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