eZPublish(LegacyStack)  5.1
eZOrderStatusHistory Class Reference

Handles a list of status changes to an order item. More...

+ Inheritance diagram for eZOrderStatusHistory:
+ Collaboration diagram for eZOrderStatusHistory:

Public Member Functions

 eZOrderStatusHistory ($row)
 
 fetchOrderStatus ()
 
 fetchOrderStatusName ()
 
 modifier ()
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

Static Public Member Functions

static create ($orderID, $statusID, $userID=false, $timestamp=false)
 
static definition ()
 
 fetch ($id, $asObject=true)
 
static fetchCount ($orderID, $asObject=true)
 
static fetchListByOrder ($orderID, $asObject=true)
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
static fetchObjectList ($def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

Public Attributes

 $Modifier
 This is used for caching the current modifier, it will either contain null (uncached) or a content object (cached). More...
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

Detailed Description

Handles a list of status changes to an order item.

This uses the database table ezorder_status_history to store changes in status for an order item. Each entry consists of the new status, the time it was done and the person who did the change.

The order_id refers to the external ID of an order (order_nr) and not the internal auto increment value.

To fetch a given history element use fetch() with the history ID. If you intend to display the history elements for an order item use the fetchListByOrder() function which returns the history sorted by date (newest first). If you are interested in the number of history elements for an order use the fetchCount() function.

If you intend to create a new history element use the create() function.

Member Function Documentation

static eZOrderStatusHistory::create (   $orderID,
  $statusID,
  $userID = false,
  $timestamp = false 
)
static
Returns
A new eZOrderStatusHistory object initialized with the input parameters.

Referenced by eZOrder\createStatusHistory(), and eZOrder\modifyStatus().

static eZOrderStatusHistory::definition ( )
static
Returns
the persistent object definition for the eZOrderStatusHistory class.

Referenced by fetch().

eZOrderStatusHistory::eZOrderStatusHistory (   $row)

Initialises the persistent object with $row. If status_name is present in $row it will cache it in the $StatusName variable.

Referenced by create().

eZOrderStatusHistory::fetch (   $id,
  $asObject = true 
)
static
Returns
the status history object with the given DB ID.
static eZOrderStatusHistory::fetchCount (   $orderID,
  $asObject = true 
)
static
Parameters
$asObjectIf true return them as objects.
Returns
A list of defined orders sorted by status ID.

Referenced by eZShopFunctionCollection\fetchOrderStatusHistoryCount().

static eZOrderStatusHistory::fetchListByOrder (   $orderID,
  $asObject = true 
)
static
Parameters
$asObjectIf true return them as objects.
Returns
A list of defined orders sorted by status ID.

Referenced by eZShopFunctionCollection\fetchOrderStatusHistory().

eZOrderStatusHistory::fetchOrderStatus ( )
Returns
The order status object for this history entry.
See Also
fetchOrderStatusName()

Referenced by fetchOrderStatusName().

eZOrderStatusHistory::fetchOrderStatusName ( )
Returns
The name of the order status for this history entry.
See Also
fetchOrderStatus()
eZOrderStatusHistory::modifier ( )
Returns
The user which modified the status, this is returned as a content object.
Note
The field modified_id is used to find the user, this will contain the content object ID of the user.

Member Data Documentation

eZOrderStatusHistory::$Modifier

This is used for caching the current modifier, it will either contain null (uncached) or a content object (cached).

Referenced by modifier().


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