eZ Publish  [4.2]
eZOrderItem Class Reference

eZOrderItem handles custom order itemsCustom order items are used to automatically add new items to a specific order. You can use it to e.g. specify shipping and handling, special discount or wrapping costs. More...

+ Inheritance diagram for eZOrderItem:
+ Collaboration diagram for eZOrderItem:

List of all members.

Public Member Functions

 eZOrderItem ($row)
 priceExVAT ()
 priceIncVAT ()
 vatValue ()

Static Public Member Functions

 cleanup ()
static definition ()
static fetchList ($orderID, $asObject=true)
static fetchListByType ($orderID, $itemType, $asObject=true)

Detailed Description

eZOrderItem handles custom order items

Custom order items are used to automatically add new items to a specific order. You can use it to e.g. specify shipping and handling, special discount or wrapping costs.

The order items is different from the product collection items in the way that there is no product for each order item.

See also:
eZProductCollection eZBasket eZOrder

Definition at line 44 of file ezorderitem.php.


Member Function Documentation

eZOrderItem::cleanup ( ) [static]

Removes all order items from the database.

Note:
Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 148 of file ezorderitem.php.

static eZOrderItem::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 51 of file ezorderitem.php.

Referenced by fetchList(), and fetchListByType().

eZOrderItem::eZOrderItem ( row)

Definition at line 46 of file ezorderitem.php.

static eZOrderItem::fetchList ( orderID,
asObject = true 
) [static]

Definition at line 92 of file ezorderitem.php.

static eZOrderItem::fetchListByType ( orderID,
itemType,
asObject = true 
) [static]

Definition at line 102 of file ezorderitem.php.

Referenced by eZOrder\orderItemsByType().

eZOrderItem::priceExVAT ( )

Definition at line 132 of file ezorderitem.php.

eZOrderItem::priceIncVAT ( )

Definition at line 118 of file ezorderitem.php.

eZOrderItem::vatValue ( )

Definition at line 113 of file ezorderitem.php.

Referenced by priceExVAT(), and priceIncVAT().


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