eZPublishCommunityProject(LegacyStack)  2013.9
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, $sorts=array( 'contentobject_id'=> 'desc'))
 Fetch basket items (ordered by object id by default) More...
 
 itemsInfo ()
 
 itemsOrdered ($asObject=true, $order=true)
 Fetch basket items ordered by id ( the order they are added to basket ) More...
 
 productCollection ()
 
 removeItem ($itemID)
 
 totalExVAT ()
 
 totalIncVAT ()
 
 type ()
 
 updatePrices ()
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 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. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

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)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
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)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

Public Attributes

const ITEM_LIMIT = 3000
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

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.

Referenced by ezpKernelWeb\requestInit().

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(), and ezpKernelWeb\requestInit().

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.

Referenced by ezpKernelWeb\requestInit().

eZBasket::isEmpty ( )
eZBasket::isVATKnown ( )

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

eZBasket::items (   $asObject = true,
  $sorts = array( 'contentobject_id' => 'desc' ) 
)

Fetch basket items (ordered by object id by default)

Parameters
bool$asObject
array | null$sortsArray with sort data sent directly to eZPersistentObject::fetchObjectList()

Referenced by isEmpty(), isVATKnown(), itemsInfo(), itemsOrdered(), totalExVAT(), totalIncVAT(), and updatePrices().

eZBasket::itemsInfo ( )

Fetching calculated information about the product items.

eZBasket::itemsOrdered (   $asObject = true,
  $order = true 
)

Fetch basket items ordered by id ( the order they are added to basket )

Parameters
bool$asObject
bool$orderTrue (default) for ascending[0->9] and false for decending[9->0]
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: