oxVendorList Class Reference

Inheritance diagram for oxVendorList:

Collaboration diagram for oxVendorList:

Public Member Functions
	__construct ($sObjectsInListName= 'oxvendor')
	setShowVendorArticleCnt ($blShowVendorArticleCnt=false)
	loadVendorList ()
	buildVendorTree ($sLinkTarget, $sActCat, $sShopHomeUrl)
	getRootCat ()
	getPath ()
	setClickVendor ($oVendor)
	getClickVendor ()
Public Member Functions inherited from oxList
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $oBase)
	offsetUnset ($offset)
	arrayKeys ()
	rewind ()
	current ()
	key ()
	prev ()
	next ()
	valid ()
	count ()
	clear ()
	assign ($aArray)
	reverse ()
	__get ($sName)
	getArray ()
	init ($sObjectName, $sCoreTable=null)
	getBaseObject ()
	selectString ($sSql)
	assignArray ($aData)
	setSqlLimit ($iStart, $iRecords)
	containsFieldValue ($oVal, $sFieldName)
	getList ()
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	__construct ()
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_addCategoryFields ($oVendor)
	_seoSetVendorData ()
Protected Member Functions inherited from oxList
	_assignElement ($oListObject, $aDbFields)
	_getFieldLongName ($sFieldName)

Protected Attributes
	$_oRoot = null
	$_aPath = array()
	$_blShowVendorArticleCnt = false
	$_oClickedVendor = null
Protected Attributes inherited from oxList
	$_aArray = array()
	$_blRemovedActive = false
	$_sObjectsInListName = 'oxBase'
	$_sCoreTable = null
	$_sShopID = null
	$_aSqlLimit = array()

Additional Inherited Members
Static Protected Attributes inherited from oxSuperCfg
static	$_oConfig = null
static	$_oSession = null
static	$_oRights = null
static	$_oActUser = null
static	$_blIsAdmin = null

Detailed Description

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

Definition at line 8 of file oxvendorlist.php.

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 46 of file oxvendorlist.php.

Member Function Documentation

oxVendorList::_addCategoryFields (   $oVendor )

protected

Adds category specific fields to vendor object

Parameters

object

$oVendor

vendor object

Returns

null

Definition at line 155 of file oxvendorlist.php.

oxVendorList::_seoSetVendorData ( )

protected

Processes vendor category URLs

Returns

null

Definition at line 193 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::getClickVendor

(

)

returns active (open) vendor object

Returns

oxvendor

Definition at line 183 of file oxvendorlist.php.

oxVendorList::getPath

(

)

Returns vendor path array

Returns

array

Definition at line 143 of file oxvendorlist.php.

oxVendorList::getRootCat

(

)

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

Returns

oxvendor

Definition at line 133 of file oxvendorlist.php.

oxVendorList::loadVendorList

(

)

Loads simple vendor list

Returns

null

Definition at line 69 of file oxvendorlist.php.

oxVendorList::setClickVendor

(

$oVendor

)

Sets active (open) vendor object

Parameters

oxvendor

$oVendor

active vendor

Returns

null

Definition at line 173 of file oxvendorlist.php.

oxVendorList::setShowVendorArticleCnt

(

$blShowVendorArticleCnt = false

)

Enables/disables vendor article count calculation

Parameters

bool

$blShowVendorArticleCnt

to show article count or not

Returns

null

Definition at line 59 of file oxvendorlist.php.

Member Data Documentation

oxVendorList::$_aPath = array()

protected

Definition at line 22 of file oxvendorlist.php.

oxVendorList::$_blShowVendorArticleCnt = false

protected

Definition at line 29 of file oxvendorlist.php.

oxVendorList::$_oClickedVendor = null

protected

Definition at line 36 of file oxvendorlist.php.

oxVendorList::$_oRoot = null

protected

Definition at line 15 of file oxvendorlist.php.

---

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

• application/models/oxvendorlist.php