Public Member Functions | Protected Member Functions | Protected Attributes

VendorList Class Reference

Inheritance diagram for VendorList:
Collaboration diagram for VendorList:

List of all members.

Public Member Functions

 render ()
 setItemSorting ($sCnid, $sSortBy, $sSortDir=null)
 getSorting ($sCnid)
 generatePageNavigationUrl ()
 hasVisibleSubCats ()
 getSubCatList ()
 getArticleList ()
 getTitle ()
 getTreePath ()
 getActiveCategory ()
 getCatTreePath ()
 getTitleSuffix ()
 getAddUrlParams ()
 getBreadCrumb ()
 getVendorTree ()
 setVendorTree ($oVendorTree)
 getAttributes ()

Protected Member Functions

 _getProductLinkType ()
 _loadArticles ($oVendor)
 _getSeoObjectId ()
 _addPageNrParam ($sUrl, $iPage, $iLang=null)
 _getVendorId ()
 _prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
 _prepareMetaDescription ($sMeta, $iLength=1024, $blDescTag=false)
 _getSubject ($iLang)

Protected Attributes

 $_sListType = 'vendor'
 $_blVisibleSubCats = null
 $_oSubCatList = null
 $_sTplLocation = null
 $_sCatTitle = null
 $_oPageNavigation = null
 $_blShowSorting = true
 $_iViewIndexState = VIEW_INDEXSTATE_INDEX
 $_oVendorTree = null

Detailed Description

List of articles for a selected vendor. Collects list of articles, according to it generates links for list gallery, meta tags (for search engines). Result - "vendorlist.tpl" template. OXID eShop -> (Any selected shop product category).

Definition at line 9 of file vendorlist.php.

Member Function Documentation

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
int $iLang active language id
Returns:
string

Reimplemented from aList.

Definition at line 192 of file vendorlist.php.

VendorList._getProductLinkType (  )  [protected]

Returns product link type (OXARTICLE_LINKTYPE_VENDOR)

Returns:
int

Reimplemented from aList.

Definition at line 107 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 175 of file vendorlist.php.

VendorList._getSubject ( $  iLang  )  [protected]

returns object, associated with current view. (the object that is shown in frontend)

Parameters:
int $iLang language id
Returns:
object

Reimplemented from aList.

Definition at line 391 of file vendorlist.php.

VendorList._getVendorId (  )  [protected]

Definition at line 303 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 149 of file vendorlist.php.

VendorList._prepareMetaDescription ( $  sMeta,
$  iLength = 1024,
$  blDescTag = false 
) [protected]

Returns current view meta description data (calls parent._collectMetaDescription())

Parameters:
string $sMeta category path
int $iLength max length of result, -1 for no truncation
bool $blDescTag if true - performs additional duplicate cleaning
Returns:
string

Reimplemented from aList.

Definition at line 378 of file vendorlist.php.

VendorList._prepareMetaKeyword ( $  sKeywords,
$  blRemoveDuplicatedWords = true 
) [protected]

Returns current view keywords separated by comma (calls parent._collectMetaKeyword())

Parameters:
string $sKeywords data to use as keywords
bool $blRemoveDuplicatedWords remove duplicated words
Returns:
string

Reimplemented from aList.

Definition at line 363 of file vendorlist.php.

VendorList.generatePageNavigationUrl (  ) 

Returns current view Url

Returns:
string

Reimplemented from aList.

Definition at line 210 of file vendorlist.php.

VendorList.getActiveCategory (  ) 

Template variable getter. Returns active vendor

Returns:
object

Reimplemented from aList.

Definition at line 313 of file vendorlist.php.

VendorList.getAddUrlParams (  ) 

Returns additional URL parameters which must be added to list products dynamic urls

Returns:
string

Reimplemented from aList.

Definition at line 401 of file vendorlist.php.

VendorList.getArticleList (  ) 

Get vendor article list

Returns:
array

Reimplemented from aList.

Definition at line 261 of file vendorlist.php.

VendorList.getAttributes (  ) 

Template variable getter. Returns array of attribute values we do have here in this category

Returns:
array

Reimplemented from aList.

Definition at line 470 of file vendorlist.php.

VendorList.getBreadCrumb (  ) 

Returns Bread Crumb - you are here page1/page2/page3...

Returns:
array

Reimplemented from aList.

Definition at line 416 of file vendorlist.php.

VendorList.getCatTreePath (  ) 

Template variable getter. Returns template location

Returns:
string

Reimplemented from aList.

Definition at line 331 of file vendorlist.php.

VendorList.getSorting ( $  sCnid  ) 

Returns vendor sorting config

Parameters:
string $sCnid sortable item id
Deprecated:
since v4.7.3/5.0.3 (2013-01-07); duplicated code
Returns:
string

Reimplemented from aList.

Definition at line 137 of file vendorlist.php.

VendorList.getSubCatList (  ) 

Returns vendor subcategories

Returns:
array

Reimplemented from aList.

Definition at line 245 of file vendorlist.php.

VendorList.getTitle (  ) 

Return vendor title

Returns:
string

Reimplemented from aList.

Definition at line 280 of file vendorlist.php.

VendorList.getTitleSuffix (  ) 

Returns title suffix used in template

Returns:
string

Reimplemented from aList.

Definition at line 347 of file vendorlist.php.

VendorList.getTreePath (  ) 

Template variable getter. Returns category path array

Returns:
array

Reimplemented from aList.

Definition at line 296 of file vendorlist.php.

VendorList.getVendorTree (  ) 

Returns vendor tree

Returns:
oxVendorList

Definition at line 441 of file vendorlist.php.

VendorList.hasVisibleSubCats (  ) 

Returns if vendor has visible sub-cats and load them.

Returns:
bool

Reimplemented from aList.

Definition at line 224 of file vendorlist.php.

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 meta tags info (oxUBase._convertForMetaTags()) and returns name of template to render.

Returns:
string $this->_sThisTemplate current template file name

Reimplemented from aList.

Definition at line 79 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)
Deprecated:
since v4.7.3/5.0.3 (2013-01-07); duplicated code
Returns:
null

Reimplemented from oxUBase.

Definition at line 123 of file vendorlist.php.

VendorList.setVendorTree ( $  oVendorTree  ) 

Vendor tree setter

Parameters:
oxVendorList $oVendorTree vendor tree
Returns:
null

Definition at line 459 of file vendorlist.php.

Member Data Documentation

VendorList.$_blShowSorting = true [protected]

Reimplemented from aList.

Definition at line 53 of file vendorlist.php.

VendorList.$_blVisibleSubCats = null [protected]

Definition at line 21 of file vendorlist.php.

VendorList.$_iViewIndexState = VIEW_INDEXSTATE_INDEX [protected]

Current view search engine indexing state: VIEW_INDEXSTATE_INDEX - index without limitations VIEW_INDEXSTATE_NOINDEXNOFOLLOW - no index / no follow VIEW_INDEXSTATE_NOINDEXFOLLOW - no index / follow

Reimplemented from oxUBase.

Definition at line 60 of file vendorlist.php.

VendorList.$_oPageNavigation = null [protected]

Reimplemented from aList.

Definition at line 47 of file vendorlist.php.

VendorList.$_oSubCatList = null [protected]

Definition at line 27 of file vendorlist.php.

VendorList.$_oVendorTree = null [protected]

Definition at line 67 of file vendorlist.php.

VendorList.$_sCatTitle = null [protected]

Reimplemented from aList.

Definition at line 41 of file vendorlist.php.

VendorList.$_sListType = 'vendor' [protected]

Reimplemented from oxUBase.

Definition at line 15 of file vendorlist.php.

VendorList.$_sTplLocation = null [protected]

Definition at line 34 of file vendorlist.php.

The documentation for this class was generated from the following file:
Generated by  doxygen 1.7.1