Inheritance diagram for VendorList:

Collaboration diagram for VendorList:

Public Member Functions
	render ()
	generatePageNavigationUrl ()
	hasVisibleSubCats ()
	getSubCatList ()
	getArticleList ()
	getTitle ()
	getTreePath ()
	getActiveCategory ()
	getCatTreePath ()
	getTitleSuffix ()
	getAddUrlParams ()
	getBreadCrumb ()
	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).

Definition at line 9 of file vendorlist.php.

Member Function Documentation

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

VendorList._getProductLinkType ( ) [protected]

Returns product link type (OXARTICLE_LINKTYPE_VENDOR)

Returns:: int

Reimplemented from aList.

Definition at line 113 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 151 of file vendorlist.php.

VendorList._getSubject ( $ iLang ) [protected]

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

Parameters:

int

$iLang language id

Returns:: object

Reimplemented from aList.

Definition at line 379 of file vendorlist.php.

VendorList._getVendorId ( ) [protected]

Returns request parameter of vendor id.

Returns:: string

Definition at line 289 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 125 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 duplicate cleaning

Returns:: string

Reimplemented from aList.

Definition at line 366 of file vendorlist.php.

VendorList._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

Reimplemented from aList.

Definition at line 351 of file vendorlist.php.

VendorList.generatePageNavigationUrl ( )

Returns current view Url

Returns:: string

Reimplemented from aList.

Definition at line 187 of file vendorlist.php.

VendorList.getActiveCategory ( )

Template variable getter. Returns active vendor

Returns:: object

Reimplemented from aList.

Definition at line 299 of file vendorlist.php.

VendorList.getAddUrlParams ( )

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

Returns:: string

Reimplemented from aList.

Definition at line 389 of file vendorlist.php.

VendorList.getArticleList ( )

Get vendor article list

Returns:: array

Reimplemented from aList.

Definition at line 240 of file vendorlist.php.

VendorList.getAttributes ( )

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

Returns:: array

Reimplemented from aList.

Definition at line 462 of file vendorlist.php.

VendorList.getBreadCrumb ( )

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

Returns:: array

Reimplemented from aList.

Definition at line 405 of file vendorlist.php.

VendorList.getCatTreePath ( )

Template variable getter. Returns template location

Returns:: string

Reimplemented from aList.

Definition at line 318 of file vendorlist.php.

VendorList.getSubCatList ( )

Returns vendor subcategories

Returns:: array

Reimplemented from aList.

Definition at line 223 of file vendorlist.php.

VendorList.getTitle ( )

Return vendor title

Returns:: string

Reimplemented from aList.

Definition at line 260 of file vendorlist.php.

VendorList.getTitleSuffix ( )

Returns title suffix used in template

Returns:: string

Reimplemented from aList.

Definition at line 335 of file vendorlist.php.

VendorList.getTreePath ( )

Template variable getter. Returns category path array

Returns:: array

Reimplemented from aList.

Definition at line 277 of file vendorlist.php.

VendorList.hasVisibleSubCats ( )

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

Returns:: bool

Reimplemented from aList.

Definition at line 201 of file vendorlist.php.

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 meta tags 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 vendorlist.php.

VendorList.setVendorTree ( $ oVendorTree )

Vendor tree setter

Parameters:

oxVendorList

$oVendorTree vendor tree

Definition at line 451 of file vendorlist.php.

Member Data Documentation

VendorList.$_blShowSorting = true [protected]

Reimplemented from aList.

Definition at line 59 of file vendorlist.php.

VendorList.$_blVisibleSubCats = null [protected]

Definition at line 24 of file vendorlist.php.

VendorList.$_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 66 of file vendorlist.php.

VendorList.$_oPageNavigation = null [protected]

Reimplemented from aList.

Definition at line 52 of file vendorlist.php.

VendorList.$_oSubCatList = null [protected]

Definition at line 31 of file vendorlist.php.

VendorList.$_oVendorTree = null [protected]

Definition at line 73 of file vendorlist.php.

VendorList.$_sCatTitle = null [protected]

Reimplemented from aList.

Definition at line 45 of file vendorlist.php.

VendorList.$_sListType = 'vendor' [protected]

Reimplemented from oxUBase.

Definition at line 17 of file vendorlist.php.

VendorList.$_sTplLocation = null [protected]

Definition at line 38 of file vendorlist.php.

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

application/controllers/vendorlist.php

VendorList Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation