- Developper API  2.0.5
Review Class Reference

The Review is a data structure that embed information about a review (author, source content...). Those objects are usually embedded inside Wine object. More...

Public Member Functions

 __construct ($author, $source, $content, $mark, $date, $url)
 Review constructor.
 getAuthor ()
 returns the review's author.
 getSource ()
 returns the review's source.
 getContent ()
 returns the review's content.
 getMark ()
 returns the review's mark.
 getDate ()
 returns the review's publication date.
 getUrl ()
 returns the review's url.

Static Public Member Functions

static getReviewFromSXMLElement ($node)
 Build a Review object from a SimpleXMLElement node. It may return false if the node doesn t contain a review.
static isSXMLNodeProperty ($node)
 Check whether a node is acceptable to get a Review from.

Detailed Description

The Review is a data structure that embed information about a review (author, source content...). Those objects are usually embedded inside Wine object.

Author:
Thomas
Version:
1.0
Date:
08/12/2011

Constructor & Destructor Documentation

__construct ( author,
source,
content,
mark,
date,
url 
)

Review constructor.

Parameters:
Stringauthor
Stringsource
Stringcontent
Stringmark
Stringdate
Stringurl
Returns:
Review

Definition at line 39 of file Review.php.


Member Function Documentation

getAuthor ( ) [final]

returns the review's author.

Returns:
String / false

Definition at line 53 of file Review.php.

getContent ( ) [final]

returns the review's content.

Returns:
String / false

Definition at line 71 of file Review.php.

getDate ( ) [final]

returns the review's publication date.

Returns:
String / false

Definition at line 89 of file Review.php.

getMark ( ) [final]

returns the review's mark.

Returns:
String / false

Definition at line 80 of file Review.php.

static getReviewFromSXMLElement ( node) [static, final]

Build a Review object from a SimpleXMLElement node. It may return false if the node doesn t contain a review.

Parameters:
SimpleXmlElementnode
Returns:
Review / false

Definition at line 108 of file Review.php.

getSource ( ) [final]

returns the review's source.

Returns:
String / false

Definition at line 62 of file Review.php.

getUrl ( ) [final]

returns the review's url.

Returns:
String / false

Definition at line 98 of file Review.php.

static isSXMLNodeProperty ( node) [static, final]

Check whether a node is acceptable to get a Review from.

Parameters:
SimpleXmlElementnode
Returns:
Boolean

Definition at line 161 of file Review.php.


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