eZPublishCommunityProject(LegacyStack)  2013.6
eZOrderStatus Class Reference

Handles statuses which can be used on orders. More...

+ Inheritance diagram for eZOrderStatus:
+ Collaboration diagram for eZOrderStatus:

Public Member Functions

 eZOrderStatus ($row)
 
 isInternal ()
 
 removeThis ()
 
 storeCustom ()
 
- 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 ()
 
static createUndefined ()
 
static definition ()
 
static fetch ($id, $asObject=true)
 
static fetchByStatus ($statusID, $asObject=true)
 
static fetchList ($asObject=true, $showInactive=false)
 
static fetchMap ($asObject=true, $showInactive=false)
 
static fetchOrderedList ($asObject=true, $showInactive=false)
 
static fetchPolicyList ($showInactive=false)
 
static flush ()
 
static orderStatusCount ($showInactive=false)
 
- 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

const CUSTOM = 1000
 
const DELIVERED = 3
 
const PENDING = 1
 
const PROCESSING = 2
 
const UNDEFINED = 0
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

Detailed Description

Handles statuses which can be used on orders.

This encapsulates the information about a status using the database table ezorder_status.

This status can be selected on an order and is also stored in a history per order (eZOrderStatusHistory).

The status consists of a name, a global ID and whether it is considered active or not.

The following attributes are defined:

  • id - The auto increment ID for the status, this is only used to fetch a given status element from the database.
  • status_id - The global ID of the status, values below 1000 is considerd internal and cannot be removed by the user.
  • name - The name of the status.
  • is_active - Whether the status can be used by the end-user or not.

Some special attributes:

  • is_internal - Returns true if the status is considerd an internal one (ID less than 1000).

If the user creates a new status the function storeCustom() must be used, it will find the next available ID in the database and will use locking to avoid race conditions.

To fetch a given status use fetch() when you have the DB ID or fetchByStatus() if you have a status ID. To fetch lists use fetchList() or fetchOrderedList() for a list sorted by name. If you intend to lookup many statuses using the ID the map from fetchMap() might be useful. To find the number of statuses in the system use orderStatusCount().

Member Function Documentation

static eZOrderStatus::create ( )
static

Creates a new order status and returns it.

static eZOrderStatus::createUndefined ( )
static

Creates an order status which contains 'Undefined' as name and 0 as status ID. This can be used whenever code expects a status object to work with.

Returns
The newly created status object.

Referenced by fetchByStatus().

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

Referenced by fetch(), fetchByStatus(), fetchList(), fetchMap(), fetchOrderedList(), and removeThis().

eZOrderStatus::eZOrderStatus (   $row)

Referenced by create(), and createUndefined().

static eZOrderStatus::fetch (   $id,
  $asObject = true 
)
static
Returns
the status object with the given DB ID.

Referenced by eZOrder\status().

static eZOrderStatus::fetchByStatus (   $statusID,
  $asObject = true 
)
static
Returns
the status object with the given status ID.
Note
It is safe to call this with ID 0, instead of fetching the DB data it calls createUndefined() and returns that data.

Referenced by eZOrder\statusName(), and eZOrder\statusObject().

static eZOrderStatus::fetchList (   $asObject = true,
  $showInactive = false 
)
static
Parameters
$asObjectIf true return them as objects.
$showInactiveIf true it will include status items that are not active, default is false.
Returns
A list of defined orders sorted by status ID.
static eZOrderStatus::fetchMap (   $asObject = true,
  $showInactive = false 
)
static
Parameters
$asObjectIf true return them as objects.
$showInactiveIf true it will include status items that are not active, default is false.
Returns
A list of defined orders which maps from the status ID to the object.

Referenced by eZOrderStatusHistory\fetchOrderStatus().

static eZOrderStatus::fetchOrderedList (   $asObject = true,
  $showInactive = false 
)
static
Parameters
$asObjectIf true return them as objects.
$showInactiveIf true it will include status items that are not active, default is false.
Returns
A list of defined orders sorted by name.

Referenced by eZOrder\statusModificationList().

static eZOrderStatus::fetchPolicyList (   $showInactive = false)
static
Parameters
$asObjectIf true return them as objects.
$showInactiveIf true it will include status items that are not active, default is false.
Returns
A list of defined orders sorted by status ID.
static eZOrderStatus::flush ( )
static

Flushes all global caches for the statuses.

Referenced by removeThis(), and storeCustom().

eZOrderStatus::isInternal ( )
Returns
true if the status is considered an internal status.
static eZOrderStatus::orderStatusCount (   $showInactive = false)
static
Returns
the number of active order statuses
eZOrderStatus::removeThis ( )

Will remove the current status from the database identifed by its DB ID.

Note
transaction safe
eZOrderStatus::storeCustom ( )

Stores a new custom order status. If there is no status ID yet it will acquire a new unique and store it with that. If it already has an ID it calls store() as normally.

Member Data Documentation

const eZOrderStatus::CUSTOM = 1000

Referenced by isInternal(), and storeCustom().

const eZOrderStatus::DELIVERED = 3
const eZOrderStatus::PENDING = 1

Referenced by eZBasket\createOrder().

const eZOrderStatus::PROCESSING = 2
const eZOrderStatus::UNDEFINED = 0

Referenced by createUndefined().


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