Manual

SDK

 
   

API Reference
 

Sections

Todo

eZOrder Class Reference
[Kernel system]

eZOrder handles orders More...

Inheritance diagram for eZOrder:

eZPersistentObject List of all members.

Public Methods

& definition ()
& active ($asObject=true,$offset,$limit)
& activeCount ()
 attribute ($attr)
 hasAttribute ($attr)
 discount ($userID,&$object)
& totalVAT ()
& user ()
& accountInformation ()
 activate ()
 accountViewTemplate ()

Detailed Description

eZOrder handles orders

See also:
eZBasket

Definition at line ezorder.php.

Member Function Documentation

& eZOrder::accountInformation (    ) 
 

Returns:
the account information The shop account handler decides what is returned here

Definition at line ezorder.php.

Referenced by attribute().

eZOrder::accountViewTemplate (    ) 
 

Returns:
the template to use for account view

Definition at line ezorder.php.

Referenced by attribute().

eZOrder::activate (    ) 
 

Creates a real order from the temporary state

Definition at line ezorder.php.

References eZPersistentObject::store().

& eZOrder::active (  $    asObject = true,
$    offset,
$    limit
) 
 

Returns:
the active orders

Definition at line ezorder.php.

References eZPersistentObject::fetchObjectList().

& eZOrder::activeCount (    ) 
 

Returns:
the number of active orders

Definition at line ezorder.php.

References eZDB::instance().

eZOrder::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 ezorder.php.

References user().

& eZOrder::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 ezorder.php.

Referenced by active().

eZOrder::discount (  $    userID,
&$    object
) 
 

Returns:
the discountrules for a user

Definition at line ezorder.php.

References user().

eZOrder::hasAttribute (  $    attr ) 
 

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

Reimplemented from eZPersistentObject.

Definition at line ezorder.php.

References eZPersistentObject::hasAttribute().

& eZOrder::totalVAT (    ) 
 

Returns:
the total VAT value of the order

Definition at line ezorder.php.

& eZOrder::user (    ) 
 

Returns:
the user who has created the order.

Definition at line ezorder.php.

Referenced by discount().

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

Exponential