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

Definition at line 6 of file oxbasketitem.php.

Public Member Functions
	init ($sProductID, $dAmount, $aSel=null, $aPersParam=null, $blBundle=null)
	initFromOrderArticle ($oOrderArticle)
	setAsDiscountArticle ($blIsDiscountArticle)
	setStockCheckStatus ($blStatus)
	getStockCheckStatus ()
	setAmount ($dAmount, $blOverride=true)
	setPrice ($oPrice)
	getImageUrl ()
	getArticle ($blCheckProduct=true, $sProductId=null, $blDisableLazyLoading=false)
	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)
	_setFromOrderArticle ($oOrderArticle)
	_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
	$_blCheckArticleStock = true

---

Member Function Documentation

oxBasketItem.init	(	$	sProductID,
		$	dAmount,
		$	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
	array	$aSel selection
	array	$aPersParam persistent params
	bool	$blBundle bundle

Exceptions:

oxNoArticleException,oxOutOfStockException,oxArticleInputException

Returns:

null

Definition at line 194 of file oxbasketitem.php.

oxBasketItem.initFromOrderArticle

(

$

oOrderArticle

)

Initializes basket item from oxorderarticle object

• oxbasketitem._setFromOrderArticle() - assigns $oOrderArticle parameter to oxBasketItem._oArticle. Thus oxOrderArticle is used as oxArticle (calls standard methods implemented by oxIArticle interface);
• oxbasketitem.setAmount();
• oxbasketitem._setSelectList();
• oxbasketitem.setPersParams().

Parameters:

oxorderarticle

$oOrderArticle order article to load info from

Returns:

null

Definition at line 216 of file oxbasketitem.php.

oxBasketItem.setAsDiscountArticle

(

$

blIsDiscountArticle

)

Marks if item is discount bundle ( oxbasketitem._blIsDiscountArticle )

Parameters:

bool

$blIsDiscountArticle if item is discount bundle

Returns:

null

Definition at line 231 of file oxbasketitem.php.

oxBasketItem.setStockCheckStatus

(

$

blStatus

)

Sets stock control mode

Parameters:

bool

$blStatus stock control mode

Returns:

null

Definition at line 243 of file oxbasketitem.php.

oxBasketItem.getStockCheckStatus

(

)

Returns stock control mode

Returns:

bool

Definition at line 253 of file oxbasketitem.php.

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

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

Parameters:

	double	$dAmount amount
	bool	$blOverride overide current amoutn or not

Exceptions:

oxOutOfStockException,oxArticleInputException

Returns:

null

Definition at line 269 of file oxbasketitem.php.

oxBasketItem.setPrice

(

$

oPrice

)

Sets $this->oPrice

Parameters:

object

$oPrice price

Returns:

null

Definition at line 330 of file oxbasketitem.php.

oxBasketItem.getImageUrl

(

)

Getter which returns image path according to SSL mode

Returns:

string

Definition at line 350 of file oxbasketitem.php.

oxBasketItem.getArticle	(	$	blCheckProduct = true,
		$	sProductId = null,
		$	blDisableLazyLoading = false
	)

Retrieves the article .Throws an execption if article does not exist, is not buyable or visible.

Parameters:

	bool	$blCheckProduct checks if product is buyable and visible
	string	$sProductId product id
	bool	$blDisableLazyLoading disable lazy loading

Exceptions:

oxArticleException,oxNoArticleException

exception

Returns:

oxarticle

Definition at line 372 of file oxbasketitem.php.

oxBasketItem.getdBundledAmount

(

)

Returns bundle amount

Returns:

double

Definition at line 434 of file oxbasketitem.php.

oxBasketItem.getPrice

(

)

Returns the price.

Returns:

oxprice

Definition at line 444 of file oxbasketitem.php.

oxBasketItem.getUnitPrice

(

)

Returns the price.

Returns:

oxprice

Definition at line 454 of file oxbasketitem.php.

oxBasketItem.getAmount

(

)

Returns the amount of item.

Returns:

double

Definition at line 464 of file oxbasketitem.php.

oxBasketItem.getWeight

(

)

returns the price.

Returns:

double

Definition at line 474 of file oxbasketitem.php.

oxBasketItem.getTitle

(

)

Returns product title

Returns:

string

Definition at line 484 of file oxbasketitem.php.

oxBasketItem.getIcon

(

)

Returns product icon URL

Returns:

string

Definition at line 494 of file oxbasketitem.php.

oxBasketItem.getLink

(

)

Returns product details URL

Returns:

string

Definition at line 504 of file oxbasketitem.php.

oxBasketItem.getShopId

(

)

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

Returns:

string

Definition at line 514 of file oxbasketitem.php.

oxBasketItem.getSelList

(

)

Returns user passed select list information

Returns:

array

Definition at line 524 of file oxbasketitem.php.

oxBasketItem.getChosenSelList

(

)

Returns user chosen select list information

Returns:

array

Definition at line 534 of file oxbasketitem.php.

oxBasketItem.isBundle

(

)

Returns true if product is bundle

Returns:

bool

Definition at line 544 of file oxbasketitem.php.

oxBasketItem.isDiscountArticle

(

)

Returns true if product is given as discount

Returns:

bool

Definition at line 554 of file oxbasketitem.php.

oxBasketItem.isSkipDiscount

(

)

Returns true if discount must be skipped for current product

Returns:

bool

Definition at line 564 of file oxbasketitem.php.

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

Definition at line 578 of file oxbasketitem.php.

oxBasketItem.__sleep

(

)

Does not return _oArticle var on serialisation

Returns:

array

Definition at line 590 of file oxbasketitem.php.

oxBasketItem._setDeprecatedValues

(

)

[protected]

Sets object deprecated values

Deprecated:

This method is deprecated as all deprecated values are

Returns:

null

Definition at line 608 of file oxbasketitem.php.

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

Definition at line 711 of file oxbasketitem.php.

oxBasketItem._setFromOrderArticle

(

$

oOrderArticle

)

[protected]

Assigns general product parameters to oxbasketitem object:

• sProduct - oxarticle object ID;
• title - products title;
• sShopId - current shop ID;
• sNativeShopId - article shop ID;

Parameters:

oxorderarticle

$oOrderArticle order article

Returns:

null

Definition at line 749 of file oxbasketitem.php.

oxBasketItem._setSelectList

(

$

aSelList

)

[protected]

Stores item select lists ( oxbasketitem.aSelList )

Parameters:

array

$aSelList item select lists

Returns:

null

Definition at line 772 of file oxbasketitem.php.

oxBasketItem.getPersParams

(

)

Get persistent parameters ( oxbasketitem._aPersistentParameters )

Returns:

array

Definition at line 799 of file oxbasketitem.php.

oxBasketItem.setPersParams

(

$

aPersParam

)

Stores items persistent parameters ( oxbasketitem._aPersistentParameters )

Parameters:

array

$aPersParam items persistent parameters

Returns:

null

Definition at line 811 of file oxbasketitem.php.

oxBasketItem.setBundle

(

$

blBundle

)

Marks if item is bundle ( oxbasketitem.blBundle )

Parameters:

bool

$blBundle if item is bundle

Returns:

null

Definition at line 823 of file oxbasketitem.php.

oxBasketItem.setSkipDiscounts

(

$

blSkip

)

Used to set "skip discounts" status for basket item

Parameters:

bool

$blSkip set true to skip discounts

Returns:

null

Definition at line 835 of file oxbasketitem.php.

oxBasketItem.getProductId

(

)

Returns product Id

Returns:

string product id

Definition at line 845 of file oxbasketitem.php.

oxBasketItem.setWrapping

(

$

sWrapId

)

Product wrapping paper id setter

Parameters:

string

$sWrapId wrapping paper id

Returns:

null

Definition at line 857 of file oxbasketitem.php.

oxBasketItem.getWrappingId

(

)

Returns wrapping paper ID (if such was applied)

Returns:

string

Definition at line 867 of file oxbasketitem.php.

oxBasketItem.getWrapping

(

)

Returns basket item wrapping object

Returns:

oxwrapping

Definition at line 877 of file oxbasketitem.php.

oxBasketItem.getWishId

(

)

Returns wishlist user Id

Returns:

string

Definition at line 892 of file oxbasketitem.php.

oxBasketItem.setWishId

(

$

sWishId

)

Wish user id setter

Parameters:

string

$sWishId user id

Returns:

null

Definition at line 904 of file oxbasketitem.php.

oxBasketItem.setWishArticleId

(

$

sArticleId

)

Wish article Id setter

Parameters:

string

$sArticleId wish article id

Returns:

null

Definition at line 916 of file oxbasketitem.php.

oxBasketItem.getWishArticleId

(

)

Returns wish article Id

Returns:

string

Definition at line 926 of file oxbasketitem.php.

oxBasketItem.getFUnitPrice

(

)

Returns formatted unit price

Returns:

string

Definition at line 936 of file oxbasketitem.php.

oxBasketItem.getFTotalPrice

(

)

Returns formatted total price

Returns:

string

Definition at line 946 of file oxbasketitem.php.

oxBasketItem.getVatPercent

(

)

Returns formatted total price

Returns:

string

Definition at line 956 of file oxbasketitem.php.

oxBasketItem.getVarSelect

(

)

Returns varselect value

Returns:

string

Definition at line 966 of file oxbasketitem.php.

---

Member Data Documentation

oxBasketItem.$_sProductId = null [protected]

Definition at line 13 of file oxbasketitem.php.

oxBasketItem.$_sTitle = null [protected]

Definition at line 20 of file oxbasketitem.php.

oxBasketItem.$_sVarSelect = null [protected]

Definition at line 27 of file oxbasketitem.php.

oxBasketItem.$_sIcon = null [protected]

Definition at line 34 of file oxbasketitem.php.

oxBasketItem.$_sLink = null [protected]

Definition at line 41 of file oxbasketitem.php.

oxBasketItem.$_oPrice = null [protected]

Definition at line 48 of file oxbasketitem.php.

oxBasketItem.$_oUnitPrice = null [protected]

Definition at line 55 of file oxbasketitem.php.

oxBasketItem.$_dAmount = 0.0 [protected]

Definition at line 62 of file oxbasketitem.php.

oxBasketItem.$_dWeight = 0 [protected]

Definition at line 69 of file oxbasketitem.php.

oxBasketItem.$_aSelList = array() [protected]

Definition at line 76 of file oxbasketitem.php.

oxBasketItem.$_sShopId = null [protected]

Definition at line 83 of file oxbasketitem.php.

oxBasketItem.$_sNativeShopId = null [protected]

Definition at line 90 of file oxbasketitem.php.

oxBasketItem.$_blSkipDiscounts = false [protected]

Definition at line 97 of file oxbasketitem.php.

oxBasketItem.$_aPersistentParameters = array() [protected]

Definition at line 104 of file oxbasketitem.php.

oxBasketItem.$_blBundle = false [protected]

Definition at line 111 of file oxbasketitem.php.

oxBasketItem.$_blIsDiscountArticle = false [protected]

Definition at line 118 of file oxbasketitem.php.

oxBasketItem.$_oArticle = null [protected]

Definition at line 125 of file oxbasketitem.php.

oxBasketItem.$_sDimageDirNoSsl = null [protected]

Definition at line 132 of file oxbasketitem.php.

oxBasketItem.$_sDimageDirSsl = null [protected]

Definition at line 139 of file oxbasketitem.php.

oxBasketItem.$_aChosenSelectlist = array() [protected]

Definition at line 146 of file oxbasketitem.php.

oxBasketItem.$_sWrappingId = null [protected]

Definition at line 153 of file oxbasketitem.php.

oxBasketItem.$_sWishId = null [protected]

Definition at line 160 of file oxbasketitem.php.

oxBasketItem.$_sWishArticleId = null [protected]

Definition at line 167 of file oxbasketitem.php.

oxBasketItem.$_blCheckArticleStock = true [protected]

Definition at line 174 of file oxbasketitem.php.

---

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

• core/oxbasketitem.php