Inheritance diagram for Basket:

Collaboration diagram for Basket:

Public Member Functions
	render ()
	getBasketArticles ()
	getFirstBasketProduct ()
	getBasketSimilarList ()
	getSimilarRecommListIds ()
	showBackToShop ()
	addVoucher ()
	removeVoucher ()
	backToShop ()
	getErrorDestination ()
	isWrapping ()
	getWrappingList ()
	getCardList ()
	changeWrapping ()
	getBreadCrumb ()
	getBasketContentMarkGenerator ()
Public Member Functions inherited from oxUBase
	init ()
	getViewId ()
	showSorting ()
	setComponents ($aComponents=null)
	getComponents ()
	getComponent ($sName)
	setIsOrderStep ($blIsOrderStep=null)
	getIsOrderStep ()
	setActiveCategory ($oCategory)
	getActiveCategory ()
	getListType ()
	getListDisplayType ()
	getCustomListDisplayType ()
	setListType ($sType)
	loadCurrency ()
	dontShowEmptyCategories ()
	showCategoryArticlesCount ()
	isLanguageLoaded ()
	getTopNavigationCatCnt ()
	addRssFeed ($sTitle, $sUrl, $key=null)
	getSortOrderByParameterName ()
	getSortOrderParameterName ()
	getSortIdent ()
	getDefaultSorting ()
	getUserSelectedSorting ()
	getSavedSorting ($sSortIdent)
	setListOrderBy ($sColumn)
	setListOrderDirection ($sDirection)
	getListOrderBy ()
	getListOrderDirection ()
	setMetaDescription ($sDescription)
	setMetaKeywords ($sKeywords)
	getMetaKeywords ()
	getMetaDescription ()
	getActCurrency ()
	setActCurrency ($oCur)
	getCompareItemCount ()
	noIndex ()
	getMenueList ()
	setMenueList ($aMenu)
	getNavigationParams ()
	setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
	getSorting ($sSortIdent)
	getSortingSql ($sIdent)
	getTitleSuffix ()
	getTitlePageSuffix ()
	getTitlePrefix ()
	getPageTitle ()
	getDynUrlParams ()
	getBaseLink ($iLang=null)
	getLink ($iLang=null)
	getCanonicalUrl ()
	getSearchParamForHtml ()
	showSearch ()
	getRssLinks ()
	getSortColumns ()
	setSortColumns ($aSortColumns)
	getEditTags ()
	getRecommSearch ()
	getPaymentList ()
	getActiveRecommList ()
	getAccessoires ()
	getCrossSelling ()
	getSimilarProducts ()
	getAlsoBoughtTheseProducts ()
	getArticleId ()
	getTitle ()
	getActiveLangAbbr ()
	addGlobalParams ($oShop=null)
	getAdditionalParams ()
	generatePageNavigationUrl ()
	getPageNavigation ()
	getPageNavigationLimitedTop ($iPositionCount=7)
	getPageNavigationLimitedBottom ($iPositionCount=11)
	generatePageNavigation ($iPositionCount=0)
	getViewProduct ()
	setViewProduct ($oProduct)
	getViewProductList ()
	getActPage ()
	getActTag ()
	getActVendor ()
	getActManufacturer ()
	setActVendor ($oVendor)
	setActManufacturer ($oManufacturer)
	getActSearch ()
	getCategoryTree ()
	setCategoryTree ($oCatTree)
	getManufacturerTree ()
	setManufacturerTree ($oManufacturerTree)
	getAddUrlParams ()
	getTop5ArticleList ($iCount=null)
	getBargainArticleList ()
	isLowOrderPrice ()
	getMinOrderPrice ()
	getNewsRealStatus ()
	getProduct ()
	getManufacturerlist ()
	setManufacturerlist ($aList)
	setRootVendor ($oVendor)
	getRootVendor ()
	setRootManufacturer ($oManufacturer)
	getRootManufacturer ()
	getVendorId ()
	getManufacturerId ()
	getCatMoreUrl ()
	getCatTreePath ()
	getContentByIdent ($sIdent)
	getContentCategory ()
	getMustFillFields ()
	isFieldRequired ($sField)
	getFormId ()
	canAcceptFormData ()
	getPromoFinishedList ()
	getPromoCurrentList ()
	getPromoFutureList ()
	getShowPromotionList ()
	isEnabledPrivateSales ()
	getFieldValidationErrors ()
	setRootCatChanged ($blRootCatChanged)
	isRootCatChanged ()
	getInvoiceAddress ()
	getDeliveryAddress ()
	setDeliveryAddress ($aDeliveryAddress)
	setInvoiceAddress ($aAddress)
	getActiveUsername ()
	getWishlistUserId ()
	getSearchCatId ()
	getSearchVendor ()
	getSearchManufacturer ()
	getLastProducts ()
	getNewBasketItemMsgType ()
	isActive ($sName)
	isFbWidgetVisible ()
	isEnabledDownloadableFiles ()
	showRememberMe ()
	isVatIncluded ()
	isPriceCalculated ()
	showTags ()
	getWishlistName ()
	getWidgetLink ()
Public Member Functions inherited from oxView
	setViewParameters ($aParams=null)
	getViewParameter ($sKey)
	setIsCallForCache ($blIsCallForCache=null)
	getIsCallForCache ()
	addTplParam ($sPara, $sValue)
	getBelboonParam ()
	getViewConfig ()
	getTemplateName ()
	setTemplateName ($sTemplate)
	setClassName ($sClassName)
	getClassName ()
	setFncName ($sFncName)
	getFncName ()
	setViewData ($aViewData=null)
	getViewData ()
	getViewDataElement ($sParamId=null)
	setClassLocation ($sClassLocation=null)
	getClassLocation ()
	setThisAction ($sThisAction=null)
	getThisAction ()
	setParent ($oParent=null)
	getParent ()
	setIsComponent ($blIsComponent=null)
	getIsComponent ()
	executeFunction ($sFunction)
	getTrustedShopId ()
	getTSExcellenceId ()
	getCharSet ()
	getShopVersion ()
	getShopEdition ()
	getRevision ()
	getPackageInfo ()
	getShopFullEdition ()
	isDemoVersion ()
	isBetaVersion ()
	isRCVersion ()
	showBetaNote ()
	isDemoShop ()
	showNewsletter ()
	setShowNewsletter ($blShow)
	getShopLogo ()
	setShopLogo ($sLogo)
	getActCategory ()
	setActCategory ($oCategory)
	getCategoryId ()
	setCategoryId ($sCategoryId)
	getActionClassName ()
	isConnectedWithFb ()
	getFbUserId ()
	showFbConnectToAccountMsg ()
	isMall ()
	showRdfa ()
	getSidForWidget ()
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
	_setWrappingInfo ($oBasket, $aWrapping)
Protected Member Functions inherited from oxUBase
	_getComponentNames ()
	_processRequest ()
	_getMetaFromSeo ($sDataType)
	_getMetaFromContent ($sMetaIdent)
	_forceNoIndex ()
	_setNrOfArtPerPage ()
	_getSeoObjectId ()
	_prepareMetaDescription ($sMeta, $iLength=1024, $blRemoveDuplicatedWords=false)
	_prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
	_removeDuplicatedWords ($aInput, $aSkipTags=array())
	_getSubject ($iLang)
	_getRequestParams ($blAddPageNr=true)
	_getSeoRequestParams ()
	_addPageNrParam ($sUrl, $iPage, $iLang=null)
	_canRedirect ()
Protected Member Functions inherited from oxView
	_executeNewAction ($sNewAction)

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
Protected Attributes inherited from oxUBase
	$_blFbWidgetsOn = null
	$_sRemoveMetaChars = '.\+*?[^]$(){}=!<>\|:&'
	$_oaComponents = array()
	$_blIsOrderStep = false
	$_sListType = null
	$_aListDisplayTypes = array('grid', 'line', 'infogrid')
	$_sListDisplayType = null
	$_sCustomListDisplayType = null
	$_oActCategory = null
	$_oActManufacturer = null
	$_oActVendor = null
	$_oActiveRecommList = null
	$_oActSearch = null
	$_blShowSorting = false
	$_blLoadCurrency = null
	$_blLoadManufacturerTree = null
	$_blDontShowEmptyCats = null
	$_blLoadLanguage = null
	$_iTopCatNavItmCnt = null
	$_aRssLinks = null
	$_sListOrderBy = null
	$_sListOrderDir = null
	$_sMetaDescription = null
	$_sMetaKeywords = null
	$_sMetaDescriptionIdent = null
	$_sMetaKeywordsIdent = null
	$_sAdditionalParams = null
	$_oActCurrency = null
	$_blEnabledPrivateSales = null
	$_blCommonAdded = false
	$_iViewIndexState = VIEW_INDEXSTATE_INDEX
	$_blForceNoIndex = false
	$_iCompItemsCnt = null
	$_sContentId = null
	$_oContent = null
	$_sViewResetID = null
	$_aMenueList = null
	$_aComponentNames
	$_aUserComponentNames = array()
	$_oProduct = null
	$_iActPage = null
	$_aArticleList = null
	$_oManufacturerTree = null
	$_oCategoryTree = null
	$_aTop5ArticleList = null
	$_aBargainArticleList = null
	$_blLowOrderPrice = null
	$_sMinOrderPrice = null
	$_iNewsRealStatus = null
	$_aBlockRedirectParams = array('fnc', 'stoken', 'force_sid', 'force_admin_sid')
	$_oRootVendor = null
	$_sVendorId = null
	$_aManufacturerlist = null
	$_oRootManufacturer = null
	$_sManufacturerId = null
	$_blNewsSubscribed = null
	$_oDelAddress = null
	$_sCatTreePath = null
	$_aContents = array()
	$_blTop5Action = false
	$_blBargainAction = false
	$_aMustFillFields = null
	$_blShowTagCloud = true
	$_blRootCatChanged = false
	$_aInvoiceAddress = null
	$_aDeliveryAddress = null
	$_sActiveUsername = null
	$_blLoadComponents = true
	$_aSortColumns = null
Protected Attributes inherited from oxView
	$_aViewData = array()
	$_sClassLocation = null
	$_sThisAction = null
	$_oParent = null
	$_blIsComponent = false
	$_sThisTemplate = null
	$_sViewId = null
	$_sClass = null
	$_sFnc = null
	$_sTrustedShopId = null
	$_sTSExcellenceId = null
	$_sCharSet = null
	$_sVersion = null
	$_blDemoVersion = null
	$_blDemoShop = null
	$_iNewsStatus = null
	$_sShopLogo = null
	$_sCategoryId = null
	$_oClickCat = null
	$_blIsCallForCache = false
	$_oViewConf = null

Additional Inherited Members
Static Protected Attributes inherited from oxUBase
static	$_aCollectedComponentNames = 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.

Definition at line 9 of file basket.php.

Member Function Documentation

Basket::_setWrappingInfo	(	$oBasket,
		$aWrapping
	)

protected

Sets basket wrapping

Parameters

oxBasket	$oBasket
array	$aWrapping

Definition at line 375 of file basket.php.

Basket::addVoucher ( )

Assigns voucher to current basket

Returns: null

Definition at line 201 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 233 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()).

Definition at line 323 of file basket.php.

Basket::getBasketArticles ( )

Return the current articles from the basket

Returns: object | bool

Definition at line 111 of file basket.php.

Basket::getBasketContentMarkGenerator ( )

Method returns object with explanation marks for articles in basket.

Returns: oxBasketContentMarkGenerator

Definition at line 361 of file basket.php.

Basket::getBasketSimilarList ( )

return the similar articles

Returns: object | bool

Definition at line 149 of file basket.php.

Basket::getBreadCrumb ( )

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

Returns: array

Reimplemented from oxUBase.

Definition at line 343 of file basket.php.

Basket::getCardList ( )

Returns greeting cards list if available

Returns: oxlist

Definition at line 301 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 250 of file basket.php.

Basket::getFirstBasketProduct ( )

return the basket articles

Returns: object | bool

Definition at line 130 of file basket.php.

Basket::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

Reimplemented from oxUBase.

Definition at line 170 of file basket.php.

Basket::getWrappingList ( )

Return basket wrappings list if available

Returns: oxlist

Definition at line 282 of file basket.php.

Basket::isWrapping ( )

Returns wrapping options availability state (TRUE/FALSE)

Returns: bool

Definition at line 260 of file basket.php.

Basket::removeVoucher ( )

Removes voucher from basket (calls oxBasket::removeVoucher())

Returns: null

Definition at line 216 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 95 of file basket.php.

Basket::showBackToShop ( )

return the Link back to shop

Returns: bool

Definition at line 188 of file basket.php.

Member Data Documentation

Basket::$_aSimilarRecommListIds = null

protected

Definition at line 85 of file basket.php.

Basket::$_blIsOrderStep = true

protected

Definition at line 24 of file basket.php.

Basket::$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW

protected

Definition at line 62 of file basket.php.

Basket::$_oBasketArticles = null

protected

Definition at line 31 of file basket.php.

Basket::$_oCards = null

protected

Definition at line 76 of file basket.php.

Basket::$_oFirstBasketProduct = null

protected

Definition at line 55 of file basket.php.

Basket::$_oRecommList = null

protected

Definition at line 47 of file basket.php.

Basket::$_oSimilarList = null

protected

Definition at line 38 of file basket.php.

Basket::$_oWrappings = null

protected

Definition at line 69 of file basket.php.

Basket::$_sThisTemplate = 'page/checkout/basket.tpl'

protected

Definition at line 17 of file basket.php.

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

application/controllers/basket.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation