eZPublish  3.8
eZOrderStatus Class Reference

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

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

Public Member Functions

 definition ()
 
 eZOrderStatus ($row)
 
 fetch ($id, $asObject=true)
 
 fetchByStatus ($statusID, $asObject=true)
 
 fetchList ($asObject=true, $showInactive=false)
 
 fetchOrderedList ($asObject=true, $showInactive=false)
 
 fetchPolicyList ($showInactive=false)
 
isInternal ()
 
 orderStatusCount ($showInactive=false)
 
 remove ()
 
 storeCustom ()
 
- Public Member Functions inherited from eZPersistentObject
attribute ($attr, $noFunction=false)
 
 attributes ()
 
 conditionText (&$conditions)
 
conditionTextByRow (&$conditions, &$row)
 
 definition ()
 
escapeArray (&$array)
 
 eZPersistentObject ($row)
 
 fetchObject (&$def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
 fetchObjectList (&$def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null)
 
 fill (&$row)
 
 getShortAttributeName (&$db, &$def, $attrName)
 
 handleRows (&$rows, $class_name, $asObject)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 newObjectOrder (&$def, $orderField, $conditions)
 
 remove ($conditions=null, $extraConditions=null)
 
 removeObject (&$def, $conditions=null, $extraConditions=null)
 
 reorderObject (&$def, $orderField, $conditions, $down=true)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 swapRow ($table, &$keys, &$order_id, &$rows, $id1, $id2)
 
 sync ($fieldFilters=null)
 
 updateObjectList ($parameters)
 

Static Public Member Functions

 create ()
 
 createUndefined ()
 
 fetchMap ($asObject=true, $showInactive=false)
 
 flush ()
 

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

eZOrderStatus::create ( )
static

Creates a new order status and returns it.

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().

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

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

eZOrderStatus::eZOrderStatus (   $row)

Referenced by create(), and createUndefined().

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

Referenced by eZOrder\status().

eZOrderStatus::fetchByStatus (   $statusID,
  $asObject = true 
)
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().

eZOrderStatus::fetchList (   $asObject = true,
  $showInactive = false 
)
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.
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().

eZOrderStatus::fetchOrderedList (   $asObject = true,
  $showInactive = false 
)
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().

eZOrderStatus::fetchPolicyList (   $showInactive = false)
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.
eZOrderStatus::flush ( )
static

Flushes all global caches for the statuses.

Referenced by remove(), and storeCustom().

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

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.


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