Variety Class Reference

The Variety class is a data structure that contains information about variety of grape (or "cepage" in french). Those objects are usually embedded inside Wine object. More...

Public Member Functions
	__construct ($name, $amount)
	Variety constructor.
	getName ()
	Returns the variety's name or false if empty.
	getAmount ()
	Returns the variety's amount or false if empty.
Static Public Member Functions
static	getVarietyFromSXMLElement ($node)
	Build a Variety object from a SimpleXMLElement node. It may return false if the node doesn t contain a variety.
static	isSXMLNodeProperty ($node)
	Check whether a node is acceptable to get a Variety from.

---

Detailed Description

The Variety class is a data structure that contains information about variety of grape (or "cepage" in french). Those objects are usually embedded inside Wine object.

Author:

Thomas

Version:

1.0

Date:

08/12/2011

---

Constructor & Destructor Documentation

__construct	(	$	name,
		$	amount
	)

Variety constructor.

Parameters:

String	name
String	amount

Returns:

Variety

Definition at line 27 of file Variety.php.

---

Member Function Documentation

getAmount

(

)

Returns the variety's amount or false if empty.

Returns:

String / false

Definition at line 46 of file Variety.php.

getName

(

)

Returns the variety's name or false if empty.

Returns:

String / false

Definition at line 37 of file Variety.php.

static getVarietyFromSXMLElement

(

$

node

)

[static, final]

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

Parameters:

SimpleXmlElement

node

Returns:

Variety / false

Definition at line 56 of file Variety.php.

static isSXMLNodeProperty

(

$

node

)

[static, final]

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

Parameters:

SimpleXmlElement

node

Returns:

Boolean

Definition at line 86 of file Variety.php.

---

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

• developerApi_2.0.5/Variety.php