vendorlist Class Reference

Inheritance diagram for vendorlist:

[legend]

Collaboration diagram for vendorlist:

[legend]

List of all members.

---

Detailed Description

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

Public Member Functions
	render ()
	setItemSorting ($sCnid, $sSortBy, $sSortDir=null)
	getSorting ($sCnid)
	generatePageNavigationUrl ()
	hasVisibleSubCats ()
	getSubCatList ()
	getArticleList ()
	getArticleCnt ()
	getRecommList ()
	getTitle ()
	getTemplateLocation ()
	getActiveCategory ()
	getTreeCatPath ()
	getPageNavigation ()
	getTitleSuffix ()
Protected Member Functions
	_processListArticles ()
	_loadArticles ($oVendor)
	_getSeoObjectId ()
	_addPageNrParam ($sUrl, $iPage, $iLang=null)
	_prepareMetaKeyword ($aCatPath)
	_prepareMetaDescription ($aCatPath, $iLength=1024, $blDescTag=false)
Protected Attributes
	$_sListType = 'vendor'
	$_blVisibleSubCats = null
	$_oSubCatList = null
	$_iArticleCnt = null
	$_oRecommList = null
	$_sTplLocation = null
	$_sCatTitle = null
	$_sActCatPath = null
	$_oPageNavigation = null
	$_blShowSorting = true
	$_iViewIndexState = 2

---

Member Function Documentation

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 metatags info (oxview._convertForMetaTags()) and returns name of template to render.

Template variables: articlelist, pageNavigation, subcatlist, meta_keywords, meta_description

Returns:

string $this->_sThisTemplate current template file name

Reimplemented from aList.

vendorlist._processListArticles

(

)

[protected]

Iterates through list articles and performs list view specific tasks:

• sets type of link whicn needs to be generated (vendor link)
• appends link with vendor list specific parameters

Returns:

null

Reimplemented from oxUBase.

vendorlist.setItemSorting	(	$	sCnid,
		$	sSortBy,
		$	sSortDir = null
	)

Sets vendor item sorting config

Parameters:

	string	$sCnid sortable vendor id
	string	$sSortBy sort field
	string	$sSortDir sort direction (optional)

Returns:

null

Reimplemented from oxView.

vendorlist.getSorting

(

$

sCnid

)

Returns vendor sorting config

Parameters:

string

$sCnid sortable item id

Returns:

string

Reimplemented from aList.

vendorlist._loadArticles

(

$

oVendor

)

[protected]

Loads and returns article list of active vendor.

Parameters:

object

$oVendor vendor object

Returns:

array

Reimplemented from aList.

vendorlist._getSeoObjectId

(

)

[protected]

Returns active product id to load its seo meta info

Returns:

string

Reimplemented from aList.

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

Returns:

string

Reimplemented from aList.

vendorlist.generatePageNavigationUrl

(

)

Returns current view Url

Returns:

string

Reimplemented from aList.

vendorlist.hasVisibleSubCats

(

)

Template variable getter. Returns active object's reviews

Returns:

array

Reimplemented from aList.

vendorlist.getSubCatList

(

)

Template variable getter. Returns active object's reviews

Returns:

array

Reimplemented from aList.

vendorlist.getArticleList

(

)

Template variable getter. Returns active object's reviews

Returns:

array

Reimplemented from aList.

vendorlist.getArticleCnt

(

)

Template variable getter. Returns active object's reviews

Returns:

array

vendorlist.getRecommList

(

)

Template variable getter. Returns recommlist's reviews

Returns:

array

vendorlist.getTitle

(

)

Template variable getter. Returns template location

Returns:

string

Reimplemented from aList.

vendorlist.getTemplateLocation

(

)

Template variable getter. Returns template location

Returns:

string

Reimplemented from aList.

vendorlist.getActiveCategory

(

)

Template variable getter. Returns active vendor

Returns:

object

Reimplemented from aList.

vendorlist.getTreeCatPath

(

)

Template variable getter. Returns template location

Returns:

string

vendorlist.getPageNavigation

(

)

Template variable getter. Returns page navigation

Returns:

object

Reimplemented from aList.

vendorlist.getTitleSuffix

(

)

Returns title suffix used in template

Returns:

string

Reimplemented from aList.

vendorlist._prepareMetaKeyword

(

$

aCatPath

)

[protected]

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

Parameters:

mixed

$aCatPath category path

Returns:

string

Reimplemented from aList.

vendorlist._prepareMetaDescription	(	$	aCatPath,
		$	iLength = 1024,
		$	blDescTag = false
	)			[protected]

Metatags - description and keywords - generator for search engines. Uses string passed by parameters, cleans HTML tags, string dublicates, 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.

---

Member Data Documentation

vendorlist.$_sListType = 'vendor' [protected]

Reimplemented from oxView.

vendorlist.$_blVisibleSubCats = null [protected]

vendorlist.$_oSubCatList = null [protected]

vendorlist.$_iArticleCnt = null [protected]

vendorlist.$_oRecommList = null [protected]

Reimplemented from aList.

vendorlist.$_sTplLocation = null [protected]

vendorlist.$_sCatTitle = null [protected]

Reimplemented from aList.

vendorlist.$_sActCatPath = null [protected]

vendorlist.$_oPageNavigation = null [protected]

Reimplemented from aList.

vendorlist.$_blShowSorting = true [protected]

Reimplemented from aList.

vendorlist.$_iViewIndexState = 2 [protected]

Current view search engine indexing state: 0 - index without limitations 1 - no index / no follow 2 - no index / follow

Reimplemented from oxView.

---

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

• views/vendorlist.php