ManufacturerList Class Reference

Inheritance diagram for ManufacturerList:

Collaboration diagram for ManufacturerList:

List of all members.

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).

Definition at line 9 of file manufacturerlist.php.

---

Member Function Documentation

ManufacturerList._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 171 of file manufacturerlist.php.

ManufacturerList._getProductLinkType

(

)

[protected]

Returns product link type (OXARTICLE_LINKTYPE_MANUFACTURER)

Returns:

int

Reimplemented from aList.

Definition at line 113 of file manufacturerlist.php.

ManufacturerList._getSeoObjectId

(

)

[protected]

Returns active product id to load its seo meta info

Returns:

string

Reimplemented from aList.

Definition at line 151 of file manufacturerlist.php.

ManufacturerList._getSubject

(

$

iLang

)

[protected]

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

Parameters:

int

$iLang language id

Returns:

object

Reimplemented from aList.

Definition at line 381 of file manufacturerlist.php.

ManufacturerList._loadArticles

(

$

oManufacturer

)

[protected]

Loads and returns article list of active Manufacturer.

Parameters:

oxManufacturer

$oManufacturer Manufacturer object

Returns:

array

Reimplemented from aList.

Definition at line 125 of file manufacturerlist.php.

ManufacturerList._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 dublicate cleaning

Returns:

string $sString converted string

Reimplemented from aList.

Definition at line 368 of file manufacturerlist.php.

ManufacturerList._prepareMetaKeyword	(	$	aCatPath,
		$	blRemoveDuplicatedWords = true
	)			[protected]

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

Parameters:

	mixed	$aCatPath category path
	bool	$blRemoveDuplicatedWords remove dublicated words

Returns:

string

Reimplemented from aList.

Definition at line 351 of file manufacturerlist.php.

ManufacturerList.generatePageNavigationUrl

(

)

Returns current view Url

Returns:

string

Reimplemented from aList.

Definition at line 190 of file manufacturerlist.php.

ManufacturerList.getActiveCategory

(

)

Template variable getter. Returns active Manufacturer

Returns:

object

Reimplemented from aList.

Definition at line 297 of file manufacturerlist.php.

ManufacturerList.getAddUrlParams

(

)

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

Returns:

string

Reimplemented from aList.

Definition at line 391 of file manufacturerlist.php.

ManufacturerList.getArticleList

(

)

Template variable getter. Returns active object's reviews

Returns:

array

Reimplemented from aList.

Definition at line 240 of file manufacturerlist.php.

ManufacturerList.getAttributes

(

)

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

Returns:

array

Reimplemented from aList.

Definition at line 432 of file manufacturerlist.php.

ManufacturerList.getBreadCrumb

(

)

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

Returns:

array

Reimplemented from aList.

Definition at line 407 of file manufacturerlist.php.

ManufacturerList.getCatTreePath

(

)

Template variable getter. Returns template location

Returns:

string

Reimplemented from aList.

Definition at line 316 of file manufacturerlist.php.

ManufacturerList.getSubCatList

(

)

Template variable getter. Returns active object's reviews

Returns:

array

Reimplemented from aList.

Definition at line 226 of file manufacturerlist.php.

ManufacturerList.getTitle

(

)

Template variable getter. Returns template location

Returns:

string

Reimplemented from aList.

Definition at line 263 of file manufacturerlist.php.

ManufacturerList.getTitleSuffix

(

)

Returns title suffix used in template

Returns:

string

Reimplemented from aList.

Definition at line 333 of file manufacturerlist.php.

ManufacturerList.getTreePath

(

)

Template variable getter. Returns category path array

Returns:

array

Reimplemented from aList.

Definition at line 282 of file manufacturerlist.php.

ManufacturerList.hasVisibleSubCats

(

)

Template variable getter. Returns active object's reviews

Returns:

array

Reimplemented from aList.

Definition at line 204 of file manufacturerlist.php.

ManufacturerList.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 (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 manufacturerlist.php.

---

Member Data Documentation

ManufacturerList.$_blShowSorting = true [protected]

Reimplemented from aList.

Definition at line 66 of file manufacturerlist.php.

ManufacturerList.$_blVisibleSubCats = null [protected]

Definition at line 24 of file manufacturerlist.php.

ManufacturerList.$_iViewIndexState = VIEW_INDEXSTATE_INDEX [protected]

Current view search engine indexing state: VIEW_INDEXSTATE_INDEX - index without limitations VIEW_INDEXSTATE_NOINDEXNOFOLLOW - no index / no follow VIEW_INDEXSTATE_NOINDEXFOLLOW - no index / follow

Reimplemented from oxUBase.

Definition at line 73 of file manufacturerlist.php.

ManufacturerList.$_oPageNavigation = null [protected]

Reimplemented from aList.

Definition at line 59 of file manufacturerlist.php.

ManufacturerList.$_oRecommList = null [protected]

Reimplemented from aList.

Definition at line 38 of file manufacturerlist.php.

ManufacturerList.$_oSubCatList = null [protected]

Definition at line 31 of file manufacturerlist.php.

ManufacturerList.$_sCatTitle = null [protected]

Reimplemented from aList.

Definition at line 52 of file manufacturerlist.php.

ManufacturerList.$_sListType = 'manufacturer' [protected]

Reimplemented from oxUBase.

Definition at line 17 of file manufacturerlist.php.

ManufacturerList.$_sTplLocation = null [protected]

Definition at line 45 of file manufacturerlist.php.

---

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

• application/controllers/manufacturerlist.php