oxVendorList Class Reference

Inheritance diagram for oxVendorList:

[legend]

Collaboration diagram for oxVendorList:

[legend]

List of all members.

---

Detailed Description

Vendor list manager. Collects list of vendors according to collection rules (activ, etc.).

Definition at line 7 of file oxvendorlist.php.

Public Member Functions
	__construct ($sObjectsInListName= 'oxvendor')
	setShowVendorArticleCnt ($blShowVendorArticleCnt=false)
	loadVendorList ()
	buildVendorTree ($sLinkTarget, $sActCat, $sShopHomeUrl)
	getRootCat ()
	getPath ()
	getHtmlPath ()
	setClickVendor ($oVendor)
	getClickVendor ()
Protected Member Functions
	_addCategoryFields ($oVendor)
	_seoSetVendorData ()
Protected Attributes
	$_oRoot = null
	$_aPath = array()
	$_blShowVendorArticleCnt = false
	$_oClickedVendor = null

---

Constructor & Destructor Documentation

oxVendorList.__construct

(

$

sObjectsInListName = 'oxvendor'

)

Class constructor, sets callback so that Shopowner is able to add any information to the article.

Parameters:

string

$sObjectsInListName optional parameter, not used

Returns:

null

Reimplemented from oxList.

Definition at line 45 of file oxvendorlist.php.

---

Member Function Documentation

oxVendorList.setShowVendorArticleCnt

(

$

blShowVendorArticleCnt = false

)

Enables/disables vendor article count calculation

Parameters:

bool

$blShowVendorArticleCnt to show article count or not

Returns:

null

Definition at line 58 of file oxvendorlist.php.

oxVendorList.loadVendorList

(

)

Loads simple vendor list

Returns:

null

Definition at line 68 of file oxvendorlist.php.

oxVendorList.buildVendorTree	(	$	sLinkTarget,
		$	sActCat,
		$	sShopHomeUrl
	)

Creates fake root for vendor tree, and ads category list fileds for each vendor item

Parameters:

	string	$sLinkTarget Name of class, responsible for category rendering
	string	$sActCat Active category
	string	$sShopHomeUrl base shop url ($myConfig->getShopHomeURL())

Returns:

null

Definition at line 96 of file oxvendorlist.php.

oxVendorList.getRootCat

(

)

Root vendor list node (which usually is a manually prefilled object) getter

Returns:

oxvendor

Definition at line 132 of file oxvendorlist.php.

oxVendorList.getPath

(

)

Returns vendor path array

Returns:

array

Definition at line 142 of file oxvendorlist.php.

oxVendorList.getHtmlPath

(

)

Returns HTML formated active vendor path

Returns:

string

Definition at line 152 of file oxvendorlist.php.

oxVendorList._addCategoryFields

(

$

oVendor

)

[protected]

Adds category specific fields to vendor object

Parameters:

object

$oVendor vendor object

Returns:

null

Definition at line 170 of file oxvendorlist.php.

oxVendorList.setClickVendor

(

$

oVendor

)

Sets active (open) vendor object

Parameters:

oxvendor

$oVendor active vendor

Returns:

null

Definition at line 188 of file oxvendorlist.php.

oxVendorList.getClickVendor

(

)

returns active (open) vendor object

Returns:

oxvendor

Definition at line 198 of file oxvendorlist.php.

oxVendorList._seoSetVendorData

(

)

[protected]

Processes vendor category URLs

Returns:

null

Definition at line 208 of file oxvendorlist.php.

---

Member Data Documentation

oxVendorList.$_oRoot = null [protected]

Definition at line 14 of file oxvendorlist.php.

oxVendorList.$_aPath = array() [protected]

Definition at line 21 of file oxvendorlist.php.

oxVendorList.$_blShowVendorArticleCnt = false [protected]

Definition at line 28 of file oxvendorlist.php.

oxVendorList.$_oClickedVendor = null [protected]

Definition at line 35 of file oxvendorlist.php.

---

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

• core/oxvendorlist.php