eZ Publish  [4.2]
eZEnumValue Class Reference

The class eZEnumValue does. More...

+ Inheritance diagram for eZEnumValue:
+ Collaboration diagram for eZEnumValue:

List of all members.

Public Member Functions

 __clone ()
 eZEnumValue ($row)

Static Public Member Functions

static create ($contentClassAttributeID, $contentClassAttributeVersion, $element)
static createCopy ($id, $contentClassAttributeID, $contentClassAttributeVersion, $element, $value, $placement)
static definition ()
static fetch ($id, $version, $asObject=true)
static fetchAllElements ($classAttributeID, $version, $asObject=true)
static removeAllElements ($contentClassAttributeID, $version)
static removeByID ($id, $version)

Public Attributes

 $ContentClassAttributeID
 $ContentClassAttributeVersion
 $EnumElement
 $EnumValue
 $ID
 $Placement

Detailed Description

The class eZEnumValue does.

Definition at line 41 of file ezenumvalue.php.


Member Function Documentation

eZEnumValue::__clone ( )

Definition at line 87 of file ezenumvalue.php.

static eZEnumValue::create ( contentClassAttributeID,
contentClassAttributeVersion,
element 
) [static]

Definition at line 92 of file ezenumvalue.php.

Referenced by eZEnum\addEnumeration().

static eZEnumValue::createCopy ( id,
contentClassAttributeID,
contentClassAttributeVersion,
element,
value,
placement 
) [static]

Definition at line 106 of file ezenumvalue.php.

Referenced by eZEnum\setVersion().

static eZEnumValue::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:

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" );
}

Reimplemented from eZPersistentObject.

Definition at line 51 of file ezenumvalue.php.

Referenced by create(), fetch(), fetchAllElements(), removeAllElements(), and removeByID().

eZEnumValue::eZEnumValue ( row)

Constructor

Definition at line 46 of file ezenumvalue.php.

Referenced by create(), and createCopy().

static eZEnumValue::fetch ( id,
version,
asObject = true 
) [static]

Definition at line 131 of file ezenumvalue.php.

Referenced by eZEnum\setValue().

static eZEnumValue::fetchAllElements ( classAttributeID,
version,
asObject = true 
) [static]
static eZEnumValue::removeAllElements ( contentClassAttributeID,
version 
) [static]
static eZEnumValue::removeByID ( id,
version 
) [static]

Definition at line 124 of file ezenumvalue.php.

Referenced by eZEnum\removeEnumeration().


Member Data Documentation

eZEnumValue::$ContentClassAttributeID

Definition at line 157 of file ezenumvalue.php.

eZEnumValue::$ContentClassAttributeVersion

Definition at line 158 of file ezenumvalue.php.

eZEnumValue::$EnumElement

Definition at line 159 of file ezenumvalue.php.

eZEnumValue::$EnumValue

Definition at line 160 of file ezenumvalue.php.

eZEnumValue::$ID

Definition at line 156 of file ezenumvalue.php.

eZEnumValue::$Placement

Definition at line 161 of file ezenumvalue.php.


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