aList Class Reference

Inheritance diagram for aList:

Inheritance graph
[legend]
Collaboration diagram for aList:

Collaboration graph
[legend]

List of all members.


Detailed Description

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

Definition at line 9 of file alist.php.


Public Member Functions

 getViewId ()
 render ()
 noIndex ()
 executefilter ()
 getTemplateName ()
 generatePageNavigationUrl ()
 getSorting ($sCnid)
 getTitleSuffix ()
 getAttributes ()
 getArticleList ()
 getSimilarRecommLists ()
 getCatTreePath ()
 getTemplateLocation ()
 hasVisibleSubCats ()
 getSubCatList ()
 getPageNavigation ()
 getTitle ()
 getTop5ArticleList ()
 getBargainArticleList ()
 getActiveCategory ()

Protected Member Functions

 _processListArticles ()
 _getProductLinkType ()
 _loadArticles ($oCategory)
 _getSeoObjectId ()
 _getCatPathString ()
 _prepareMetaDescription ($sMeta, $iLength=1024, $blDescTag=false)
 _collectMetaDescription ($sMeta, $iLength=1024, $blDescTag=false)
 _prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
 _collectMetaKeyword ($sKeywords)
 _addPageNrParam ($sUrl, $iPage, $iLang=null)
 _isFixedUrl ($oCategory)
 _isActCategory ()
 _getCategory ()
 _getSubject ($iLang)

Protected Attributes

 $_iAllArtCnt = 0
 $_iCntPages = null
 $_sThisTemplate = 'list.tpl'
 $_sThisMoreTemplate = 'list_more.tpl'
 $_sCatPathString = null
 $_blShowSorting = true
 $_aAttributes = null
 $_aCatArtList = null
 $_sCatTreeHtmlPath = null
 $_blHasVisibleSubCats = null
 $_aSubCatList = null
 $_oPageNavigation = null
 $_blIsCat = null
 $_oRecommList = null
 $_sCatTitle = null
 $_blFixedUrl = null

Member Function Documentation

aList.getViewId (  ) 

Generates (if not generated yet) and returns view ID (for template engine caching).

Returns:
string $this->_sViewId view id

Reimplemented from oxUBase.

Definition at line 113 of file alist.php.

aList.render (  ) 

Executes parent.render(), loads active category, prepares article list sorting rules. According to category type loads list of articles - regular (oxarticlelist.LoadCategoryArticles()) or price dependent (oxarticlelist.LoadPriceArticles()). 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, filterattributes, pageNavigation, subcatlist, meta_keywords, meta_description

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

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 144 of file alist.php.

aList._processListArticles (  )  [protected]

Iterates through list articles and performs list view specific tasks:

  • sets type of link whicn needs to be generated (Manufacturer link)

Returns:
null

Reimplemented from oxUBase.

Definition at line 214 of file alist.php.

aList.noIndex (  ) 

Special page indexing handling for price categories (page should not be indexed):

  • if current category is price category returns VIEW_INDEXSTATE_NOINDEXFOLLOW
  • else returns parent.noIndex()

Returns:
int

Reimplemented from oxUBase.

Definition at line 231 of file alist.php.

aList._getProductLinkType (  )  [protected]

Returns product link type:

  • OXARTICLE_LINKTYPE_PRICECATEGORY - when active category is price category
  • OXARTICLE_LINKTYPE_CATEGORY - when active category is regular category

Returns:
int

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 248 of file alist.php.

aList.executefilter (  ) 

Stores chosen category filter into session.

Session variables: session_attrfilter

Returns:
null

Definition at line 265 of file alist.php.

aList._loadArticles ( oCategory  )  [protected]

Loads and returns article list of active category.

Parameters:
string $oCategory category object
Returns:
array

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 282 of file alist.php.

aList._getSeoObjectId (  )  [protected]

Returns active product id to load its seo meta info

Returns:
string

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 316 of file alist.php.

aList._getCatPathString (  )  [protected]

Returns string built from category titles

Returns:
string

Reimplemented in Tag.

Definition at line 328 of file alist.php.

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

Returns current view meta description data

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 $sString converted string

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 360 of file alist.php.

aList._collectMetaDescription ( sMeta,
iLength = 1024,
blDescTag = false 
) [protected]

Metatags - description and keywords - generator for search engines. Uses string passed by parameters, cleans HTML tags, string dublicates, special chars. Also removes strings defined in $myConfig->aSkipTags (Admin area).

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 $sString converted string

Definition at line 397 of file alist.php.

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

Returns current view keywords seperated by comma

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

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 432 of file alist.php.

aList._collectMetaKeyword ( sKeywords  )  [protected]

Creates a string of keyword filtered by the function prepareMetaDescription and without any duplicates additional the admin defined strings are removed

Parameters:
string $sKeywords category path
Returns:
string

Definition at line 469 of file alist.php.

aList.getTemplateName (  ) 

Assigns Template name ($this->_sThisTemplate) for article list preview. Name of template can be defined in admin or passed by URL ("tpl" variable).

Returns:
string

Reimplemented from oxView.

Definition at line 511 of file alist.php.

aList._addPageNrParam ( sUrl,
iPage,
iLang = null 
) [protected]

Adds page number parameter to current Url and returns formatted url

Parameters:
string $sUrl url to append page numbers
int $iPage current page number
int $iLang requested language
Returns:
string

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 532 of file alist.php.

aList._isFixedUrl ( oCategory  )  [protected]

Returns category seo url status (fixed or not)

Parameters:
oxcategory $oCategory active category
Returns:
bool

Definition at line 551 of file alist.php.

aList._isActCategory (  )  [protected]

Returns true if we have category

Returns:
bool

Definition at line 568 of file alist.php.

aList._getCategory (  )  [protected]

Template variable getter. Returns active category

Deprecated:
Returns:
bool

Definition at line 580 of file alist.php.

aList.generatePageNavigationUrl (  ) 

Generates Url for page navigation

Returns:
string

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 590 of file alist.php.

aList.getSorting ( sCnid  ) 

Returns SQL sorting string with additional checking if category has its own sorting configuration

Parameters:
string $sCnid sortable item id
Returns:
string

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 606 of file alist.php.

aList.getTitleSuffix (  ) 

Returns title suffix used in template

Returns:
string

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, and VendorList.

Definition at line 626 of file alist.php.

aList._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 oxUBase.

Definition at line 641 of file alist.php.

aList.getAttributes (  ) 

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

Returns:
array

Definition at line 652 of file alist.php.

aList.getArticleList (  ) 

Template variable getter. Returns category's article list

Returns:
array

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 670 of file alist.php.

aList.getSimilarRecommLists (  ) 

Template variable getter. Returns recommendation list

Returns:
object

Reimplemented from oxUBase.

Definition at line 688 of file alist.php.

aList.getCatTreePath (  ) 

Template variable getter. Returns category path

Returns:
string

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, and VendorList.

Definition at line 705 of file alist.php.

aList.getTemplateLocation (  ) 

Template variable getter. Returns category html path

Returns:
string

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 722 of file alist.php.

aList.hasVisibleSubCats (  ) 

Template variable getter. Returns true if category has active subcategories.

Returns:
bool

Reimplemented in ManufacturerList, and VendorList.

Definition at line 740 of file alist.php.

aList.getSubCatList (  ) 

Template variable getter. Returns list of subategories.

Returns:
array

Reimplemented in ManufacturerList, and VendorList.

Definition at line 756 of file alist.php.

aList.getPageNavigation (  ) 

Template variable getter. Returns page navigation

Returns:
object

Definition at line 772 of file alist.php.

aList.getTitle (  ) 

Template variable getter. Returns category title.

Returns:
string

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 785 of file alist.php.

aList.getTop5ArticleList (  ) 

Template variable getter. Returns Top 5 article list

Returns:
array

Reimplemented from oxUBase.

Definition at line 801 of file alist.php.

aList.getBargainArticleList (  ) 

Template variable getter. Returns bargain article list

Returns:
array

Reimplemented from oxUBase.

Definition at line 823 of file alist.php.

aList.getActiveCategory (  ) 

Template variable getter. Returns active search

Returns:
object

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 843 of file alist.php.


Member Data Documentation

aList.$_iAllArtCnt = 0 [protected]

Definition at line 15 of file alist.php.

aList.$_iCntPages = null [protected]

Definition at line 21 of file alist.php.

aList.$_sThisTemplate = 'list.tpl' [protected]

Reimplemented from oxView.

Definition at line 27 of file alist.php.

aList.$_sThisMoreTemplate = 'list_more.tpl' [protected]

Definition at line 33 of file alist.php.

aList.$_sCatPathString = null [protected]

Definition at line 39 of file alist.php.

aList.$_blShowSorting = true [protected]

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 45 of file alist.php.

aList.$_aAttributes = null [protected]

Definition at line 51 of file alist.php.

aList.$_aCatArtList = null [protected]

Definition at line 57 of file alist.php.

aList.$_sCatTreeHtmlPath = null [protected]

Definition at line 63 of file alist.php.

aList.$_blHasVisibleSubCats = null [protected]

Definition at line 69 of file alist.php.

aList.$_aSubCatList = null [protected]

Definition at line 75 of file alist.php.

aList.$_oPageNavigation = null [protected]

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 81 of file alist.php.

aList.$_blIsCat = null [protected]

Definition at line 87 of file alist.php.

aList.$_oRecommList = null [protected]

Reimplemented in ManufacturerList, and VendorList.

Definition at line 93 of file alist.php.

aList.$_sCatTitle = null [protected]

Reimplemented in ManufacturerList, and VendorList.

Definition at line 99 of file alist.php.

aList.$_blFixedUrl = null [protected]

Definition at line 105 of file alist.php.


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

Generated on Tue Sep 29 16:45:50 2009 for OXID eShop CE by  doxygen 1.5.5