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.

Definition at line 8 of file recommlist.php.

Public Member Functions
	render ()
	getAddUrlParams ()
	saveReview ()
	showLogin ()
	getNavigationParams ()
	getActiveRecommList ()
	getActiveRecommItems ()
	getSimilarRecommLists ()
	getRecommId ()
	getReviews ()
	isReviewActive ()
	canRate ()
	getRatingValue ()
	getRatingCount ()
	getRecommLists ()
	getRecommSearch ()
	getTemplateLocation ()
	getSearchForHtml ()
	getLoginFormAnchor ()
	getPageNavigation ()
	getAdditionalParams ()
Protected Member Functions
	_processListArticles ()
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

(

)

Collects current view data, return current template file name

Returns:

string

Reimplemented from oxUBase.

Definition at line 106 of file recommlist.php.

RecommList._processListArticles

(

)

[protected]

Iterates through list articles and performs list view specific tasks

Returns:

null

Reimplemented from oxUBase.

Definition at line 173 of file recommlist.php.

RecommList.getAddUrlParams

(

)

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

Returns:

string

Reimplemented from oxUBase.

Definition at line 188 of file recommlist.php.

RecommList.saveReview

(

)

Saves user ratings and review text (oxreview object)

Returns:

null

Definition at line 209 of file recommlist.php.

RecommList.showLogin

(

)

Show login template

Returns:

null;

Definition at line 258 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 269 of file recommlist.php.

RecommList.getActiveRecommList

(

)

Template variable getter. Returns active recommlists

Returns:

object

Reimplemented from oxUBase.

Definition at line 282 of file recommlist.php.

RecommList.getActiveRecommItems

(

)

Template variable getter. Returns active recommlist's items

Returns:

object

Definition at line 299 of file recommlist.php.

RecommList.getSimilarRecommLists

(

)

Template variable getter. Returns other recommlists

Returns:

object

Reimplemented from oxUBase.

Definition at line 330 of file recommlist.php.

RecommList.getRecommId

(

)

Template variable getter. Returns recommlist id

Returns:

string

Definition at line 351 of file recommlist.php.

RecommList.getReviews

(

)

Template variable getter. Returns recommlist's reviews

Returns:

array

Definition at line 367 of file recommlist.php.

RecommList.isReviewActive

(

)

Template variable getter. Returns if review modul is on

Returns:

bool

Definition at line 385 of file recommlist.php.

RecommList.canRate

(

)

Template variable getter. Returns if user can rate

Returns:

bool

Definition at line 402 of file recommlist.php.

RecommList.getRatingValue

(

)

Template variable getter. Returns rating value

Returns:

double

Definition at line 421 of file recommlist.php.

RecommList.getRatingCount

(

)

Template variable getter. Returns rating count

Returns:

integer

Definition at line 439 of file recommlist.php.

RecommList.getRecommLists

(

)

Template variable getter. Returns searched recommlist

Returns:

object

Definition at line 457 of file recommlist.php.

RecommList.getRecommSearch

(

)

Template variable getter. Returns search string

Returns:

string

Reimplemented from oxUBase.

Definition at line 479 of file recommlist.php.

RecommList.getTemplateLocation

(

)

Template variable getter. Returns template location

Returns:

string

Definition at line 495 of file recommlist.php.

RecommList.getSearchForHtml

(

)

Template variable getter. Returns search string

Returns:

string

Definition at line 518 of file recommlist.php.

RecommList.getLoginFormAnchor

(

)

Template variable getter. Returns search string

Returns:

string

Definition at line 528 of file recommlist.php.

RecommList.getPageNavigation

(

)

Template variable getter. Returns page navigation

Returns:

object

Definition at line 538 of file recommlist.php.

RecommList.getAdditionalParams

(

)

Template variable getter. Returns additional params for url

Returns:

string

Reimplemented from oxUBase.

Definition at line 552 of file recommlist.php.

---

Member Data Documentation

RecommList.$_sListType = 'recommlist' [protected]

Reimplemented from oxUBase.

Definition at line 14 of file recommlist.php.

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

Reimplemented from oxView.

Definition at line 20 of file recommlist.php.

RecommList.$_sRecommId = null [protected]

Definition at line 26 of file recommlist.php.

RecommList.$_oActiveRecommList = null [protected]

Definition at line 32 of file recommlist.php.

RecommList.$_oActiveRecommItems = null [protected]

Definition at line 38 of file recommlist.php.

RecommList.$_oOtherRecommList = null [protected]

Definition at line 44 of file recommlist.php.

RecommList.$_aReviews = null [protected]

Definition at line 50 of file recommlist.php.

RecommList.$_blReviewActive = null [protected]

Definition at line 56 of file recommlist.php.

RecommList.$_blRate = null [protected]

Definition at line 62 of file recommlist.php.

RecommList.$_dRatingValue = null [protected]

Definition at line 68 of file recommlist.php.

RecommList.$_iRatingCnt = null [protected]

Definition at line 74 of file recommlist.php.

RecommList.$_oSearchRecommLists = null [protected]

Definition at line 80 of file recommlist.php.

RecommList.$_sSearch = null [protected]

Definition at line 86 of file recommlist.php.

RecommList.$_sTplLocation = null [protected]

Definition at line 93 of file recommlist.php.

RecommList.$_oPageNavigation = null [protected]

Definition at line 99 of file recommlist.php.

---

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

• views/recommlist.php