- Developper API  2.0.5
WEObject Class Reference

The WEObject class is a data structure that contains WineEverybody's information. Those objects are usually embedded inside Wine object. More...

Public Member Functions

 __construct ($title, $url, $text, $category, $date)
 WEObject constructor.
 getTitle ()
 Returns the WEObject's title or false if empty.
 getURL ()
 Returns the WEObject's url or false if empty.
 getText ()
 Returns the WEObject's text or false if empty.
 getCategory ()
 Returns the WEObject's category or false if empty.
 getDate ()
 Returns the WEObject's date or false if empty.

Static Public Member Functions

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

Detailed Description

The WEObject class is a data structure that contains WineEverybody's information. Those objects are usually embedded inside Wine object.

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

Constructor & Destructor Documentation

__construct ( title,
url,
text,
category,
date 
)

WEObject constructor.

Parameters:
Stringtitle
Stringurl
Stringtext
Stringcategory
Stringdate
Returns:
WEObject

Definition at line 36 of file WEObject.php.


Member Function Documentation

getCategory ( ) [final]

Returns the WEObject's category or false if empty.

Returns:
String / false

Definition at line 76 of file WEObject.php.

getDate ( ) [final]

Returns the WEObject's date or false if empty.

Returns:
String / false

Definition at line 85 of file WEObject.php.

getText ( ) [final]

Returns the WEObject's text or false if empty.

Returns:
String / false

Definition at line 67 of file WEObject.php.

getTitle ( ) [final]

Returns the WEObject's title or false if empty.

Returns:
String / false

Definition at line 49 of file WEObject.php.

getURL ( ) [final]

Returns the WEObject's url or false if empty.

Returns:
String / false

Definition at line 58 of file WEObject.php.

static getWEObjectFromSXMLElement ( node) [static, final]

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

Parameters:
SimpleXmlElementnode
Returns:
WEObject / false

Definition at line 95 of file WEObject.php.

static isSXMLNodeProperty ( node) [static, final]

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

Parameters:
SimpleXmlElementnode
Returns:
Boolean

Definition at line 142 of file WEObject.php.


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