- Developper API  2.0.5
Recipe Class Reference

The Recipe class is a kind of DataStructure with a video attribute. Those objects are usually embedded inside Wine object. More...

Inheritance diagram for Recipe:
DataStructure

Public Member Functions

 __construct ($name, $type, $url, $video="")
 Recipe constructor.
 hasVideo ()
 Returns whether or not the Recipe has a video.
 getVideo ()
 Returns the recipe's video as String (HTML content) or false if empty.

Static Public Member Functions

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

Detailed Description

The Recipe class is a kind of DataStructure with a video attribute. Those objects are usually embedded inside Wine object.

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

Constructor & Destructor Documentation

__construct ( name,
type,
url,
video = "" 
)

Recipe constructor.

Parameters:
Stringname
Stringtype
Stringurl
Stringvideo
Returns:
Recipe

Definition at line 32 of file Recipe.php.


Member Function Documentation

static getRecipeFromSXMLElement ( node) [static, final]

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

Parameters:
SimpleXmlElementnode
Returns:
Recipe / false

Definition at line 61 of file Recipe.php.

getVideo ( ) [final]

Returns the recipe's video as String (HTML content) or false if empty.

Returns:
String / false

Definition at line 51 of file Recipe.php.

hasVideo ( ) [final]

Returns whether or not the Recipe has a video.

Returns:
Boolean

Definition at line 42 of file Recipe.php.

static isSXMLNodeProperty ( node) [static, final]

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

Parameters:
SimpleXmlElementnode
Returns:
Boolean

Definition at line 103 of file Recipe.php.


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