eZEnumObjectValue Class Reference

The class eZEnumObjectValue stores chosen enum values of an object attribute. More...

Inheritance diagram for eZEnumObjectValue:

Collaboration diagram for eZEnumObjectValue:

List of all members.

Public Member Functions
	eZEnumObjectValue ($row)
	removeByOAID ($contentObjectAttributeID, $contentObjectAttributeVersion, $enumid)
Static Public Member Functions
static	create ($contentObjectAttributeID, $contentObjectAttributeVersion, $enumID, $enumElement, $enumValue)
static	definition ()
	Returns the definition for the object, the default implementation is to return an empty array.
static	fetch ($contentObjectAttributeID, $contentObjectAttributeVersion, $enumid, $asObject=true)
static	fetchAllElements ($contentObjectAttributeID, $contentObjectAttributeVersion, $asObject=true)
static	removeAllElements ($contentObjectAttributeID, $contentObjectAttributeVersion)
Public Attributes
	$ContentObjectAttributeID
	$ContentObjectAttributeVersion
	$EnumElement
	$EnumID
	$EnumValue

---

Detailed Description

The class eZEnumObjectValue stores chosen enum values of an object attribute.

Definition at line 17 of file ezenumobjectvalue.php.

---

Member Function Documentation

static eZEnumObjectValue::create	(	$	contentObjectAttributeID,
		$	contentObjectAttributeVersion,
		$	enumID,
		$	enumElement,
		$	enumValue
	)		[static]

Definition at line 59 of file ezenumobjectvalue.php.

Referenced by eZEnum\storeObjectEnumeration().

static eZEnumObjectValue::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 ezenumobjectvalue.php.

Referenced by fetch(), fetchAllElements(), removeAllElements(), and removeByOAID().

eZEnumObjectValue::eZEnumObjectValue

(

$

row

)

Constructor

Definition at line 22 of file ezenumobjectvalue.php.

Referenced by create().

static eZEnumObjectValue::fetch	(	$	contentObjectAttributeID,
		$	contentObjectAttributeVersion,
		$	enumid,
		$	asObject = true
	)		[static]

Definition at line 92 of file ezenumobjectvalue.php.

static eZEnumObjectValue::fetchAllElements	(	$	contentObjectAttributeID,
		$	contentObjectAttributeVersion,
		$	asObject = true
	)		[static]

Definition at line 102 of file ezenumobjectvalue.php.

Referenced by eZEnumType\initializeObjectAttribute(), eZEnumType\serializeContentObjectAttribute(), and eZEnum\setObjectEnumValue().

static eZEnumObjectValue::removeAllElements	(	$	contentObjectAttributeID,
		$	contentObjectAttributeVersion
	)		[static]

Definition at line 69 of file ezenumobjectvalue.php.

Referenced by eZEnumType\deleteStoredObjectAttribute(), and eZEnum\removeObjectEnumerations().

eZEnumObjectValue::removeByOAID	(	$	contentObjectAttributeID,
		$	contentObjectAttributeVersion,
		$	enumid
	)

Definition at line 84 of file ezenumobjectvalue.php.

---

Member Data Documentation

eZEnumObjectValue::$ContentObjectAttributeID

Definition at line 113 of file ezenumobjectvalue.php.

eZEnumObjectValue::$ContentObjectAttributeVersion

Definition at line 114 of file ezenumobjectvalue.php.

eZEnumObjectValue::$EnumElement

Definition at line 116 of file ezenumobjectvalue.php.

eZEnumObjectValue::$EnumID

Definition at line 115 of file ezenumobjectvalue.php.

eZEnumObjectValue::$EnumValue

Definition at line 117 of file ezenumobjectvalue.php.

---

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

• ezenumobjectvalue.php