oxBasketItem Class Reference

Inheritance diagram for oxBasketItem:

Collaboration diagram for oxBasketItem:

Public Member Functions
	getRegularUnitPrice ()
	setRegularUnitPrice ($oRegularUnitPrice)
	init ($sProductID, $dAmount, $aSel=null, $aPersParam=null, $blBundle=null)
	initFromOrderArticle ($oOrderArticle)
	setAsDiscountArticle ($blIsDiscountArticle)
	setStockCheckStatus ($blStatus)
	getStockCheckStatus ()
	setAmount ($dAmount, $blOverride=true, $sItemKey=null)
	setPrice ($oPrice)
	getIconUrl ()
	getArticle ($blCheckProduct=false, $sProductId=null, $blDisableLazyLoading=false)
	getdBundledAmount ()
	getPrice ()
	getUnitPrice ()
	getAmount ()
	getWeight ()
	getTitle ()
	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 ()
	getFRegularUnitPrice ()
	getFUnitPrice ()
	getFTotalPrice ()
	getVatPercent ()
	getVarSelect ()
	getLanguageId ()
	setLanguageId ($iLanguageId)
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
	_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
	$_iLanguageId = null
	$_blSsl = null
	$_sIconUrl = null
	$_oRegularUnitPrice = 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

UserBasketItem class, responsible for storing most important fields

Definition at line 7 of file oxbasketitem.php.

Member Function Documentation

oxBasketItem::__get

(

$sName

)

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

Parameters

string

$sName

parameter name

Returns

mixed

Definition at line 631 of file oxbasketitem.php.

oxBasketItem::__sleep

(

)

Does not return _oArticle var on serialisation

Returns

array

Definition at line 643 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 671 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 711 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 734 of file oxbasketitem.php.

oxBasketItem::getAmount

(

)

Returns the amount of item.

Returns

double

Definition at line 513 of file oxbasketitem.php.

oxBasketItem::getArticle	(		$blCheckProduct = false,
			$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 422 of file oxbasketitem.php.

oxBasketItem::getChosenSelList

(

)

Returns user chosen select list information

Returns

array

Definition at line 587 of file oxbasketitem.php.

oxBasketItem::getdBundledAmount

(

)

Returns bundle amount

Returns

double

Definition at line 483 of file oxbasketitem.php.

oxBasketItem::getFRegularUnitPrice

(

)

Returns formatted regular unit price

Deprecated:

in v4.8/5.1 on 2013-10-08; use oxPrice smarty formatter

Returns

string

Definition at line 900 of file oxbasketitem.php.

oxBasketItem::getFTotalPrice

(

)

Returns formatted total price

Deprecated:

in v4.8/5.1 on 2013-10-08; use oxPrice smarty formatter

Returns

string

Definition at line 924 of file oxbasketitem.php.

oxBasketItem::getFUnitPrice

(

)

Returns formatted unit price

Deprecated:

in v4.8/5.1 on 2013-10-08; use oxPrice smarty formatter

Returns

string

Definition at line 912 of file oxbasketitem.php.

oxBasketItem::getIconUrl

(

)

Returns article icon picture url

Returns

string

Definition at line 401 of file oxbasketitem.php.

oxBasketItem::getLanguageId

(

)

Get language id

Returns

integer

Definition at line 959 of file oxbasketitem.php.

oxBasketItem::getLink

(

)

Returns product details URL

Returns

string

Definition at line 553 of file oxbasketitem.php.

oxBasketItem::getPersParams

(

)

Get persistent parameters ( oxbasketitem::_aPersistentParameters )

Returns

array

Definition at line 761 of file oxbasketitem.php.

oxBasketItem::getPrice

(

)

Returns the price.

Returns

oxprice

Definition at line 493 of file oxbasketitem.php.

oxBasketItem::getProductId

(

)

Returns product Id

Returns

string product id

Definition at line 807 of file oxbasketitem.php.

oxBasketItem::getRegularUnitPrice

(

)

Return regular unit price

Returns

oxPrice

Definition at line 213 of file oxbasketitem.php.

oxBasketItem::getSelList

(

)

Returns user passed select list information

Returns

array

Definition at line 577 of file oxbasketitem.php.

oxBasketItem::getShopId

(

)

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

Returns

string

Definition at line 567 of file oxbasketitem.php.

oxBasketItem::getStockCheckStatus

(

)

Returns stock control mode

Returns

bool

Definition at line 310 of file oxbasketitem.php.

oxBasketItem::getTitle

(

)

Returns product title

Returns

string

Definition at line 533 of file oxbasketitem.php.

oxBasketItem::getUnitPrice

(

)

Returns the price.

Returns

oxprice

Definition at line 503 of file oxbasketitem.php.

oxBasketItem::getVarSelect

(

)

Returns varselect value

Returns

string

Definition at line 944 of file oxbasketitem.php.

oxBasketItem::getVatPercent

(

)

Returns formatted total price

Returns

string

Definition at line 934 of file oxbasketitem.php.

oxBasketItem::getWeight

(

)

returns the total weight.

Returns

double

Definition at line 523 of file oxbasketitem.php.

oxBasketItem::getWishArticleId

(

)

Returns wish article Id

Returns

string

Definition at line 888 of file oxbasketitem.php.

oxBasketItem::getWishId

(

)

Returns wishlist user Id

Returns

string

Definition at line 854 of file oxbasketitem.php.

oxBasketItem::getWrapping

(

)

Returns basket item wrapping object

Returns

oxwrapping

Definition at line 839 of file oxbasketitem.php.

oxBasketItem::getWrappingId

(

)

Returns wrapping paper ID (if such was applied)

Returns

string

Definition at line 829 of file oxbasketitem.php.

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 249 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 272 of file oxbasketitem.php.

oxBasketItem::isBundle

(

)

Returns true if product is bundle

Returns

bool

Definition at line 597 of file oxbasketitem.php.

oxBasketItem::isDiscountArticle

(

)

Returns true if product is given as discount

Returns

bool

Definition at line 607 of file oxbasketitem.php.

oxBasketItem::isSkipDiscount

(

)

Returns true if discount must be skipped for current product

Returns

bool

Definition at line 617 of file oxbasketitem.php.

oxBasketItem::setAmount	(		$dAmount,
			$blOverride = true,
			$sItemKey = null
	)

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

Parameters

double	$dAmount	amount
bool	$blOverride	overide current amoutn or not
string	$sItemKey	item key

Exceptions

oxOutOfStockException,oxArticleInputException

Returns

null

Definition at line 327 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 288 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 785 of file oxbasketitem.php.

oxBasketItem::setLanguageId

(

$iLanguageId

)

Set language Id, reload basket content on language change.

Parameters

integer

$iLanguageId

language id

Returns

none

Definition at line 971 of file oxbasketitem.php.

oxBasketItem::setPersParams

(

$aPersParam

)

Stores items persistent parameters ( oxbasketitem::_aPersistentParameters )

Parameters

array

$aPersParam

items persistent parameters

Returns

null

Definition at line 773 of file oxbasketitem.php.

oxBasketItem::setPrice

(

$oPrice

)

Sets $this->_oPrice

Parameters

object

$oPrice

price

Returns

null

Definition at line 388 of file oxbasketitem.php.

oxBasketItem::setRegularUnitPrice

(

$oRegularUnitPrice

)

Set regular unit price

Parameters

oxPrice

$oRegularUnitPrice

regular price

Returns

null

Definition at line 225 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 797 of file oxbasketitem.php.

oxBasketItem::setStockCheckStatus

(

$blStatus

)

Sets stock control mode

Parameters

bool

$blStatus

stock control mode

Returns

null

Definition at line 300 of file oxbasketitem.php.

oxBasketItem::setWishArticleId

(

$sArticleId

)

Wish article Id setter

Parameters

string

$sArticleId

wish article id

Returns

null

Definition at line 878 of file oxbasketitem.php.

oxBasketItem::setWishId

(

$sWishId

)

Wish user id setter

Parameters

string

$sWishId

user id

Returns

null

Definition at line 866 of file oxbasketitem.php.

oxBasketItem::setWrapping

(

$sWrapId

)

Product wrapping paper id setter

Parameters

string

$sWrapId

wrapping paper id

Returns

null

Definition at line 819 of file oxbasketitem.php.

Member Data Documentation

oxBasketItem::$_aChosenSelectlist = array()

protected

Definition at line 147 of file oxbasketitem.php.

oxBasketItem::$_aPersistentParameters = array()

protected

Definition at line 105 of file oxbasketitem.php.

oxBasketItem::$_aSelList = array()

protected

Definition at line 77 of file oxbasketitem.php.

oxBasketItem::$_blBundle = false

protected

Definition at line 112 of file oxbasketitem.php.

oxBasketItem::$_blCheckArticleStock = true

protected

Definition at line 175 of file oxbasketitem.php.

oxBasketItem::$_blIsDiscountArticle = false

protected

Definition at line 119 of file oxbasketitem.php.

oxBasketItem::$_blSkipDiscounts = false

protected

Definition at line 98 of file oxbasketitem.php.

oxBasketItem::$_blSsl = null

protected

Definition at line 190 of file oxbasketitem.php.

oxBasketItem::$_dAmount = 0.0

protected

Definition at line 63 of file oxbasketitem.php.

oxBasketItem::$_dWeight = 0

protected

Definition at line 70 of file oxbasketitem.php.

oxBasketItem::$_iLanguageId = null

protected

Definition at line 183 of file oxbasketitem.php.

oxBasketItem::$_oArticle = null

protected

Definition at line 126 of file oxbasketitem.php.

oxBasketItem::$_oPrice = null

protected

Definition at line 49 of file oxbasketitem.php.

oxBasketItem::$_oRegularUnitPrice = null

protected

Definition at line 205 of file oxbasketitem.php.

oxBasketItem::$_oUnitPrice = null

protected

Definition at line 56 of file oxbasketitem.php.

oxBasketItem::$_sDimageDirNoSsl = null

protected

Definition at line 133 of file oxbasketitem.php.

oxBasketItem::$_sDimageDirSsl = null

protected

Definition at line 140 of file oxbasketitem.php.

oxBasketItem::$_sIcon = null

protected

Definition at line 35 of file oxbasketitem.php.

oxBasketItem::$_sIconUrl = null

protected

Definition at line 197 of file oxbasketitem.php.

oxBasketItem::$_sLink = null

protected

Definition at line 42 of file oxbasketitem.php.

oxBasketItem::$_sNativeShopId = null

protected

Definition at line 91 of file oxbasketitem.php.

oxBasketItem::$_sProductId = null

protected

Definition at line 14 of file oxbasketitem.php.

oxBasketItem::$_sShopId = null

protected

Definition at line 84 of file oxbasketitem.php.

oxBasketItem::$_sTitle = null

protected

Definition at line 21 of file oxbasketitem.php.

oxBasketItem::$_sVarSelect = null

protected

Definition at line 28 of file oxbasketitem.php.

oxBasketItem::$_sWishArticleId = null

protected

Definition at line 168 of file oxbasketitem.php.

oxBasketItem::$_sWishId = null

protected

Definition at line 161 of file oxbasketitem.php.

oxBasketItem::$_sWrappingId = null

protected

Definition at line 154 of file oxbasketitem.php.

---

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

• application/models/oxbasketitem.php