The DataObjectFactory is probably the most important class of the API. It's the main place AbstractDataObject such as Wine, Winery, Range and Owner are created. All the developper must provide is either an id or vincod and the language (ex: en,fr,de...). More...

Static Public Member Functions
static	getApikey ()
	return the apikey
static	getRangesByWineryId ($id, $language)
	return Range array that share the same WineryId
static	getRangeByVincod ($id, $language)
	return Range of the specified vincod
static	getRangesByOwnerId ($id, $language)
	return Range array that share the same OwnerId
static	getRangeById ($id, $language)
	return Range of the specified id
static	getWinesByRangeId ($id, $language)
	return Wine array that share the same RangeId
static	getWinesByWineryId ($id, $language)
	return Wine array that share the same WineryId
static	getWinesByOwnerId ($id, $language)
	return Wine array that share the same OwnerId
static	getWinesByVintageYear ($vintageYear, $language)
	return Wine array that share the same VintageYear
static	getVintagesByVintageYear ($vintageYear, $language)
	return Wine array that share the same VintageYear
static	getWineByVincod ($id, $language)
	return Wine of the specified vincod
static	getOtherVintagesByVincod ($id, $language)
	return other Wine in array for a specific vincod
static	getOtherLanguagesByVincod ($id, $language)
	return Wine into another language using a Vincod
static	getAvailableLanguagesByVincod ($id)
	return String array with available languages for a vincod
static	getWineryByRangeId ($id, $language)
	return Winery of the specified RangeId
static	getWineryByVincod ($id, $language)
	return Winery of the specified Vincod
static	getWineriesByOwnerId ($id, $language)
	return Winery array that share the same OwnerId
static	getWineryById ($id, $language)
	return Winery of the specified id
static	getOwnerByRangeId ($id, $language)
	return Owner of the specified RangeId
static	getOwnerByVincod ($id, $language)
	return Owner of the specified Vincod
static	getOwnerByWineryId ($id, $language)
	return Owner of the specified WineryId
static	getOwnerById ($id, $language)
	return Owner of the specified Id

Detailed Description

The DataObjectFactory is probably the most important class of the API. It's the main place AbstractDataObject such as Wine, Winery, Range and Owner are created. All the developper must provide is either an id or vincod and the language (ex: en,fr,de...).

Author:: Thomas

Version:: 1.0

Date:: 08/12/2011

Member Function Documentation

static getApikey ( ) [static, final]

return the apikey

Returns:: String

Definition at line 31 of file DataObjectFactory.php.

static getAvailableLanguagesByVincod ( $ id ) [static, final]

return String array with available languages for a vincod

Parameters:

id	is the vincod used to find other wines.

Returns:: String[]

Definition at line 277 of file DataObjectFactory.php.

static getOtherLanguagesByVincod	(	$	id,
		$	language
	)		`[static, final]`

return Wine into another language using a Vincod

Parameters:

id	is the vincod used to find other wines.
lang	is the language you want to get information in.

Returns:: Wine / false

Definition at line 261 of file DataObjectFactory.php.

static getOtherVintagesByVincod	(	$	id,
		$	language
	)		`[static, final]`

return other Wine in array for a specific vincod

Parameters:

id	is the vincod you want to get Vintages of.
lang	is the language you want to get information in.

Returns:: Wine[]

Definition at line 244 of file DataObjectFactory.php.

static getOwnerById	(	$	id,
		$	language
	)		`[static, final]`

return Owner of the specified Id

Parameters:

id	is the owner's id you want to get owner of.
lang	is the language you want to get information in.

Returns:: Owner / false

Definition at line 458 of file DataObjectFactory.php.

static getOwnerByRangeId	(	$	id,
		$	language
	)		`[static, final]`

return Owner of the specified RangeId

Parameters:

id	is the range's id you want to get owner of.
lang	is the language you want to get information in.

Returns:: Owner / false

Definition at line 407 of file DataObjectFactory.php.

static getOwnerByVincod	(	$	id,
		$	language
	)		`[static, final]`

return Owner of the specified Vincod

Parameters:

id	is the vincod you want to get owner of.
lang	is the language you want to get information in.

Returns:: Owner / false

Definition at line 424 of file DataObjectFactory.php.

static getOwnerByWineryId	(	$	id,
		$	language
	)		`[static, final]`

return Owner of the specified WineryId

Parameters:

id	is the winery's id you want to get owner of.
lang	is the language you want to get information in.

Returns:: Owner / false

Definition at line 441 of file DataObjectFactory.php.

static getRangeById	(	$	id,
		$	language
	)		`[static, final]`

return Range of the specified id

Parameters:

id	is the range's id you want to get range of.
lang	is the language you want to get information in.

Returns:: Range / false

Definition at line 112 of file DataObjectFactory.php.

static getRangeByVincod	(	$	id,
		$	language
	)		`[static, final]`

return Range of the specified vincod

Parameters:

id	is the vincod you want to get range of.
lang	is the language you want to get information in.

Returns:: Range / false

Definition at line 78 of file DataObjectFactory.php.

static getRangesByOwnerId	(	$	id,
		$	language
	)		`[static, final]`

return Range array that share the same OwnerId

Parameters:

id	is the owner's id you want to get ranges of.
lang	is the language you want to get information in.

Returns:: Range[]

Definition at line 95 of file DataObjectFactory.php.

static getRangesByWineryId	(	$	id,
		$	language
	)		`[static, final]`

return Range array that share the same WineryId

Parameters:

id	is the winery's id you want to get ranges of.
lang	is the language you want to get information in.

Returns:: Range[]

Definition at line 61 of file DataObjectFactory.php.

static getVintagesByVintageYear	(	$	vintageYear,
		$	language
	)		`[static, final]`

return Wine array that share the same VintageYear

Parameters:

vintageYear	is the vintage year you want to get wine of.
lang	is the language you want to get information in.

Returns:: Wine[]

Definition at line 209 of file DataObjectFactory.php.

static getWineByVincod	(	$	id,
		$	language
	)		`[static, final]`

return Wine of the specified vincod

Parameters:

id	is the vincod you want to get wine of.
lang	is the language you want to get information in.

Returns:: Wine / false

Definition at line 226 of file DataObjectFactory.php.

static getWineriesByOwnerId	(	$	id,
		$	language
	)		`[static, final]`

return Winery array that share the same OwnerId

Parameters:

id	is the owner's id you want to get winery of.
lang	is the language you want to get information in.

Returns:: Winery[]

Definition at line 354 of file DataObjectFactory.php.

static getWineryById	(	$	id,
		$	language
	)		`[static, final]`

return Winery of the specified id

Parameters:

id	is the winery's id you want to get winery of.
lang	is the language you want to get information in.

Returns:: Winery / false

Definition at line 371 of file DataObjectFactory.php.

static getWineryByRangeId	(	$	id,
		$	language
	)		`[static, final]`

return Winery of the specified RangeId

Parameters:

id	is the range's id you want to get winery of.
lang	is the language you want to get information in.

Returns:: Winery / false

Definition at line 320 of file DataObjectFactory.php.

static getWineryByVincod	(	$	id,
		$	language
	)		`[static, final]`

return Winery of the specified Vincod

Parameters:

id	is the vincod you want to get winery of.
lang	is the language you want to get information in.

Returns:: Winery / false

Definition at line 337 of file DataObjectFactory.php.

static getWinesByOwnerId	(	$	id,
		$	language
	)		`[static, final]`

return Wine array that share the same OwnerId

Parameters:

id	is the owner's id you want to get wine of.
lang	is the language you want to get information in.

Returns:: Wine[]

Definition at line 175 of file DataObjectFactory.php.

static getWinesByRangeId	(	$	id,
		$	language
	)		`[static, final]`

return Wine array that share the same RangeId

Parameters:

id	is the range's id you want to get wine of.
lang	is the language you want to get information in.

Returns:: Wine[]

Definition at line 147 of file DataObjectFactory.php.

static getWinesByVintageYear	(	$	vintageYear,
		$	language
	)		`[static, final]`

return Wine array that share the same VintageYear

Parameters:

vintageYear	is the vintage year you want to get wine of.
lang	is the language you want to get information in.

Returns:: Wine[]

Definition at line 192 of file DataObjectFactory.php.

static getWinesByWineryId	(	$	id,
		$	language
	)		`[static, final]`

return Wine array that share the same WineryId

Parameters:

id	is the winery's id you want to get wine of.
lang	is the language you want to get information in.

Returns:: Wine[]

Definition at line 158 of file DataObjectFactory.php.

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

developerApi_2.0.5/DataObjectFactory.php

Static Public Member Functions

Detailed Description

Member Function Documentation