oxBasket Class Reference

Inheritance diagram for oxBasket:

Collaboration diagram for oxBasket:

Public Member Functions
	enableSaveToDataBase ($blSave=true)
	isSaveToDataBaseEnabled ()
	isCalculationModeNetto ()
	setCalculationModeNetto ($blNettoMode=true)
	getNettoSum ()
	getBruttoSum ()
	setNettoSum ($dNettoSum)
	setBruttoSum ($dBruttoSum)
	isEnabled ()
	addToBasket ($sProductID, $dAmount, $aSel=null, $aPersParam=null, $blOverride=false, $blBundle=false, $sOldBasketItemId=null)
	addOrderArticleToBasket ($oOrderArticle)
	setStockCheckMode ($blCheck)
	getStockCheckMode ()
	getItemKey ($sProductId, $aSel=null, $aPersParam=null, $blBundle=false, $sAdditionalParam= '')
	removeItem ($sItemKey)
	setDiscountCalcMode ($blCalcDiscounts)
	canCalcDiscounts ()
	getBasketUser ()
	setBasketUser ($oUser)
	getMostUsedVatPercent ()
	getAdditionalServicesVatPercent ()
	isProportionalCalculationOn ()
	setVoucherDiscount ($dDiscount)
	isPriceViewModeNetto ()
	setCost ($sCostName, $oPrice=null)
	calculateBasket ($blForceUpdate=false)
	onUpdate ()
	afterUpdate ()
	getBasketSummary ()
	addVoucher ($sVoucherId)
	removeVoucher ($sVoucherId)
	resetUserInfo ()
	load ()
	deleteBasket ()
	setPayment ($sPaymentId=null)
	getPaymentId ()
	setShipping ($sShippingSetId=null)
	setDeliveryPrice ($oShippingPrice=null)
	getShippingId ()
	getBasketArticles ()
	getDiscountProductsPrice ()
	getProductsPrice ()
	getPrice ()
	setPrice ($oPrice)
	getOrderId ()
	setOrderId ($sId)
	getCosts ($sId=null)
	getVouchers ()
	getProductsCount ()
	getItemsCount ()
	getWeight ()
	getContents ()
	getProductVats ($blFormatCurrency=true)
	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 ()
	getPaymentCost ()
	getFPaymentCosts ()
	getVoucherDiscValue ()
	getFVoucherDiscountValue ()
	getWrappCostVatPercent ()
	getGiftCardCostVatPercent ()
	getWrappCostVat ()
	getWrappCostNet ()
	getFWrappingCosts ()
	getWrappingCost ()
	getGiftCardCostVat ()
	getGiftCardCostNet ()
	getFGiftCardCosts ()
	getGiftCardCost ()
	getFPrice ()
	getFDeliveryCosts ()
	getDeliveryCosts ()
	getDeliveryCost ()
	setTotalDiscount ($dDiscount)
	getPriceForPayment ()
	_getDiscountedProductsSum ()
	getTotalDiscountSum ()
	getDiscountedProductsBruttoPrice ()
	isBelowMinOrderPrice ()
	getArtStockInBasket ($sArtId, $sExpiredArtId=null)
	canAddProductToBasket ($sProductId)
	setBasketRootCatId ($sRoot)
	getBasketRootCatId ()
	setCatChangeWarningState ($blShow)
	showCatChangeWarning ()
	setTsProductId ($sProductId)
	getTsProductId ()
	getFTsProtectionCosts ()
	getTsProtectionVatPercent ()
	getTsProtectionVat ()
	getTsProtectionNet ()
	getTsProtectionCosts ()
	getTrustedShopProtectionCost ()
	getNotDiscountProductsPrice ()
	__wakeUp ()
	isNewItemAdded ()
	hasDownloadableProducts ()
	hasArticlesWithIntangibleAgreement ()
	hasArticlesWithDownloadableAgreement ()
	getMinOrderPrice ()
	getTsInsuredSum ()
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	__construct ()
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_changeBasketItemKey ($sOldKey, $sNewKey, $value=null)
	_clearBundles ()
	_getArticleBundles ($oBasketItem)
	_getItemBundles ($oBasketItem, $aBundles=array())
	_getBasketBundles ($aBundles=array())
	_addBundles ()
	_addBundlesToBasket ($aBundles)
	_calcItemsPrice ()
	_mergeDiscounts ($aDiscounts, $aItemDiscounts)
	_calcDeliveryCost ()
	_calcTotalPrice ()
	_calcVoucherDiscount ()
	_applyDiscounts ()
	_getPriceObject ()
	_calcBasketDiscount ()
	_calcBasketTotalDiscount ()
	_calcBasketWrapping ()
	_calcBasketGiftCard ()
	_calcPaymentCost ()
	_calcTsProtectionCost ()
	formatDiscount ()
	_canSaveBasket ()
	_save ()
	_deleteSavedBasket ()
	_findDelivCountry ()
	_isProductInRootCategory ($sProductId, $sRootCatId)
	_addedNewItem ($sProductID, $dAmount, $aSel, $aPersParam, $blOverride, $blBundle, $sOldBasketItemId)

Protected Attributes
	$_aBasketContents = array()
	$_iProductsCnt = 0
	$_dItemsCnt = 0.0
	$_dWeight = 0.0
	$_oPrice = null
	$_isCalculationModeNetto = null
	$_dNettoSum = null
	$_dBruttoSum = null
	$_oProductsPriceList = null
	$_aDiscounts = array()
	$_aItemDiscounts = array()
	$_sOrderId = null
	$_aVouchers = array()
	$_aCosts = array()
	$_oDiscountProductsPriceList = null
	$_oNotDiscountedProductsPriceList = null
	$_blUpdateNeeded = true
	$_aBasketSummary = null
	$_sPaymentId = null
	$_sShippingSetId = null
	$_oUser = null
	$_oTotalDiscount = null
	$_oVoucherDiscount = null
	$_oCurrency = null
	$_blSkipVouchersAvailabilityChecking = null
	$_dDiscountedProductNettoPrice = null
	$_aDiscountedVats = null
	$_blSkipDiscounts = false
	$_oDeliveryPrice = null
	$_blCheckStock = true
	$_blCalcDiscounts = true
	$_sBasketCategoryId = null
	$_blShowCatChangeWarning = false
	$_sTsProductId = null
	$_blNewITemAdded = null
	$_blDownloadableProducts = null
	$_blSaveToDataBase = null

Additional Inherited Members
Static Protected Attributes inherited from oxSuperCfg
static	$_oConfig = null
static	$_oSession = null
static	$_oRights = null
static	$_oActUser = null
static	$_blIsAdmin = null

Detailed Description

Basket manager

Definition at line 7 of file oxbasket.php.

Member Function Documentation

oxBasket::__wakeUp

(

)

Resets new basket item addition state on unserialization

Definition at line 3063 of file oxbasket.php.

oxBasket::_addBundles ( )

protected

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

Definition at line 714 of file oxbasket.php.

oxBasket::_addBundlesToBasket (   $aBundles )

protected

Adds bundles to basket

Parameters

array

$aBundles

added bundle articles

Definition at line 755 of file oxbasket.php.

oxBasket::_addedNewItem (   $sProductID,   $dAmount,   $aSel,   $aPersParam,   $blOverride,   $blBundle,   $sOldBasketItemId  )

protected

Is called when new basket item is successfully added

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

Definition at line 3052 of file oxbasket.php.

oxBasket::_applyDiscounts ( )

protected

Performs netto price and VATs calculations including discounts and vouchers.

Definition at line 1133 of file oxbasket.php.

oxBasket::_calcBasketDiscount ( )

protected

Loads basket discounts and calculates discount values.

Definition at line 1194 of file oxbasket.php.

oxBasket::_calcBasketGiftCard ( )

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 1317 of file oxbasket.php.

oxBasket::_calcBasketTotalDiscount ( )

protected

Calculates total basket discount value.

Definition at line 1257 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 1286 of file oxbasket.php.

oxBasket::_calcDeliveryCost ( )

protected

Iterates through basket items and calculates its delivery costs

Returns

oxPrice

Definition at line 883 of file oxbasket.php.

oxBasket::_calcItemsPrice ( )

protected

Iterates through basket items and calculates its prices and discounts

Definition at line 778 of file oxbasket.php.

oxBasket::_calcPaymentCost ( )

protected

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

Returns

object oxPrice

Definition at line 1348 of file oxbasket.php.

oxBasket::_calcTotalPrice ( )

protected

Performs final sum calculation and rounding.

Definition at line 1002 of file oxbasket.php.

oxBasket::_calcTsProtectionCost ( )

protected

TS Protection cost calculation. Returns oxprice object.

Returns

object oxPrice

Definition at line 1372 of file oxbasket.php.

oxBasket::_calcVoucherDiscount ( )

protected

Calculates voucher discount

Definition at line 1064 of file oxbasket.php.

oxBasket::_canSaveBasket ( )

protected

Checks whether basket can be saved

Deprecated:

in v5.2.0 on 2013-04-28; use oxBasket::isSaveToDataBaseEnabled()

Returns

bool

Definition at line 1669 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)

Definition at line 376 of file oxbasket.php.

oxBasket::_clearBundles ( )

protected

Unsets bundled basket items from basket contents array

Definition at line 605 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 1730 of file oxbasket.php.

oxBasket::_findDelivCountry ( )

protected

Tries to fetch user delivery country ID

Returns

string

Definition at line 1748 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 622 of file oxbasket.php.

oxBasket::_getBasketBundles (   $aBundles = array() )

protected

Returns array of bundled discount articles for whole basket

Parameters

array

$aBundles

array of found bundles

Returns

array

Definition at line 685 of file oxbasket.php.

oxBasket::_getDiscountedProductsSum

(

)

Returns ( current basket products sum - total discount - voucher discount )

Returns

double

Definition at line 2701 of file oxbasket.php.

oxBasket::_getItemBundles (   $oBasketItem,   $aBundles = array()  )

protected

Returns array of bundled discount articles

Parameters

object	$oBasketItem	basket item object
array	$aBundles	array of found bundles

Returns

array

Definition at line 647 of file oxbasket.php.

oxBasket::_getPriceObject ( )

protected

Returns prepared oxPrice object depending on view mode

Returns

oxPrice

Definition at line 1178 of file oxbasket.php.

oxBasket::_isProductInRootCategory (   $sProductId,   $sRootCatId  )

protected

Checks if product is in root category

Parameters

string	$sProductId	product id
string	$sRootCatId	root category id

Returns

bool

Definition at line 2862 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 864 of file oxbasket.php.

oxBasket::_save ( )

protected

Saves existing basket to database

Definition at line 1704 of file oxbasket.php.

oxBasket::addOrderArticleToBasket

(

$oOrderArticle

)

Adds order article to basket (method normally used while recalculating order)

Parameters

oxorderarticle

$oOrderArticle

order article to store in basket

Returns

oxbasketitem

Definition at line 511 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 succeeded

Parameters

string	$sProductID	id of product
double	$dAmount	product amount
mixed	$aSel	product select lists (default null)
mixed	$aPersParam	product persistent parameters (default null)
bool	$blOverride	marker to accumulate passed amount or renew (default false)
bool	$blBundle	marker if product is bundle or not (default false)
mixed	$sOldBasketItemId	id if old basket item if to change it

Exceptions

oxOutOfStockException

oxArticleInputException, oxNoArticleException

Returns

object

Definition at line 406 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

Definition at line 1582 of file oxbasket.php.

oxBasket::afterUpdate

(

)

Marks basket as up-to-date

Definition at line 1499 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 1405 of file oxbasket.php.

oxBasket::canAddProductToBasket

(

$sProductId

)

Checks if product can be added to basket

Parameters

string

$sProductId

product id

Returns

bool

Definition at line 2813 of file oxbasket.php.

oxBasket::canCalcDiscounts

(

)

Returns true if discount calculation is enabled

Returns

bool

Definition at line 850 of file oxbasket.php.

oxBasket::deleteBasket

(

)

Deletes user basket object from session

Definition at line 1786 of file oxbasket.php.

oxBasket::enableSaveToDataBase

(

$blSave = true

)

Enables or disable saving to data base

Parameters

boolean

$blSave

Definition at line 275 of file oxbasket.php.

oxBasket::formatDiscount ( )

protected

Formatting discounts

Definition at line 1649 of file oxbasket.php.

oxBasket::getAdditionalServicesVatPercent

(

)

Get most used vat percent:

Returns

double

Definition at line 972 of file oxbasket.php.

oxBasket::getArtStockInBasket	(		$sArtId,
			$sExpiredArtId = null
	)

Returns stock of article in basket, including bundle article

Parameters

string	$sArtId	article id
string	$sExpiredArtId	item id of updated article

Returns

double

Definition at line 2792 of file oxbasket.php.

oxBasket::getBasketArticles

(

)

Returns array of basket oxarticle objects

Returns

array

Definition at line 1877 of file oxbasket.php.

oxBasket::getBasketCurrency

(

)

Basket currency getter

Returns

object

Definition at line 2197 of file oxbasket.php.

oxBasket::getBasketRootCatId

(

)

Get active basket root category

Returns

string

Definition at line 2894 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 1511 of file oxbasket.php.

oxBasket::getBasketUser

(

)

Basket user getter

Returns

oxuser

Definition at line 935 of file oxbasket.php.

oxBasket::getBruttoSum

(

)

Return basket brutto sum (in B2C view mode sum include discount)

Returns

decimal

Definition at line 334 of file oxbasket.php.

oxBasket::getCard

(

)

Returns gift card object (if available)

Returns

oxWrapping

Definition at line 2132 of file oxbasket.php.

oxBasket::getCardId

(

)

Returns applied gift card ID

Returns

string

Definition at line 2122 of file oxbasket.php.

oxBasket::getCardMessage

(

)

Returns gift card message text

Returns

string

Definition at line 2102 of file oxbasket.php.

oxBasket::getContents

(

)

Returns basket items array

Returns

array

Definition at line 2048 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 1993 of file oxbasket.php.

oxBasket::getDelCostNet

(

)

Returns formatted netto price of delivery costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string

Definition at line 2298 of file oxbasket.php.

oxBasket::getDelCostVat

(

)

Returns formatted VAT of delivery costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string | bool

Definition at line 2279 of file oxbasket.php.

oxBasket::getDelCostVatPercent

(

)

Returns VAT of delivery costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

double

Definition at line 2267 of file oxbasket.php.

oxBasket::getDeliveryCost

(

)

Returns delivery costs

Returns

oxPrice

Definition at line 2656 of file oxbasket.php.

oxBasket::getDeliveryCosts

(

)

Returns if exists delivery costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string | bool

Definition at line 2642 of file oxbasket.php.

oxBasket::getDiscountedProductsBruttoPrice

(

)

Returns ( current basket products sum - total discount - voucher discount )

Returns

double

Definition at line 2744 of file oxbasket.php.

oxBasket::getDiscountProductsPrice

(

)

Returns price list object of discounted products

Returns

oxPriceList

Definition at line 1920 of file oxbasket.php.

oxBasket::getDiscounts

(

)

Returns applied discount information array

Returns

array

Definition at line 2159 of file oxbasket.php.

oxBasket::getFDeliveryCosts

(

)

Returns if exists formatted delivery costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string | bool

Definition at line 2624 of file oxbasket.php.

oxBasket::getFGiftCardCosts

(

)

Returns if exists formatted gift card costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string | bool

Definition at line 2584 of file oxbasket.php.

oxBasket::getFPaymentCosts

(

)

Returns if exists formatted payment costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string | bool

Definition at line 2396 of file oxbasket.php.

oxBasket::getFPrice

(

)

Returns formatted basket total price

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string

Definition at line 2612 of file oxbasket.php.

oxBasket::getFProductsPrice

(

)

Formatted Products price getter

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string

Definition at line 2255 of file oxbasket.php.

oxBasket::getFTsProtectionCosts

(

)

Returns if exists formatted TS protection costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string | bool

Definition at line 2946 of file oxbasket.php.

oxBasket::getFVoucherDiscountValue

(

)

Returns formatted voucher discount

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string | bool

Definition at line 2427 of file oxbasket.php.

oxBasket::getFWrappingCosts

(

)

Returns if exists formatted wrapping costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string | bool

Definition at line 2513 of file oxbasket.php.

oxBasket::getGiftCardCost

(

)

Gets gift card cost.

Returns

oxPrice

Definition at line 2600 of file oxbasket.php.

oxBasket::getGiftCardCostNet

(

)

Returns formatted netto price of gift card costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string

Definition at line 2563 of file oxbasket.php.

oxBasket::getGiftCardCostVat

(

)

Returns formatted VAT of gift card costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string | bool

Definition at line 2541 of file oxbasket.php.

oxBasket::getGiftCardCostVatPercent

(

)

Returns VAT of gift card costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

double

Definition at line 2459 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 567 of file oxbasket.php.

oxBasket::getItemsCount

(

)

Returns count of items stored in basket

Returns

double

Definition at line 2028 of file oxbasket.php.

oxBasket::getMinOrderPrice

(

)

Returns min order price value

Returns

decimal

Definition at line 3148 of file oxbasket.php.

oxBasket::getMostUsedVatPercent

(

)

Get most used vat percent:

Returns

double

Definition at line 960 of file oxbasket.php.

oxBasket::getNettoSum

(

)

Return basket netto sum (in B2B view mode sum include discount)

Returns

decimal

Definition at line 324 of file oxbasket.php.

oxBasket::getNotDiscountProductsPrice

(

)

Returns pricelist object of not discounted products

Returns

oxprice in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Definition at line 3036 of file oxbasket.php.

oxBasket::getOrderId

(

)

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

Returns

string

Definition at line 1970 of file oxbasket.php.

oxBasket::getPayCostNet

(

)

Returns formatted netto price of payment costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string

Definition at line 2351 of file oxbasket.php.

oxBasket::getPayCostVat

(

)

Returns formatted VAT of payment costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string

Definition at line 2332 of file oxbasket.php.

oxBasket::getPayCostVatPercent

(

)

Returns VAT of payment costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

double

Definition at line 2320 of file oxbasket.php.

oxBasket::getPaymentCost

(

)

Returns payment costs

Returns

oxPrice

Definition at line 2384 of file oxbasket.php.

oxBasket::getPaymentCosts

(

)

Returns payment costs brutto value

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

double | bool

Definition at line 2371 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 1814 of file oxbasket.php.

oxBasket::getPrice

(

)

Returns basket price object

Returns

oxPrice

Definition at line 1944 of file oxbasket.php.

oxBasket::getPriceForPayment

(

)

Get basket price for payment cost calculation. Returned price is with applied discounts, vouchers and added delivery cost

Returns

double

Definition at line 2679 of file oxbasket.php.

oxBasket::getProductsCount

(

)

Returns number of different products stored in basket

Returns

int

Definition at line 2018 of file oxbasket.php.

oxBasket::getProductsNetPrice

(

)

Formatted Products net price getter

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string

Definition at line 2243 of file oxbasket.php.

oxBasket::getProductsPrice

(

)

Returns basket products price list object

Returns

oxPriceList

Definition at line 1930 of file oxbasket.php.

oxBasket::getProductVats

(

$blFormatCurrency = true

)

Returns array of plain of formatted VATs which were calculated for basket

Parameters

bool

$blFormatCurrency

enables currency formatting

Returns

array

Definition at line 2060 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 1849 of file oxbasket.php.

oxBasket::getStockCheckMode

(

)

Returns stock control mode

Returns

bool

Definition at line 550 of file oxbasket.php.

oxBasket::getTotalDiscount

(

)

Returns total basket discount oxPrice object

Returns

oxPrice

Definition at line 2149 of file oxbasket.php.

oxBasket::getTotalDiscountSum

(

)

Gets total discount sum.

Returns

float|int

Definition at line 2724 of file oxbasket.php.

oxBasket::getTrustedShopProtectionCost

(

)

Returns TS protection costs brutto value

Returns

double in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Definition at line 3025 of file oxbasket.php.

oxBasket::getTsInsuredSum

(

)

Return sum of basket insured by trusted shops

Returns

decimal

Definition at line 3158 of file oxbasket.php.

oxBasket::getTsProductId

(

)

Trusted shops protection product ID getter

Returns

string

Definition at line 2934 of file oxbasket.php.

oxBasket::getTsProtectionCosts

(

)

Returns TS protection costs brutto value

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

double

Definition at line 3010 of file oxbasket.php.

oxBasket::getTsProtectionNet

(

)

Returns formatted netto price of TS protection costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string

Definition at line 2993 of file oxbasket.php.

oxBasket::getTsProtectionVat

(

)

Returns formatted VAT of TS protection costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string

Definition at line 2975 of file oxbasket.php.

oxBasket::getTsProtectionVatPercent

(

)

Returns VAT of TS protection costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string | bool

Definition at line 2963 of file oxbasket.php.

oxBasket::getVoucherDiscount

(

)

Returns basket voucher discount oxPrice object

Returns

oxPrice

Definition at line 2173 of file oxbasket.php.

oxBasket::getVoucherDiscValue

(

)

Returns value of voucher discount

Returns

double

Definition at line 2411 of file oxbasket.php.

oxBasket::getVouchers

(

)

Returns array of vouchers applied to basket

Returns

array

Definition at line 2008 of file oxbasket.php.

oxBasket::getWeight

(

)

Returns total basket weight

Returns

double

Definition at line 2038 of file oxbasket.php.

oxBasket::getWrappCostNet

(

)

Returns formatted netto price of wrapping costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string

Definition at line 2492 of file oxbasket.php.

oxBasket::getWrappCostVat

(

)

Returns formatted VAT of wrapping costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string | bool

Definition at line 2471 of file oxbasket.php.

oxBasket::getWrappCostVatPercent

(

)

Returns VAT of wrapping costs

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

double

Definition at line 2446 of file oxbasket.php.

oxBasket::getWrappingCost

(

)

Returns array of wrapping costs

Returns

array

Definition at line 2529 of file oxbasket.php.

oxBasket::hasArticlesWithDownloadableAgreement

(

)

Returns whether there are any articles in basket with downloadable products agreement enabled.

Returns

bool

Definition at line 3128 of file oxbasket.php.

oxBasket::hasArticlesWithIntangibleAgreement

(

)

Returns whether there are any articles in basket with intangible products agreement enabled.

Returns

bool

Definition at line 3108 of file oxbasket.php.

oxBasket::hasDownloadableProducts

(

)

Returns true if at least one product is downloadable in basket

Returns

bool

Definition at line 3089 of file oxbasket.php.

oxBasket::hasSkipedDiscount

(

)

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

Returns

bool

Definition at line 2221 of file oxbasket.php.

oxBasket::isBelowMinOrderPrice

(

)

Returns TRUE if ( current basket products sum - total discount - voucher discount ) > 0

Returns

bool

Definition at line 2767 of file oxbasket.php.

oxBasket::isCalculationModeNetto

(

)

Return true if calculation mode is netto

Returns

bool

Definition at line 300 of file oxbasket.php.

oxBasket::isEnabled

(

)

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

Returns

bool

Definition at line 364 of file oxbasket.php.

oxBasket::isNewItemAdded

(

)

Returns true if new product was just added to basket

Returns

bool

Definition at line 3074 of file oxbasket.php.

oxBasket::isPriceViewModeNetto

(

)

Returns true if view mode is netto

Returns

bool

Definition at line 1162 of file oxbasket.php.

oxBasket::isProportionalCalculationOn

(

)

Get most used vat percent:

Returns

double

Definition at line 988 of file oxbasket.php.

oxBasket::isSaveToDataBaseEnabled

(

)

Returns true if saving to data base enabled

Returns

boolean

Definition at line 285 of file oxbasket.php.

oxBasket::load

(

)

Populates current basket from the saved one.

Returns

null

Definition at line 1679 of file oxbasket.php.

oxBasket::onUpdate

(

)

Notifies basket that recalculation is needed

Definition at line 1491 of file oxbasket.php.

oxBasket::removeItem

(

$sItemKey

)

Removes item from basket

Parameters

string

$sItemKey

basket item key

Definition at line 582 of file oxbasket.php.

oxBasket::removeVoucher

(

$sVoucherId

)

Removes voucher from basket and unreserved it.

Parameters

string

$sVoucherId

removable voucher ID

Definition at line 1620 of file oxbasket.php.

oxBasket::resetUserInfo

(

)

Resets user related information kept in basket object

Definition at line 1640 of file oxbasket.php.

oxBasket::setBasketCurrency

(

$oCurrency

)

Set basket currency

Parameters

object

$oCurrency

currency object

Definition at line 2187 of file oxbasket.php.

oxBasket::setBasketRootCatId

(

$sRoot

)

Set active basket root category

Parameters

string

$sRoot

Root category id

Definition at line 2884 of file oxbasket.php.

oxBasket::setBasketUser

(

$oUser

)

Basket user setter

Parameters

oxuser

$oUser

Basket user

Definition at line 949 of file oxbasket.php.

oxBasket::setBruttoSum

(

$dBruttoSum

)

Set basket brutto sum

Parameters

decimal

$dBruttoSum

sum of basket in brutto mode

Definition at line 354 of file oxbasket.php.

oxBasket::setCalculationModeNetto

(

$blNettoMode = true

)

Set netto calculation mode

Parameters

bool

$blNettoMode

- true in netto; false - turn off

Definition at line 314 of file oxbasket.php.

oxBasket::setCardId

(

$sCardId

)

Gift card ID setter

Parameters

string

$sCardId

gift card id

Definition at line 2112 of file oxbasket.php.

oxBasket::setCardMessage

(

$sMessage

)

Gift card message setter

Parameters

string

$sMessage

gift card message

Definition at line 2092 of file oxbasket.php.

oxBasket::setCatChangeWarningState

(

$blShow

)

Sets category change warn state

Parameters

bool

$blShow

to show warning or not

Definition at line 2904 of file oxbasket.php.

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

Sets basket additional costs

Parameters

string	$sCostName	additional costs
object	$oPrice	oxPrice

Definition at line 1392 of file oxbasket.php.

oxBasket::setDeliveryPrice

(

$oShippingPrice = null

)

Set basket shipping price

Parameters

string

$oShippingPrice

delivery costs

Definition at line 1839 of file oxbasket.php.

oxBasket::setDiscountCalcMode

(

$blCalcDiscounts

)

Sets discount calculation mode

Parameters

bool

$blCalcDiscounts

calculate discounts or not

Definition at line 840 of file oxbasket.php.

oxBasket::setNettoSum

(

$dNettoSum

)

Set basket netto sum

Parameters

decimal

$dNettoSum

sum of basket in netto mode

Definition at line 344 of file oxbasket.php.

oxBasket::setOrderId

(

$sId

)

Basket order ID setter

Parameters

string

$sId

unique id for basket order

Definition at line 1980 of file oxbasket.php.

oxBasket::setPayment

(

$sPaymentId = null

)

Set basket payment ID

Parameters

string

$sPaymentId

payment id

Definition at line 1804 of file oxbasket.php.

oxBasket::setPrice

(

$oPrice

)

Set basket total sum price object

Parameters

oxPrice

$oPrice

Price object

Definition at line 1958 of file oxbasket.php.

oxBasket::setShipping

(

$sShippingSetId = null

)

Set basket shipping set ID

Parameters

string

$sShippingSetId

delivery set id

Definition at line 1828 of file oxbasket.php.

oxBasket::setSkipDiscounts

(

$blSkip

)

Used to set "skip discounts" status for basket

Parameters

bool

$blSkip

set true to skip discounts

Definition at line 2231 of file oxbasket.php.

oxBasket::setSkipVouchersChecking

(

$blSkipChecking = null

)

Set skip or not vouchers availability checking

Parameters

bool

$blSkipChecking

skip or not vouchers checking

Definition at line 2211 of file oxbasket.php.

oxBasket::setStockCheckMode

(

$blCheck

)

Sets stock control mode

Parameters

bool

$blCheck

stock control mode

Definition at line 540 of file oxbasket.php.

oxBasket::setTotalDiscount

(

$dDiscount

)

Sets total discount value

Parameters

double

$dDiscount

new total discount value

Definition at line 2666 of file oxbasket.php.

oxBasket::setTsProductId

(

$sProductId

)

Trusted shops protection product ID setter

Parameters

string

$sProductId

product id

Definition at line 2924 of file oxbasket.php.

oxBasket::setVoucherDiscount

(

$dDiscount

)

Voucher discount setter

Parameters

double

$dDiscount

voucher discount value

Definition at line 1054 of file oxbasket.php.

oxBasket::showCatChangeWarning

(

)

Tells to show category change warning

Returns

bool

Definition at line 2914 of file oxbasket.php.

Member Data Documentation

oxBasket::$_aBasketContents = array()

protected

Definition at line 15 of file oxbasket.php.

oxBasket::$_aBasketSummary = null

protected

Definition at line 134 of file oxbasket.php.

oxBasket::$_aCosts = array()

protected

Definition at line 106 of file oxbasket.php.

oxBasket::$_aDiscountedVats = null

protected

Definition at line 197 of file oxbasket.php.

oxBasket::$_aDiscounts = array()

protected

Definition at line 78 of file oxbasket.php.

oxBasket::$_aItemDiscounts = array()

protected

Definition at line 85 of file oxbasket.php.

oxBasket::$_aVouchers = array()

protected

Definition at line 99 of file oxbasket.php.

oxBasket::$_blCalcDiscounts = true

protected

Definition at line 225 of file oxbasket.php.

oxBasket::$_blCheckStock = true

protected

Definition at line 218 of file oxbasket.php.

oxBasket::$_blDownloadableProducts = null

protected

Definition at line 260 of file oxbasket.php.

oxBasket::$_blNewITemAdded = null

protected

Definition at line 253 of file oxbasket.php.

oxBasket::$_blSaveToDataBase = null

protected

Definition at line 268 of file oxbasket.php.

oxBasket::$_blShowCatChangeWarning = false

protected

Definition at line 239 of file oxbasket.php.

oxBasket::$_blSkipDiscounts = false

protected

Definition at line 204 of file oxbasket.php.

oxBasket::$_blSkipVouchersAvailabilityChecking = null

protected

Definition at line 183 of file oxbasket.php.

oxBasket::$_blUpdateNeeded = true

protected

Definition at line 127 of file oxbasket.php.

oxBasket::$_dBruttoSum = null

protected

Definition at line 64 of file oxbasket.php.

oxBasket::$_dDiscountedProductNettoPrice = null

protected

Definition at line 190 of file oxbasket.php.

oxBasket::$_dItemsCnt = 0.0

protected

Definition at line 29 of file oxbasket.php.

oxBasket::$_dNettoSum = null

protected

Definition at line 57 of file oxbasket.php.

oxBasket::$_dWeight = 0.0

protected

Definition at line 36 of file oxbasket.php.

oxBasket::$_iProductsCnt = 0

protected

Definition at line 22 of file oxbasket.php.

oxBasket::$_isCalculationModeNetto = null

protected

Definition at line 50 of file oxbasket.php.

oxBasket::$_oCurrency = null

protected

Definition at line 176 of file oxbasket.php.

oxBasket::$_oDeliveryPrice = null

protected

Definition at line 211 of file oxbasket.php.

oxBasket::$_oDiscountProductsPriceList = null

protected

Definition at line 113 of file oxbasket.php.

oxBasket::$_oNotDiscountedProductsPriceList = null

protected

Definition at line 120 of file oxbasket.php.

oxBasket::$_oPrice = null

protected

Definition at line 43 of file oxbasket.php.

oxBasket::$_oProductsPriceList = null

protected

Definition at line 71 of file oxbasket.php.

oxBasket::$_oTotalDiscount = null

protected

Definition at line 162 of file oxbasket.php.

oxBasket::$_oUser = null

protected

Definition at line 155 of file oxbasket.php.

oxBasket::$_oVoucherDiscount = null

protected

Definition at line 169 of file oxbasket.php.

oxBasket::$_sBasketCategoryId = null

protected

Definition at line 232 of file oxbasket.php.

oxBasket::$_sOrderId = null

protected

Definition at line 92 of file oxbasket.php.

oxBasket::$_sPaymentId = null

protected

Definition at line 141 of file oxbasket.php.

oxBasket::$_sShippingSetId = null

protected

Definition at line 148 of file oxbasket.php.

oxBasket::$_sTsProductId = null

protected

Definition at line 246 of file oxbasket.php.

---

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

• application/models/oxbasket.php