Basket Class Reference

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)
	prepareSortColumns ()
	getListOrderBy ()
	getListOrderDirection ()
	setMetaDescription ($sDescription)
	setMetaKeywords ($sKeywords)
	getMetaKeywords ()
	getMetaDescription ()
	getActCurrency ()
	setActCurrency ($oCur)
	getCompareItemCount ()
	noIndex ()
	isSortingActive ()
	getMenueList ()
	setMenueList ($aMenue)
	getNavigationParams ()
	setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
	getSorting ($sSortIdent)
	getSortingSql ($sIdent)
	getTitleSuffix ()
	getTitlePageSuffix ()
	getTitlePrefix ()
	getDynUrlParams ()
	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 ()
	getSearchCatTree ()
	setSearchCatTree ($aTree)
	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
	$_blActiveSorting = 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
	$_aSearchCatTree = 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 360 of file basket.php.

Basket::addVoucher

(

)

Assigns voucher to current basket

Returns

null

Definition at line 187 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 219 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 309 of file basket.php.

Basket::getBasketArticles

(

)

Return the current articles from the basket

Returns

object | bool

Definition at line 106 of file basket.php.

Basket::getBasketContentMarkGenerator

(

)

Method returns object with explanation marks for articles in basket.

Returns

oxBasketContentMarkGenerator

Definition at line 346 of file basket.php.

Basket::getBasketSimilarList

(

)

return the similar articles

Returns

object | bool

Definition at line 142 of file basket.php.

Basket::getBreadCrumb

(

)

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

Returns

array

Reimplemented from oxUBase.

Definition at line 329 of file basket.php.

Basket::getCardList

(

)

Returns greeting cards list if available

Returns

oxlist

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

Basket::getFirstBasketProduct

(

)

return the basket articles

Returns

object | bool

Definition at line 124 of file basket.php.

Basket::getSimilarRecommListIds

(

)

Return array of id to form recommend list.

Returns

array

Reimplemented from oxUBase.

Definition at line 160 of file basket.php.

Basket::getWrappingList

(

)

Return basket wrappings list if available

Returns

oxlist

Definition at line 267 of file basket.php.

Basket::isWrapping

(

)

Returns wrapping options availability state (TRUE/FALSE)

Returns

bool

Definition at line 245 of file basket.php.

Basket::removeVoucher

(

)

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

Returns

null

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

Basket::showBackToShop

(

)

return the Link back to shop

Returns

bool

Definition at line 177 of file basket.php.

Member Data Documentation

Basket::$_aSimilarRecommListIds = null

protected

Definition at line 80 of file basket.php.

Basket::$_blIsOrderStep = true

protected

Definition at line 23 of file basket.php.

Basket::$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW

protected

Definition at line 59 of file basket.php.

Basket::$_oBasketArticles = null

protected

Definition at line 30 of file basket.php.

Basket::$_oCards = null

protected

Definition at line 73 of file basket.php.

Basket::$_oFirstBasketProduct = null

protected

Definition at line 52 of file basket.php.

Basket::$_oRecommList = null

protected

Definition at line 44 of file basket.php.

Basket::$_oSimilarList = null

protected

Definition at line 37 of file basket.php.

Basket::$_oWrappings = null

protected

Definition at line 66 of file basket.php.

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

protected

Definition at line 16 of file basket.php.

---

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

• application/controllers/basket.php