eZPublish  4.4
eZBasket Class Reference

eZBasket handles shopping baskets More...

+ Inheritance diagram for eZBasket:
+ Collaboration diagram for eZBasket:

Public Member Functions

 canAddProduct ($contentObject)
 
 createOrder ()
 
 eZBasket ($row)
 
 isEmpty ()
 
 isVATKnown ()
 
 items ($asObject=true)
 
 itemsInfo ()
 
 productCollection ()
 
 removeItem ($itemID)
 
 totalExVAT ()
 
 totalIncVAT ()
 
 type ()
 
 updatePrices ()
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 
 attributes ()
 
 eZPersistentObject ($row)
 
 fill ($row)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 remove ($conditions=null, $extraConditions=null)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 sync ($fieldFilters=null)
 

Static Public Member Functions

static cleanup ()
 
static cleanupCurrentBasket ($useSetting=true)
 
static cleanupExpired ($time)
 
static currentBasket ($asObject=true, $byOrderID=-1)
 
static definition ()
 
static fetch ($sessionKey)
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 
static conditionTextByRow ($conditions, $row)
 
static count ($def, $conds=null, $field=null)
 
static definition ()
 
static escapeArray ($array)
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
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)
 
static getShortAttributeName ($db, $def, $attrName)
 
static handleRows ($rows, $class_name, $asObject)
 
static newObjectOrder ($def, $orderField, $conditions)
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 
static updateObjectList ($parameters)
 

Public Attributes

const ITEM_LIMIT = 3000
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 Whether the data is dirty, ie needs to be stored, or not. More...
 

Detailed Description

eZBasket handles shopping baskets

See Also
eZProductCollection

Member Function Documentation

eZBasket::canAddProduct (   $contentObject)
static eZBasket::cleanup ( )
static

Removes all baskets for all users.

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.
static eZBasket::cleanupCurrentBasket (   $useSetting = true)
static

Removes current basket.

Parameters
$useSetting- if "true" use ini setting in site.ini [ShopSettings].ClearBasketOnLogout, or just clear current basket otherwise.
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.

Referenced by eZUser\logoutCurrent().

static eZBasket::cleanupExpired (   $time)
static

Removes all baskets which are considered expired (due to session expiration).

Note
This will also remove the product collection the basket is using.

Referenced by eZSessionBasketGarbageCollector().

eZBasket::createOrder ( )

Creates a temporary order for the current basket. The order object is returned.

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.
static eZBasket::currentBasket (   $asObject = true,
  $byOrderID = -1 
)
static

Will return the basket for the current session. If a basket does not exist one will be created.

Returns
current eZBasket object
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.

Referenced by eZShopOperationCollection\activateOrder(), eZShopOperationCollection\addToBasket(), cleanupCurrentBasket(), eZShopOperationCollection\updateBasket(), and eZShopOperationCollection\updateShippingInfo().

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

Referenced by currentBasket(), fetch(), and eZShopFunctionCollection\fetchBasket().

eZBasket::eZBasket (   $row)

Referenced by currentBasket().

static eZBasket::fetch (   $sessionKey)
static

Fetches the basket which belongs to session $sessionKey.

Parameters
$sessionKeyA string containing the session key.
Returns
An eZSessionBasket object or false if none was found.
eZBasket::isEmpty ( )
eZBasket::isVATKnown ( )

Returns true if VAT percentage is known for all basket items.

eZBasket::items (   $asObject = true)
eZBasket::itemsInfo ( )

Fetching calculated information about the product items.

eZBasket::productCollection ( )
eZBasket::removeItem (   $itemID)
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.
eZBasket::totalExVAT ( )
eZBasket::totalIncVAT ( )
eZBasket::type ( )
Returns
the type of basket. In other words: what type of products the basket contains.

Referenced by canAddProduct().

eZBasket::updatePrices ( )
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.

Member Data Documentation

const eZBasket::ITEM_LIMIT = 3000

Controls the default value for how many items are cleaned in one batch operation.


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