OxidEsales\EshopCommunity\Application\Model\VendorList Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Model\VendorList:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Model\VendorList:

Public Member Functions
	__construct ()
	setShowVendorArticleCnt ($blShowVendorArticleCnt=false)
	loadVendorList ()
	buildVendorTree ($sLinkTarget, $sActCat, $sShopHomeUrl)
	getRootCat ()
	getPath ()
	setClickVendor ($oVendor)
	getClickVendor ()

Protected Member Functions
	_addCategoryFields ($oVendor)
	_seoSetVendorData ()

Protected Attributes
	$_oRoot = null
	$_aPath = []
	$_blShowVendorArticleCnt = false
	$_oClickedVendor = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Application\Model\VendorList::__construct

(

)

Calls parent constructor and defines if Article vendor count is shown

Member Function Documentation

_addCategoryFields()

OxidEsales\EshopCommunity\Application\Model\VendorList::_addCategoryFields (   $oVendor )

protected

Adds category specific fields to vendor object

Parameters

object

$oVendor

vendor object

_seoSetVendorData()

OxidEsales\EshopCommunity\Application\Model\VendorList::_seoSetVendorData ( )

protected

Processes vendor category URLs

buildVendorTree()

OxidEsales\EshopCommunity\Application\Model\VendorList::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())

getClickVendor()

OxidEsales\EshopCommunity\Application\Model\VendorList::getClickVendor

(

)

returns active (open) vendor object

Returns

\OxidEsales\Eshop\Application\Model\Vendor

getPath()

OxidEsales\EshopCommunity\Application\Model\VendorList::getPath

(

)

Returns vendor path array

Returns

array

getRootCat()

OxidEsales\EshopCommunity\Application\Model\VendorList::getRootCat

(

)

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

Returns

\OxidEsales\Eshop\Application\Model\Vendor

loadVendorList()

OxidEsales\EshopCommunity\Application\Model\VendorList::loadVendorList

(

)

Loads simple vendor list

setClickVendor()

OxidEsales\EshopCommunity\Application\Model\VendorList::setClickVendor

(

$oVendor

)

Sets active (open) vendor object

Parameters

\OxidEsales\Eshop\Application\Model\Vendor

$oVendor

active vendor

setShowVendorArticleCnt()

OxidEsales\EshopCommunity\Application\Model\VendorList::setShowVendorArticleCnt

(

$blShowVendorArticleCnt = false

)

Enables/disables vendor article count calculation

Parameters

bool

$blShowVendorArticleCnt

to show article count or not

Member Data Documentation

$_aPath

OxidEsales\EshopCommunity\Application\Model\VendorList::$_aPath = []

protected

$_blShowVendorArticleCnt

OxidEsales\EshopCommunity\Application\Model\VendorList::$_blShowVendorArticleCnt = false

protected

$_oClickedVendor

OxidEsales\EshopCommunity\Application\Model\VendorList::$_oClickedVendor = null

protected

$_oRoot

OxidEsales\EshopCommunity\Application\Model\VendorList::$_oRoot = null

protected

---

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

• /oxideshop-ce/source/Application/Model/VendorList.php