Review Class Reference

Inheritance diagram for Review:

Collaboration diagram for Review:

List of all members.

Public Member Functions
	getViewId ()
	init ()
	render ()
	saveReview ()
	getReviewUser ()
	getReviewUserHash ()
	getReviewUserId ()
	getActiveRecommList ()
	canRate ()
	getReviews ()
	getRecommList ()
	getActiveRecommItems ()
	getReviewSendStatus ()
	getPageNavigation ()
	getAdditionalParams ()
	getDynUrlParams ()
Protected Member Functions
	_checkDirectReview ($sReviewUserId)
	_allowDirectReview ($sUserId)
	_getActiveObject ()
	_getActiveType ()
Protected Attributes
	$_oRevUser = null
	$_oActObject = null
	$_oActiveRecommList = null
	$_oActiveRecommItems = null
	$_blRate = null
	$_aReviews = null
	$_oCrossSelling = null
	$_oSimilarProducts = null
	$_oRecommList = null
	$_blReviewSendStatus = null
	$_oPageNavigation = null
	$_sThisTemplate = 'review.tpl'
	$_sThisLoginTemplate = 'review_login.tpl'
	$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW

---

Detailed Description

Review of chosen article. Collects article review data, saves new review to DB.

Definition at line 7 of file review.php.

---

Member Function Documentation

Review._allowDirectReview

(

$

sUserId

)

[protected]

Returns bool whether user is allowed to write review without logging in, only providing reviewuserid URL parameter.

Parameters:

string

$sUserId user id

Deprecated:

not used any more

Returns:

bool

Definition at line 247 of file review.php.

Review._checkDirectReview

(

$

sReviewUserId

)

[protected]

checks if given user id is current user, if not, cheks if given user id can use direct review

Parameters:

string

$sReviewUserId user to check

Deprecated:

not used any more

Returns:

boolean

Definition at line 232 of file review.php.

Review._getActiveObject

(

)

[protected]

Template variable getter. Returns active object (oxarticle or oxrecommlist)

Returns:

object

Definition at line 308 of file review.php.

Review._getActiveType

(

)

[protected]

Template variable getter. Returns active type (oxarticle or oxrecommlist)

Returns:

string

Definition at line 327 of file review.php.

Review.canRate

(

)

Template variable getter. Returns if user can rate

Returns:

bool

Reimplemented from Details.

Definition at line 367 of file review.php.

Review.getActiveRecommItems

(

)

Template variable getter. Returns active recommlist's items

Returns:

object

Definition at line 417 of file review.php.

Review.getActiveRecommList

(

)

Template variable getter. Returns active recommlist

Returns:

oxRecommList

Reimplemented from oxUBase.

Definition at line 343 of file review.php.

Review.getAdditionalParams

(

)

Template variable getter. Returns additional params for url

Returns:

string

Reimplemented from oxUBase.

Definition at line 474 of file review.php.

Review.getDynUrlParams

(

)

returns additional url params for dynamic url building

Returns:

string

Reimplemented from oxUBase.

Definition at line 488 of file review.php.

Review.getPageNavigation

(

)

Template variable getter. Returns page navigation

Returns:

object

Definition at line 458 of file review.php.

Review.getRecommList

(

)

Template variable getter. Returns recommlists

Returns:

object

Definition at line 400 of file review.php.

Review.getReviews

(

)

Template variable getter. Returns active object's reviews

Returns:

array

Reimplemented from Details.

Definition at line 384 of file review.php.

Review.getReviewSendStatus

(

)

Template variable getter. Returns review send status

Returns:

bool

Definition at line 448 of file review.php.

Review.getReviewUser

(

)

Returns review user object

Returns:

oxuser

Definition at line 257 of file review.php.

Review.getReviewUserHash

(

)

Template variable getter. Returns review user id

Returns:

string

Definition at line 282 of file review.php.

Review.getReviewUserId

(

)

Template variable getter. Returns review user id

Deprecated:

this getter should not be used in forms, use oxUBase.getReviewUserHash() instead

Returns:

string

Reimplemented from oxUBase.

Definition at line 294 of file review.php.

Review.getViewId

(

)

Returns prefix ID used by template engine.

Returns:

string $this->_sViewID view id

Reimplemented from Details.

Definition at line 99 of file review.php.

Review.init

(

)

Executes parent.init(), Loads user chosen product object (with all data).

Returns:

null

Reimplemented from Details.

Definition at line 109 of file review.php.

Review.render

(

)

Executes parent.render, loads article reviews and additional data (oxarticle.getReviews(), oxarticle.getCrossSelling(), oxarticle.GetSimilarProducts()). Returns name of template file to render review._sThisTemplate.

Template variables: product, reviews, crossselllist, similarlist

Returns:

string current template file name

Reimplemented from Details.

Definition at line 130 of file review.php.

Review.saveReview

(

)

Saves user review text (oxreview object)

Template variables: success

Returns:

null

Reimplemented from Details.

Definition at line 177 of file review.php.

---

Member Data Documentation

Review.$_aReviews = null [protected]

Reimplemented from Details.

Definition at line 43 of file review.php.

Review.$_blRate = null [protected]

Definition at line 37 of file review.php.

Review.$_blReviewSendStatus = null [protected]

Definition at line 67 of file review.php.

Review.$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW [protected]

Current view search engine indexing state: VIEW_INDEXSTATE_INDEX - index without limitations VIEW_INDEXSTATE_NOINDEXNOFOLLOW - no index / no follow VIEW_INDEXSTATE_NOINDEXFOLLOW - no index / follow

Reimplemented from oxUBase.

Definition at line 92 of file review.php.

Review.$_oActiveRecommItems = null [protected]

Definition at line 31 of file review.php.

Review.$_oActiveRecommList = null [protected]

Reimplemented from oxUBase.

Definition at line 25 of file review.php.

Review.$_oActObject = null [protected]

Definition at line 19 of file review.php.

Review.$_oCrossSelling = null [protected]

Reimplemented from Details.

Definition at line 49 of file review.php.

Review.$_oPageNavigation = null [protected]

Definition at line 73 of file review.php.

Review.$_oRecommList = null [protected]

Reimplemented from Details.

Definition at line 61 of file review.php.

Review.$_oRevUser = null [protected]

Definition at line 13 of file review.php.

Review.$_oSimilarProducts = null [protected]

Reimplemented from Details.

Definition at line 55 of file review.php.

Review.$_sThisLoginTemplate = 'review_login.tpl' [protected]

Definition at line 85 of file review.php.

Review.$_sThisTemplate = 'review.tpl' [protected]

Reimplemented from Details.

Definition at line 79 of file review.php.

---

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

• views/review.php