Inheritance diagram for VendorList:

Collaboration diagram for VendorList:

Public Member Functions
	render ()
	generatePageNavigationUrl ()
	hasVisibleSubCats ()
	getSubCatList ()
	getArticleList ()
	getTitle ()
	getTreePath ()
	getActiveCategory ()
	getCatTreePath ()
	getTitleSuffix ()
	getAddUrlParams ()
	getBreadCrumb ()
	setVendorTree ($oVendorTree)
	getAttributes ()
Public Member Functions inherited from aList
	getViewId ()
	getAddSeoUrlParams ()
	executefilter ()
	getActPage ()
	getMetaDescription ()
	getTemplateName ()
	getDefaultSorting ()
	getTitlePageSuffix ()
	getArticleCount ()
	getSimilarRecommListIds ()
	getPageNavigation ()
	getBargainArticleList ()
	getCanonicalUrl ()
	canSelectDisplayType ()
	getPageCount ()
Public Member Functions inherited from oxUBase
	init ()
	showSorting ()
	setComponents ($aComponents=null)
	getComponents ()
	getComponent ($sName)
	setIsOrderStep ($blIsOrderStep=null)
	getIsOrderStep ()
	setActiveCategory ($oCategory)
	getListType ()
	getListDisplayType ()
	getCustomListDisplayType ()
	setListType ($sType)
	loadCurrency ()
	dontShowEmptyCategories ()
	showCategoryArticlesCount ()
	isLanguageLoaded ()
	getTopNavigationCatCnt ()
	addRssFeed ($sTitle, $sUrl, $key=null)
	getSortOrderByParameterName ()
	getSortOrderParameterName ()
	getSortIdent ()
	getUserSelectedSorting ()
	getSavedSorting ($sSortIdent)
	setListOrderBy ($sColumn)
	setListOrderDirection ($sDirection)
	getListOrderBy ()
	getListOrderDirection ()
	setMetaDescription ($sDescription)
	setMetaKeywords ($sKeywords)
	getMetaKeywords ()
	getActCurrency ()
	setActCurrency ($oCur)
	getCompareItemCount ()
	noIndex ()
	getMenueList ()
	setMenueList ($aMenu)
	getNavigationParams ()
	setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
	getSorting ($sSortIdent)
	getSortingSql ($sIdent)
	getTitlePrefix ()
	getPageTitle ()
	getDynUrlParams ()
	getBaseLink ($iLang=null)
	getLink ($iLang=null)
	getSearchParamForHtml ()
	showSearch ()
	getRssLinks ()
	getSortColumns ()
	setSortColumns ($aSortColumns)
	getEditTags ()
	getRecommSearch ()
	getPaymentList ()
	getActiveRecommList ()
	getAccessoires ()
	getCrossSelling ()
	getSimilarProducts ()
	getAlsoBoughtTheseProducts ()
	getArticleId ()
	getActiveLangAbbr ()
	addGlobalParams ($oShop=null)
	getAdditionalParams ()
	getPageNavigationLimitedTop ($iPositionCount=7)
	getPageNavigationLimitedBottom ($iPositionCount=11)
	generatePageNavigation ($iPositionCount=0)
	getViewProduct ()
	setViewProduct ($oProduct)
	getViewProductList ()
	getActTag ()
	getActVendor ()
	getActManufacturer ()
	setActVendor ($oVendor)
	setActManufacturer ($oManufacturer)
	getActSearch ()
	getCategoryTree ()
	setCategoryTree ($oCatTree)
	getManufacturerTree ()
	setManufacturerTree ($oManufacturerTree)
	getTop5ArticleList ($iCount=null)
	isLowOrderPrice ()
	getMinOrderPrice ()
	getNewsRealStatus ()
	getProduct ()
	getManufacturerlist ()
	setManufacturerlist ($aList)
	setRootVendor ($oVendor)
	getRootVendor ()
	setRootManufacturer ($oManufacturer)
	getRootManufacturer ()
	getVendorId ()
	getManufacturerId ()
	getCatMoreUrl ()
	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 ()
	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 ()
	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)
	getErrorDestination ()
	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
	_getProductLinkType ()
	_loadArticles ($oVendor)
	_getSeoObjectId ()
	_addPageNrParam ($sUrl, $iPage, $iLang=null)
	_getVendorId ()
	_prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
	_prepareMetaDescription ($sMeta, $iLength=1024, $blDescTag=false)
	_getSubject ($iLang)
Protected Member Functions inherited from aList
	_checkRequestedPage ()
	_processListArticles ()
	_getRequestPageNr ()
	_getListDisplayType ()
	_getCatPathString ()
	_collectMetaDescription ($sMeta, $iLength=1024, $blDescTag=false)
	_collectMetaKeyword ($sKeywords)
	_isActCategory ()
Protected Member Functions inherited from oxUBase
	_getComponentNames ()
	_processRequest ()
	_getMetaFromSeo ($sDataType)
	_getMetaFromContent ($sMetaIdent)
	_forceNoIndex ()
	_setNrOfArtPerPage ()
	_removeDuplicatedWords ($aInput, $aSkipTags=array())
	_getRequestParams ($blAddPageNr=true)
	_getSeoRequestParams ()
	_canRedirect ()
Protected Member Functions inherited from oxView
	_executeNewAction ($sNewAction)

Protected Attributes
	$_sListType = 'vendor'
	$_blVisibleSubCats = null
	$_oSubCatList = null
	$_sTplLocation = null
	$_sCatTitle = null
	$_oPageNavigation = null
	$_blShowSorting = true
	$_iViewIndexState = VIEW_INDEXSTATE_INDEX
	$_oVendorTree = null
Protected Attributes inherited from aList
	$_iAllArtCnt = 0
	$_iCntPages = 0
	$_sThisTemplate = 'page/list/list.tpl'
	$_sThisMoreTemplate = 'page/list/morecategories.tpl'
	$_sCatPathString = null
	$_blShowSorting = true
	$_aAttributes = null
	$_aCatArtList = null
	$_blHasVisibleSubCats = null
	$_aSubCatList = null
	$_oPageNavigation = null
	$_blIsCat = null
	$_oRecommList = null
	$_sCatTitle = null
	$_blShowTagCloud = true
	$_blBargainAction = false
	$_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

List of articles for a selected vendor. Collects list of articles, according to it generates links for list gallery, meta tags (for search engines). Result - "vendorlist.tpl" template. OXID eShop -> (Any selected shop product category).

Definition at line 9 of file vendorlist.php.

Member Function Documentation

VendorList::_addPageNrParam	(	$sUrl,
		$iPage,
		$iLang = `null`
	)

protected

Modifies url by adding page parameters. When seo is on, url is additionally formatted by SEO engine

Parameters

string	$sUrl	current url
int	$iPage	page number
int	$iLang	active language id

Returns: string

Reimplemented from aList.

Definition at line 168 of file vendorlist.php.

VendorList::_getProductLinkType ( )

protected

Returns product link type (OXARTICLE_LINKTYPE_VENDOR)

Returns: int

Reimplemented from aList.

Definition at line 113 of file vendorlist.php.

VendorList::_getSeoObjectId ( )

protected

Returns active product id to load its seo meta info

Returns: string

Reimplemented from aList.

Definition at line 151 of file vendorlist.php.

VendorList::_getSubject ( $iLang )

protected

returns object, associated with current view. (the object that is shown in frontend)

Parameters

int $iLang language id

Returns: object

Reimplemented from aList.

Definition at line 379 of file vendorlist.php.

VendorList::_getVendorId ( )

protected

Returns request parameter of vendor id.

Returns: string

Definition at line 289 of file vendorlist.php.

VendorList::_loadArticles ( $oVendor )

protected

Loads and returns article list of active vendor.

Parameters

object $oVendor vendor object

Returns: array

Reimplemented from aList.

Definition at line 125 of file vendorlist.php.

VendorList::_prepareMetaDescription	(	$sMeta,
		$iLength = `1024`,
		$blDescTag = `false`
	)

protected

Returns current view meta description data (calls parent::_collectMetaDescription())

Parameters

string	$sMeta	category path
int	$iLength	max length of result, -1 for no truncation
bool	$blDescTag	if true - performs additional duplicate cleaning

Returns: string

Reimplemented from aList.

Definition at line 366 of file vendorlist.php.

VendorList::_prepareMetaKeyword	(	$sKeywords,
		$blRemoveDuplicatedWords = `true`
	)

protected

Returns current view keywords separated by comma (calls parent::_collectMetaKeyword())

Parameters

string	$sKeywords	data to use as keywords
bool	$blRemoveDuplicatedWords	remove duplicated words

Returns: string

Reimplemented from aList.

Definition at line 351 of file vendorlist.php.

VendorList::generatePageNavigationUrl ( )

Returns current view Url

Returns: string

Reimplemented from aList.

Definition at line 187 of file vendorlist.php.

VendorList::getActiveCategory ( )

Template variable getter. Returns active vendor

Returns: object

Reimplemented from aList.

Definition at line 299 of file vendorlist.php.

VendorList::getAddUrlParams ( )

Returns additional URL parameters which must be added to list products dynamic urls

Returns: string

Reimplemented from aList.

Definition at line 389 of file vendorlist.php.

VendorList::getArticleList ( )

Get vendor article list

Returns: array

Reimplemented from aList.

Definition at line 240 of file vendorlist.php.

VendorList::getAttributes ( )

Template variable getter. Returns array of attribute values we do have here in this category

Returns: array

Reimplemented from aList.

Definition at line 462 of file vendorlist.php.

VendorList::getBreadCrumb ( )

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

Returns: array

Reimplemented from aList.

Definition at line 405 of file vendorlist.php.

VendorList::getCatTreePath ( )

Template variable getter. Returns template location

Returns: string

Reimplemented from aList.

Definition at line 318 of file vendorlist.php.

VendorList::getSubCatList ( )

Returns vendor subcategories

Returns: array

Reimplemented from aList.

Definition at line 223 of file vendorlist.php.

VendorList::getTitle ( )

Return vendor title

Returns: string

Reimplemented from aList.

Definition at line 260 of file vendorlist.php.

VendorList::getTitleSuffix ( )

Returns title suffix used in template

Returns: string

Reimplemented from aList.

Definition at line 335 of file vendorlist.php.

VendorList::getTreePath ( )

Template variable getter. Returns category path array

Returns: array

Reimplemented from aList.

Definition at line 277 of file vendorlist.php.

VendorList::hasVisibleSubCats ( )

Returns if vendor has visible sub-cats and load them.

Returns: bool

Reimplemented from aList.

Definition at line 201 of file vendorlist.php.

VendorList::render ( )

Executes parent::render(), loads active vendor, prepares article list sorting rules. Loads list of articles which belong to this vendor Generates page navigation data such as previous/next window URL, number of available pages, generates meta tags info (oxUBase::_convertForMetaTags()) and returns name of template to render.

Returns: string $this->_sThisTemplate current template file name

Reimplemented from aList.

Definition at line 85 of file vendorlist.php.

VendorList::setVendorTree ( $oVendorTree )

Vendor tree setter

Parameters

oxVendorList $oVendorTree vendor tree

Definition at line 451 of file vendorlist.php.

Member Data Documentation

VendorList::$_blShowSorting = true

protected

Definition at line 59 of file vendorlist.php.

VendorList::$_blVisibleSubCats = null

protected

Definition at line 24 of file vendorlist.php.

VendorList::$_iViewIndexState = VIEW_INDEXSTATE_INDEX

protected

Definition at line 66 of file vendorlist.php.

VendorList::$_oPageNavigation = null

protected

Definition at line 52 of file vendorlist.php.

VendorList::$_oSubCatList = null

protected

Definition at line 31 of file vendorlist.php.

VendorList::$_oVendorTree = null

protected

Definition at line 73 of file vendorlist.php.

VendorList::$_sCatTitle = null

protected

Definition at line 45 of file vendorlist.php.

VendorList::$_sListType = 'vendor'

protected

Definition at line 17 of file vendorlist.php.

VendorList::$_sTplLocation = null

protected

Definition at line 38 of file vendorlist.php.

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

application/controllers/vendorlist.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation