Review Class Reference

Inheritance diagram for Review:
[legend]
Collaboration diagram for Review:
[legend]

List of all members.


Detailed Description

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

Definition at line 7 of file review.php.


Public Member Functions

 init ()
 render ()
 saveReview ()
 getReviewUserId ()
 getProduct ()
 getActiveRecommList ()
 canRate ()
 getReviews ()
 getCrossSelling ()
 getSimilarProducts ()
 getRecommList ()
 getActiveRecommItems ()
 getReviewSendStatus ()
 getPageNavigation ()

Protected Member Functions

 _checkDirectReview ($sReviewUserId)
 _allowDirectReview ($sUserId)
 _getActiveObject ()
 _getActiveType ()

Protected Attributes

 $_sReviewUserId = 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 = 1

Member Function Documentation

Review.init (  ) 

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

Returns:
null

Reimplemented from oxUBase.

Definition at line 100 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 oxUBase.

Definition at line 125 of file review.php.

Review.saveReview (  ) 

Saves user review text (oxreview object)

Template variables: success

Returns:
null

Definition at line 179 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
Returns:
boolean

Definition at line 238 of file review.php.

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
Returns:
bool

Definition at line 257 of file review.php.

Review.getReviewUserId (  ) 

Template variable getter. Returns review user id

Returns:
string

Reimplemented from oxView.

Definition at line 276 of file review.php.

Review.getProduct (  ) 

Template variable getter. Returns search product

Returns:
object

Reimplemented from oxUBase.

Definition at line 296 of file review.php.

Review._getActiveObject (  )  [protected]

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

Returns:
object

Definition at line 313 of file review.php.

Review._getActiveType (  )  [protected]

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

Returns:
string

Definition at line 332 of file review.php.

Review.getActiveRecommList (  ) 

Template variable getter. Returns active recommlist

Returns:
object

Reimplemented from oxView.

Definition at line 347 of file review.php.

Review.canRate (  ) 

Template variable getter. Returns if user can rate

Returns:
bool

Definition at line 367 of file review.php.

Review.getReviews (  ) 

Template variable getter. Returns active object's reviews

Returns:
array

Definition at line 385 of file review.php.

Review.getCrossSelling (  ) 

Template variable getter. Returns crosssellings

Returns:
object

Reimplemented from oxView.

Definition at line 401 of file review.php.

Review.getSimilarProducts (  ) 

Template variable getter. Returns similar products

Returns:
object

Reimplemented from oxView.

Definition at line 417 of file review.php.

Review.getRecommList (  ) 

Template variable getter. Returns recommlists

Returns:
object

Definition at line 433 of file review.php.

Review.getActiveRecommItems (  ) 

Template variable getter. Returns active recommlist's items

Returns:
object

Definition at line 450 of file review.php.

Review.getReviewSendStatus (  ) 

Template variable getter. Returns review send status

Returns:
bool

Definition at line 481 of file review.php.

Review.getPageNavigation (  ) 

Template variable getter. Returns page navigation

Returns:
object

Definition at line 491 of file review.php.


Member Data Documentation

Review.$_sReviewUserId = null [protected]

Definition at line 13 of file review.php.

Review.$_oActObject = null [protected]

Definition at line 19 of file review.php.

Review.$_oActiveRecommList = null [protected]

Definition at line 25 of file review.php.

Review.$_oActiveRecommItems = null [protected]

Definition at line 31 of file review.php.

Review.$_blRate = null [protected]

Definition at line 37 of file review.php.

Review.$_aReviews = null [protected]

Definition at line 43 of file review.php.

Review.$_oCrossSelling = null [protected]

Definition at line 49 of file review.php.

Review.$_oSimilarProducts = null [protected]

Definition at line 55 of file review.php.

Review.$_oRecommList = null [protected]

Definition at line 61 of file review.php.

Review.$_blReviewSendStatus = null [protected]

Definition at line 67 of file review.php.

Review.$_oPageNavigation = null [protected]

Definition at line 73 of file review.php.

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

Reimplemented from oxView.

Definition at line 79 of file review.php.

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

Definition at line 85 of file review.php.

Review.$_iViewIndexState = 1 [protected]

Current view search engine indexing state: 0 - index without limitations 1 - no index / no follow 2 - no index / follow

Reimplemented from oxView.

Definition at line 93 of file review.php.


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

Generated on Thu Dec 4 12:05:40 2008 for OXID eShop CE by  doxygen 1.5.5