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).Definition at line 9 of file alist.php.
Member Function Documentation
| aList.getViewId | ( | ) |
| 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.
| 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.
| 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.
| aList.executefilter | ( | ) |
| 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.
| aList._getSeoObjectId | ( | ) | [protected] |
Returns active product id to load its seo meta info
- Returns:
- string
Reimplemented from oxUBase.
Reimplemented in ManufacturerList, Tag, and VendorList.
| aList._getCatPathString | ( | ) | [protected] |
| 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.
| aList.getMetaDescription | ( | ) |
| 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
| 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.
| aList._collectMetaKeyword | ( | $ | sKeywords | ) | [protected] |
| aList.getTemplateName | ( | ) |
| 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.
| aList._isFixedUrl | ( | $ | oCategory | ) | [protected] |
| aList._isActCategory | ( | ) | [protected] |
| 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 ManufacturerList, 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 oxUBase.
Reimplemented in ManufacturerList, Tag, and VendorList.
| aList.getTitleSuffix | ( | ) |
Returns title suffix used in template
- Returns:
- string
Reimplemented from oxUBase.
Reimplemented in ManufacturerList, and VendorList.
| aList.getTitlePageSuffix | ( | ) |
| 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.
| aList.getAttributes | ( | ) |
| aList.getArticleList | ( | ) |
Template variable getter. Returns category's article list
- Returns:
- array
Reimplemented in ManufacturerList, Tag, and VendorList.
| aList.getSimilarRecommLists | ( | ) |
| aList.getCatTreePath | ( | ) |
Template variable getter. Returns category path
- Returns:
- string
Reimplemented from oxUBase.
Reimplemented in ManufacturerList, and VendorList.
| aList.getTemplateLocation | ( | ) |
Template variable getter. Returns category html path
- Deprecated:
- use aList.getTreePath() and adjust template
- Returns:
- string
Reimplemented in ManufacturerList, Tag, and VendorList.
| aList.getTreePath | ( | ) |
Template variable getter. Returns category path array
- Returns:
- array
Reimplemented in ManufacturerList, Tag, and VendorList.
| aList.hasVisibleSubCats | ( | ) |
Template variable getter. Returns true if category has active subcategories.
- Returns:
- bool
Reimplemented in ManufacturerList, and VendorList.
| aList.getSubCatList | ( | ) |
Template variable getter. Returns list of subategories.
- Returns:
- array
Reimplemented in ManufacturerList, and VendorList.
| aList.getPageNavigation | ( | ) |
| aList.getTitle | ( | ) |
Template variable getter. Returns category title.
- Returns:
- string
Reimplemented from oxUBase.
Reimplemented in ManufacturerList, Tag, and VendorList.
| aList.getTop5ArticleList | ( | ) |
| aList.getBargainArticleList | ( | ) |
| aList.getActiveCategory | ( | ) |
Template variable getter. Returns active search
- Returns:
- object
Reimplemented from oxUBase.
Reimplemented in ManufacturerList, Tag, and VendorList.
| aList.getCanonicalUrl | ( | ) |
Member Data Documentation
aList.$_sThisTemplate = 'list.tpl' [protected] |
aList.$_blShowSorting = true [protected] |
aList.$_oPageNavigation = null [protected] |
aList.$_oRecommList = null [protected] |
aList.$_sCatTitle = null [protected] |
The documentation for this class was generated from the following file:
- views/alist.php
