aList Class Reference
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).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 oxView.
| 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 (oxview._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 Tag, and vendorlist.
| aList.executefilter | ( | ) |
Stores chosen category filter into session.
Session variables: session_attrfilter
- Returns:
- null
| aList._loadArticles | ( | $ | oCategory | ) | [protected] |
Loads and returns article list of active category.
- Parameters:
-
string $oCategory category object
- Returns:
- array
Reimplemented in Tag, and vendorlist.
| aList._getSeoObjectId | ( | ) | [protected] |
Returns active product id to load its seo meta info
- Returns:
- string
Reimplemented from oxView.
Reimplemented in Tag, and vendorlist.
| aList._getCatPathString | ( | ) | [protected] |
| aList._prepareMetaDescription | ( | $ | aCatPath, | |
| $ | iLength = 1024, |
|||
| $ | blDescTag = false | |||
| ) | [protected] |
Creates list view meta description which looks like:
You are here: {Parent category title} - {Current category title}. {Shops start title}
- Parameters:
-
mixed $aCatPath category path (not used) int $iLength max length of result, -1 for no truncation (not used) bool $blDescTag if true - performs additional dublicate cleaning (not used)
- Returns:
- string $sString converted string
Reimplemented from oxView.
Reimplemented in Tag, and vendorlist.
| aList._collectMetaDescription | ( | $ | aCatPath, | |
| $ | 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:
-
mixed $aCatPath 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
| aList._prepareMetaKeyword | ( | $ | aCatPath | ) | [protected] |
Creates string of keywords (category titles) seperated by comma
- Parameters:
-
mixed $aCatPath category path (not used)
- Returns:
- string
Reimplemented from oxView.
Reimplemented in Tag, and vendorlist.
| aList._collectMetaKeyword | ( | $ | aCatPath | ) | [protected] |
creates a string of keyword filtered by the function prepareMetaDescription and without any duplicates additional the admin defined strings are removed
- Parameters:
-
mixed $aCatPath category path
- Returns:
- string of keywords seperated by comma
| aList._loadTemplateName | ( | $ | sCategorieTPL = null |
) | [protected] |
Assigns Template name ($this->_sThisTemplate) for article list preview. Name of template may be passed by parameter $sCategorieTPL, defined in admin, or passed by URL ("tpl" variable).
- Parameters:
-
string $sCategorieTPL category template
- Returns:
- null
| 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 Tag, and vendorlist.
| aList._isFixedUrl | ( | $ | oCategory | ) | [protected] |
Returns category seo url status (fixed or not)
- Returns:
- bool
| aList._isActCategory | ( | ) |
Template variable getter. Returns true if we have category
- Returns:
- bool
| aList._getCategory | ( | ) | [protected] |
Template variable getter. Returns active category
- Returns:
- bool
| aList.generatePageNavigationUrl | ( | ) |
Generates Url for page navigation
- Returns:
- string
Reimplemented from oxUBase.
Reimplemented in Tag, and vendorlist.
| 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 oxView.
Reimplemented in Tag, and vendorlist.
| aList.getTitleSuffix | ( | ) |
Returns title suffix used in template
- Returns:
- string
Reimplemented from oxView.
Reimplemented in vendorlist.
| aList.getSubject | ( | ) | [protected] |
returns object, assosiated with current view. (the object that is shown in frontend)
- Returns:
- object
Reimplemented from oxView.
| aList.getAttributes | ( | ) |
Template variable getter. Returns array of attribute values we do have here in this category
- Returns:
- array
| aList.getArticleList | ( | ) |
Template variable getter. Returns category's article list
- Returns:
- array
Reimplemented in Tag, and vendorlist.
| aList.getSimilarRecommLists | ( | ) |
| aList.getCatTreePath | ( | ) |
Template variable getter. Returns category path
- Returns:
- string
| aList.getTemplateLocation | ( | ) |
Template variable getter. Returns category html path
- Returns:
- string
Reimplemented in Tag, and vendorlist.
| aList.hasVisibleSubCats | ( | ) |
Template variable getter. Returns true if category has active subcategories.
- Returns:
- bool
Reimplemented in vendorlist.
| aList.getSubCatList | ( | ) |
| aList.getPageNavigation | ( | ) |
Template variable getter. Returns page navigation
- Returns:
- object
Reimplemented in Tag, and vendorlist.
| aList.getTitle | ( | ) |
Template variable getter. Returns category title.
- Returns:
- string
Reimplemented from oxView.
Reimplemented in Tag, and vendorlist.
| aList.getTop5ArticleList | ( | ) |
| aList.getBargainArticleList | ( | ) |
| aList.getActiveCategory | ( | ) |
Template variable getter. Returns active search
- Returns:
- object
Reimplemented from oxView.
Reimplemented in Tag, and vendorlist.
Member Data Documentation
aList.$_iAllArtCnt = 0 [protected] |
aList.$_iCntPages = null [protected] |
aList.$_sThisTemplate = 'list.tpl' [protected] |
Reimplemented from oxView.
aList.$_sThisMoreTemplate = 'list_more.tpl' [protected] |
aList.$_sCatPathString = null [protected] |
aList.$_blShowSorting = true [protected] |
aList.$_aAttributes = null [protected] |
aList.$_aCatArtList = null [protected] |
aList.$_sCatTreePath = null [protected] |
aList.$_sCatTreeHtmlPath = null [protected] |
aList.$_blHasVisibleSubCats = null [protected] |
aList.$_aSubCatList = null [protected] |
aList.$_oPageNavigation = null [protected] |
Reimplemented in Tag, and vendorlist.
aList.$_oCategory = null [protected] |
aList.$_blIsCat = null [protected] |
aList.$_oRecommList = null [protected] |
Reimplemented in vendorlist.
aList.$_sCatTitle = null [protected] |
Reimplemented in vendorlist.
aList.$_blFixedUrl = null [protected] |
The documentation for this class was generated from the following file:
- views/alist.php
