OXID eShop CE  4.8.12
 All Classes Files Functions Variables Pages
ManufacturerList Class Reference
+ Inheritance diagram for ManufacturerList:
+ Collaboration diagram for ManufacturerList:

Public Member Functions

 render ()
 setItemSorting ($sCnid, $sSortBy, $sSortDir=null)
 getSorting ($sCnid)
 generatePageNavigationUrl ()
 hasVisibleSubCats ()
 getSubCatList ()
 getArticleList ()
 getTitle ()
 getTreePath ()
 getActiveCategory ()
 getCatTreePath ()
 getTitleSuffix ()
 getAddUrlParams ()
 getBreadCrumb ()
 getAttributes ()
- Public Member Functions inherited from aList
 getViewId ()
 getAddSeoUrlParams ()
 executefilter ()
 getActPage ()
 getMetaDescription ()
 getTemplateName ()
 getDefaultSorting ()
 getTitlePageSuffix ()
 getArticleCount ()
 getSimilarRecommListIds ()
 getPageNavigation ()
 getBargainArticleList ()
 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 ()
 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

 _getProductLinkType ()
 _loadArticles ($oManufacturer)
 _getSeoObjectId ()
 _addPageNrParam ($sUrl, $iPage, $iLang=null)
 _prepareMetaKeyword ($aCatPath, $blRemoveDuplicatedWords=true)
 _prepareMetaDescription ($aCatPath, $iLength=1024, $blDescTag=false)
 _getSubject ($iLang)
- Protected Member Functions inherited from aList
 _checkRequestedPage ()
 _processListArticles ()
 _getRequestPageNr ()
 _getCatPathString ()
 _collectMetaDescription ($sMeta, $iLength=1024, $blDescTag=false)
 _collectMetaKeyword ($sKeywords)
 _isActCategory ()
- 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

 $_sListType = 'manufacturer'
 $_blVisibleSubCats = null
 $_oSubCatList = null
 $_oRecommList = null
 $_sTplLocation = null
 $_sCatTitle = null
 $_oPageNavigation = null
 $_blShowSorting = true
 $_iViewIndexState = VIEW_INDEXSTATE_INDEX
- Protected Attributes inherited from aList
 $_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 Manufacturer. Collects list of articles, according to it generates links for list gallery, metatags (for search engines). Result - "manufacturerlist.tpl" template. OXID eShop -> (Any selected shop product category).

Definition at line 9 of file manufacturerlist.php.

Member Function Documentation

ManufacturerList::_addPageNrParam (   $sUrl,
  $iPage,
  $iLang = null 
)
protected

Modifies url by adding page parameters. When seo is on, url is additionally formatted by SEO engine

Parameters
string$sUrlcurrent url
int$iPagepage number
int$iLangactive language id
Returns
string

Reimplemented from aList.

Definition at line 193 of file manufacturerlist.php.

ManufacturerList::_getProductLinkType ( )
protected

Returns product link type (OXARTICLE_LINKTYPE_MANUFACTURER)

Returns
int

Reimplemented from aList.

Definition at line 106 of file manufacturerlist.php.

ManufacturerList::_getSeoObjectId ( )
protected

Returns active product id to load its seo meta info

Returns
string

Reimplemented from aList.

Definition at line 174 of file manufacturerlist.php.

ManufacturerList::_getSubject (   $iLang)
protected

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

Parameters
int$iLanglanguage id
Returns
object

Reimplemented from aList.

Definition at line 393 of file manufacturerlist.php.

ManufacturerList::_loadArticles (   $oManufacturer)
protected

Loads and returns article list of active Manufacturer.

Parameters
oxmanufacturer$oManufacturerManufacturer object
Returns
array

Reimplemented from aList.

Definition at line 148 of file manufacturerlist.php.

ManufacturerList::_prepareMetaDescription (   $aCatPath,
  $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
mixed$aCatPathcategory path
int$iLengthmax length of result, -1 for no truncation
bool$blDescTagif true - performs additional dublicate cleaning
Returns
string $sString converted string

Reimplemented from aList.

Definition at line 380 of file manufacturerlist.php.

ManufacturerList::_prepareMetaKeyword (   $aCatPath,
  $blRemoveDuplicatedWords = true 
)
protected

Calls and returns result of parent:: _collectMetaKeyword();

Parameters
mixed$aCatPathcategory path
bool$blRemoveDuplicatedWordsremove dublicated words
Returns
string

Reimplemented from aList.

Definition at line 363 of file manufacturerlist.php.

ManufacturerList::generatePageNavigationUrl ( )

Returns current view Url

Returns
string

Reimplemented from aList.

Definition at line 211 of file manufacturerlist.php.

ManufacturerList::getActiveCategory ( )

Template variable getter. Returns active Manufacturer

Returns
object

Reimplemented from aList.

Definition at line 312 of file manufacturerlist.php.

ManufacturerList::getAddUrlParams ( )

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

Returns
string

Reimplemented from aList.

Definition at line 403 of file manufacturerlist.php.

ManufacturerList::getArticleList ( )

Template variable getter. Returns active object's reviews

Returns
array

Reimplemented from aList.

Definition at line 259 of file manufacturerlist.php.

ManufacturerList::getAttributes ( )

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

Returns
array

Reimplemented from aList.

Definition at line 443 of file manufacturerlist.php.

ManufacturerList::getBreadCrumb ( )

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

Returns
array

Reimplemented from aList.

Definition at line 418 of file manufacturerlist.php.

ManufacturerList::getCatTreePath ( )

Template variable getter. Returns template location

Returns
string

Reimplemented from aList.

Definition at line 330 of file manufacturerlist.php.

ManufacturerList::getSorting (   $sCnid)

Returns Manufacturer sorting config

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

Reimplemented from aList.

Definition at line 136 of file manufacturerlist.php.

ManufacturerList::getSubCatList ( )

Template variable getter. Returns active object's reviews

Returns
array

Reimplemented from aList.

Definition at line 246 of file manufacturerlist.php.

ManufacturerList::getTitle ( )

Template variable getter. Returns template location

Returns
string

Reimplemented from aList.

Definition at line 280 of file manufacturerlist.php.

ManufacturerList::getTitleSuffix ( )

Returns title suffix used in template

Returns
string

Reimplemented from aList.

Definition at line 346 of file manufacturerlist.php.

ManufacturerList::getTreePath ( )

Template variable getter. Returns category path array

Returns
array

Reimplemented from aList.

Definition at line 298 of file manufacturerlist.php.

ManufacturerList::hasVisibleSubCats ( )

Template variable getter. Returns active object's reviews

Returns
array

Reimplemented from aList.

Definition at line 225 of file manufacturerlist.php.

ManufacturerList::render ( )

Executes parent::render(), loads active Manufacturer, prepares article list sorting rules. Loads list of articles which belong to this Manufacturer 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.

Returns
string $this->_sThisTemplate current template file name

Reimplemented from aList.

Definition at line 78 of file manufacturerlist.php.

ManufacturerList::setItemSorting (   $sCnid,
  $sSortBy,
  $sSortDir = null 
)

Sets Manufacturer item sorting config

Parameters
string$sCnidsortable Manufacturer id
string$sSortBysort field
string$sSortDirsort direction (optional)
Deprecated:
since v4.7.3/5.0.3 (2013-01-07); dublicated code
Returns
null

Reimplemented from oxUBase.

Definition at line 122 of file manufacturerlist.php.

Member Data Documentation

ManufacturerList::$_blShowSorting = true
protected

Definition at line 59 of file manufacturerlist.php.

ManufacturerList::$_blVisibleSubCats = null
protected

Definition at line 21 of file manufacturerlist.php.

ManufacturerList::$_iViewIndexState = VIEW_INDEXSTATE_INDEX
protected

Definition at line 66 of file manufacturerlist.php.

ManufacturerList::$_oPageNavigation = null
protected

Definition at line 53 of file manufacturerlist.php.

ManufacturerList::$_oRecommList = null
protected

Definition at line 33 of file manufacturerlist.php.

ManufacturerList::$_oSubCatList = null
protected

Definition at line 27 of file manufacturerlist.php.

ManufacturerList::$_sCatTitle = null
protected

Definition at line 47 of file manufacturerlist.php.

ManufacturerList::$_sListType = 'manufacturer'
protected

Definition at line 15 of file manufacturerlist.php.

ManufacturerList::$_sTplLocation = null
protected

Definition at line 40 of file manufacturerlist.php.


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