OXID eShop CE  6.1.5
OxidEsales\EshopCommunity\Application\Controller\BasketController Class Reference
+ Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\BasketController:
+ Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\BasketController:

Public Member Functions

 render ()
 
 getBasketArticles ()
 
 getFirstBasketProduct ()
 
 getBasketSimilarList ()
 
 getSimilarRecommListIds ()
 
 showBackToShop ()
 
 addVoucher ()
 
 removeVoucher ()
 
 backToShop ()
 
 getErrorDestination ()
 
 isWrapping ()
 
 getWrappingList ()
 
 getCardList ()
 
 changeWrapping ()
 
 getBreadCrumb ()
 
 getBasketContentMarkGenerator ()
 

Protected Member Functions

 _setWrappingInfo ($oBasket, $aWrapping)
 

Protected Attributes

 $_sThisTemplate = 'page/checkout/basket.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, top offer articles. OXID eShop -> SHOPPING CART.

Member Function Documentation

◆ _setWrappingInfo()

OxidEsales\EshopCommunity\Application\Controller\BasketController::_setWrappingInfo (   $oBasket,
  $aWrapping 
)
protected

Sets basket wrapping

Parameters
\OxidEsales\Eshop\Application\Model\Basket$oBasket
array$aWrapping

◆ addVoucher()

OxidEsales\EshopCommunity\Application\Controller\BasketController::addVoucher ( )

Assigns voucher to current basket

Returns
null

◆ backToShop()

OxidEsales\EshopCommunity\Application\Controller\BasketController::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

◆ changeWrapping()

OxidEsales\EshopCommunity\Application\Controller\BasketController::changeWrapping ( )

Updates wrapping data in session basket object (\OxidEsales\Eshop\Core\Session::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 (\OxidEsales\Eshop\Core\Session::setBasket()).

◆ getBasketArticles()

OxidEsales\EshopCommunity\Application\Controller\BasketController::getBasketArticles ( )

Return the current articles from the basket

Returns
object | bool

◆ getBasketContentMarkGenerator()

OxidEsales\EshopCommunity\Application\Controller\BasketController::getBasketContentMarkGenerator ( )

Method returns object with explanation marks for articles in basket.

Returns
\OxidEsales\Eshop\Application\Model\BasketContentMarkGenerator

◆ getBasketSimilarList()

OxidEsales\EshopCommunity\Application\Controller\BasketController::getBasketSimilarList ( )

return the similar articles

Returns
object | bool

◆ getBreadCrumb()

OxidEsales\EshopCommunity\Application\Controller\BasketController::getBreadCrumb ( )

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

Returns
array

◆ getCardList()

OxidEsales\EshopCommunity\Application\Controller\BasketController::getCardList ( )

Returns greeting cards list if available

Returns
oxlist

◆ getErrorDestination()

OxidEsales\EshopCommunity\Application\Controller\BasketController::getErrorDestination ( )

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

Returns
null

◆ getFirstBasketProduct()

OxidEsales\EshopCommunity\Application\Controller\BasketController::getFirstBasketProduct ( )

return the basket articles

Returns
object | bool

◆ getSimilarRecommListIds()

OxidEsales\EshopCommunity\Application\Controller\BasketController::getSimilarRecommListIds ( )

Return array of id to form recommend list.

Deprecated:
since v5.3 (2016-06-17); Listmania will be moved to an own module.
Returns
array

◆ getWrappingList()

OxidEsales\EshopCommunity\Application\Controller\BasketController::getWrappingList ( )

Return basket wrappings list if available

Returns
oxlist

◆ isWrapping()

OxidEsales\EshopCommunity\Application\Controller\BasketController::isWrapping ( )

Returns wrapping options availability state (TRUE/FALSE)

Returns
bool

◆ removeVoucher()

OxidEsales\EshopCommunity\Application\Controller\BasketController::removeVoucher ( )

Removes voucher from basket (calls \OxidEsales\Eshop\Application\Model\Basket::removeVoucher())

Returns
null

◆ render()

OxidEsales\EshopCommunity\Application\Controller\BasketController::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

◆ showBackToShop()

OxidEsales\EshopCommunity\Application\Controller\BasketController::showBackToShop ( )

return the Link back to shop

Returns
bool

Member Data Documentation

◆ $_aSimilarRecommListIds

OxidEsales\EshopCommunity\Application\Controller\BasketController::$_aSimilarRecommListIds = null
protected

◆ $_blIsOrderStep

OxidEsales\EshopCommunity\Application\Controller\BasketController::$_blIsOrderStep = true
protected

◆ $_iViewIndexState

OxidEsales\EshopCommunity\Application\Controller\BasketController::$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW
protected

◆ $_oBasketArticles

OxidEsales\EshopCommunity\Application\Controller\BasketController::$_oBasketArticles = null
protected

◆ $_oCards

OxidEsales\EshopCommunity\Application\Controller\BasketController::$_oCards = null
protected

◆ $_oFirstBasketProduct

OxidEsales\EshopCommunity\Application\Controller\BasketController::$_oFirstBasketProduct = null
protected

◆ $_oRecommList

OxidEsales\EshopCommunity\Application\Controller\BasketController::$_oRecommList = null
protected

◆ $_oSimilarList

OxidEsales\EshopCommunity\Application\Controller\BasketController::$_oSimilarList = null
protected

◆ $_oWrappings

OxidEsales\EshopCommunity\Application\Controller\BasketController::$_oWrappings = null
protected

◆ $_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\BasketController::$_sThisTemplate = 'page/checkout/basket.tpl'
protected

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