VendorList Class Reference

Inheritance diagram for VendorList:

Inheritance graph
[legend]
Collaboration diagram for VendorList:

Collaboration graph
[legend]

List of all members.


Detailed Description

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

Definition at line 9 of file vendorlist.php.


Public Member Functions

 render ()
 setItemSorting ($sCnid, $sSortBy, $sSortDir=null)
 getSorting ($sCnid)
 generatePageNavigationUrl ()
 hasVisibleSubCats ()
 getSubCatList ()
 getArticleList ()
 getTitle ()
 getTemplateLocation ()
 getTreePath ()
 getActiveCategory ()
 getCatTreePath ()
 getTitleSuffix ()

Protected Member Functions

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

Protected Attributes

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

Member Function Documentation

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

Template variables: articlelist, pageNavigation, subcatlist, meta_keywords, meta_description

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

Reimplemented from aList.

Definition at line 82 of file vendorlist.php.

VendorList._getProductLinkType (  )  [protected]

Returns product link type (OXARTICLE_LINKTYPE_VENDOR)

Returns:
int

Reimplemented from aList.

Definition at line 126 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)
Returns:
null

Reimplemented from oxUBase.

Definition at line 140 of file vendorlist.php.

VendorList.getSorting ( sCnid  ) 

Returns vendor sorting config

Parameters:
string $sCnid sortable item id
Returns:
string

Reimplemented from aList.

Definition at line 152 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 164 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 187 of file vendorlist.php.

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 204 of file vendorlist.php.

VendorList.generatePageNavigationUrl (  ) 

Returns current view Url

Returns:
string

Reimplemented from aList.

Definition at line 221 of file vendorlist.php.

VendorList.hasVisibleSubCats (  ) 

Template variable getter. Returns active object's reviews

Returns:
array

Reimplemented from aList.

Definition at line 235 of file vendorlist.php.

VendorList.getSubCatList (  ) 

Template variable getter. Returns active object's reviews

Returns:
array

Reimplemented from aList.

Definition at line 256 of file vendorlist.php.

VendorList.getArticleList (  ) 

Template variable getter. Returns active object's reviews

Returns:
array

Reimplemented from aList.

Definition at line 272 of file vendorlist.php.

VendorList.getTitle (  ) 

Template variable getter. Returns template location

Returns:
string

Reimplemented from aList.

Definition at line 293 of file vendorlist.php.

VendorList.getTemplateLocation (  ) 

Template variable getter. Returns template location

Deprecated:
use vendorList.getTreePath() and adjust template
Returns:
string

Reimplemented from aList.

Definition at line 313 of file vendorlist.php.

VendorList.getTreePath (  ) 

Template variable getter. Returns category path array

Returns:
array

Reimplemented from aList.

Definition at line 329 of file vendorlist.php.

VendorList.getActiveCategory (  ) 

Template variable getter. Returns active vendor

Returns:
object

Reimplemented from aList.

Definition at line 341 of file vendorlist.php.

VendorList.getCatTreePath (  ) 

Template variable getter. Returns template location

Returns:
string

Reimplemented from aList.

Definition at line 359 of file vendorlist.php.

VendorList.getTitleSuffix (  ) 

Returns title suffix used in template

Returns:
string

Reimplemented from aList.

Definition at line 375 of file vendorlist.php.

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

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

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

Reimplemented from aList.

Definition at line 391 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 dublicate cleaning
Returns:
string

Reimplemented from aList.

Definition at line 406 of file vendorlist.php.

VendorList._getSubject ( iLang  )  [protected]

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

Parameters:
int $iLang language id
Returns:
object

Reimplemented from aList.

Definition at line 419 of file vendorlist.php.


Member Data Documentation

VendorList.$_sListType = 'vendor' [protected]

Reimplemented from oxUBase.

Definition at line 15 of file vendorlist.php.

VendorList.$_blVisibleSubCats = null [protected]

Definition at line 21 of file vendorlist.php.

VendorList.$_oSubCatList = null [protected]

Definition at line 27 of file vendorlist.php.

VendorList.$_oRecommList = null [protected]

Reimplemented from aList.

Definition at line 33 of file vendorlist.php.

VendorList.$_sTplLocation = null [protected]

Definition at line 40 of file vendorlist.php.

VendorList.$_sCatTitle = null [protected]

Reimplemented from aList.

Definition at line 47 of file vendorlist.php.

VendorList.$_oPageNavigation = null [protected]

Reimplemented from aList.

Definition at line 53 of file vendorlist.php.

VendorList.$_blShowSorting = true [protected]

Reimplemented from aList.

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


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

Generated on Mon Oct 26 20:13:02 2009 for OXID eShop CE by  doxygen 1.5.5