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

Definition at line 9 of file vendorlist.php.

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

---

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 (oxubase._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.

Definition at line 82 of file vendorlist.php.

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.

Definition at line 128 of file vendorlist.php.

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

Definition at line 147 of file vendorlist.php.

VendorList.getSorting

(

$

sCnid

)

Returns vendor sorting config

Parameters:

string

$sCnid sortable item id

Returns:

string

Reimplemented from aList.

Definition at line 159 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 171 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 194 of file vendorlist.php.

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 211 of file vendorlist.php.

VendorList.generatePageNavigationUrl

(

)

Returns current view Url

Returns:

string

Reimplemented from aList.

Definition at line 229 of file vendorlist.php.

VendorList.hasVisibleSubCats

(

)

Template variable getter. Returns active object's reviews

Returns:

array

Reimplemented from aList.

Definition at line 243 of file vendorlist.php.

VendorList.getSubCatList

(

)

Template variable getter. Returns active object's reviews

Returns:

array

Reimplemented from aList.

Definition at line 264 of file vendorlist.php.

VendorList.getArticleList

(

)

Template variable getter. Returns active object's reviews

Returns:

array

Reimplemented from aList.

Definition at line 280 of file vendorlist.php.

VendorList.getTitle

(

)

Template variable getter. Returns template location

Returns:

string

Reimplemented from aList.

Definition at line 301 of file vendorlist.php.

VendorList.getTemplateLocation

(

)

Template variable getter. Returns template location

Returns:

string

Reimplemented from aList.

Definition at line 319 of file vendorlist.php.

VendorList.getActiveCategory

(

)

Template variable getter. Returns active vendor

Returns:

object

Reimplemented from aList.

Definition at line 335 of file vendorlist.php.

VendorList.getCatTreePath

(

)

Template variable getter. Returns template location

Returns:

string

Reimplemented from aList.

Definition at line 353 of file vendorlist.php.

VendorList.getTitleSuffix

(

)

Returns title suffix used in template

Returns:

string

Reimplemented from aList.

Definition at line 369 of file vendorlist.php.

VendorList._prepareMetaKeyword

(

$

sKeywords

)

[protected]

Returns current view keywords seperated by comma (calls parent._collectMetaKeyword())

Parameters:

string

$sKeywords data to use as keywords

Returns:

string

Reimplemented from aList.

Definition at line 384 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 dublicate cleaning

Returns:

string

Reimplemented from aList.

Definition at line 399 of file vendorlist.php.

---

Member Data Documentation

VendorList.$_sListType = 'vendor' [protected]

Reimplemented from oxUBase.

Definition at line 15 of file vendorlist.php.

VendorList.$_blVisibleSubCats = null [protected]

Definition at line 21 of file vendorlist.php.

VendorList.$_oSubCatList = null [protected]

Definition at line 27 of file vendorlist.php.

VendorList.$_oRecommList = null [protected]

Reimplemented from aList.

Definition at line 33 of file vendorlist.php.

VendorList.$_sTplLocation = null [protected]

Definition at line 40 of file vendorlist.php.

VendorList.$_sCatTitle = null [protected]

Reimplemented from aList.

Definition at line 47 of file vendorlist.php.

VendorList.$_oPageNavigation = null [protected]

Reimplemented from aList.

Definition at line 53 of file vendorlist.php.

VendorList.$_blShowSorting = true [protected]

Reimplemented from aList.

Definition at line 59 of file vendorlist.php.

VendorList.$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXFOLLOW [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 66 of file vendorlist.php.

---

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

• views/vendorlist.php