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

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

Public Member Functions
	render ()

	generatePageNavigationUrl ()

	hasVisibleSubCats ()

	getSubCatList ()

	getArticleList ()

	getTitle ()

	getTreePath ()

	getActiveCategory ()

	getCatTreePath ()

	getTitleSuffix ()

	getAddUrlParams ()

	getBreadCrumb ()

	getAttributes ()

Protected Member Functions
	_getProductLinkType ()

	_loadArticles ($oManufacturer)

	_getSeoObjectId ()

	_addPageNrParam ($sUrl, $iPage, $iLang=null)

	_prepareMetaKeyword ($aCatPath, $blRemoveDuplicatedWords=true)

	_prepareMetaDescription ($aCatPath, $iLength=1024, $blDescTag=false)

	_getSubject ($iLang)

Protected Attributes
	$_sListType = 'manufacturer'

	$_blVisibleSubCats = null

	$_oSubCatList = null

	$_oRecommList = null

	$_sTplLocation = null

	$_sCatTitle = null

	$_oPageNavigation = null

	$_blShowSorting = true

	$_iViewIndexState = VIEW_INDEXSTATE_INDEX

Detailed Description

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

Member Function Documentation

◆ _addPageNrParam()

OxidEsales\EshopCommunity\Application\Controller\ManufacturerListController::_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\ManufacturerListController::_getProductLinkType ( )

protected

Returns product link type (OXARTICLE_LINKTYPE_MANUFACTURER)

Returns: int

◆ _getSeoObjectId()

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

protected

Returns active product id to load its seo meta info

Returns: string

◆ _getSubject()

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

protected

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

Parameters

int $iLang language id

Returns: object

◆ _loadArticles()

OxidEsales\EshopCommunity\Application\Controller\ManufacturerListController::_loadArticles ( $oManufacturer )

protected

Loads and returns article list of active Manufacturer.

Parameters

\OxidEsales\Eshop\Application\Model\Manufacturer $oManufacturer Manufacturer object

Returns: array

◆ _prepareMetaDescription()

OxidEsales\EshopCommunity\Application\Controller\ManufacturerListController::_prepareMetaDescription	(	$aCatPath,
		$iLength = `1024`,
		$blDescTag = `false`
	)

protected

Meta tags - description and keywords - generator for search engines. Uses string passed by parameters, cleans HTML tags, string duplicates, special chars. Also removes strings defined in $myConfig->aSkipTags (Admin area).

Parameters

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

Returns: string $sString converted string

◆ _prepareMetaKeyword()

OxidEsales\EshopCommunity\Application\Controller\ManufacturerListController::_prepareMetaKeyword	(	$aCatPath,
		$blRemoveDuplicatedWords = `true`
	)

protected

Calls and returns result of parent:: _collectMetaKeyword();

Parameters

mixed	$aCatPath	category path
bool	$blRemoveDuplicatedWords	remove duplicated words

Returns: string

◆ generatePageNavigationUrl()

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

Returns current view Url

Returns: string

◆ getActiveCategory()

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

Template variable getter. Returns active Manufacturer

Returns: object

◆ getAddUrlParams()

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

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

Returns: string

◆ getArticleList()

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

Template variable getter. Returns active object's reviews

Returns: array

◆ getAttributes()

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

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

Returns: array

◆ getBreadCrumb()

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

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

Returns: array

◆ getCatTreePath()

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

Template variable getter. Returns template location

Returns: string

◆ getSubCatList()

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

Template variable getter. Returns active object's reviews

Returns: array

◆ getTitle()

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

Template variable getter. Returns template location

Returns: string

◆ getTitleSuffix()

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

Returns title suffix used in template

Returns: string

◆ getTreePath()

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

Template variable getter. Returns category path array

Returns: array

◆ hasVisibleSubCats()

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

Template variable getter. Returns active object's reviews

Returns: array

◆ render()

OxidEsales\EshopCommunity\Application\Controller\ManufacturerListController::render ( )

Executes parent::render(), loads active Manufacturer, prepares article list sorting rules. Loads list of articles which belong to this Manufacturer Generates page navigation data such as previous/next window URL, number of available pages, generates metatags info (\OxidEsales\Eshop\Application\Controller\FrontendController::_convertForMetaTags()) and returns name of template to render.

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

Member Data Documentation

◆ $_blShowSorting

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

protected

◆ $_blVisibleSubCats

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

protected

◆ $_iViewIndexState

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

protected

◆ $_oPageNavigation

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

protected

◆ $_oRecommList

OxidEsales\EshopCommunity\Application\Controller\ManufacturerListController::$_oRecommList = null

protected

◆ $_oSubCatList

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

protected

◆ $_sCatTitle

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

protected

◆ $_sListType

OxidEsales\EshopCommunity\Application\Controller\ManufacturerListController::$_sListType = 'manufacturer'

protected

◆ $_sTplLocation

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

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _addPageNrParam()

◆ _getProductLinkType()

◆ _getSeoObjectId()

◆ _getSubject()

◆ _loadArticles()

◆ _prepareMetaDescription()

◆ _prepareMetaKeyword()

◆ generatePageNavigationUrl()

◆ getActiveCategory()

◆ getAddUrlParams()

◆ getArticleList()

◆ getAttributes()

◆ getBreadCrumb()

◆ getCatTreePath()

◆ getSubCatList()

◆ getTitle()

◆ getTitleSuffix()

◆ getTreePath()

◆ hasVisibleSubCats()

◆ render()

Member Data Documentation

◆ $_blShowSorting

◆ $_blVisibleSubCats

◆ $_iViewIndexState

◆ $_oPageNavigation

◆ $_oRecommList

◆ $_oSubCatList

◆ $_sCatTitle

◆ $_sListType

◆ $_sTplLocation