eZ Publish  [4.2]
eZContentObjectTrashNode Class Reference

The class eZContentObjectTrashNode. More...

+ Inheritance diagram for eZContentObjectTrashNode:
+ Collaboration diagram for eZContentObjectTrashNode:

List of all members.

Public Member Functions

 eZContentObjectTrashNode ($row=array())
 originalParent ()
 originalParentPathIdentificationString ()
 storeToTrash ()

Static Public Member Functions

static createFromNode ($node)
static definition ()
static fetchListForObject ($objectID, $asObject=true, $offset=false, $limit=false)
static purgeForObject ($contentObjectID)
static trashList ($params=false, $asCount=false)
static trashListCount ($params=false)

Detailed Description

The class eZContentObjectTrashNode.

Definition at line 40 of file ezcontentobjecttrashnode.php.


Member Function Documentation

static eZContentObjectTrashNode::createFromNode ( node) [static]
static eZContentObjectTrashNode::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 eZContentObjectTreeNode.

Definition at line 50 of file ezcontentobjecttrashnode.php.

eZContentObjectTrashNode::eZContentObjectTrashNode ( row = array())

Constructor

Definition at line 45 of file ezcontentobjecttrashnode.php.

Referenced by createFromNode(), and trashList().

static eZContentObjectTrashNode::fetchListForObject ( objectID,
asObject = true,
offset = false,
limit = false 
) [static]

Definition at line 195 of file ezcontentobjecttrashnode.php.

eZContentObjectTrashNode::originalParent ( )
eZContentObjectTrashNode::originalParentPathIdentificationString ( )

Definition at line 343 of file ezcontentobjecttrashnode.php.

static eZContentObjectTrashNode::purgeForObject ( contentObjectID) [static]

Definition at line 185 of file ezcontentobjecttrashnode.php.

Referenced by eZContentObject\purge().

eZContentObjectTrashNode::storeToTrash ( )

Definition at line 165 of file ezcontentobjecttrashnode.php.

static eZContentObjectTrashNode::trashList ( params = false,
asCount = false 
) [static]

Definition at line 203 of file ezcontentobjecttrashnode.php.

Referenced by trashListCount().

static eZContentObjectTrashNode::trashListCount ( params = false) [static]

Definition at line 314 of file ezcontentobjecttrashnode.php.


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