OXID eShop CE  4.10.3
 All Classes Namespaces Files Functions Variables Pages
oxVendorList Class Reference
+ Inheritance diagram for oxVendorList:
+ Collaboration diagram for oxVendorList:

Public Member Functions

 __construct ()
 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 ()
 __construct ($sObjectName=null)
 __get ($sName)
 getArray ()
 init ($sObjectName, $sCoreTable=null)
 getBaseObject ()
 setBaseObject ($oObject)
 selectString ($sSql)
 add ($oObject)
 assignArray ($aData)
 setSqlLimit ($iStart, $iRecords)
 containsFieldValue ($oVal, $sFieldName)
 getList ()
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 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 ( )

Calls parent constructor and defines if Article vendor count is shown

Returns
null

Reimplemented from oxSuperCfg.

Definition at line 44 of file oxvendorlist.php.

Member Function Documentation

oxVendorList::_addCategoryFields (   $oVendor)
protected

Adds category specific fields to vendor object

Parameters
object$oVendorvendor object

Definition at line 145 of file oxvendorlist.php.

oxVendorList::_seoSetVendorData ( )
protected

Processes vendor category URLs

Definition at line 179 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$sLinkTargetName of class, responsible for category rendering
string$sActCatActive category
string$sShopHomeUrlbase shop url ($myConfig->getShopHomeURL())

Definition at line 88 of file oxvendorlist.php.

oxVendorList::getClickVendor ( )

returns active (open) vendor object

Returns
oxvendor

Definition at line 171 of file oxvendorlist.php.

oxVendorList::getPath ( )

Returns vendor path array

Returns
array

Definition at line 135 of file oxvendorlist.php.

oxVendorList::getRootCat ( )

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

Returns
oxvendor

Definition at line 125 of file oxvendorlist.php.

oxVendorList::loadVendorList ( )

Loads simple vendor list

Definition at line 63 of file oxvendorlist.php.

oxVendorList::setClickVendor (   $oVendor)

Sets active (open) vendor object

Parameters
oxvendor$oVendoractive vendor

Definition at line 161 of file oxvendorlist.php.

oxVendorList::setShowVendorArticleCnt (   $blShowVendorArticleCnt = false)

Enables/disables vendor article count calculation

Parameters
bool$blShowVendorArticleCntto show article count or not

Definition at line 55 of file oxvendorlist.php.

Member Data Documentation

oxVendorList::$_aPath = array()
protected

Definition at line 23 of file oxvendorlist.php.

oxVendorList::$_blShowVendorArticleCnt = false
protected

Definition at line 30 of file oxvendorlist.php.

oxVendorList::$_oClickedVendor = null
protected

Definition at line 37 of file oxvendorlist.php.

oxVendorList::$_oRoot = null
protected

Definition at line 16 of file oxvendorlist.php.


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