oxcmp_basket Class Reference

Inheritance diagram for oxcmp_basket:

Collaboration diagram for oxcmp_basket:

List of all members.

Public Member Functions
	init ()
	render ()
	tobasket ($sProductId=null, $dAmount=null, $aSel=null, $aPersParam=null, $blOverride=false)
	changebasket ($sProductId=null, $dAmount=null, $aSel=null, $aPersParam=null, $blOverride=true)
	isRootCatChanged ()
	executeuserchoice ()
Public Attributes
	$aRedirectParams
Protected Member Functions
	_getRedirectUrl ()
	_getItems ($sProductId=null, $dAmount=null, $aSel=null, $aPersParam=null, $blOverride=false)
	_addItems ($aProducts)
	_setLastCall ($sCallName, $aProductInfo, $aBasketInfo)
	_setLastCallFnc ($sCallName)
	_getLastCallFnc ()
Protected Attributes
	$_blIsComponent = true
	$_sLastCallFnc = null

---

Detailed Description

Main shopping basket manager. Arranges shopping basket contents, updates amounts, prices, taxes etc. oxcmp

Definition at line 8 of file oxcmp_basket.php.

---

Member Function Documentation

oxcmp_basket._addItems

(

$

aProducts

)

[protected]

Adds all articles user wants to add to basket. Returns last added to basket item.

Parameters:

array

$aProducts products to add array

Returns:

object $oBasketItem last added basket item

Definition at line 303 of file oxcmp_basket.php.

oxcmp_basket._getItems	(	$	sProductId = null,
		$	dAmount = null,
		$	aSel = null,
		$	aPersParam = null,
		$	blOverride = false
	)			[protected]

Collects and returns array of items to add to basket. Product info is taken not only from given parameters, but additionally from request 'aproducts' parameter

Parameters:

	string	$sProductId product ID
	double	$dAmount product amount
	array	$aSel product select lists
	array	$aPersParam product persistent parameters
	bool	$blOverride amount override status

Returns:

mixed

Definition at line 243 of file oxcmp_basket.php.

oxcmp_basket._getLastCallFnc

(

)

[protected]

Getting last call function name (data used by econda)

Returns:

string

Definition at line 389 of file oxcmp_basket.php.

oxcmp_basket._getRedirectUrl

(

)

[protected]

Formats and returns redirect URL where shop must be redirected after storing something to basket

Returns:

string $sClass.$sPosition redirection URL

Definition at line 195 of file oxcmp_basket.php.

oxcmp_basket._setLastCall	(	$	sCallName,
		$	aProductInfo,
		$	aBasketInfo
	)			[protected]

Setting last call data to session (data used by econda)

Parameters:

	string	$sCallName name of action ('tobasket', 'changebasket')
	array	$aProductInfo data which comes from request when you press button "to basket"
	array	$aBasketInfo array returned by oxbasket.getBasketSummary()

Returns:

null

Definition at line 367 of file oxcmp_basket.php.

oxcmp_basket._setLastCallFnc

(

$

sCallName

)

[protected]

Setting last call function name (data used by econda)

Parameters:

string

$sCallName name of action ('tobasket', 'changebasket')

Returns:

null

Definition at line 379 of file oxcmp_basket.php.

oxcmp_basket.changebasket	(	$	sProductId = null,
		$	dAmount = null,
		$	aSel = null,
		$	aPersParam = null,
		$	blOverride = true
	)

Similar to tobasket, except that as product id "bindex" parameter is (can be) taken

Parameters:

	string	$sProductId Product ID (default null)
	double	$dAmount Product amount (default null)
	array	$aSel (default null)
	array	$aPersParam (default null)
	bool	$blOverride If true means increase amount of chosen article (default false)

Returns:

mixed

Definition at line 150 of file oxcmp_basket.php.

oxcmp_basket.executeuserchoice

(

)

Executes user choice:

• if user clicked on "Proceed to checkout" - redirects to basket,
• if clicked "Continue shopping" - clear basket

Returns:

mixed

Definition at line 430 of file oxcmp_basket.php.

oxcmp_basket.init

(

)

Initiates component.

Returns:

null

Reimplemented from oxView.

Definition at line 46 of file oxcmp_basket.php.

oxcmp_basket.isRootCatChanged

(

)

Returns true if active root category was changed

Returns:

bool

Definition at line 399 of file oxcmp_basket.php.

oxcmp_basket.render

(

)

Loads basket ($oBasket = $mySession->getBasket()), calls oBasket->calculateBasket, executes parent.render() and returns basket object.

Returns:

object $oBasket basket object

Reimplemented from oxView.

Definition at line 81 of file oxcmp_basket.php.

oxcmp_basket.tobasket	(	$	sProductId = null,
		$	dAmount = null,
		$	aSel = null,
		$	aPersParam = null,
		$	blOverride = false
	)

Basket content update controller. Before adding article - check if client is not a search engine. If yes - exits method by returning false. If no - executes oxcmp_basket._addItems() and puts article to basket. Returns position where to redirect user browser.

Parameters:

	string	$sProductId Product ID (default null)
	double	$dAmount Product amount (default null)
	array	$aSel (default null)
	array	$aPersParam (default null)
	bool	$blOverride If true means increase amount of chosen article (default false)

Returns:

mixed

Definition at line 108 of file oxcmp_basket.php.

---

Member Data Documentation

oxcmp_basket.$_blIsComponent = true [protected]

Reimplemented from oxView.

Definition at line 15 of file oxcmp_basket.php.

oxcmp_basket.$_sLastCallFnc = null [protected]

Definition at line 21 of file oxcmp_basket.php.

oxcmp_basket.$aRedirectParams

Initial value:

 array( 'cnid',        
                                     'mnid',        
                                     'anid',        
                                     'tpl',         
                                     'listtype',    
                                     'searchcnid',  
                                     'searchvendor',
                                     'searchmanufacturer',
                                     'searchtag',   
                                     'searchrecomm',
                                     'recommid'     
                                    )

Definition at line 28 of file oxcmp_basket.php.

---

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

• application/components/oxcmp_basket.php