A Wine is an AbstractDataObject. It contains all information about a single wine. Mostly made up of properties and DataStructure objects (Media, Shop, Recipe) and others such as Review, Variety, VintageProperty and WEObject. It s also possible to get other AbstractDataObject (Owner, Winery, Range) concerning the Wine. More...

Inheritance diagram for Wine:

Public Member Functions
	__construct ($id, $type, $xmlObject, $language)
	Wine constructor.
	getDateUpdate ()
	Return the last update date as Property object.
	getVincod ()
	Return the vincod as Property object.
	getVincodPerso ()
	Return the vincodperso as Property object.
	getAbsoluteVincod ()
	Return either vincodperso if not empty or vincod.
	getAbstract ()
	Return the abstract (short wine description) as Property object.
	getName ()
	Return the name as Property object.
	getVintageYear ()
	Return the vintage year as Property object.
	getPicture ()
	Return the picture as Property object.
	getTag ()
	Return the tag as Property object.
	getMore ()
	Return the "more" as Property object.
	getWineType ()
	Return the wine type as Property object.
	getAppellation ()
	Return the appellation as Property object.
	getAdvice ()
	Return the advice as Property Array.
	getPresentation ()
	Return the presentation as Property Array.
	getSpecifications ()
	Return the specifications as Property Array.
	isVintage ()
	Return whether or not the wine is a Vintage.
	getVintageProperty ()
	Return the Vintage property or false if not a Vintage.
	getReviews ()
	Return the Reviews.
	getGrapesVarieties ()
	Return the Varieties.
	getMedias ()
	Return the Medias.
	getRecipes ()
	Return the Recipes.
	getShops ()
	Return the Shops.
	getWES ()
	Return the WEs.
	getOwner ()
	Return the wine's owner as Owner object or false if Owner cannot be instanciated.
	getWinery ()
	Return the wine's winery as Winery object or false if Winery cannot be instanciated.
	getRange ()
	Return the wine's range as Range object or false if Range cannot be instanciated.
	getOtherVintages ()
	Return other vintages as Wine array.
	getOtherLanguage ($lang)
	Return other wine in other language or false if queried language not valid.
	getAvailableLanguages ()
	Return all available languages for the wine.
Protected Member Functions
	isCustomProperties ($propertyName)
	Must be implemented in subclasses and is used to know whether a property is custom or defined.

Detailed Description

A Wine is an AbstractDataObject. It contains all information about a single wine. Mostly made up of properties and DataStructure objects (Media, Shop, Recipe) and others such as Review, Variety, VintageProperty and WEObject. It s also possible to get other AbstractDataObject (Owner, Winery, Range) concerning the Wine.

Author:: Thomas

Version:: 1.0

Date:: 08/12/2011

Constructor & Destructor Documentation

__construct	(	$	id,
		$	type,
		$	xmlObject,
		$	language
	)

Wine constructor.

Parameters:

String	id is what will be used to identify the object and query other objects.
TYPE	type relates to the pseudo-enum TYPE from AbstractDataObject and refer to the object type.
SimpleXMLElement	xmlObject represents the object on which queries will be done.
String	language is the language in which the first query has been done.

Returns:: Wine

Reimplemented from AbstractDataObject.

Definition at line 52 of file Wine.php.

Member Function Documentation

getAbsoluteVincod ( ) [final]

Return either vincodperso if not empty or vincod.

Returns:: Property / false

Definition at line 110 of file Wine.php.

getAbstract ( ) [final]

Return the abstract (short wine description) as Property object.

Returns:: Property / false

Definition at line 129 of file Wine.php.

getAdvice ( ) [final]

Return the advice as Property Array.

Returns:: Property[]

Definition at line 177 of file Wine.php.

getAppellation ( ) [final]

Return the appellation as Property object.

Returns:: Property / false

Definition at line 171 of file Wine.php.

getAvailableLanguages ( ) [final]

Return all available languages for the wine.

Returns:: String[]

Definition at line 518 of file Wine.php.

getDateUpdate ( ) [final]

Return the last update date as Property object.

Returns:: Property / false

Definition at line 92 of file Wine.php.

getGrapesVarieties ( ) [final]

Return the Varieties.

Returns:: Variety[]

Definition at line 272 of file Wine.php.

getMedias ( ) [final]

Return the Medias.

Returns:: Media[]

Definition at line 308 of file Wine.php.

getMore ( ) [final]

Return the "more" as Property object.

Returns:: Property / false

Definition at line 159 of file Wine.php.

getName ( ) [final]

Return the name as Property object.

Returns:: Property / false

Definition at line 135 of file Wine.php.

getOtherLanguage ( $ lang ) [final]

Return other wine in other language or false if queried language not valid.

Returns:: Wine / false

Definition at line 504 of file Wine.php.

getOtherVintages ( ) [final]

Return other vintages as Wine array.

Returns:: Wine[]

Definition at line 491 of file Wine.php.

getOwner ( ) [final]

Return the wine's owner as Owner object or false if Owner cannot be instanciated.

Returns:: Owner / false

Definition at line 452 of file Wine.php.

getPicture ( ) [final]

Return the picture as Property object.

Returns:: Property / false

Definition at line 147 of file Wine.php.

getPresentation ( ) [final]

Return the presentation as Property Array.

Returns:: Property[]

Definition at line 183 of file Wine.php.

getRange ( ) [final]

Return the wine's range as Range object or false if Range cannot be instanciated.

Returns:: Range / false

Definition at line 478 of file Wine.php.

getRecipes ( ) [final]

Return the Recipes.

Returns:: Recipe[]

Definition at line 344 of file Wine.php.

getReviews ( ) [final]

Return the Reviews.

Returns:: Review[]

Definition at line 236 of file Wine.php.

getShops ( ) [final]

Return the Shops.

Returns:: Shop[]

Definition at line 380 of file Wine.php.

getSpecifications ( ) [final]

Return the specifications as Property Array.

Returns:: Property[]

Definition at line 189 of file Wine.php.

getTag ( ) [final]

Return the tag as Property object.

Returns:: Property / false

Definition at line 153 of file Wine.php.

getVincod ( ) [final]

Return the vincod as Property object.

Returns:: Property / false

Definition at line 98 of file Wine.php.

getVincodPerso ( ) [final]

Return the vincodperso as Property object.

Returns:: Property / false

Definition at line 104 of file Wine.php.

getVintageProperty ( ) [final]

Return the Vintage property or false if not a Vintage.

Returns:: VintageProperty / false

Definition at line 201 of file Wine.php.

getVintageYear ( ) [final]

Return the vintage year as Property object.

Returns:: Property / false

Definition at line 141 of file Wine.php.

getWES ( ) [final]

Return the WEs.

Returns:: WE[]

Definition at line 416 of file Wine.php.

getWinery ( ) [final]

Return the wine's winery as Winery object or false if Winery cannot be instanciated.

Returns:: Winery / false

Definition at line 465 of file Wine.php.

getWineType ( ) [final]

Return the wine type as Property object.

Returns:: Property / false

Definition at line 165 of file Wine.php.

isCustomProperties ( $ label ) [protected]

Must be implemented in subclasses and is used to know whether a property is custom or defined.

Returns:: Boolean

Reimplemented from AbstractDataObject.

Definition at line 59 of file Wine.php.

isVintage ( ) [final]

Return whether or not the wine is a Vintage.

Returns:: Boolean

Definition at line 195 of file Wine.php.

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

developerApi_2.0.5/Wine.php

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation