RecommList Class Reference

Inheritance diagram for RecommList:

[legend]

Collaboration diagram for RecommList:

[legend]

List of all members.

---

Detailed Description

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

Public Member Functions
	render ()
	getAddUrlParams ()
	saveReview ()
	showLogin ()
	getActiveRecommList ()
	getActiveRecommItems ()
	getSimilarRecommLists ()
	getRecommId ()
	getReviews ()
	isReviewActive ()
	canRate ()
	getRatingValue ()
	getRatingCount ()
	getRecommLists ()
	getRecommSearch ()
	getTemplateLocation ()
	getSearchForHtml ()
	getLoginFormAnchor ()
	getPageNavigation ()
Protected Member Functions
	_processListArticles ()
	_getNavigationParams ()
Protected Attributes
	$_sListType = 'recommlist'
	$_sThisTemplate = 'recommlist.tpl'
	$_sRecommId = null
	$_oActiveRecommList = null
	$_oActiveRecommItems = null
	$_oOtherRecommList = null
	$_aReviews = null
	$_blReviewActive = null
	$_blRate = null
	$_dRatingValue = null
	$_iRatingCnt = null
	$_oSearchRecommLists = null
	$_sSearch = null
	$_sTplLocation = null
	$_oPageNavigation = null

---

Member Function Documentation

RecommList.render

(

)

Returns:

string current template file name

Reimplemented from oxUBase.

RecommList._processListArticles

(

)

[protected]

Iterates through list articles and performs list view specific tasks

Returns:

null

Reimplemented from oxUBase.

RecommList.getAddUrlParams

(

)

Returns additional URL paramerets which must be added to list products urls

Returns:

string

Reimplemented from oxUBase.

RecommList.saveReview

(

)

Saves user ratings and review text (oxreview object)

Returns:

null

RecommList.showLogin

(

)

Show login template

Returns:

null;

RecommList._getNavigationParams

(

)

[protected]

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

Returns:

array

Reimplemented from oxView.

RecommList.getActiveRecommList

(

)

Template variable getter. Returns active recommlists

Returns:

object

Reimplemented from oxView.

RecommList.getActiveRecommItems

(

)

Template variable getter. Returns active recommlist's items

Returns:

object

RecommList.getSimilarRecommLists

(

)

Template variable getter. Returns other recommlists

Returns:

object

Reimplemented from oxView.

RecommList.getRecommId

(

)

Template variable getter. Returns recommlist id

Returns:

string

RecommList.getReviews

(

)

Template variable getter. Returns recommlist's reviews

Returns:

array

RecommList.isReviewActive

(

)

Template variable getter. Returns if review modul is on

Returns:

bool

RecommList.canRate

(

)

Template variable getter. Returns if user can rate

Returns:

bool

RecommList.getRatingValue

(

)

Template variable getter. Returns rating value

Returns:

double

RecommList.getRatingCount

(

)

Template variable getter. Returns rating count

Returns:

integer

RecommList.getRecommLists

(

)

Template variable getter. Returns searched recommlist

Returns:

object

RecommList.getRecommSearch

(

)

Template variable getter. Returns search string

Returns:

string

Reimplemented from oxView.

RecommList.getTemplateLocation

(

)

Template variable getter. Returns template location

Returns:

string

RecommList.getSearchForHtml

(

)

Template variable getter. Returns search string

Returns:

string

RecommList.getLoginFormAnchor

(

)

Template variable getter. Returns search string

Returns:

string

RecommList.getPageNavigation

(

)

Template variable getter. Returns page navigation

Returns:

object

---

Member Data Documentation

RecommList.$_sListType = 'recommlist' [protected]

Reimplemented from oxView.

RecommList.$_sThisTemplate = 'recommlist.tpl' [protected]

Reimplemented from oxView.

RecommList.$_sRecommId = null [protected]

RecommList.$_oActiveRecommList = null [protected]

RecommList.$_oActiveRecommItems = null [protected]

RecommList.$_oOtherRecommList = null [protected]

RecommList.$_aReviews = null [protected]

RecommList.$_blReviewActive = null [protected]

RecommList.$_blRate = null [protected]

RecommList.$_dRatingValue = null [protected]

RecommList.$_iRatingCnt = null [protected]

RecommList.$_oSearchRecommLists = null [protected]

RecommList.$_sSearch = null [protected]

RecommList.$_sTplLocation = null [protected]

RecommList.$_oPageNavigation = null [protected]

---

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

• views/recommlist.php