eZ Publish  [4.2]
eZOperationMemento Class Reference

The class eZOperationMemento does. More...

+ Inheritance diagram for eZOperationMemento:
+ Collaboration diagram for eZOperationMemento:

List of all members.

Public Member Functions

 data ()
 eZOperationMemento ($row)
mainMemento ()
 setData ($data=array())

Static Public Member Functions

static cleanup ()
static create ($mementoKey, $data=array(), $isMainKey=false, $mainKey=null)
static createKey ($parameters)
static definition ()
static fetch ($mementoKey, $asObject=true)
static fetchChild ($mementoKey, $asObject=true)
static fetchList ($mementoKey, $asObject=true)
static fetchMain ($mementoKey, $asObject=true)

Detailed Description

The class eZOperationMemento does.

Definition at line 40 of file ezoperationmemento.php.


Member Function Documentation

static eZOperationMemento::cleanup ( ) [static]

Removes all active operation mementos.

Definition at line 187 of file ezoperationmemento.php.

static eZOperationMemento::create ( mementoKey,
data = array(),
isMainKey = false,
mainKey = null 
) [static]
static eZOperationMemento::createKey ( parameters) [static]

Definition at line 170 of file ezoperationmemento.php.

Referenced by create(), fetch(), fetchChild(), fetchList(), and fetchMain().

eZOperationMemento::data ( )

Definition at line 150 of file ezoperationmemento.php.

static eZOperationMemento::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 50 of file ezoperationmemento.php.

Referenced by fetch(), fetchChild(), fetchList(), and fetchMain().

eZOperationMemento::eZOperationMemento ( row)

Constructor

Definition at line 45 of file ezoperationmemento.php.

Referenced by create().

static eZOperationMemento::fetch ( mementoKey,
asObject = true 
) [static]

Definition at line 88 of file ezoperationmemento.php.

static eZOperationMemento::fetchChild ( mementoKey,
asObject = true 
) [static]

Definition at line 101 of file ezoperationmemento.php.

static eZOperationMemento::fetchList ( mementoKey,
asObject = true 
) [static]

Definition at line 129 of file ezoperationmemento.php.

Referenced by eZModuleOperationInfo\execute().

static eZOperationMemento::fetchMain ( mementoKey,
asObject = true 
) [static]

Definition at line 115 of file ezoperationmemento.php.

Referenced by eZModuleOperationInfo\execute(), and mainMemento().

& eZOperationMemento::mainMemento ( )

Definition at line 79 of file ezoperationmemento.php.

eZOperationMemento::setData ( data = array())

Definition at line 145 of file ezoperationmemento.php.


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