Manual

SDK

 
   

API Reference
 

Sections

Todo

eZOrderItem Class Reference
[Kernel system]

eZOrderItem handles custom order items More...

Inheritance diagram for eZOrderItem:

eZPersistentObject List of all members.

Public Methods

& definition ()
 attribute ($attr)
 hasAttribute ($attr)

Public Attributes

 VATValue = false
 Cached value of the vat percentage.

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:
eZOrder

Definition at line ezorderitem.php.

Member Function Documentation

eZOrderItem::attribute (  $    attr ) 
 

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.

Reimplemented from eZPersistentObject.

Definition at line ezorderitem.php.

References eZPersistentObject::attribute().

& eZOrderItem::definition (    ) 
 

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: 
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 ezorderitem.php.

References VATValue.

eZOrderItem::hasAttribute (  $    attr ) 
 

Returns:
true if the attribute $attr is part of the definition fields or function attributes.

Reimplemented from eZPersistentObject.

Definition at line ezorderitem.php.

References eZPersistentObject::hasAttribute().

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

Exponential