OXID eShop CE  4.10.1
 All Classes Namespaces Files Functions Variables Pages
Review Class Reference
+ Inheritance diagram for Review:
+ Collaboration diagram for Review:

Public Member Functions

 getViewId ()
 init ()
 render ()
 saveReview ()
 getReviewUser ()
 getReviewUserHash ()
 getActiveRecommList ()
 canRate ()
 getReviews ()
 getRecommList ()
 getActiveRecommItems ()
 getReviewSendStatus ()
 getPageNavigation ()
 getAdditionalParams ()
 getDynUrlParams ()
- Public Member Functions inherited from Details
 getNavigationParams ()
 addToRecomm ()
 addTags ()
 editTags ()
 cancelTags ()
 getEditTags ()
 getTags ()
 getProduct ()
 getLinkType ()
 drawParentUrl ()
 getParentName ()
 getParentUrl ()
 getPictureGallery ()
 getActPictureId ()
 getActPicture ()
 getPictures ()
 getArtPic ($sPicNr)
 getSelectLists ()
 getCrossSelling ()
 getSimilarProducts ()
 getSimilarRecommListIds ()
 getAccessoires ()
 getAlsoBoughtTheseProducts ()
 isPriceAlarm ()
 getSearchTitle ()
 setSearchTitle ($sTitle)
 setCatTreePath ($sActCatPath)
 noIndex ()
 getTitle ()
 getMetaDescription ()
 getTag ()
 getCanonicalUrl ()
 getBreadCrumb ()
 getCaptcha ()
 addme ()
 getPriceAlarmStatus ()
 getBidPrice ()
 getVariantSelections ()
 getPicturesProduct ()
 getSearchParamForHtml ()
 showRdfa ()
 getRDFaNormalizedRating ()
 getRDFaValidityPeriod ($sShopConfVar)
 getRDFaBusinessFnc ()
 getRDFaCustomers ()
 getRDFaVAT ()
 getRDFaGenericCondition ()
 getBundleArticle ()
 getRDFaPaymentMethods ()
 getRDFaDeliverySetMethods ()
 getProductsDeliveryList ()
 getRDFaDeliveryChargeSpecLoc ()
 getRDFaPaymentChargeSpecLoc ()
 getRDFaBusinessEntityLoc ()
 showRDFaProductStock ()
 canChangeTags ()
 getTagCloudManager ()
 showZoomPics ()
 isReviewActive ()
 getDefaultSorting ()
 getSortingParameters ()
- Public Member Functions inherited from oxUBase
 showSorting ()
 setComponents ($aComponents=null)
 getComponents ()
 getComponent ($sName)
 setIsOrderStep ($blIsOrderStep=null)
 getIsOrderStep ()
 setActiveCategory ($oCategory)
 getActiveCategory ()
 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 ()
 getMenueList ()
 setMenueList ($aMenu)
 setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
 getSorting ($sSortIdent)
 getSortingSql ($sIdent)
 getTitleSuffix ()
 getTitlePageSuffix ()
 getTitlePrefix ()
 getPageTitle ()
 getBaseLink ($iLang=null)
 getLink ($iLang=null)
 showSearch ()
 getRssLinks ()
 getSortColumns ()
 setSortColumns ($aSortColumns)
 getRecommSearch ()
 getPaymentList ()
 getArticleId ()
 getActiveLangAbbr ()
 addGlobalParams ($oShop=null)
 generatePageNavigationUrl ()
 getPageNavigationLimitedTop ($iPositionCount=7)
 getPageNavigationLimitedBottom ($iPositionCount=11)
 generatePageNavigation ($iPositionCount=0)
 getViewProduct ()
 setViewProduct ($oProduct)
 getViewProductList ()
 getActPage ()
 getActTag ()
 getActVendor ()
 getActManufacturer ()
 setActVendor ($oVendor)
 setActManufacturer ($oManufacturer)
 getActSearch ()
 getCategoryTree ()
 setCategoryTree ($oCatTree)
 getManufacturerTree ()
 setManufacturerTree ($oManufacturerTree)
 getAddUrlParams ()
 getTop5ArticleList ($iCount=null)
 getBargainArticleList ()
 isLowOrderPrice ()
 getMinOrderPrice ()
 getNewsRealStatus ()
 getManufacturerlist ()
 setManufacturerlist ($aList)
 setRootVendor ($oVendor)
 getRootVendor ()
 setRootManufacturer ($oManufacturer)
 getRootManufacturer ()
 getVendorId ()
 getManufacturerId ()
 getCatMoreUrl ()
 getCatTreePath ()
 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 ()
 getTemplateName ()
 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 ()
 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

 _getActiveObject ()
 _getActiveType ()
- Protected Member Functions inherited from Details
 _getParentProduct ($sParentId)
 _getAddUrlParams ()
 _processProduct ($oProduct)
 _prepareMetaDescription ($sMeta, $iLength=200, $blDescTag=false)
 _prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
 _addTagsToList ($oArticleTagList, $aTags, $aAddedTags)
 _getSeoObjectId ()
 _additionalChecksForArticle ()
 _getSubject ($iLang)
 _getVendorBreadCrumb ()
 _getRecommendationListBredCrumb ()
 _getTagBreadCrumb ()
 _getSearchBreadCrumb ()
 _getCategoryBreadCrumb ()
- Protected Member Functions inherited from oxUBase
 _getComponentNames ()
 _processRequest ()
 _getMetaFromSeo ($sDataType)
 _getMetaFromContent ($sMetaIdent)
 _forceNoIndex ()
 _setNrOfArtPerPage ()
 _removeDuplicatedWords ($aInput, $aSkipTags=array())
 _getRequestParams ($blAddPageNr=true)
 _getSeoRequestParams ()
 _addPageNrParam ($sUrl, $iPage, $iLang=null)
 _canRedirect ()
- Protected Member Functions inherited from oxView
 _executeNewAction ($sNewAction)

Protected Attributes

 $_oRevUser = null
 $_oActObject = null
 $_oActiveRecommList = null
 $_oActiveRecommItems = null
 $_blRate = null
 $_aReviews = null
 $_oCrossSelling = null
 $_oSimilarProducts = null
 $_oRecommList = null
 $_blReviewSendStatus = null
 $_oPageNavigation = null
 $_sThisTemplate = 'page/review/review.tpl'
 $_sThisLoginTemplate = 'page/review/review_login.tpl'
 $_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW
- Protected Attributes inherited from Details
 $_sThisTemplate = 'page/details/details.tpl'
 $_oParentProd = null
 $_blEditTags = null
 $_aTags = null
 $_oCaptcha = null
 $_sParentName = null
 $_sParentUrl = null
 $_aPicGallery = null
 $_aSelectLists = null
 $_aReviews = null
 $_oCrossSelling = null
 $_oSimilarProducts = null
 $_oAccessoires = null
 $_aAlsoBoughtArts = null
 $_sSearchTitle = null
 $_blIsInitialized = false
 $_iLinkType = null
 $_sBidPrice = null
 $_iPriceAlarmStatus = null
 $_sSearchParamForHtml = null
 $_aSimilarRecommListIds = null
 $_blShowSorting = true
- 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

Review of chosen article. Collects article review data, saves new review to DB.

Definition at line 7 of file review.php.

Member Function Documentation

Review::_getActiveObject ( )
protected

Template variable getter. Returns active object (oxarticle or oxrecommlist)

Returns
object

Definition at line 276 of file review.php.

Review::_getActiveType ( )
protected

Template variable getter. Returns active type (oxarticle or oxrecommlist)

Returns
string

Definition at line 296 of file review.php.

Review::canRate ( )

Template variable getter. Returns if user can rate

Returns
bool

Definition at line 342 of file review.php.

Review::getActiveRecommItems ( )

Template variable getter. Returns active recommlist's items

Deprecated:
since v5.3 (2016-06-17); Listmania will be moved to an own module.
Returns
object

Definition at line 403 of file review.php.

Review::getActiveRecommList ( )

Template variable getter. Returns active recommlist

Deprecated:
since v5.3 (2016-06-17); Listmania will be moved to an own module.
Returns
oxRecommList

Reimplemented from oxUBase.

Definition at line 317 of file review.php.

Review::getAdditionalParams ( )

Template variable getter. Returns additional params for url

Returns
string

Reimplemented from oxUBase.

Definition at line 464 of file review.php.

Review::getDynUrlParams ( )

returns additional url params for dynamic url building

Returns
string

Reimplemented from oxUBase.

Definition at line 481 of file review.php.

Review::getPageNavigation ( )

Template variable getter. Returns page navigation

Returns
object

Reimplemented from oxUBase.

Definition at line 445 of file review.php.

Review::getRecommList ( )

Template variable getter. Returns recommlists

Deprecated:
since v5.3 (2016-06-17); Listmania will be moved to an own module.
Returns
object

Definition at line 383 of file review.php.

Review::getReviews ( )

Template variable getter. Returns active object's reviews

Returns
array

Reimplemented from Details.

Definition at line 364 of file review.php.

Review::getReviewSendStatus ( )

Template variable getter. Returns review send status

Returns
bool

Definition at line 435 of file review.php.

Review::getReviewUser ( )

Returns review user object

Returns
oxuser

Definition at line 240 of file review.php.

Review::getReviewUserHash ( )

Template variable getter. Returns review user id

Returns
string

Definition at line 266 of file review.php.

Review::getViewId ( )

Returns prefix ID used by template engine.

Returns
string $this->_sViewID view id

Reimplemented from Details.

Definition at line 121 of file review.php.

Review::init ( )

Executes parent::init(), Loads user chosen product object (with all data).

Reimplemented from oxUBase.

Definition at line 129 of file review.php.

Review::render ( )

Executes parent::render, loads article reviews and additional data (oxarticle::getReviews(), oxarticle::getCrossSelling(), oxarticle::GetSimilarProducts()). Returns name of template file to render review::_sThisTemplate.

Returns
string current template file name

Reimplemented from Details.

Definition at line 148 of file review.php.

Review::saveReview ( )

Saves user review text (oxreview object)

Returns
null

Reimplemented from Details.

Definition at line 185 of file review.php.

Member Data Documentation

Review::$_aReviews = null
protected

Definition at line 56 of file review.php.

Review::$_blRate = null
protected

Definition at line 49 of file review.php.

Review::$_blReviewSendStatus = null
protected

Definition at line 86 of file review.php.

Review::$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW
protected

Definition at line 114 of file review.php.

Review::$_oActiveRecommItems = null
protected

Definition at line 42 of file review.php.

Review::$_oActiveRecommList = null
protected

Definition at line 33 of file review.php.

Review::$_oActObject = null
protected

Definition at line 24 of file review.php.

Review::$_oCrossSelling = null
protected

Definition at line 63 of file review.php.

Review::$_oPageNavigation = null
protected

Definition at line 93 of file review.php.

Review::$_oRecommList = null
protected

Definition at line 79 of file review.php.

Review::$_oRevUser = null
protected

Definition at line 15 of file review.php.

Review::$_oSimilarProducts = null
protected

Definition at line 70 of file review.php.

Review::$_sThisLoginTemplate = 'page/review/review_login.tpl'
protected

Definition at line 107 of file review.php.

Review::$_sThisTemplate = 'page/review/review.tpl'
protected

Definition at line 100 of file review.php.


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