Basket Class Reference

Inheritance diagram for Basket:

Collaboration diagram for Basket:

List of all members.

Public Member Functions
	render ()
	getBasketArticles ()
	getFirstBasketProduct ()
	getBasketSimilarList ()
	getSimilarRecommListIds ()
	showBackToShop ()
	addVoucher ()
	removeVoucher ()
	backToShop ()
	getErrorDestination ()
	isWrapping ()
	getWrappingList ()
	getCardList ()
	changeWrapping ()
	getBreadCrumb ()
Protected Attributes
	$_sThisTemplate = 'page/checkout/basket.tpl'
	$_sThisAltTemplate = 'content.tpl'
	$_blIsOrderStep = true
	$_oBasketArticles = null
	$_oSimilarList = null
	$_oRecommList = null
	$_oFirstBasketProduct = null
	$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW
	$_oWrappings = null
	$_oCards = null
	$_aSimilarRecommListIds = null

---

Detailed Description

Current session shopping cart (basket item list). Contains with user selected articles (with detail information), list of similar products, topoffer articles. OXID eShop -> SHOPPING CART.

Definition at line 9 of file basket.php.

---

Member Function Documentation

Basket.addVoucher

(

)

Assigns voucher to current basket

Returns:

null

Definition at line 199 of file basket.php.

Basket.backToShop

(

)

Redirects user back to previous part of shop (list, details, ...) from basket. Used with option "Display Message when Product is added to Cart" set to "Open Basket" ($myConfig->iNewBasketItemMessage == 3)

Returns:

string $sBackLink back link

Definition at line 231 of file basket.php.

Basket.changeWrapping

(

)

Updates wrapping data in session basket object (oxsession.getBasket()) - adds wrapping info to each article in basket (if possible). Plus adds gift message and chosen card ( takes from GET/POST/session; oBasket.giftmessage, oBasket.chosencard). Then sets basket back to session (oxsession.setBasket()).

Returns:

string

Definition at line 320 of file basket.php.

Basket.getBasketArticles

(

)

Return the current articles from the basket

Returns:

object | bool

Definition at line 118 of file basket.php.

Basket.getBasketSimilarList

(

)

return the similar articles

Returns:

object | bool

Definition at line 154 of file basket.php.

Basket.getBreadCrumb

(

)

Returns Bread Crumb - you are here page1/page2/page3...

Returns:

array

Reimplemented from oxUBase.

Definition at line 347 of file basket.php.

Basket.getCardList

(

)

Returns greeting cards list if available

Returns:

oxlist

Definition at line 296 of file basket.php.

Basket.getErrorDestination

(

)

Returns a name of the view variable containing the error/exception messages

Returns:

null

Reimplemented from oxView.

Definition at line 246 of file basket.php.

Basket.getFirstBasketProduct

(

)

return the basket articles

Returns:

object | bool

Definition at line 136 of file basket.php.

Basket.getSimilarRecommListIds

(

)

Return array of id to form recommend list.

Returns:

array

Reimplemented from oxUBase.

Definition at line 172 of file basket.php.

Basket.getWrappingList

(

)

Return basket wrappings list if available

Returns:

oxlist

Definition at line 278 of file basket.php.

Basket.isWrapping

(

)

Returns wrapping options availability state (TRUE/FALSE)

Returns:

bool

Definition at line 256 of file basket.php.

Basket.removeVoucher

(

)

Removes voucher from basket (calls oxbasket.removeVoucher())

Returns:

null

Definition at line 214 of file basket.php.

Basket.render

(

)

Executes parent.render(), creates list with basket articles Returns name of template file basket._sThisTemplate (for Search engines return "content.tpl" template to avoid fake orders etc).

Returns:

string $this->_sThisTemplate current template file name

Reimplemented from oxUBase.

Definition at line 97 of file basket.php.

Basket.showBackToShop

(

)

return the Link back to shop

Returns:

bool

Definition at line 189 of file basket.php.

---

Member Data Documentation

Basket.$_aSimilarRecommListIds = null [protected]

Definition at line 87 of file basket.php.

Basket.$_blIsOrderStep = true [protected]

Reimplemented from oxUBase.

Definition at line 30 of file basket.php.

Basket.$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW [protected]

Current view search engine indexing state: VIEW_INDEXSTATE_INDEX - index without limitations VIEW_INDEXSTATE_NOINDEXNOFOLLOW - no index / no follow VIEW_INDEXSTATE_NOINDEXFOLLOW - no index / follow

Reimplemented from oxUBase.

Definition at line 66 of file basket.php.

Basket.$_oBasketArticles = null [protected]

Definition at line 37 of file basket.php.

Basket.$_oCards = null [protected]

Definition at line 80 of file basket.php.

Basket.$_oFirstBasketProduct = null [protected]

Definition at line 59 of file basket.php.

Basket.$_oRecommList = null [protected]

Definition at line 51 of file basket.php.

Basket.$_oSimilarList = null [protected]

Definition at line 44 of file basket.php.

Basket.$_oWrappings = null [protected]

Definition at line 73 of file basket.php.

Basket.$_sThisAltTemplate = 'content.tpl' [protected]

Definition at line 23 of file basket.php.

Basket.$_sThisTemplate = 'page/checkout/basket.tpl' [protected]

Reimplemented from oxView.

Definition at line 16 of file basket.php.

---

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

• application/controllers/basket.php