RecommList Class Reference

Inheritance diagram for RecommList:

Collaboration diagram for RecommList:

List of all members.

Public Member Functions
	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.

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	$sUrl url to append page numbers
	int	$iPage current page number
	int	$iLang requested 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

$iLang requested 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.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]

Reimplemented from aList.

Definition at line 86 of file recommlist.php.

RecommList.$_oSearchRecommLists = null [protected]

Definition at line 65 of file recommlist.php.

RecommList.$_sListType = 'recommlist' [protected]

Reimplemented from oxUBase.

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]

Reimplemented from aList.

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:

• application/controllers/recommlist.php