oxBasketItem Class Reference

Inheritance diagram for oxBasketItem:

[legend]

Collaboration diagram for oxBasketItem:

[legend]

List of all members.

---

Detailed Description

UserBasketItem class, responsible for storing most important fields

Public Member Functions
	init ($sProductID, $dAmount, $blAllowUnevenAmounts, $aSel=null, $aPersParam=null, $blBundle=null)
	setAsDiscountArticle ($blIsDiscountArticle)
	setAmount ($dAmount, $blAllowUnevenAmounts, $blOverride=true)
	setPrice ($oPrice)
	getImageUrl ()
	getArticle ()
	getdBundledAmount ()
	getPrice ()
	getUnitPrice ()
	getAmount ()
	getWeight ()
	getTitle ()
	getIcon ()
	getLink ()
	getShopId ()
	getSelList ()
	getChosenSelList ()
	isBundle ()
	isDiscountArticle ()
	isSkipDiscount ()
	__get ($sName)
	__sleep ()
	getPersParams ()
	setPersParams ($aPersParam)
	setBundle ($blBundle)
	setSkipDiscounts ($blSkip)
	getProductId ()
	setWrapping ($sWrapId)
	getWrappingId ()
	getWrapping ()
	getWishId ()
	setWishId ($sWishId)
	setWishArticleId ($sArticleId)
	getWishArticleId ()
	getFUnitPrice ()
	getFTotalPrice ()
	getVatPercent ()
	getVarSelect ()
Protected Member Functions
	_setDeprecatedValues ()
	_setArticle ($sProductId)
	_setSelectList ($aSelList)
Protected Attributes
	$_sProductId = null
	$_sTitle = null
	$_sVarSelect = null
	$_sIcon = null
	$_sLink = null
	$_oPrice = null
	$_oUnitPrice = null
	$_dAmount = 0.0
	$_dWeight = 0
	$_aSelList = array()
	$_sShopId = null
	$_sNativeShopId = null
	$_blSkipDiscounts = false
	$_aPersistentParameters = array()
	$_blBundle = false
	$_blIsDiscountArticle = false
	$_oArticle = null
	$_sDimageDirNoSsl = null
	$_sDimageDirSsl = null
	$_aChosenSelectlist = array()
	$_sWrappingId = null
	$_sWishId = null
	$_sWishArticleId = null

---

Member Function Documentation

oxBasketItem.init	(	$	sProductID,
		$	dAmount,
		$	blAllowUnevenAmounts,
		$	aSel = null,
		$	aPersParam = null,
		$	blBundle = null
	)

Assigns basic params to basket item

• oxbasketitem._setArticle();
• oxbasketitem.setAmount();
• oxbasketitem._setSelectList();
• oxbasketitem.setPersParams().
• oxbasketitem.setBundle();

Parameters:

	string	$sProductID product id
	double	$dAmount amount
	bool	$blAllowUnevenAmounts allow uneven amounts
	array	$aSel selection
	array	$aPersParam persistent params
	bool	$blBundle bundle

Exceptions:

oxNoArticleException,oxOutOfStockException,oxArticleInputException

Returns:

null

oxBasketItem.setAsDiscountArticle

(

$

blIsDiscountArticle

)

Marks if item is discount bundle ( oxbasketitem._blIsDiscountArticle )

Parameters:

bool

$blIsDiscountArticle if item is discount bundle

Returns:

null

oxBasketItem.setAmount	(	$	dAmount,
		$	blAllowUnevenAmounts,
		$	blOverride = true
	)

Sets item amount and weight which depends on amount ( oxbasketitem.dAmount, oxbasketitem.dWeight )

Parameters:

	double	$dAmount amount
	bool	$blAllowUnevenAmounts allow uneven amounts
	bool	$blOverride overide

Exceptions:

oxOutOfStockException,oxArticleInputException

Returns:

null

oxBasketItem.setPrice

(

$

oPrice

)

Sets $this->oPrice

Parameters:

object

$oPrice price

Returns:

null

oxBasketItem.getImageUrl

(

)

Getter which returns image path according to SSL mode

Returns:

string

oxBasketItem.getArticle

(

)

Retrieves the article

Exceptions:

oxArticleException

exception

Returns:

oxarticle

oxBasketItem.getdBundledAmount

(

)

Returns bundle amount

Returns:

double

oxBasketItem.getPrice

(

)

Returns the price.

Returns:

oxprice

oxBasketItem.getUnitPrice

(

)

Returns the price.

Returns:

oxprice

oxBasketItem.getAmount

(

)

Returns the amount of item.

Returns:

double

oxBasketItem.getWeight

(

)

returns the price.

Returns:

double

oxBasketItem.getTitle

(

)

Returns product title

Returns:

string

oxBasketItem.getIcon

(

)

Returns product icon URL

Returns:

string

oxBasketItem.getLink

(

)

Returns product details URL

Returns:

string

oxBasketItem.getShopId

(

)

Returns ID of shop from which this product was added into basket

Returns:

string

oxBasketItem.getSelList

(

)

Returns user passed select list information

Returns:

array

oxBasketItem.getChosenSelList

(

)

Returns user chosen select list information

Returns:

array

oxBasketItem.isBundle

(

)

Returns true if product is bundle

Returns:

bool

oxBasketItem.isDiscountArticle

(

)

Returns true if product is given as discount

Returns:

bool

oxBasketItem.isSkipDiscount

(

)

Returns true if discount must be skipped for current product

Returns:

bool

oxBasketItem.__get

(

$

sName

)

Special getter function for backwards compatability. Executes methods by rule "get".$sVariableName and returns result processed by executed function.

Parameters:

string

$sName parameter name

Returns:

mixed

oxBasketItem.__sleep

(

)

Does not return _oArticle var on serialisation

Returns:

array

oxBasketItem._setDeprecatedValues

(

)

[protected]

Sets object deprecated values

Deprecated:

This method is deprecated as all deprecated values are

Returns:

null

oxBasketItem._setArticle

(

$

sProductId

)

[protected]

Assigns general product parameters to oxbasketitem object :

• sProduct - oxarticle object ID;
• title - products title;
• icon - icon name;
• link - details URL's;
• sShopId - current shop ID;
• sNativeShopId - article shop ID;
• _sDimageDirNoSsl - NON SSL mode image path;
• _sDimageDirSsl - SSL mode image path;

Parameters:

string

$sProductId product id

Exceptions:

oxNoArticleException

exception

Returns:

null

oxBasketItem._setSelectList

(

$

aSelList

)

[protected]

Stores item select lists ( oxbasketitem.aSelList )

Parameters:

array

$aSelList item select lists

Returns:

null

oxBasketItem.getPersParams

(

)

Get persistent parameters ( oxbasketitem._aPersistentParameters )

Returns:

array

oxBasketItem.setPersParams

(

$

aPersParam

)

Stores items persistent parameters ( oxbasketitem._aPersistentParameters )

Parameters:

array

$aPersParam items persistent parameters

Returns:

null

oxBasketItem.setBundle

(

$

blBundle

)

Marks if item is bundle ( oxbasketitem.blBundle )

Parameters:

bool

$blBundle if item is bundle

Returns:

null

oxBasketItem.setSkipDiscounts

(

$

blSkip

)

Used to set "skip discounts" status for basket item

Parameters:

bool

$blSkip set true to skip discounts

Returns:

null

oxBasketItem.getProductId

(

)

Returns product Id

Returns:

string product id

oxBasketItem.setWrapping

(

$

sWrapId

)

Product wrapping paper id setter

Parameters:

string

$sWrapId wrapping paper id

Returns:

null

oxBasketItem.getWrappingId

(

)

Returns wrapping paper ID (if such was applied)

Returns:

string

oxBasketItem.getWrapping

(

)

Returns basket item wrapping object

Returns:

oxwrapping

oxBasketItem.getWishId

(

)

Returns wishlist user Id

Returns:

string

oxBasketItem.setWishId

(

$

sWishId

)

Wish user id setter

Parameters:

string

$sWishId user id

Returns:

null

oxBasketItem.setWishArticleId

(

$

sArticleId

)

Wish article Id setter

Parameters:

string

$sArticleId wish article id

Returns:

null

oxBasketItem.getWishArticleId

(

)

Returns wish article Id

Returns:

string

oxBasketItem.getFUnitPrice

(

)

Returns formatted unit price

Returns:

string

oxBasketItem.getFTotalPrice

(

)

Returns formatted total price

Returns:

string

oxBasketItem.getVatPercent

(

)

Returns formatted total price

Returns:

string

oxBasketItem.getVarSelect

(

)

Returns varselect value

Returns:

string

---

Member Data Documentation

oxBasketItem.$_sProductId = null [protected]

oxBasketItem.$_sTitle = null [protected]

oxBasketItem.$_sVarSelect = null [protected]

oxBasketItem.$_sIcon = null [protected]

oxBasketItem.$_sLink = null [protected]

oxBasketItem.$_oPrice = null [protected]

oxBasketItem.$_oUnitPrice = null [protected]

oxBasketItem.$_dAmount = 0.0 [protected]

oxBasketItem.$_dWeight = 0 [protected]

oxBasketItem.$_aSelList = array() [protected]

oxBasketItem.$_sShopId = null [protected]

oxBasketItem.$_sNativeShopId = null [protected]

oxBasketItem.$_blSkipDiscounts = false [protected]

oxBasketItem.$_aPersistentParameters = array() [protected]

oxBasketItem.$_blBundle = false [protected]

oxBasketItem.$_blIsDiscountArticle = false [protected]

oxBasketItem.$_oArticle = null [protected]

oxBasketItem.$_sDimageDirNoSsl = null [protected]

oxBasketItem.$_sDimageDirSsl = null [protected]

oxBasketItem.$_aChosenSelectlist = array() [protected]

oxBasketItem.$_sWrappingId = null [protected]

oxBasketItem.$_sWishId = null [protected]

oxBasketItem.$_sWishArticleId = null [protected]

---

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

• core/oxbasketitem.php