

Definition at line 5 of file oxbasket.php.
| oxBasket.isEnabled | ( | ) |
Checks if configuration allows basket usage or if user agent is search engine
Definition at line 215 of file oxbasket.php.
| oxBasket._changeBasketItemKey | ( | $ | sOldKey, | |
| $ | sNewKey, | |||
| $ | value = null | |||
| ) | [protected] |
change old key to new one but retain key position in array
| string | $sOldKey old key | |
| string | $sNewKey new key to place in old one's place | |
| mixed | $value (optional) |
Definition at line 229 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
| 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 |
Definition at line 259 of file oxbasket.php.
| oxBasket.addOrderArticleToBasket | ( | $ | oOrderArticle | ) |
Adds order article to basket (method normally used while recalculating order)
| oxorderarticle | $oOrderArticle order article to store in basket |
Definition at line 346 of file oxbasket.php.
| oxBasket.setStockCheckMode | ( | $ | blCheck | ) |
Sets stock control mode
| bool | $blCheck stock control mode |
Definition at line 371 of file oxbasket.php.
| oxBasket.getStockCheckMode | ( | ) |
| 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
| 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 |
Definition at line 398 of file oxbasket.php.
| oxBasket.removeItem | ( | $ | sItemKey | ) |
Removes item from basket
| string | $sItemKey basket item key |
Definition at line 415 of file oxbasket.php.
| oxBasket._clearBundles | ( | ) | [protected] |
Unsets bundled basket items from basket contents array
Definition at line 425 of file oxbasket.php.
| oxBasket._getArticleBundles | ( | $ | oBasketItem | ) | [protected] |
Returns array of bundled articles IDs for basket item
| object | $oBasketItem basket item object |
Definition at line 442 of file oxbasket.php.
| oxBasket._getItemBundles | ( | $ | oBasketItem | ) | [protected] |
Returns array of bundled discount articles
| object | $oBasketItem basket item object |
Definition at line 465 of file oxbasket.php.
| oxBasket._getBasketBundles | ( | ) | [protected] |
Returns array of bundled discount articles for whole basket
Definition at line 497 of file oxbasket.php.
| oxBasket._addBundles | ( | ) | [protected] |
Iterates through basket contents and adds bundles to items + adds global basket bundles
Definition at line 529 of file oxbasket.php.
| oxBasket._addBundlesToBasket | ( | $ | aBundles | ) | [protected] |
Adds bundles to basket
| array | $aBundles added bundle articles |
Definition at line 571 of file oxbasket.php.
| oxBasket._calcItemsPrice | ( | ) | [protected] |
Iterates through basket items and calculates its prices and discounts
Definition at line 590 of file oxbasket.php.
| oxBasket.setDiscountCalcMode | ( | $ | blCalcDiscounts | ) |
Sets discount calculation mode
| bool | $blCalcDiscounts calculate discounts or not |
Definition at line 654 of file oxbasket.php.
| oxBasket.canCalcDiscounts | ( | ) |
Returns true if discount calculation is enabled
Definition at line 664 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.
Definition at line 678 of file oxbasket.php.
| oxBasket._calcDeliveryCost | ( | ) | [protected] |
Iterates through basket items and calculates its delivery costs
Definition at line 696 of file oxbasket.php.
| oxBasket.getBasketUser | ( | ) |
| oxBasket.setBasketUser | ( | $ | oUser | ) |
Basket user setter
| oxuser | $oUser Basket user |
Definition at line 762 of file oxbasket.php.
| oxBasket.getMostUsedVatPercent | ( | ) |
| oxBasket._calcTotalPrice | ( | ) | [protected] |
Performs final sum calculations and roundings.
Definition at line 785 of file oxbasket.php.
| oxBasket.setVoucherDiscount | ( | $ | dDiscount | ) |
Voucher discount setter
| double | $dDiscount voucher discount value |
Definition at line 834 of file oxbasket.php.
| oxBasket._calcVoucherDiscount | ( | ) | [protected] |
| oxBasket._applyDiscounts | ( | ) | [protected] |
Performs netto price and VATs calculations including discounts and vouchers.
Definition at line 902 of file oxbasket.php.
| oxBasket._calcBasketDiscount | ( | ) | [protected] |
Loads basket discounts and calculates discount values.
Definition at line 932 of file oxbasket.php.
| oxBasket._calcBasketTotalDiscount | ( | ) | [protected] |
| 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.
Definition at line 998 of file oxbasket.php.
| oxBasket._calcPaymentCost | ( | ) | [protected] |
Payment cost calculation, applying payment discount if available. Returns oxprice object.
Definition at line 1033 of file oxbasket.php.
| oxBasket.setCost | ( | $ | sCostName, | |
| $ | oPrice = null | |||
| ) |
Sets basket additional costs
| string | $sCostName additional costs | |
| object | $oPrice oxPrice |
Definition at line 1059 of file oxbasket.php.
| oxBasket.calculateBasket | ( | $ | blForceUpdate = false |
) |
Executes all needed functions to calculate basket price and other needed info
| bool | $blForceUpdate set this parameter to TRUE to force basket recalculation |
Definition at line 1072 of file oxbasket.php.
| oxBasket.onUpdate | ( | ) |
Notifies basket that recalculation is needed
Definition at line 1136 of file oxbasket.php.
| oxBasket.afterUpdate | ( | ) |
| 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
Definition at line 1158 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())
| string | $sVoucherId voucher ID |
Definition at line 1223 of file oxbasket.php.
| oxBasket.removeVoucher | ( | $ | sVoucherId | ) |
Removes voucher from basket and unreserves it.
| string | $sVoucherId removable voucher ID |
Definition at line 1263 of file oxbasket.php.
| oxBasket.resetUserInfo | ( | ) |
Resets user related information kept in basket object
Definition at line 1285 of file oxbasket.php.
| oxBasket._setDeprecatedValues | ( | ) | [protected] |
Sets deprecate values
Definition at line 1298 of file oxbasket.php.
| oxBasket._canMergeBasket | ( | ) | [protected] |
Checks if basket can be merged. Returns true if can
Definition at line 1397 of file oxbasket.php.
| oxBasket._mergeSavedBasket | ( | ) | [protected] |
Populates current basket from the saved one. Saves current basket items to SaveBasket
Definition at line 1413 of file oxbasket.php.
| oxBasket._addItemToSavedBasket | ( | $ | sProductId, | |
| $ | dAmount, | |||
| $ | aSel, | |||
| $ | blOverride = false | |||
| ) | [protected] |
Adds item to saved basket (history
| string | $sProductId product id | |
| double | $dAmount item amount | |
| array | $aSel article select lists | |
| bool | $blOverride override item amount or not |
Definition at line 1455 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.
Definition at line 1470 of file oxbasket.php.
| oxBasket._findDelivCountry | ( | ) | [protected] |
Tries to fetch user delivery country ID
Definition at line 1483 of file oxbasket.php.
| oxBasket.deleteBasket | ( | ) |
| oxBasket.setPayment | ( | $ | sPaymentId = null |
) |
Set basket payment ID
| string | $sPaymentId payment id |
Definition at line 1538 of file oxbasket.php.
| oxBasket.getPaymentId | ( | ) |
Get basket payment, if payment id is not set, try to get it from session
Definition at line 1548 of file oxbasket.php.
| oxBasket.setShipping | ( | $ | sShippingSetId = null |
) |
Set basket shipping set ID
| string | $sShippingSetId deliveryset id |
Definition at line 1563 of file oxbasket.php.
| oxBasket.setDeliveryPrice | ( | $ | oShippingPrice = null |
) |
Set basket shipping price
| string | $oShippingPrice delivery costs |
Definition at line 1576 of file oxbasket.php.
| oxBasket.getShippingId | ( | ) |
Get basket shipping set, if shipping set id is not set, try to get it from session
Definition at line 1586 of file oxbasket.php.
| oxBasket.getBasketArticles | ( | ) |
Returns array of basket oxarticle objects
Definition at line 1614 of file oxbasket.php.
| oxBasket.getDiscountProductsPrice | ( | ) |
Returns discount articles products price object
Definition at line 1655 of file oxbasket.php.
| oxBasket.getProductsPrice | ( | ) |
Returns basket products price list object
Definition at line 1665 of file oxbasket.php.
| oxBasket.getPrice | ( | ) |
| oxBasket.getOrderId | ( | ) |
Returns unique order ID assigned to current basket. This id is only awailable on last order step
Definition at line 1694 of file oxbasket.php.
| oxBasket.setOrderId | ( | $ | sId | ) |
Basket order ID setter
| string | $sId unique id for basket order |
Definition at line 1706 of file oxbasket.php.
| oxBasket.getCosts | ( | $ | sId = null |
) |
Returns array of basket costs. By passing cost identifier method will return this cost if available
| string | $sId cost id ( optional ) |
Definition at line 1719 of file oxbasket.php.
| oxBasket.getVouchers | ( | ) |
Returns array of vouchers applied to basket
Definition at line 1733 of file oxbasket.php.
| oxBasket.getProductsCount | ( | ) |
Returns number of different products stored in basket
Definition at line 1743 of file oxbasket.php.
| oxBasket.getItemsCount | ( | ) |
Returns count of items stored in basket
Definition at line 1753 of file oxbasket.php.
| oxBasket.getWeight | ( | ) |
| oxBasket.getContents | ( | ) |
| oxBasket.getProductVats | ( | ) |
Returns array of formatted VATs which were calculated for basket
Definition at line 1783 of file oxbasket.php.
| oxBasket.getDiscountedNettoPrice | ( | ) |
Returns products netto price with applied discounts and vouschers
Definition at line 1816 of file oxbasket.php.
| oxBasket.setCardMessage | ( | $ | sMessage | ) |
Gift card message setter
| string | $sMessage gift card message |
Definition at line 1831 of file oxbasket.php.
| oxBasket.getCardMessage | ( | ) |
| oxBasket.setCardId | ( | $ | sCardId | ) |
Gift card ID setter
| string | $sCardId gift card id |
Definition at line 1853 of file oxbasket.php.
| oxBasket.getCardId | ( | ) |
| oxBasket.getCard | ( | ) |
Returns gift card object (if available)
Definition at line 1873 of file oxbasket.php.
| oxBasket.getTotalDiscount | ( | ) |
Returns total basket discount oxprice object
Definition at line 1888 of file oxbasket.php.
| oxBasket.getDiscounts | ( | ) |
Returns applied discount information array
Definition at line 1898 of file oxbasket.php.
| oxBasket.getVoucherDiscount | ( | ) |
Returns basket voucher discount oxprice object
Definition at line 1912 of file oxbasket.php.
| oxBasket.setBasketCurrency | ( | $ | oCurrency | ) |
Set basket currency
| object | $oCurrency currency object |
Definition at line 1924 of file oxbasket.php.
| oxBasket.getBasketCurrency | ( | ) |
| oxBasket.setSkipVouchersChecking | ( | $ | blSkipChecking = null |
) |
Set skip or not vouchers availability checking
| bool | $blSkipChecking skip or not vouchers checking |
Definition at line 1950 of file oxbasket.php.
| oxBasket.hasSkipedDiscount | ( | ) |
Returns true if discount must be skipped for one of the products
Definition at line 1960 of file oxbasket.php.
| oxBasket.setSkipDiscounts | ( | $ | blSkip | ) |
Used to set "skip discounts" status for basket
| bool | $blSkip set true to skip discounts |
Definition at line 1972 of file oxbasket.php.
| oxBasket.getProductsNetPrice | ( | ) |
| oxBasket.getFProductsPrice | ( | ) |
| oxBasket.getDelCostVatPercent | ( | ) |
| oxBasket.getDelCostVat | ( | ) |
Returns formatted VAT of delivery costs
Definition at line 2015 of file oxbasket.php.
| oxBasket.getDelCostNet | ( | ) |
Returns formatted netto price of delivery costs
Definition at line 2029 of file oxbasket.php.
| oxBasket.getPayCostVatPercent | ( | ) |
| oxBasket.getPayCostVat | ( | ) |
| oxBasket.getPayCostNet | ( | ) |
Returns formatted netto price of payment costs
Definition at line 2066 of file oxbasket.php.
| oxBasket.getPaymentCosts | ( | ) |
Returns payment costs brutto value
Definition at line 2076 of file oxbasket.php.
| oxBasket.getFPaymentCosts | ( | ) |
Returns if exists formatted payment costs
Definition at line 2086 of file oxbasket.php.
| oxBasket.getVoucherDiscValue | ( | ) |
| oxBasket.getWrappCostVatPercent | ( | ) |
| oxBasket.getWrappCostVat | ( | ) |
Returns formatted VAT of wrapping costs
Definition at line 2124 of file oxbasket.php.
| oxBasket.getWrappCostNet | ( | ) |
Returns formatted netto price of wrapping costs
Definition at line 2139 of file oxbasket.php.
| oxBasket.getFWrappingCosts | ( | ) |
Returns if exists formatted wrapping costs
Definition at line 2153 of file oxbasket.php.
| oxBasket.getFPrice | ( | ) |
| oxBasket.getFDeliveryCosts | ( | ) |
Returns if exists formatted delivery costs
Definition at line 2177 of file oxbasket.php.
| oxBasket.getDeliveryCosts | ( | ) |
Returns if exists delivery costs
Definition at line 2191 of file oxbasket.php.
| oxBasket.setTotalDiscount | ( | $ | dDiscount | ) |
Sets total discount value
| double | $dDiscount new total discount value |
Definition at line 2206 of file oxbasket.php.
| oxBasket.getPriceForPayment | ( | ) |
Get basket price for payment cost calculation. Returned price is with applied discounts, vouchers and added delivery cost
Definition at line 2219 of file oxbasket.php.
| oxBasket.getDiscountedProductsBruttoPrice | ( | ) |
Returns ( current basket products sum - total discount - voucher discount )
Definition at line 2244 of file oxbasket.php.
| oxBasket.isBelowMinOrderPrice | ( | ) |
Returns TRUE if ( current basket products sum - total discount - voucher discount ) > 0
Definition at line 2277 of file oxbasket.php.
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.
oxBasket.$_blCalcDiscounts = true [protected] |
Definition at line 208 of file oxbasket.php.
1.5.5