RecommList Class Reference

Inheritance diagram for RecommList:

Collaboration diagram for RecommList:

List of all members.

Public Member Functions
	render ()
	getAddUrlParams ()
	getAddSeoUrlParams ()
	saveReview ()
	showLogin ()
	getNavigationParams ()
	getActiveRecommItems ()
	getArticleList ()
	getSimilarRecommLists ()
	getRecommId ()
	getReviews ()
	isReviewActive ()
	canRate ()
	getRatingValue ()
	getRatingCount ()
	getRecommLists ()
	getRecommSearch ()
	getTemplateLocation ()
	getTreePath ()
	getSearchForHtml ()
	getLoginFormAnchor ()
	generatePageNavigationUrl ()
	getAdditionalParams ()
	getLink ($iLang=null)
Protected Member Functions
	_getProductLinkType ()
	_addPageNrParam ($sUrl, $iPage, $iLang=null)
Protected Attributes
	$_sListType = 'recommlist'
	$_sThisTemplate = '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 533 of file recommlist.php.

RecommList._getProductLinkType

(

)

[protected]

Returns product link type (OXARTICLE_LINKTYPE_RECOMM)

Returns:

int

Reimplemented from aList.

Definition at line 147 of file recommlist.php.

RecommList.canRate

(

)

Template variable getter. Returns if user can rate

Returns:

bool

Definition at line 354 of file recommlist.php.

RecommList.generatePageNavigationUrl

(

)

Generates Url for page navigation

Returns:

string

Reimplemented from aList.

Definition at line 514 of file recommlist.php.

RecommList.getActiveRecommItems

(

)

Template variable getter. Returns active recommlist's items

Deprecated:

use recommlist.getArticleList() instead

Returns:

object

Definition at line 257 of file recommlist.php.

RecommList.getAdditionalParams

(

)

Template variable getter. Returns additional params for url

Returns:

string

Reimplemented from oxUBase.

Definition at line 551 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 174 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 157 of file recommlist.php.

RecommList.getArticleList

(

)

Template variable getter. Returns category's article list

Returns:

array

Reimplemented from aList.

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

RecommList.getLoginFormAnchor

(

)

Template variable getter. Returns search string

Returns:

string

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

RecommList.getRatingCount

(

)

Template variable getter. Returns rating count

Returns:

integer

Definition at line 387 of file recommlist.php.

RecommList.getRatingValue

(

)

Template variable getter. Returns rating value

Returns:

double

Definition at line 371 of file recommlist.php.

RecommList.getRecommId

(

)

Template variable getter. Returns recommlist id

Deprecated:

use oxUBase.getActiveRecommList()->getId()

Returns:

string

Definition at line 318 of file recommlist.php.

RecommList.getRecommLists

(

)

Template variable getter. Returns searched recommlist

Returns:

object

Definition at line 403 of file recommlist.php.

RecommList.getRecommSearch

(

)

Template variable getter. Returns search string

Returns:

string

Reimplemented from oxUBase.

Definition at line 424 of file recommlist.php.

RecommList.getReviews

(

)

Template variable getter. Returns recommlist's reviews

Returns:

array

Definition at line 328 of file recommlist.php.

RecommList.getSearchForHtml

(

)

Template variable getter. Returns search string

Returns:

string

Definition at line 490 of file recommlist.php.

RecommList.getSimilarRecommLists

(

)

Template variable getter. Returns other recommlists

Returns:

object

Reimplemented from aList.

Definition at line 297 of file recommlist.php.

RecommList.getTemplateLocation

(

)

Template variable getter. Returns template location

Deprecated:

use recommList.getTreePath() and adjust template

Returns:

string

Reimplemented from aList.

Definition at line 442 of file recommlist.php.

RecommList.getTreePath

(

)

Template variable getter. Returns category path array

Returns:

array

Reimplemented from aList.

Definition at line 465 of file recommlist.php.

RecommList.isReviewActive

(

)

Template variable getter. Returns if review modul is on

Returns:

bool

Definition at line 344 of file recommlist.php.

RecommList.render

(

)

Collects current view data, return current template file name

Returns:

string

Reimplemented from aList.

Definition at line 82 of file recommlist.php.

RecommList.saveReview

(

)

Saves user ratings and review text (oxreview object)

Returns:

null

Definition at line 188 of file recommlist.php.

RecommList.showLogin

(

)

Show login template

Deprecated:

use link to account page instead (e.g. "cl=account&sourcecl=recommlist"+required parameters)

Returns:

null;

Definition at line 231 of file recommlist.php.

---

Member Data Documentation

RecommList.$_aReviews = null [protected]

Definition at line 32 of file recommlist.php.

RecommList.$_blRate = null [protected]

Definition at line 38 of file recommlist.php.

RecommList.$_dRatingValue = null [protected]

Definition at line 44 of file recommlist.php.

RecommList.$_iRatingCnt = null [protected]

Definition at line 50 of file recommlist.php.

RecommList.$_oOtherRecommList = null [protected]

Definition at line 26 of file recommlist.php.

RecommList.$_oPageNavigation = null [protected]

Reimplemented from aList.

Definition at line 75 of file recommlist.php.

RecommList.$_oSearchRecommLists = null [protected]

Definition at line 56 of file recommlist.php.

RecommList.$_sListType = 'recommlist' [protected]

Reimplemented from oxUBase.

Definition at line 14 of file recommlist.php.

RecommList.$_sSearch = null [protected]

Definition at line 62 of file recommlist.php.

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

Reimplemented from aList.

Definition at line 20 of file recommlist.php.

RecommList.$_sTplLocation = null [protected]

Definition at line 69 of file recommlist.php.

---

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

• views/recommlist.php