OXID eShop CE  4.8.12
 All Classes Files Functions Variables Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
aList Class Reference
+ Inheritance diagram for aList:
+ Collaboration diagram for aList:

Public Member Functions

 getViewId ()
 render ()
 getAddUrlParams ()
 getAddSeoUrlParams ()
 executefilter ()
 getActPage ()
 getMetaDescription ()
 getTemplateName ()
 generatePageNavigationUrl ()
 getSorting ($sCnid)
 getDefaultSorting ()
 getTitleSuffix ()
 getTitlePageSuffix ()
 getAttributes ()
 getArticleList ()
 getArticleCount ()
 getSimilarRecommListIds ()
 getCatTreePath ()
 getTreePath ()
 getBreadCrumb ()
 hasVisibleSubCats ()
 getSubCatList ()
 getPageNavigation ()
 getTitle ()
 getBargainArticleList ()
 getActiveCategory ()
 getCanonicalUrl ()
 canSelectDisplayType ()
 getPageCount ()
- Public Member Functions inherited from oxUBase
 init ()
 showSorting ()
 setComponents ($aComponents=null)
 getComponents ()
 getComponent ($sName)
 setIsOrderStep ($blIsOrderStep=null)
 getIsOrderStep ()
 setActiveCategory ($oCategory)
 getListType ()
 getListDisplayType ()
 getCustomListDisplayType ()
 setListType ($sType)
 loadCurrency ()
 dontShowEmptyCategories ()
 showCategoryArticlesCount ()
 isLanguageLoaded ()
 getTopNavigationCatCnt ()
 addRssFeed ($sTitle, $sUrl, $key=null)
 getSortOrderByParameterName ()
 getSortOrderParameterName ()
 getSortIdent ()
 getUserSelectedSorting ()
 getSavedSorting ($sSortIdent)
 setListOrderBy ($sColumn)
 setListOrderDirection ($sDirection)
 prepareSortColumns ()
 getListOrderBy ()
 getListOrderDirection ()
 setMetaDescription ($sDescription)
 setMetaKeywords ($sKeywords)
 getMetaKeywords ()
 getActCurrency ()
 setActCurrency ($oCur)
 getCompareItemCount ()
 noIndex ()
 isSortingActive ()
 getMenueList ()
 setMenueList ($aMenue)
 getNavigationParams ()
 setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
 getSortingSql ($sIdent)
 getTitlePrefix ()
 getDynUrlParams ()
 getLink ($iLang=null)
 getSearchParamForHtml ()
 showSearch ()
 getRssLinks ()
 getSortColumns ()
 setSortColumns ($aSortColumns)
 getEditTags ()
 getRecommSearch ()
 getPaymentList ()
 getActiveRecommList ()
 getAccessoires ()
 getCrossSelling ()
 getSimilarProducts ()
 getAlsoBoughtTheseProducts ()
 getArticleId ()
 getActiveLangAbbr ()
 addGlobalParams ($oShop=null)
 getAdditionalParams ()
 getPageNavigationLimitedTop ($iPositionCount=7)
 getPageNavigationLimitedBottom ($iPositionCount=11)
 generatePageNavigation ($iPositionCount=0)
 getViewProduct ()
 setViewProduct ($oProduct)
 getViewProductList ()
 getActTag ()
 getActVendor ()
 getActManufacturer ()
 setActVendor ($oVendor)
 setActManufacturer ($oManufacturer)
 getActSearch ()
 getCategoryTree ()
 setCategoryTree ($oCatTree)
 getManufacturerTree ()
 setManufacturerTree ($oManufacturerTree)
 getTop5ArticleList ($iCount=null)
 isLowOrderPrice ()
 getMinOrderPrice ()
 getNewsRealStatus ()
 getProduct ()
 getManufacturerlist ()
 setManufacturerlist ($aList)
 setRootVendor ($oVendor)
 getRootVendor ()
 setRootManufacturer ($oManufacturer)
 getRootManufacturer ()
 getVendorId ()
 getManufacturerId ()
 getSearchCatTree ()
 setSearchCatTree ($aTree)
 getCatMoreUrl ()
 getContentByIdent ($sIdent)
 getContentCategory ()
 getMustFillFields ()
 isFieldRequired ($sField)
 getFormId ()
 canAcceptFormData ()
 getPromoFinishedList ()
 getPromoCurrentList ()
 getPromoFutureList ()
 getShowPromotionList ()
 isEnabledPrivateSales ()
 getFieldValidationErrors ()
 setRootCatChanged ($blRootCatChanged)
 isRootCatChanged ()
 getInvoiceAddress ()
 getDeliveryAddress ()
 setDeliveryAddress ($aDeliveryAddress)
 setInvoiceAddress ($aAddress)
 getActiveUsername ()
 getWishlistUserId ()
 getSearchCatId ()
 getSearchVendor ()
 getSearchManufacturer ()
 getLastProducts ()
 getNewBasketItemMsgType ()
 isActive ($sName)
 isFbWidgetVisible ()
 isEnabledDownloadableFiles ()
 showRememberMe ()
 isVatIncluded ()
 isPriceCalculated ()
 showTags ()
 getWishlistName ()
 getWidgetLink ()
- Public Member Functions inherited from oxView
 setViewParameters ($aParams=null)
 getViewParameter ($sKey)
 setIsCallForCache ($blIsCallForCache=null)
 getIsCallForCache ()
 addTplParam ($sPara, $sValue)
 getBelboonParam ()
 getViewConfig ()
 setTemplateName ($sTemplate)
 setClassName ($sClassName)
 getClassName ()
 setFncName ($sFncName)
 getFncName ()
 setViewData ($aViewData=null)
 getViewData ()
 getViewDataElement ($sParamId=null)
 setClassLocation ($sClassLocation=null)
 getClassLocation ()
 setThisAction ($sThisAction=null)
 getThisAction ()
 setParent ($oParent=null)
 getParent ()
 setIsComponent ($blIsComponent=null)
 getIsComponent ()
 executeFunction ($sFunction)
 getTrustedShopId ()
 getTSExcellenceId ()
 getCharSet ()
 getShopVersion ()
 getShopEdition ()
 getRevision ()
 getPackageInfo ()
 getShopFullEdition ()
 isDemoVersion ()
 isBetaVersion ()
 isRCVersion ()
 showBetaNote ()
 isDemoShop ()
 showNewsletter ()
 setShowNewsletter ($blShow)
 getShopLogo ()
 setShopLogo ($sLogo)
 getActCategory ()
 setActCategory ($oCategory)
 getCategoryId ()
 setCategoryId ($sCategoryId)
 getErrorDestination ()
 getActionClassName ()
 isConnectedWithFb ()
 getFbUserId ()
 showFbConnectToAccountMsg ()
 isMall ()
 showRdfa ()
 getSidForWidget ()
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 __construct ()
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

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 Member Functions inherited from oxUBase
 _getComponentNames ()
 _processRequest ()
 _getMetaFromSeo ($sDataType)
 _getMetaFromContent ($sMetaIdent)
 _forceNoIndex ()
 _setNrOfArtPerPage ()
 _removeDuplicatedWords ($aInput, $aSkipTags=array())
 _getRequestParams ($blAddPageNr=true)
 _getSeoRequestParams ()
 _canRedirect ()
- Protected Member Functions inherited from oxView
 _executeNewAction ($sNewAction)

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
 $_blShowTagCloud = true
 $_blBargainAction = false
 $_aSimilarRecommListIds = null
- Protected Attributes inherited from oxUBase
 $_blFbWidgetsOn = null
 $_sRemoveMetaChars = '.\+*?[^]$(){}=!<>|:&'
 $_oaComponents = array()
 $_blIsOrderStep = false
 $_sListType = null
 $_aListDisplayTypes = array( 'grid', 'line', 'infogrid' )
 $_sListDisplayType = null
 $_sCustomListDisplayType = null
 $_oActCategory = null
 $_oActManufacturer = null
 $_oActVendor = null
 $_oActiveRecommList = null
 $_oActSearch = null
 $_blShowSorting = false
 $_blLoadCurrency = null
 $_blLoadManufacturerTree = null
 $_blDontShowEmptyCats = null
 $_blLoadLanguage = null
 $_iTopCatNavItmCnt = null
 $_aRssLinks = null
 $_sListOrderBy = null
 $_sListOrderDir = null
 $_sMetaDescription = null
 $_sMetaKeywords = null
 $_sMetaDescriptionIdent = null
 $_sMetaKeywordsIdent = null
 $_sAdditionalParams = null
 $_oActCurrency = null
 $_blEnabledPrivateSales = null
 $_blCommonAdded = false
 $_iViewIndexState = VIEW_INDEXSTATE_INDEX
 $_blForceNoIndex = false
 $_iCompItemsCnt = null
 $_sContentId = null
 $_oContent = null
 $_sViewResetID = null
 $_blActiveSorting = null
 $_aMenueList = null
 $_aComponentNames
 $_aUserComponentNames = array()
 $_oProduct = null
 $_iActPage = null
 $_aArticleList = null
 $_oManufacturerTree = null
 $_oCategoryTree = null
 $_aTop5ArticleList = null
 $_aBargainArticleList = null
 $_blLowOrderPrice = null
 $_sMinOrderPrice = null
 $_iNewsRealStatus = null
 $_aBlockRedirectParams = array( 'fnc', 'stoken', 'force_sid', 'force_admin_sid' )
 $_oRootVendor = null
 $_sVendorId = null
 $_aManufacturerlist = null
 $_oRootManufacturer = null
 $_sManufacturerId = null
 $_aSearchCatTree = null
 $_blNewsSubscribed = null
 $_oDelAddress = null
 $_sCatTreePath = null
 $_aContents = array()
 $_blTop5Action = false
 $_blBargainAction = false
 $_aMustFillFields = null
 $_blShowTagCloud = true
 $_blRootCatChanged = false
 $_aInvoiceAddress = null
 $_aDeliveryAddress = null
 $_sActiveUsername = null
 $_blLoadComponents = true
 $_aSortColumns = null
- Protected Attributes inherited from oxView
 $_aViewData = array()
 $_sClassLocation = null
 $_sThisAction = null
 $_oParent = null
 $_blIsComponent = false
 $_sThisTemplate = null
 $_sViewId = null
 $_sClass = null
 $_sFnc = null
 $_sTrustedShopId = null
 $_sTSExcellenceId = null
 $_sCharSet = null
 $_sVersion = null
 $_blDemoVersion = null
 $_blDemoShop = null
 $_iNewsStatus = null
 $_sShopLogo = null
 $_sCategoryId = null
 $_oClickCat = null
 $_blIsCallForCache = false
 $_oViewConf = null

Additional Inherited Members

- Static Protected Attributes inherited from oxUBase
static $_aCollectedComponentNames = null

Detailed Description

List of articles for a selected product group. Collects list of articles, according to it generates links for list gallery, meta tags (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$sUrlurl to append page numbers
int$iPagecurrent page number
int$iLangrequested language
Returns
string

Reimplemented from oxUBase.

Reimplemented in RecommList, Tag, ManufacturerList, and VendorList.

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

aList::_collectMetaDescription (   $sMeta,
  $iLength = 1024,
  $blDescTag = false 
)
protected

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

Parameters
string$sMetacategory path
int$iLengthmax length of result, -1 for no truncation
bool$blDescTagif true - performs additional dublicate cleaning
Returns
string $sString converted string

Definition at line 482 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$sKeywordscategory path
Returns
string

Definition at line 557 of file alist.php.

aList::_getCatPathString ( )
protected

Returns string built from category titles

Returns
string

Reimplemented in Tag.

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

Definition at line 282 of file alist.php.

aList::_getRequestPageNr ( )
protected

Calls parent::getActPage();

Returns
int

Definition at line 370 of file alist.php.

aList::_getSeoObjectId ( )
protected

Returns active product id to load its seo meta info

Returns
string

Reimplemented from oxUBase.

Reimplemented in VendorList, ManufacturerList, and Tag.

Definition at line 380 of file alist.php.

aList::_getSubject (   $iLang)
protected

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

Parameters
int$iLanglanguage id
Returns
object

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, and VendorList.

Definition at line 726 of file alist.php.

aList::_isActCategory ( )
protected

Returns true if we have category

Returns
bool

Definition at line 638 of file alist.php.

aList::_loadArticles (   $oCategory)
protected

Loads and returns article list of active category.

Parameters
string$oCategorycategory object
Returns
array

Reimplemented in VendorList, ManufacturerList, and Tag.

Definition at line 323 of file alist.php.

aList::_prepareMetaDescription (   $sMeta,
  $iLength = 1024,
  $blDescTag = false 
)
protected

Returns current view meta description data

Parameters
string$sMetacategory path
int$iLengthmax length of result, -1 for no truncation
bool$blDescTagif true - performs additional duplicate cleaning
Returns
string $sString converted string

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, VendorList, and Tag.

Definition at line 424 of file alist.php.

aList::_prepareMetaKeyword (   $sKeywords,
  $blRemoveDuplicatedWords = true 
)
protected

Returns current view keywords separated by comma

Parameters
string$sKeywordsdata to use as keywords
bool$blRemoveDuplicatedWordsremove duplicated words
Returns
string

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, VendorList, and Tag.

Definition at line 520 of file alist.php.

aList::_processListArticles ( )
protected

Iterates through list articles and performs list view specific tasks:

  • sets type of link which needs to be generated (Manufacturer link)
Returns
null

Definition at line 224 of file alist.php.

aList::canSelectDisplayType ( )

Returns config parameters blShowListDisplayType value

Returns
boolean

Definition at line 982 of file alist.php.

aList::executefilter ( )

Stores chosen category filter into session.

Session variables: session_attrfilter

Returns
null

Definition at line 299 of file alist.php.

aList::generatePageNavigationUrl ( )

Generates Url for page navigation

Returns
string

Reimplemented from oxUBase.

Reimplemented in RecommList, ManufacturerList, VendorList, and Tag.

Definition at line 648 of file alist.php.

aList::getActiveCategory ( )

Template variable getter. Returns active search

Returns
oxCategory

Reimplemented from oxUBase.

Reimplemented in VendorList, and ManufacturerList.

Definition at line 947 of file alist.php.

aList::getActPage ( )

Get actual page number.

Returns
int

Reimplemented from oxUBase.

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

Definition at line 253 of file alist.php.

aList::getArticleCount ( )

Article count getter

Returns
int

Definition at line 775 of file alist.php.

aList::getArticleList ( )

Template variable getter. Returns category's article list

Returns
array

Reimplemented in VendorList, ManufacturerList, RecommList, and Tag.

Definition at line 756 of file alist.php.

aList::getAttributes ( )

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

Returns
array

Reimplemented in VendorList, and ManufacturerList.

Definition at line 737 of file alist.php.

aList::getBargainArticleList ( )

Template variable getter. Returns bargain article list

Returns
array

Reimplemented from oxUBase.

Definition at line 927 of file alist.php.

aList::getBreadCrumb ( )

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

Returns
array

Reimplemented from oxUBase.

Reimplemented in RecommList, ManufacturerList, VendorList, and Tag.

Definition at line 831 of file alist.php.

aList::getCanonicalUrl ( )

Returns view canonical url

Returns
string

Reimplemented from oxUBase.

Reimplemented in Tag.

Definition at line 964 of file alist.php.

aList::getCatTreePath ( )

Template variable getter. Returns category path

Returns
string

Reimplemented from oxUBase.

Reimplemented in VendorList, and ManufacturerList.

Definition at line 802 of file alist.php.

aList::getDefaultSorting ( )

Returns default category sorting for selected category

Returns
array

Reimplemented from oxUBase.

Definition at line 676 of file alist.php.

aList::getMetaDescription ( )

Template variable getter. Returns meta description

Returns
string

Reimplemented from oxUBase.

Definition at line 456 of file alist.php.

aList::getPageCount ( )

Get list articles pages count

Returns
int

Definition at line 992 of file alist.php.

aList::getPageNavigation ( )

Template variable getter. Returns page navigation

Returns
object

Reimplemented from oxUBase.

Definition at line 898 of file alist.php.

aList::getSimilarRecommListIds ( )

Return array of id to form recommend list.

Returns
array

Reimplemented from oxUBase.

Definition at line 785 of file alist.php.

aList::getSorting (   $sCnid)

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

Parameters
string$sCnidsortable item id
Deprecated:
since v4.7.3/5.0.3 (2013-01-07); duplicated code
Returns
string

Reimplemented from oxUBase.

Reimplemented in Tag, VendorList, and ManufacturerList.

Definition at line 665 of file alist.php.

aList::getSubCatList ( )

Template variable getter. Returns list of subcategories.

Returns
array

Reimplemented in ManufacturerList, and VendorList.

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

aList::getTitle ( )

Template variable getter. Returns category title.

Returns
string

Reimplemented from oxUBase.

Reimplemented in ManufacturerList, VendorList, and Tag.

Definition at line 911 of file alist.php.

aList::getTitlePageSuffix ( )

Returns title page suffix used in template

Returns
string

Reimplemented from oxUBase.

Definition at line 711 of file alist.php.

aList::getTitleSuffix ( )

Returns title suffix used in template

Returns
string

Reimplemented from oxUBase.

Reimplemented in VendorList, and ManufacturerList.

Definition at line 699 of file alist.php.

aList::getTreePath ( )

Template variable getter. Returns category path array

Returns
array

Reimplemented in RecommList, ManufacturerList, VendorList, and Tag.

Definition at line 819 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 121 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 865 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 meta tags 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 RecommList, VendorList, ManufacturerList, and Tag.

Definition at line 150 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::$_aSimilarRecommListIds = null
protected

Definition at line 112 of file alist.php.

aList::$_aSubCatList = null
protected

Definition at line 69 of file alist.php.

aList::$_blBargainAction = false
protected

Definition at line 105 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

Definition at line 45 of file alist.php.

aList::$_blShowTagCloud = true
protected

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

Definition at line 75 of file alist.php.

aList::$_oRecommList = null
protected

Definition at line 87 of file alist.php.

aList::$_sCatPathString = null
protected

Definition at line 39 of file alist.php.

aList::$_sCatTitle = null
protected

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

Definition at line 27 of file alist.php.

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