eZContentClassName Class Reference

Inheritance diagram for eZContentClassName:

List of all members.

Public Member Functions
	definition ()
	eZContentClassName ($row)
	fetchList ($classID, $classVersion, $languageLocaleList, $asObjects=true, $fields=null, $sorts=null, $limit=null)
	remove ($contentClassID, $contentClassVersion)
	sqlAppendFilter ($languageTable= 'ezcontentclass')
	sqlEmptyFilter ()
	sqlFilter ($languageTable= 'ezcontentclass')

---

Detailed Description

Definition at line 29 of file ezcontentclassname.php.

---

Member Function Documentation

eZContentClassName::definition

(

)

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:

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 36 of file ezcontentclassname.php.

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

eZContentClassName::eZContentClassName

(

$

row

)

Definition at line 31 of file ezcontentclassname.php.

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

Definition at line 73 of file ezcontentclassname.php.

Referenced by eZContentClassNameList::store().

eZContentClassName::remove	(	$	conditions,
		$	extraConditions
	)

Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. It uses removeObject to do the real job and passes the object defintion, conditions and extra conditions $extraConditions to this function.

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.

Reimplemented from eZPersistentObject.

Definition at line 142 of file ezcontentclassname.php.

eZContentClassName::sqlAppendFilter

(

$

languageTable = 'ezcontentclass'

)

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

Definition at line 115 of file ezcontentclassname.php.

Referenced by eZContentClassClassGroup::fetchClassList().

eZContentClassName::sqlEmptyFilter

(

)

The same as 'sqlFilter' but all fields are empty

Definition at line 132 of file ezcontentclassname.php.

Referenced by eZContentClassClassGroup::fetchClassList().

eZContentClassName::sqlFilter

(

$

languageTable = 'ezcontentclass'

)

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:

	languageTable	Name of the table containing the attribute with bitmaps, e.g. ezcontentclass
	languageListTable	Name of the table containing the attribute with language id.

Definition at line 98 of file ezcontentclassname.php.

Referenced by eZContentObjectTreeNode::canCreateClassList(), eZContentObject::canCreateClassList(), eZContentClass::canInstantiateClassList(), eZContentObjectTreeNode::createAttributeFilterSQLStrings(), eZContentObjectTreeNode::createSortingSQLStrings(), eZContentClass::fetchAllClasses(), eZContentClass::fetchList(), and eZContentObjectTreeNode::subTreeCount().

---

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

• ezcontentclassname.php