oxBasket Class Reference

Inheritance diagram for oxBasket:

Inheritance graph
[legend]
Collaboration diagram for oxBasket:

Collaboration graph
[legend]

List of all members.

Detailed Description

Definition at line 5 of file oxbasket.php.


Public Member Functions

 isEnabled ()
 addToBasket ($sProductID, $dAmount, $aSel=null, $aPersParam=null, $blOverride=false, $blBundle=false, $sOldBasketItemId=null)
 setStockCheckMode ($blCheck)
 getStockCheckMode ()
 getItemKey ($sProductId, $aSel=null, $aPersParam=null, $blBundle=false, $sAdditionalParam= '')
 removeItem ($sItemKey)
 getBasketUser ()
 setBasketUser ($oUser)
 getMostUsedVatPercent ()
 setCost ($sCostName, $oPrice=null)
 calculateBasket ($blForceUpdate=false)
 onUpdate ()
 afterUpdate ()
 getBasketSummary ()
 addVoucher ($sVoucherId)
 removeVoucher ($sVoucherId)
 resetUserInfo ()
 deleteBasket ()
 setPayment ($sPaymentId=null)
 getPaymentId ()
 setShipping ($sShippingSetId=null)
 setDeliveryPrice ($oShippingPrice=null)
 getShippingId ()
 getBasketArticles ()
 getDiscountProductsPrice ()
 getProductsPrice ()
 getPrice ()
 getOrderId ()
 setOrderId ($sId)
 getCosts ($sId=null)
 getVouchers ()
 getProductsCount ()
 getItemsCount ()
 getWeight ()
 getContents ()
 getProductVats ()
 getDiscountedNettoPrice ()
 setCardMessage ($sMessage)
 getCardMessage ()
 setCardId ($sCardId)
 getCardId ()
 getCard ()
 getTotalDiscount ()
 getDiscounts ()
 getVoucherDiscount ()
 setBasketCurrency ($oCurrency)
 getBasketCurrency ()
 setSkipVouchersChecking ($blSkipChecking=null)
 hasSkipedDiscount ()
 setSkipDiscounts ($blSkip)
 getProductsNetPrice ()
 getFProductsPrice ()
 getDelCostVatPercent ()
 getDelCostVat ()
 getDelCostNet ()
 getPayCostVatPercent ()
 getPayCostVat ()
 getPayCostNet ()
 getPaymentCosts ()
 getVoucherDiscValue ()
 getWrappCostVatPercent ()
 getWrappCostVat ()
 getWrappCostNet ()
 getFPrice ()
 getFDeliveryCosts ()
 getDeliveryCosts ()
 setTotalDiscount ($dDiscount)

Protected Member Functions

 _changeBasketItemKey ($sOldKey, $sNewKey, $value=null)
 _clearBundles ()
 _getArticleBundles ($oBasketItem)
 _getItemBundles ($oBasketItem)
 _getBasketBundles ()
 _addBundles ()
 _addBundlesToBasket ($aBundles)
 _calcItemsPrice ()
 _mergeDiscounts ($aDiscounts, $aItemDiscounts)
 _calcDeliveryCost ()
 _calcTotalPrice ()
 _calcVoucherDiscount ()
 _applyDiscounts ()
 _calcBasketDiscount ()
 _calcBasketTotalDiscount ()
 _calcBasketWrapping ()
 _calcPaymentCost ()
 _setDeprecatedValues ()
 _canMergeBasket ()
 _mergeSavedBasket ()
 _addItemToSavedBasket ($sProductId, $dAmount, $aSel, $blOverride=false)
 _deleteSavedBasket ()
 _findDelivCountry ()

Protected Attributes

 $_aBasketContents = array()
 $_iProductsCnt = 0
 $_dItemsCnt = 0.0
 $_dWeight = 0.0
 $_oPrice = null
 $_oProductsPriceList = null
 $_aDiscounts = array()
 $_aItemDiscounts = array()
 $_sOrderId = null
 $_aVouchers = array()
 $_aCosts = array()
 $_oDiscountProductsPriceList = null
 $_oNotDiscountedProductsPriceList = null
 $_blUpdateNeeded = true
 $_aBasketSummary = null
 $_blBasketMerged = false
 $_sPaymentId = null
 $_sShippingSetId = null
 $_oUser = null
 $_oTotalDiscount = null
 $_oVoucherDiscount = null
 $_oCurrency = null
 $_blSkipVouchersAvailabilityChecking = null
 $_dDiscountedProductNettoPrice = null
 $_aDiscountedVats = null
 $_blSkipDiscounts = false
 $_oDeliveryPrice = null
 $_blCheckStock = true

Member Function Documentation

oxBasket.isEnabled (  ) 

Checks if configuration allows basket usage or if user agent is search engine

Returns:
bool

Definition at line 208 of file oxbasket.php.

oxBasket._changeBasketItemKey ( $  sOldKey,
$  sNewKey,
$  value = null 
) [protected]

change old key to new one but retain key position in array

Parameters:
string $sOldKey old key
string $sNewKey new key to place in old one's place
mixed $value (optional)
Returns:
null

Definition at line 222 of file oxbasket.php.

oxBasket.addToBasket ( $  sProductID,
$  dAmount,
$  aSel = null,
$  aPersParam = null,
$  blOverride = false,
$  blBundle = false,
$  sOldBasketItemId = null 
)

Adds user item to basket. Returns oxbasketitem object if adding succeded

Parameters:
string $sProductID id of product
double $dAmount product amount
array $aSel product select lists (default null)
array $aPersParam product persistent parameters (default null)
bool $blOverride marker to acumulate passed amount or renew (default false)
bool $blBundle marker if product is bundle or not (default false)
string $sOldBasketItemId id if old basket item if to change it
Exceptions:
oxOutOfStockException oxArticleInputException, oxNoArticleException
Returns:
object

Definition at line 252 of file oxbasket.php.

oxBasket.setStockCheckMode ( $  blCheck  ) 

Sets stock control mode

Parameters:
bool $blCheck stock control mode
Returns:
null

Definition at line 335 of file oxbasket.php.

oxBasket.getStockCheckMode (  ) 

Returns stock control mode

Returns:
bool

Definition at line 345 of file oxbasket.php.

oxBasket.getItemKey ( $  sProductId,
$  aSel = null,
$  aPersParam = null,
$  blBundle = false,
$  sAdditionalParam = '' 
)

Returns unique basket item identifier which consist from product ID, select lists data, persistent info and bundle property

Parameters:
string $sProductId basket item id
array $aSel basket item selectlists
array $aPersParam basket item persistent parameters
bool $blBundle bundle marker
var $sAdditionalParam possible additional information
Returns:
string

Definition at line 362 of file oxbasket.php.

oxBasket.removeItem ( $  sItemKey  ) 

Removes item from basket

Parameters:
string $sItemKey basket item key
Returns:
null

Definition at line 379 of file oxbasket.php.

oxBasket._clearBundles (  )  [protected]

Unsets bundled basket items from basket contents array

Returns:
null

Definition at line 389 of file oxbasket.php.

oxBasket._getArticleBundles ( $  oBasketItem  )  [protected]

Returns array of bundled articles IDs for basket item

Parameters:
object $oBasketItem basket item object
Returns:
array

Definition at line 406 of file oxbasket.php.

oxBasket._getItemBundles ( $  oBasketItem  )  [protected]

Returns array of bundled discount articles

Parameters:
object $oBasketItem basket item object
Returns:
array

Definition at line 429 of file oxbasket.php.

oxBasket._getBasketBundles (  )  [protected]

Returns array of bundled discount articles for whole basket

Returns:
array

Definition at line 461 of file oxbasket.php.

oxBasket._addBundles (  )  [protected]

Iterates through basket contents and adds bundles to items + adds global basket bundles

Returns:
null

Definition at line 494 of file oxbasket.php.

oxBasket._addBundlesToBasket ( $  aBundles  )  [protected]

Adds bundles to basket

Parameters:
array $aBundles added bundle articles
Returns:
null

Definition at line 529 of file oxbasket.php.

oxBasket._calcItemsPrice (  )  [protected]

Iterates through basket items and calculates its prices and discounts

Returns:
null

Definition at line 548 of file oxbasket.php.

oxBasket._mergeDiscounts ( $  aDiscounts,
$  aItemDiscounts 
) [protected]

Merges two discount arrays. If there are two the same discounts, discount values will be added.

Parameters:
array $aDiscounts Discount array
array $aItemDiscounts Discount array
Returns:
array $aDiscounts

Definition at line 612 of file oxbasket.php.

oxBasket._calcDeliveryCost (  )  [protected]

Iterates through basket items and calculates its delivery costs

Returns:
oxPrice

Definition at line 630 of file oxbasket.php.

oxBasket.getBasketUser (  ) 

Basket user getter

Returns:
oxuser

Definition at line 680 of file oxbasket.php.

oxBasket.setBasketUser ( $  oUser  ) 

Basket user setter

Parameters:
oxuser $oUser Basket user
Returns:
null

Definition at line 696 of file oxbasket.php.

oxBasket.getMostUsedVatPercent (  ) 

Get most used vat percent:

Returns:
double

Definition at line 707 of file oxbasket.php.

oxBasket._calcTotalPrice (  )  [protected]

Performs final sum calculations and roundings.

Returns:
null

Definition at line 719 of file oxbasket.php.

oxBasket._calcVoucherDiscount (  )  [protected]

Calculates voucher discount

Returns:
null

Definition at line 767 of file oxbasket.php.

oxBasket._applyDiscounts (  )  [protected]

Performs netto price and VATs calculations including discounts and vouchers.

Returns:
null

Definition at line 820 of file oxbasket.php.

oxBasket._calcBasketDiscount (  )  [protected]

Loads basket discounts and calculates discount values.

Returns:
null

Definition at line 850 of file oxbasket.php.

oxBasket._calcBasketTotalDiscount (  )  [protected]

Calculates total basket discount value.

Returns:
null

Definition at line 886 of file oxbasket.php.

oxBasket._calcBasketWrapping (  )  [protected]

Adds Gift price info to $this->oBasket (additional field for basket item "oWrap""). Loads each basket item, checks for wrapping data, updates if available and stores back into $this->oBasket. Returns oxprice object for wrapping.

Returns:
object oxPrice

Definition at line 917 of file oxbasket.php.

oxBasket._calcPaymentCost (  )  [protected]

Payment cost calculation, applying payment discount if available. Returns oxprice object.

Returns:
object oxPrice

Definition at line 952 of file oxbasket.php.

oxBasket.setCost ( $  sCostName,
$  oPrice = null 
)

Sets basket additional costs

Parameters:
string $sCostName additional costs
object $oPrice oxPrice
Returns:
null

Definition at line 978 of file oxbasket.php.

oxBasket.calculateBasket ( $  blForceUpdate = false  ) 

Executes all needed functions to calculate basket price and other needed info

Parameters:
bool $blForceUpdate set this parameter to TRUE to force basket recalculation
Returns:
null

Definition at line 991 of file oxbasket.php.

oxBasket.onUpdate (  ) 

Notifies basket that recalculation is needed

Returns:
null

Definition at line 1053 of file oxbasket.php.

oxBasket.afterUpdate (  ) 

Marks basket as up-to-date

Returns:
null

Definition at line 1063 of file oxbasket.php.

oxBasket.getBasketSummary (  ) 

Function collects summary information about basket. Usually this info is used while calculating discounts or so. Data is stored in static class parameter oxbasket::$_aBasketSummary

Returns:
object

Definition at line 1075 of file oxbasket.php.

oxBasket.addVoucher ( $  sVoucherId  ) 

Checks and sets voucher information. Checks it's availability according to few conditions: oxvoucher.checkVoucherAvailability(), oxvoucher.checkUserAvailability(). Errors are stored in oxbasket.voucherErrors array. After all voucher is marked as reserved (oxvoucher.MarkAsReserved())

Parameters:
string $sVoucherId voucher ID
Returns:
null

Definition at line 1143 of file oxbasket.php.

oxBasket.removeVoucher ( $  sVoucherId  ) 

Removes voucher from basket and unreserves it.

Parameters:
string $sVoucherId removable voucher ID
Returns:
null

Definition at line 1183 of file oxbasket.php.

oxBasket.resetUserInfo (  ) 

Resets user related information kept in basket object

Returns:
null

Definition at line 1205 of file oxbasket.php.

oxBasket._setDeprecatedValues (  )  [protected]

Sets deprecate values

Deprecated:
This method as well as all deprecated class variables is deprecated
Returns:
null

Definition at line 1218 of file oxbasket.php.

oxBasket._canMergeBasket (  )  [protected]

Checks if basket can be merged. Returns true if can

Returns:
bool

Definition at line 1317 of file oxbasket.php.

oxBasket._mergeSavedBasket (  )  [protected]

Populates current basket from the saved one. Saves current basket items to SaveBasket

Returns:
null

Definition at line 1333 of file oxbasket.php.

oxBasket._addItemToSavedBasket ( $  sProductId,
$  dAmount,
$  aSel,
$  blOverride = false 
) [protected]

Adds item to saved basket (history

Parameters:
string $sProductId product id
double $dAmount item amount
array $aSel article select lists
bool $blOverride override item amount or not
Returns:
null

Definition at line 1375 of file oxbasket.php.

oxBasket._deleteSavedBasket (  )  [protected]

Cleans up saved basket data. This method usually is initiated by oxbasket.deleteBasket() method which cleans up basket data when user completes order.

Returns:
null

Definition at line 1390 of file oxbasket.php.

oxBasket._findDelivCountry (  )  [protected]

Tries to fetch user delivery country ID

Returns:
string

Definition at line 1403 of file oxbasket.php.

oxBasket.deleteBasket (  ) 

Deletes user basket object from session

Returns:
null

Definition at line 1442 of file oxbasket.php.

oxBasket.setPayment ( $  sPaymentId = null  ) 

Set basket payment ID

Parameters:
string $sPaymentId payment id
Returns:
null

Definition at line 1459 of file oxbasket.php.

oxBasket.getPaymentId (  ) 

Get basket payment, if payment id is not set, try to get it from session

Returns:
string

Definition at line 1469 of file oxbasket.php.

oxBasket.setShipping ( $  sShippingSetId = null  ) 

Set basket shipping set ID

Parameters:
string $sShippingSetId deliveryset id
Returns:
null

Definition at line 1484 of file oxbasket.php.

oxBasket.setDeliveryPrice ( $  oShippingPrice = null  ) 

Set basket shipping price

Parameters:
string $oShippingPrice delivery costs
Returns:
null

Definition at line 1497 of file oxbasket.php.

oxBasket.getShippingId (  ) 

Get basket shipping set, if shipping set id is not set, try to get it from session

Returns:
string oxDeliverySet

Definition at line 1507 of file oxbasket.php.

oxBasket.getBasketArticles (  ) 

Returns array of basket oxarticle objects

Returns:
array

Definition at line 1526 of file oxbasket.php.

oxBasket.getDiscountProductsPrice (  ) 

Returns discount articles products price object

Returns:
oxprice

Definition at line 1555 of file oxbasket.php.

oxBasket.getProductsPrice (  ) 

Returns basket products price list object

Returns:
oxpricelist

Definition at line 1565 of file oxbasket.php.

oxBasket.getPrice (  ) 

Returns basket price object

Returns:
oxprice

Definition at line 1579 of file oxbasket.php.

oxBasket.getOrderId (  ) 

Returns unique order ID assigned to current basket. This id is only awailable on last order step

Returns:
string

Definition at line 1594 of file oxbasket.php.

oxBasket.setOrderId ( $  sId  ) 

Basket order ID setter

Parameters:
string $sId unique id for basket order
Returns:
null

Definition at line 1606 of file oxbasket.php.

oxBasket.getCosts ( $  sId = null  ) 

Returns array of basket costs. By passing cost identifier method will return this cost if available

Parameters:
string $sId cost id ( optional )
Returns:
array

Definition at line 1619 of file oxbasket.php.

oxBasket.getVouchers (  ) 

Returns array of vouchers applied to basket

Returns:
array

Definition at line 1633 of file oxbasket.php.

oxBasket.getProductsCount (  ) 

Returns number of different products stored in basket

Returns:
int

Definition at line 1643 of file oxbasket.php.

oxBasket.getItemsCount (  ) 

Returns count of items stored in basket

Returns:
double

Definition at line 1653 of file oxbasket.php.

oxBasket.getWeight (  ) 

Returns total basket weight

Returns:
double

Definition at line 1663 of file oxbasket.php.

oxBasket.getContents (  ) 

Returns basket items array

Returns:
array

Definition at line 1673 of file oxbasket.php.

oxBasket.getProductVats (  ) 

Returns array of formatted VATs which were calculated for basket

Returns:
array

Definition at line 1683 of file oxbasket.php.

oxBasket.getDiscountedNettoPrice (  ) 

Returns products netto price with applied discounts and vouschers

Returns:
double

Definition at line 1716 of file oxbasket.php.

oxBasket.setCardMessage ( $  sMessage  ) 

Gift card message setter

Parameters:
string $sMessage gift card message
Returns:
null

Definition at line 1731 of file oxbasket.php.

oxBasket.getCardMessage (  ) 

Returns gift card message text

Returns:
string

Definition at line 1741 of file oxbasket.php.

oxBasket.setCardId ( $  sCardId  ) 

Gift card ID setter

Parameters:
string $sCardId gift card id
Returns:
null

Definition at line 1753 of file oxbasket.php.

oxBasket.getCardId (  ) 

Returns applied gift card ID

Returns:
string

Definition at line 1763 of file oxbasket.php.

oxBasket.getCard (  ) 

Returns gift card object (if available)

Returns:
oxwrapping

Definition at line 1773 of file oxbasket.php.

oxBasket.getTotalDiscount (  ) 

Returns total basket discount oxprice object

Returns:
oxprice

Definition at line 1788 of file oxbasket.php.

oxBasket.getDiscounts (  ) 

Returns applied discount information array

Returns:
array

Definition at line 1798 of file oxbasket.php.

oxBasket.getVoucherDiscount (  ) 

Returns basket voucher discount oxprice object

Returns:
oxprice

Definition at line 1812 of file oxbasket.php.

oxBasket.setBasketCurrency ( $  oCurrency  ) 

Set basket currency

Parameters:
object $oCurrency currency object
Returns:
null

Definition at line 1824 of file oxbasket.php.

oxBasket.getBasketCurrency (  ) 

Basket currency getter

Returns:
oxuser

Definition at line 1834 of file oxbasket.php.

oxBasket.setSkipVouchersChecking ( $  blSkipChecking = null  ) 

Set skip or not vouchers availability checking

Parameters:
bool $blSkipChecking skip or not vouchers checking
Returns:
null

Definition at line 1850 of file oxbasket.php.

oxBasket.hasSkipedDiscount (  ) 

Returns true if discount must be skipped for one of the products

Returns:
bool

Definition at line 1860 of file oxbasket.php.

oxBasket.setSkipDiscounts ( $  blSkip  ) 

Used to set "skip discounts" status for basket

Parameters:
bool $blSkip set true to skip discounts
Returns:
null

Definition at line 1872 of file oxbasket.php.

oxBasket.getProductsNetPrice (  ) 

Formatted Products net price getter

Returns:
string

Definition at line 1882 of file oxbasket.php.

oxBasket.getFProductsPrice (  ) 

Formatted Products price getter

Returns:
string

Definition at line 1892 of file oxbasket.php.

oxBasket.getDelCostVatPercent (  ) 

Returns VAT of delivery costs

Returns:
double

Definition at line 1905 of file oxbasket.php.

oxBasket.getDelCostVat (  ) 

Returns formatted VAT of delivery costs

Returns:
string | bool

Definition at line 1915 of file oxbasket.php.

oxBasket.getDelCostNet (  ) 

Returns formatted netto price of delivery costs

Returns:
string

Definition at line 1929 of file oxbasket.php.

oxBasket.getPayCostVatPercent (  ) 

Returns VAT of payment costs

Returns:
double

Definition at line 1939 of file oxbasket.php.

oxBasket.getPayCostVat (  ) 

Returns formatted VAT of payment costs

Returns:
string

Definition at line 1949 of file oxbasket.php.

oxBasket.getPayCostNet (  ) 

Returns formatted netto price of payment costs

Returns:
string

Definition at line 1963 of file oxbasket.php.

oxBasket.getPaymentCosts (  ) 

Returns payment costs

Returns:
double | bool

Definition at line 1973 of file oxbasket.php.

oxBasket.getVoucherDiscValue (  ) 

Returns value of voucher discount

Returns:
double

Definition at line 1983 of file oxbasket.php.

oxBasket.getWrappCostVatPercent (  ) 

Returns VAT of wrapping costs

Returns:
double

Definition at line 1996 of file oxbasket.php.

oxBasket.getWrappCostVat (  ) 

Returns formatted VAT of wrapping costs

Returns:
string | bool

Definition at line 2006 of file oxbasket.php.

oxBasket.getWrappCostNet (  ) 

Returns formatted netto price of wrapping costs

Returns:
string

Definition at line 2021 of file oxbasket.php.

oxBasket.getFPrice (  ) 

Returns formatted basket total price

Returns:
string

Definition at line 2035 of file oxbasket.php.

oxBasket.getFDeliveryCosts (  ) 

Returns if exists formatted delivery costs

Returns:
string | bool

Definition at line 2045 of file oxbasket.php.

oxBasket.getDeliveryCosts (  ) 

Returns if exists delivery costs

Returns:
string | bool

Definition at line 2059 of file oxbasket.php.

oxBasket.setTotalDiscount ( $  dDiscount  ) 

Sets total discount value

Parameters:
double $dDiscount new total discount value
Returns:
null

Definition at line 2074 of file oxbasket.php.

Member Data Documentation

oxBasket.$_aBasketContents = array() [protected]

Definition at line 12 of file oxbasket.php.

oxBasket.$_iProductsCnt = 0 [protected]

Definition at line 19 of file oxbasket.php.

oxBasket.$_dItemsCnt = 0.0 [protected]

Definition at line 26 of file oxbasket.php.

oxBasket.$_dWeight = 0.0 [protected]

Definition at line 33 of file oxbasket.php.

oxBasket.$_oPrice = null [protected]

Definition at line 40 of file oxbasket.php.

oxBasket.$_oProductsPriceList = null [protected]

Definition at line 47 of file oxbasket.php.

oxBasket.$_aDiscounts = array() [protected]

Definition at line 54 of file oxbasket.php.

oxBasket.$_aItemDiscounts = array() [protected]

Definition at line 61 of file oxbasket.php.

oxBasket.$_sOrderId = null [protected]

Definition at line 68 of file oxbasket.php.

oxBasket.$_aVouchers = array() [protected]

Definition at line 75 of file oxbasket.php.

oxBasket.$_aCosts = array() [protected]

Definition at line 82 of file oxbasket.php.

oxBasket.$_oDiscountProductsPriceList = null [protected]

Definition at line 89 of file oxbasket.php.

oxBasket.$_oNotDiscountedProductsPriceList = null [protected]

Definition at line 96 of file oxbasket.php.

oxBasket.$_blUpdateNeeded = true [protected]

Definition at line 103 of file oxbasket.php.

oxBasket.$_aBasketSummary = null [protected]

Definition at line 110 of file oxbasket.php.

oxBasket.$_blBasketMerged = false [protected]

Definition at line 117 of file oxbasket.php.

oxBasket.$_sPaymentId = null [protected]

Definition at line 124 of file oxbasket.php.

oxBasket.$_sShippingSetId = null [protected]

Definition at line 131 of file oxbasket.php.

oxBasket.$_oUser = null [protected]

Definition at line 138 of file oxbasket.php.

oxBasket.$_oTotalDiscount = null [protected]

Definition at line 145 of file oxbasket.php.

oxBasket.$_oVoucherDiscount = null [protected]

Definition at line 152 of file oxbasket.php.

oxBasket.$_oCurrency = null [protected]

Definition at line 159 of file oxbasket.php.

oxBasket.$_blSkipVouchersAvailabilityChecking = null [protected]

Definition at line 166 of file oxbasket.php.

oxBasket.$_dDiscountedProductNettoPrice = null [protected]

Definition at line 173 of file oxbasket.php.

oxBasket.$_aDiscountedVats = null [protected]

Definition at line 180 of file oxbasket.php.

oxBasket.$_blSkipDiscounts = false [protected]

Definition at line 187 of file oxbasket.php.

oxBasket.$_oDeliveryPrice = null [protected]

Definition at line 194 of file oxbasket.php.

oxBasket.$_blCheckStock = true [protected]

Definition at line 201 of file oxbasket.php.

The documentation for this class was generated from the following file:
Generated on Wed May 13 13:29:23 2009 for OXID eShop CE by  doxygen 1.5.5