eZPublish  3.8
eZBasket Class Reference

eZBasket handles shopping baskets More...

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

Public Member Functions

 canAddProduct ($contentObject)
 
 createOrder ()
 
currentBasket ($asObject=true, $byOrderID=-1)
 
 definition ()
 
 eZBasket ($row)
 
fetch ($sessionKey)
 
isEmpty ()
 
 isVATKnown ()
 
items ($asObject=true)
 
productCollection ()
 
 removeItem ($itemID)
 
totalExVAT ()
 
totalIncVAT ()
 
 type ()
 
 updatePrices ()
 
- 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

 cleanup ()
 
 cleanupCurrentBasket ($useSetting=true)
 
 cleanupExpired ($time)
 

Detailed Description

eZBasket handles shopping baskets

See Also
eZProductCollection

Member Function Documentation

eZBasket::canAddProduct (   $contentObject)
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.
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().

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

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

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

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

eZBasket::eZBasket (   $row)

Referenced by currentBasket().

& eZBasket::fetch (   $sessionKey)

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

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