Public Member Functions | Protected Member Functions | Protected Attributes

aList Class Reference

Inheritance diagram for aList:
Collaboration diagram for aList:

List of all members.

Public Member Functions

 getViewId ()
 render ()
 getAddUrlParams ()
 getAddSeoUrlParams ()
 executefilter ()
 getActPage ()
 getMetaDescription ()
 getTemplateName ()
 generatePageNavigationUrl ()
 getSorting ($sCnid)
 getTitleSuffix ()
 getTitlePageSuffix ()
 getAttributes ()
 getArticleList ()
 getSimilarRecommLists ()
 getCatTreePath ()
 getTreePath ()
 getBreadCrumb ()
 hasVisibleSubCats ()
 getSubCatList ()
 getPageNavigation ()
 getTitle ()
 getTop5ArticleList ()
 getBargainArticleList ()
 getActiveCategory ()
 getCanonicalUrl ()
 canSelectDisplayType ()
 getPageCount ()
 isMoreTagsVisible ()

Protected Member Functions

 _checkRequestedPage ()
 _processListArticles ()
 _getProductLinkType ()
 _loadArticles ($oCategory)
 _getRequestPageNr ()
 _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)
 _isActCategory ()
 _getSubject ($iLang)

Protected Attributes

 $_iAllArtCnt = 0
 $_iCntPages = 0
 $_sThisTemplate = 'page/list/list.tpl'
 $_sThisMoreTemplate = 'page/list/morecategories.tpl'
 $_sCatPathString = null
 $_blShowSorting = true
 $_aAttributes = null
 $_aCatArtList = null
 $_blHasVisibleSubCats = null
 $_aSubCatList = null
 $_oPageNavigation = null
 $_blIsCat = null
 $_oRecommList = null
 $_sCatTitle = null
 $_blTop5Action = true
 $_blShowTagCloud = true
 $_blBargainAction = false

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.


Member Function Documentation

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, RecommList, Tag, and VendorList.

Definition at line 612 of file alist.php.

aList._checkRequestedPage (  )  [protected]

Checks if requested page is valid and:

  • redirecting to first page in case requested page does not exist or
  • displays 404 error if category has no products
Returns:
null

Definition at line 206 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 477 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 549 of file alist.php.

aList._getCatPathString (  )  [protected]

Returns string built from category titles

Returns:
string

Reimplemented in Tag.

Definition at line 389 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, RecommList, Tag, and VendorList.

Definition at line 279 of file alist.php.

aList._getRequestPageNr (  )  [protected]

Calls parent.getActPage();

Returns:
int

Definition at line 367 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 377 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.

Reimplemented in ManufacturerList, and VendorList.

Definition at line 702 of file alist.php.

aList._isActCategory (  )  [protected]

Returns true if we have category

Returns:
bool

Definition at line 630 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 320 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 421 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 512 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

Definition at line 221 of file alist.php.

aList.canSelectDisplayType (  ) 

Returns cofig prameters blShowListDisplayType value

Returns:
boolean

Definition at line 966 of file alist.php.

aList.executefilter (  ) 

Stores chosen category filter into session.

Session variables: session_attrfilter

Returns:
null

Definition at line 296 of file alist.php.

aList.generatePageNavigationUrl (  ) 

Generates Url for page navigation

Returns:
string

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, RecommList, Tag, and VendorList.

Definition at line 640 of file alist.php.

aList.getActiveCategory (  ) 

Template variable getter. Returns active search

Returns:
oxcategory

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, Tag, and VendorList.

Definition at line 938 of file alist.php.

aList.getActPage (  ) 

Get actual page number.

Returns:
int

Reimplemented from oxUBase.

Definition at line 354 of file alist.php.

aList.getAddSeoUrlParams (  ) 

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

Returns:
string

Reimplemented in RecommList.

Definition at line 268 of file alist.php.

aList.getAddUrlParams (  ) 

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

Returns:
string

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, RecommList, Tag, and VendorList.

Definition at line 250 of file alist.php.

aList.getArticleList (  ) 

Template variable getter. Returns category's article list

Returns:
array

Reimplemented in ManufacturerList, RecommList, Tag, and VendorList.

Definition at line 731 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 713 of file alist.php.

aList.getBargainArticleList (  ) 

Template variable getter. Returns bargain article list

Returns:
array

Reimplemented from oxUBase.

Definition at line 918 of file alist.php.

aList.getBreadCrumb (  ) 

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

Returns:
array

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, RecommList, Tag, and VendorList.

Definition at line 800 of file alist.php.

aList.getCanonicalUrl (  ) 

Returns view canonical url

Returns:
string

Reimplemented from oxUBase.

Reimplemented in Tag.

Definition at line 948 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 771 of file alist.php.

aList.getMetaDescription (  ) 

Template variable getter. Returns meta description

Returns:
string

Reimplemented from oxUBase.

Definition at line 451 of file alist.php.

aList.getPageCount (  ) 

Get list articles pages count

Returns:
int

Definition at line 976 of file alist.php.

aList.getPageNavigation (  ) 

Template variable getter. Returns page navigation

Returns:
object

Reimplemented from oxUBase.

Definition at line 867 of file alist.php.

aList.getSimilarRecommLists (  ) 

Template variable getter. Returns recommendation list

Returns:
object

Reimplemented from oxUBase.

Reimplemented in RecommList.

Definition at line 750 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 655 of file alist.php.

aList.getSubCatList (  ) 

Template variable getter. Returns list of subategories.

Returns:
array

Reimplemented in ManufacturerList, and VendorList.

Definition at line 850 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 591 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 880 of file alist.php.

aList.getTitlePageSuffix (  ) 

Returns title page suffix used in template

Returns:
string

Reimplemented from oxUBase.

Definition at line 687 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 675 of file alist.php.

aList.getTop5ArticleList (  ) 

Template variable getter. Returns Top 5 article list

Returns:
array

Reimplemented from oxUBase.

Definition at line 896 of file alist.php.

aList.getTreePath (  ) 

Template variable getter. Returns category path array

Returns:
array

Reimplemented in ManufacturerList, RecommList, Tag, and VendorList.

Definition at line 788 of file alist.php.

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 118 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 834 of file alist.php.

aList.isMoreTagsVisible (  ) 

Should "More tags" link be visible.

Returns:
bool

Reimplemented from oxUBase.

Definition at line 986 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. Also checks if actual pages count does not exceed real articles page count. If yes - calls error_404_handler().

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

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, RecommList, Tag, and VendorList.

Definition at line 147 of file alist.php.


Member Data Documentation

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.$_aSubCatList = null [protected]

Definition at line 69 of file alist.php.

aList.$_blBargainAction = false [protected]

Reimplemented from oxUBase.

Definition at line 110 of file alist.php.

aList.$_blHasVisibleSubCats = null [protected]

Definition at line 63 of file alist.php.

aList.$_blIsCat = null [protected]

Definition at line 81 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.$_blShowTagCloud = true [protected]

Reimplemented from oxUBase.

Definition at line 104 of file alist.php.

aList.$_blTop5Action = true [protected]

Reimplemented from oxUBase.

Definition at line 99 of file alist.php.

aList.$_iAllArtCnt = 0 [protected]

Definition at line 15 of file alist.php.

aList.$_iCntPages = 0 [protected]

Definition at line 21 of file alist.php.

aList.$_oPageNavigation = null [protected]

Reimplemented in ManufacturerList, RecommList, Tag, and VendorList.

Definition at line 75 of file alist.php.

aList.$_oRecommList = null [protected]

Reimplemented in ManufacturerList, and VendorList.

Definition at line 87 of file alist.php.

aList.$_sCatPathString = null [protected]

Definition at line 39 of file alist.php.

aList.$_sCatTitle = null [protected]

Reimplemented in ManufacturerList, and VendorList.

Definition at line 93 of file alist.php.

aList.$_sThisMoreTemplate = 'page/list/morecategories.tpl' [protected]

Definition at line 33 of file alist.php.

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

Reimplemented from oxView.

Reimplemented in RecommList.

Definition at line 27 of file alist.php.


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