oxDiscountList Class Reference

Inheritance diagram for oxDiscountList:

[legend]

Collaboration diagram for oxDiscountList:

[legend]

List of all members.

---

Detailed Description

Discount list manager. Organizes list of discount objects.

Public Member Functions
	__construct ($sObjectsInListName= 'oxdiscount')
	getCountryId ($oUser)
	forceReload ()
	getArticleDiscounts ($oArticle, $oUser=null)
	getBasketItemDiscounts ($oArticle, $oBasket, $oUser=null)
	getBasketDiscounts ($oBasket, $oUser=null)
	getBasketItemBundleDiscounts ($oArticle, $oBasket, $oUser=null)
	getBasketBundleDiscounts ($oBasket, $oUser=null)
Static Public Member Functions
static	getInstance ()
Protected Member Functions
	_getList ($oUser=null)
	_getFilterSelect ($oUser)
Protected Attributes
	$_sUserId = null
	$_blReload = true
Static Protected Attributes
static	$_instance = null

---

Constructor & Destructor Documentation

oxDiscountList.__construct

(

$

sObjectsInListName = 'oxdiscount'

)

Class Constructor

Parameters:

string

$sObjectsInListName Associated list item object type

Reimplemented from oxList.

---

Member Function Documentation

static oxDiscountList.getInstance

(

)

[static]

Returns discount list instance

Returns:

oxDiscountList

oxDiscountList._getList

(

$

oUser = null

)

[protected]

Initializes current state discount list

Parameters:

object

$oUser user object (optional)

Returns:

array

oxDiscountList.getCountryId

(

$

oUser

)

Returns user country id for for discount selection

Parameters:

oxuser

$oUser oxuser object

Returns:

string

oxDiscountList.forceReload

(

)

Used to force discount list reload

Returns:

null

oxDiscountList._getFilterSelect

(

$

oUser

)

[protected]

Creates discount list filter SQL to load current state discount list

Parameters:

object

$oUser user object

Returns:

string

oxDiscountList.getArticleDiscounts	(	$	oArticle,
		$	oUser = null
	)

Returns array of discounts that can be globally (transparently) applied

Parameters:

	object	$oArticle article object
	object	$oUser oxuser object (optional)

Returns:

array

oxDiscountList.getBasketItemDiscounts	(	$	oArticle,
		$	oBasket,
		$	oUser = null
	)

Returns array of discounts that can be applied for individual basket item

Parameters:

	mixed	$oArticle article object or article id (according to needs)
	object	$oBasket array of basket items containing article id, amount and price
	object	$oUser user object (optional)

Returns:

array

oxDiscountList.getBasketDiscounts	(	$	oBasket,
		$	oUser = null
	)

Returns array of discounts that can be applied for whole basket

Parameters:

	object	$oBasket basket
	object	$oUser user object (optional)

Returns:

array

oxDiscountList.getBasketItemBundleDiscounts	(	$	oArticle,
		$	oBasket,
		$	oUser = null
	)

Returns array of bundle discounts that can be applied for whole basket

Parameters:

	object	$oArticle article object
	object	$oBasket basket
	object	$oUser user object (optional)

Returns:

array

oxDiscountList.getBasketBundleDiscounts	(	$	oBasket,
		$	oUser = null
	)

Returns array of basket bundle discounts

Parameters:

	oxbasket	$oBasket oxbasket object
	oxuser	$oUser oxuser object (optional)

Returns:

array

---

Member Data Documentation

oxDiscountList.$_instance = null [static, protected]

oxDiscountList.$_sUserId = null [protected]

oxDiscountList.$_blReload = true [protected]

---

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

• core/oxdiscountlist.php