OxidEsales\EshopCommunity\Application\Controller\RecommListController Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\RecommListController:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\RecommListController:

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 ()

Protected Member Functions
	_getProductLinkType ()
	_addPageNrParam ($sUrl, $iPage, $iLang=null)

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

Detailed Description

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

Deprecated:

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

Member Function Documentation

_addPageNrParam()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::_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

_getProductLinkType()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::_getProductLinkType ( )

protected

Returns product link type (OXARTICLE_LINKTYPE_RECOMM)

Returns

int

canRate()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::canRate

(

)

Template variable getter. Returns if user can rate

Returns

bool

generatePageNavigationUrl()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::generatePageNavigationUrl

(

)

Generates Url for page navigation

Returns

string

getAdditionalParams()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getAdditionalParams

(

)

Template variable getter. Returns additional params for url

Returns

string

getAddSeoUrlParams()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getAddSeoUrlParams

(

)

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

Returns

string

getAddUrlParams()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getAddUrlParams

(

)

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

Returns

string

getArticleList()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getArticleList

(

)

Template variable getter. Returns category's article list

Returns

array

getBreadCrumb()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getBreadCrumb

(

)

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

Returns

array

getLink()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getLink

(

$iLang = null

)

get link of current view

Parameters

int

$iLang

requested language

Returns

string

getNavigationParams()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getNavigationParams

(

)

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

Returns

array

getRatingCount()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getRatingCount

(

)

Template variable getter. Returns rating count

Returns

integer

getRatingValue()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getRatingValue

(

)

Template variable getter. Returns rating value

Returns

double

getRecommLists()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getRecommLists

(

)

Template variable getter. Returns searched recommlist

Returns

object

getRecommSearch()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getRecommSearch

(

)

Template variable getter. Returns search string

Returns

string

getReviews()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getReviews

(

)

Template variable getter. Returns recommlist's reviews

Returns

array

getSearchForHtml()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getSearchForHtml

(

)

Template variable getter. Returns search string

Returns

string

getSimilarRecommLists()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getSimilarRecommLists

(

)

Template variable getter. Returns other recommlists

Returns

object

getTitle()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getTitle

(

)

Page title

Returns

string

getTreePath()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::getTreePath

(

)

Template variable getter. Returns category path array

Returns

array

isReviewActive()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::isReviewActive

(

)

Template variable getter. Returns if review module is on

Returns

bool

render()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::render

(

)

Collects current view data, return current template file name

Returns

string

saveReview()

OxidEsales\EshopCommunity\Application\Controller\RecommListController::saveReview

(

)

Saves user ratings and review text (oxreview object)

Returns

null

Member Data Documentation

$_aReviews

OxidEsales\EshopCommunity\Application\Controller\RecommListController::$_aReviews = null

protected

$_blRate

OxidEsales\EshopCommunity\Application\Controller\RecommListController::$_blRate = null

protected

$_dRatingValue

OxidEsales\EshopCommunity\Application\Controller\RecommListController::$_dRatingValue = null

protected

$_iRatingCnt

OxidEsales\EshopCommunity\Application\Controller\RecommListController::$_iRatingCnt = null

protected

$_oOtherRecommList

OxidEsales\EshopCommunity\Application\Controller\RecommListController::$_oOtherRecommList = null

protected

$_oPageNavigation

OxidEsales\EshopCommunity\Application\Controller\RecommListController::$_oPageNavigation = null

protected

$_oSearchRecommLists

OxidEsales\EshopCommunity\Application\Controller\RecommListController::$_oSearchRecommLists = null

protected

$_sListType

OxidEsales\EshopCommunity\Application\Controller\RecommListController::$_sListType = 'recommlist'

protected

$_sSearch

OxidEsales\EshopCommunity\Application\Controller\RecommListController::$_sSearch = null

protected

$_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\RecommListController::$_sThisTemplate = 'page/recommendations/recommlist.tpl'

protected

$_sTplLocation

OxidEsales\EshopCommunity\Application\Controller\RecommListController::$_sTplLocation = null

protected

---

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

• /oxideshop-ce/source/Application/Controller/RecommListController.php