VendorList Class Reference

Inheritance diagram for VendorList:

Collaboration diagram for VendorList:

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 ()
	getArticleCnt ()
	getRecommList ()
	getTitle ()
	getTemplateLocation ()
	getActiveCategory ()
	getCatTreePath ()
	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
	$_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.

Definition at line 89 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 139 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 oxView.

Definition at line 158 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 170 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 182 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 205 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

Returns:: string

Reimplemented from aList.

Definition at line 221 of file vendorlist.php.

VendorList.generatePageNavigationUrl ( )

Returns current view Url

Returns:: string

Reimplemented from aList.

Definition at line 239 of file vendorlist.php.

VendorList.hasVisibleSubCats ( )

Template variable getter. Returns active object's reviews

Returns:: array

Reimplemented from aList.

Definition at line 253 of file vendorlist.php.

VendorList.getSubCatList ( )

Template variable getter. Returns active object's reviews

Returns:: array

Reimplemented from aList.

Definition at line 274 of file vendorlist.php.

VendorList.getArticleList ( )

Template variable getter. Returns active object's reviews

Returns:: array

Reimplemented from aList.

Definition at line 290 of file vendorlist.php.

VendorList.getArticleCnt ( )

Template variable getter. Returns active object's reviews

Returns:: array

Definition at line 313 of file vendorlist.php.

VendorList.getRecommList ( )

Template variable getter. Returns recommlist's reviews

Returns:: array

Definition at line 329 of file vendorlist.php.

VendorList.getTitle ( )

Template variable getter. Returns template location

Returns:: string

Reimplemented from aList.

Definition at line 347 of file vendorlist.php.

VendorList.getTemplateLocation ( )

Template variable getter. Returns template location

Returns:: string

Reimplemented from aList.

Definition at line 365 of file vendorlist.php.

VendorList.getActiveCategory ( )

Template variable getter. Returns active vendor

Returns:: object

Reimplemented from aList.

Definition at line 381 of file vendorlist.php.

VendorList.getCatTreePath ( )

Template variable getter. Returns template location

Returns:: string

Reimplemented from aList.

Definition at line 399 of file vendorlist.php.

VendorList.getPageNavigation ( )

Template variable getter. Returns page navigation

Returns:: object

Reimplemented from aList.

Definition at line 415 of file vendorlist.php.

VendorList.getTitleSuffix ( )

Returns title suffix used in template

Returns:: string

Reimplemented from aList.

Definition at line 429 of file vendorlist.php.

VendorList._prepareMetaKeyword ( $ aCatPath ) [protected]

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

Parameters:

mixed

$aCatPath category path

Returns:: string

Reimplemented from aList.

Definition at line 443 of file vendorlist.php.

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.

Definition at line 460 of file vendorlist.php.

Member Data Documentation

VendorList.$_sListType = 'vendor' [protected]

Reimplemented from oxView.

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.$_iArticleCnt = null [protected]

Definition at line 33 of file vendorlist.php.

VendorList.$_oRecommList = null [protected]

Reimplemented from aList.

Definition at line 39 of file vendorlist.php.

VendorList.$_sTplLocation = null [protected]

Definition at line 46 of file vendorlist.php.

VendorList.$_sCatTitle = null [protected]

Reimplemented from aList.

Definition at line 53 of file vendorlist.php.

VendorList.$_oPageNavigation = null [protected]

Reimplemented from aList.

Definition at line 59 of file vendorlist.php.

VendorList.$_blShowSorting = true [protected]

Reimplemented from aList.

Definition at line 65 of file vendorlist.php.

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.

Definition at line 73 of file vendorlist.php.

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

views/vendorlist.php

VendorList Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

Member Data Documentation