eZEnumObjectValue Class Reference

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

Inheritance diagram for eZEnumObjectValue:

eZPersistentObject List of all members.

Public Methods

 eZEnumObjectValue ($row)
definition ()

Detailed Description

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

Definition at line ezenumobjectvalue.php.


Constructor & Destructor Documentation

eZEnumObjectValue::eZEnumObjectValue   row
 

Constructor

Definition at line ezenumobjectvalue.php.

References eZPersistentObject::eZPersistentObject().


Member Function Documentation

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


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

Exponential