Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\VendorListController:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\VendorListController:

Public Member Functions
	render ()

	generatePageNavigationUrl ()

	hasVisibleSubCats ()

	getSubCatList ()

	getArticleList ()

	getTitle ()

	getTreePath ()

	getActiveCategory ()

	getCatTreePath ()

	getTitleSuffix ()

	getAddUrlParams ()

	getBreadCrumb ()

	getVendorTree ()

	setVendorTree ($oVendorTree)

	getAttributes ()

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 Attributes
	$_sListType = 'vendor'

	$_blVisibleSubCats = null

	$_oSubCatList = null

	$_sTplLocation = null

	$_sCatTitle = null

	$_oPageNavigation = null

	$_blShowSorting = true

	$_iViewIndexState = VIEW_INDEXSTATE_INDEX

	$_oVendorTree = 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).

Member Function Documentation

◆ _addPageNrParam()

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

◆ _getProductLinkType()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::_getProductLinkType ( )

protected

Returns product link type (OXARTICLE_LINKTYPE_VENDOR)

Returns: int

◆ _getSeoObjectId()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::_getSeoObjectId ( )

protected

Returns active product id to load its seo meta info

Returns: string

◆ _getSubject()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::_getSubject ( $iLang )

protected

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

Parameters

int $iLang language id

Returns: object

◆ _getVendorId()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::_getVendorId ( )

protected

Returns request parameter of vendor id.

Returns: string

◆ _loadArticles()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::_loadArticles ( $oVendor )

protected

Loads and returns article list of active vendor.

Parameters

object $oVendor vendor object

Returns: array

◆ _prepareMetaDescription()

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

◆ _prepareMetaKeyword()

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

◆ generatePageNavigationUrl()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::generatePageNavigationUrl ( )

Returns current view Url

Returns: string

◆ getActiveCategory()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::getActiveCategory ( )

Template variable getter. Returns active vendor

Returns: object

◆ getAddUrlParams()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::getAddUrlParams ( )

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

Returns: string

◆ getArticleList()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::getArticleList ( )

Get vendor article list

Returns: array

◆ getAttributes()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::getAttributes ( )

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

Returns: array

◆ getBreadCrumb()

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

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

Returns: array

◆ getCatTreePath()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::getCatTreePath ( )

Template variable getter. Returns template location

Returns: string

◆ getSubCatList()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::getSubCatList ( )

Returns vendor subcategories

Returns: array

◆ getTitle()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::getTitle ( )

Return vendor title

Returns: string

◆ getTitleSuffix()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::getTitleSuffix ( )

Returns title suffix used in template

Returns: string

◆ getTreePath()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::getTreePath ( )

Template variable getter. Returns category path array

Returns: array

◆ getVendorTree()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::getVendorTree ( )

Returns vendor tree

Returns: \OxidEsales\Eshop\Application\Model\VendorList

◆ hasVisibleSubCats()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::hasVisibleSubCats ( )

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

Returns: bool

◆ render()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::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 (\OxidEsales\Eshop\Application\Controller\FrontendController::_convertForMetaTags()) and returns name of template to render.

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

◆ setVendorTree()

OxidEsales\EshopCommunity\Application\Controller\VendorListController::setVendorTree ( $oVendorTree )

Vendor tree setter

Parameters

\OxidEsales\Eshop\Application\Model\VendorList $oVendorTree vendor tree

Member Data Documentation

◆ $_blShowSorting

OxidEsales\EshopCommunity\Application\Controller\VendorListController::$_blShowSorting = true

protected

◆ $_blVisibleSubCats

OxidEsales\EshopCommunity\Application\Controller\VendorListController::$_blVisibleSubCats = null

protected

◆ $_iViewIndexState

OxidEsales\EshopCommunity\Application\Controller\VendorListController::$_iViewIndexState = VIEW_INDEXSTATE_INDEX

protected

◆ $_oPageNavigation

OxidEsales\EshopCommunity\Application\Controller\VendorListController::$_oPageNavigation = null

protected

◆ $_oSubCatList

OxidEsales\EshopCommunity\Application\Controller\VendorListController::$_oSubCatList = null

protected

◆ $_oVendorTree

OxidEsales\EshopCommunity\Application\Controller\VendorListController::$_oVendorTree = null

protected

◆ $_sCatTitle

OxidEsales\EshopCommunity\Application\Controller\VendorListController::$_sCatTitle = null

protected

◆ $_sListType

OxidEsales\EshopCommunity\Application\Controller\VendorListController::$_sListType = 'vendor'

protected

◆ $_sTplLocation

OxidEsales\EshopCommunity\Application\Controller\VendorListController::$_sTplLocation = null

protected

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

/oxideshop-ce/source/Application/Controller/VendorListController.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _addPageNrParam()

◆ _getProductLinkType()

◆ _getSeoObjectId()

◆ _getSubject()

◆ _getVendorId()

◆ _loadArticles()

◆ _prepareMetaDescription()

◆ _prepareMetaKeyword()

◆ generatePageNavigationUrl()

◆ getActiveCategory()

◆ getAddUrlParams()

◆ getArticleList()

◆ getAttributes()

◆ getBreadCrumb()

◆ getCatTreePath()

◆ getSubCatList()

◆ getTitle()

◆ getTitleSuffix()

◆ getTreePath()

◆ getVendorTree()

◆ hasVisibleSubCats()

◆ render()

◆ setVendorTree()

Member Data Documentation

◆ $_blShowSorting

◆ $_blVisibleSubCats

◆ $_iViewIndexState

◆ $_oPageNavigation

◆ $_oSubCatList

◆ $_oVendorTree

◆ $_sCatTitle

◆ $_sListType

◆ $_sTplLocation