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

Public Member Functions

 render ()
 getAddUrlParams ()
 getAddSeoUrlParams ()
 saveReview ()
 getNavigationParams ()
 getArticleList ()
 getSimilarRecommLists ()
 getReviews ()
 isReviewActive ()
 canRate ()
 getRatingValue ()
 getRatingCount ()
 getRecommLists ()
 getRecommSearch ()
 getTreePath ()
 getSearchForHtml ()
 generatePageNavigationUrl ()
 getAdditionalParams ()
 getLink ($iLang=null)
 getBreadCrumb ()
 getTitle ()
- Public Member Functions inherited from aList
 getViewId ()
 executefilter ()
 getActPage ()
 getMetaDescription ()
 getTemplateName ()
 getDefaultSorting ()
 getTitleSuffix ()
 getTitlePageSuffix ()
 getAttributes ()
 getArticleCount ()
 getSimilarRecommListIds ()
 getCatTreePath ()
 hasVisibleSubCats ()
 getSubCatList ()
 getPageNavigation ()
 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)
 getListOrderBy ()
 getListOrderDirection ()
 setMetaDescription ($sDescription)
 setMetaKeywords ($sKeywords)
 getMetaKeywords ()
 getActCurrency ()
 setActCurrency ($oCur)
 getCompareItemCount ()
 noIndex ()
 getMenueList ()
 setMenueList ($aMenu)
 setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
 getSorting ($sSortIdent)
 getSortingSql ($sIdent)
 getTitlePrefix ()
 getPageTitle ()
 getDynUrlParams ()
 getBaseLink ($iLang=null)
 getSearchParamForHtml ()
 showSearch ()
 getRssLinks ()
 getSortColumns ()
 setSortColumns ($aSortColumns)
 getEditTags ()
 getPaymentList ()
 getActiveRecommList ()
 getAccessoires ()
 getCrossSelling ()
 getSimilarProducts ()
 getAlsoBoughtTheseProducts ()
 getArticleId ()
 getActiveLangAbbr ()
 addGlobalParams ($oShop=null)
 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 ()
 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 ()
 _addPageNrParam ($sUrl, $iPage, $iLang=null)
- Protected Member Functions inherited from aList
 _checkRequestedPage ()
 _processListArticles ()
 _loadArticles ($oCategory)
 _getRequestPageNr ()
 _getListDisplayType ()
 _getSeoObjectId ()
 _getCatPathString ()
 _prepareMetaDescription ($sMeta, $iLength=1024, $blDescTag=false)
 _collectMetaDescription ($sMeta, $iLength=1024, $blDescTag=false)
 _prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
 _collectMetaKeyword ($sKeywords)
 _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

 $_sListType = 'recommlist'
 $_sThisTemplate = 'page/recommendations/recommlist.tpl'
 $_oOtherRecommList = null
 $_aReviews = null
 $_blRate = null
 $_dRatingValue = null
 $_iRatingCnt = null
 $_oSearchRecommLists = null
 $_sSearch = null
 $_sTplLocation = null
 $_oPageNavigation = null
- 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
 $_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
 $_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

Article suggestion page. Collects some article base information, sets default recomendation text, sends suggestion mail to user.

Definition at line 8 of file recommlist.php.

Member Function Documentation

RecommList::_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 aList.

Definition at line 478 of file recommlist.php.

RecommList::_getProductLinkType ( )
protected

Returns product link type (OXARTICLE_LINKTYPE_RECOMM)

Returns
int

Reimplemented from aList.

Definition at line 143 of file recommlist.php.

RecommList::canRate ( )

Template variable getter. Returns if user can rate

Returns
bool

Definition at line 325 of file recommlist.php.

RecommList::generatePageNavigationUrl ( )

Generates Url for page navigation

Returns
string

Reimplemented from aList.

Definition at line 458 of file recommlist.php.

RecommList::getAdditionalParams ( )

Template variable getter. Returns additional params for url

Returns
string

Reimplemented from oxUBase.

Definition at line 497 of file recommlist.php.

RecommList::getAddSeoUrlParams ( )

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

Returns
string

Reimplemented from aList.

Definition at line 170 of file recommlist.php.

RecommList::getAddUrlParams ( )

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

Returns
string

Reimplemented from aList.

Definition at line 153 of file recommlist.php.

RecommList::getArticleList ( )

Template variable getter. Returns category's article list

Returns
array

Reimplemented from aList.

Definition at line 244 of file recommlist.php.

RecommList::getBreadCrumb ( )

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

Returns
array

Reimplemented from aList.

Definition at line 539 of file recommlist.php.

RecommList::getLink (   $iLang = null)

get link of current view

Parameters
int$iLangrequested language
Returns
string

Reimplemented from oxUBase.

Definition at line 519 of file recommlist.php.

RecommList::getNavigationParams ( )

Returns array of params => values which are used in hidden forms and as additional url params

Returns
array

Reimplemented from oxUBase.

Definition at line 231 of file recommlist.php.

RecommList::getRatingCount ( )

Template variable getter. Returns rating count

Returns
integer

Definition at line 361 of file recommlist.php.

RecommList::getRatingValue ( )

Template variable getter. Returns rating value

Returns
double

Definition at line 344 of file recommlist.php.

RecommList::getRecommLists ( )

Template variable getter. Returns searched recommlist

Returns
object

Definition at line 378 of file recommlist.php.

RecommList::getRecommSearch ( )

Template variable getter. Returns search string

Returns
string

Reimplemented from oxUBase.

Definition at line 400 of file recommlist.php.

RecommList::getReviews ( )

Template variable getter. Returns recommlist's reviews

Returns
array

Definition at line 298 of file recommlist.php.

RecommList::getSearchForHtml ( )

Template variable getter. Returns search string

Returns
string

Definition at line 443 of file recommlist.php.

RecommList::getSimilarRecommLists ( )

Template variable getter. Returns other recommlists

Returns
object

Definition at line 278 of file recommlist.php.

RecommList::getTitle ( )

Page title

Returns
string

Reimplemented from aList.

Definition at line 557 of file recommlist.php.

RecommList::getTreePath ( )

Template variable getter. Returns category path array

Returns
array

Reimplemented from aList.

Definition at line 417 of file recommlist.php.

RecommList::isReviewActive ( )

Template variable getter. Returns if review module is on

Returns
bool

Definition at line 315 of file recommlist.php.

RecommList::render ( )

Collects current view data, return current template file name

Returns
string

Reimplemented from aList.

Definition at line 94 of file recommlist.php.

RecommList::saveReview ( )

Saves user ratings and review text (oxreview object)

Returns
null

Definition at line 185 of file recommlist.php.

Member Data Documentation

RecommList::$_aReviews = null
protected

Definition at line 37 of file recommlist.php.

RecommList::$_blRate = null
protected

Definition at line 44 of file recommlist.php.

RecommList::$_dRatingValue = null
protected

Definition at line 51 of file recommlist.php.

RecommList::$_iRatingCnt = null
protected

Definition at line 58 of file recommlist.php.

RecommList::$_oOtherRecommList = null
protected

Definition at line 30 of file recommlist.php.

RecommList::$_oPageNavigation = null
protected

Definition at line 86 of file recommlist.php.

RecommList::$_oSearchRecommLists = null
protected

Definition at line 65 of file recommlist.php.

RecommList::$_sListType = 'recommlist'
protected

Definition at line 16 of file recommlist.php.

RecommList::$_sSearch = null
protected

Definition at line 72 of file recommlist.php.

RecommList::$_sThisTemplate = 'page/recommendations/recommlist.tpl'
protected

Definition at line 23 of file recommlist.php.

RecommList::$_sTplLocation = null
protected

Definition at line 79 of file recommlist.php.

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