Overview

Namespaces

  • BeerXML
    • Exception
    • Generator
    • Parser
    • Record
  • PHP

Classes

  • Equipment
  • Fermentable
  • Hop
  • MashProfile
  • MashStep
  • Misc
  • Recipe
  • Style
  • Water
  • Yeast
  • Overview
  • Namespace
  • Class
  • Tree

Class Recipe

Interface for classes that want to implement the optional display properties from the appendix of the specification

BeerXML\Record\Recipe implements BeerXML\Generator\IRecipeDisplay, BeerXML\Parser\IRecipeDisplay
Namespace: BeerXML\Record
Package: BeerXML\Generator
Located at BeerXML/Record/Recipe.php
Methods summary
public number
# getAge( )

Returns

number

Implementation of

BeerXML\Generator\IRecipe::getAge()
public
# setAge( number $age )

Parameters

$age
number
$age

Implementation of

BeerXML\Parser\IRecipe::setAge()
public number
# getAgeTemp( )

Returns

number

Implementation of

BeerXML\Generator\IRecipe::getAgeTemp()
public
# setAgeTemp( number $ageTemp )

Parameters

$ageTemp
number
$ageTemp

Implementation of

BeerXML\Parser\IRecipe::setAgeTemp()
public string
# getAsstBrewer( )

Returns

string

Implementation of

BeerXML\Generator\IRecipe::getAsstBrewer()
public
# setAsstBrewer( string $asstBrewer )

Parameters

$asstBrewer
string
$asstBrewer

Implementation of

BeerXML\Parser\IRecipe::setAsstBrewer()
public float
# getBatchSize( )

Returns

float

Implementation of

BeerXML\Generator\IRecipe::getBatchSize()
public
# setBatchSize( float $batchSize )

Parameters

$batchSize
float
$batchSize

Implementation of

BeerXML\Parser\IRecipe::setBatchSize()
public float
# getBoilSize( )

Returns

float

Implementation of

BeerXML\Generator\IRecipe::getBoilSize()
public
# setBoilSize( float $boilSize )

Parameters

$boilSize
float
$boilSize

Implementation of

BeerXML\Parser\IRecipe::setBoilSize()
public number
# getBoilTime( )

Returns

number

Implementation of

BeerXML\Generator\IRecipe::getBoilTime()
public
# setBoilTime( number $boilTime )

Parameters

$boilTime
number
$boilTime

Implementation of

BeerXML\Parser\IRecipe::setBoilTime()
public string
# getBrewer( )

Returns

string

Implementation of

BeerXML\Generator\IRecipe::getBrewer()
public
# setBrewer( string $brewer )

Parameters

$brewer
string
$brewer

Implementation of

BeerXML\Parser\IRecipe::setBrewer()
public float
# getCarbonation( )

Returns

float

Implementation of

BeerXML\Generator\IRecipe::getCarbonation()
public
# setCarbonation( float $carbonation )

Parameters

$carbonation
float
$carbonation

Implementation of

BeerXML\Parser\IRecipe::setCarbonation()
public number
# getCarbonationTemp( )

Returns

number

Implementation of

BeerXML\Generator\IRecipe::getCarbonationTemp()
public
# setCarbonationTemp( number $carbonationTemp )

Parameters

$carbonationTemp
number
$carbonationTemp

Implementation of

BeerXML\Parser\IRecipe::setCarbonationTemp()
public DateTime
# getDate( )

Returns

DateTime

Implementation of

BeerXML\Generator\IRecipe::getDate()
public
# setDate( DateTime $date )

Parameters

$date
DateTime
$date

Implementation of

BeerXML\Parser\IRecipe::setDate()
public float
# getEfficiency( )

Returns

float

Implementation of

BeerXML\Generator\IRecipe::getEfficiency()
public
# setEfficiency( float $efficiency )

Parameters

$efficiency
float
$efficiency

Implementation of

BeerXML\Parser\IRecipe::setEfficiency()
public BeerXML\Record\Equipment
# getEquipment( )

Returns

BeerXML\Record\Equipment

Implementation of

BeerXML\Generator\IRecipe::getEquipment()
public
# setEquipment( BeerXML\Record\Equipment $equipment )

Parameters

$equipment
BeerXML\Record\Equipment
$equipment

Implementation of

BeerXML\Parser\IRecipe::setEquipment()
public BeerXML\Record\Fermentable[]
# getFermentables( )

Returns

BeerXML\Record\Fermentable[]

Implementation of

BeerXML\Generator\IRecipe::getFermentables()
public
# addFermentable( BeerXML\Record\Fermentable $fermentable )

Parameters

$fermentable
BeerXML\Record\Fermentable
$fermentable

Implementation of

BeerXML\Parser\IRecipe::addFermentable()
public integer
# getFermentationStages( )

Returns

integer

Implementation of

BeerXML\Generator\IRecipe::getFermentationStages()
public
# setFermentationStages( integer $fermentationStages )

Parameters

$fermentationStages
integer
$fermentationStages

Implementation of

BeerXML\Parser\IRecipe::setFermentationStages()
public float
# getFg( )

Returns

float

Implementation of

BeerXML\Generator\IRecipe::getFg()
public
# setFg( float $fg )

Parameters

$fg
float
$fg

Implementation of

BeerXML\Parser\IRecipe::setFg()
public boolean
# getForcedCarbonation( )

Returns

boolean

Implementation of

BeerXML\Generator\IRecipe::getForcedCarbonation()
public
# setForcedCarbonation( boolean $forcedCarbonation )

Parameters

$forcedCarbonation
boolean
$forcedCarbonation

Implementation of

BeerXML\Parser\IRecipe::setForcedCarbonation()
public BeerXML\Record\Hop[]
# getHops( )

Returns

BeerXML\Record\Hop[]

Implementation of

BeerXML\Generator\IRecipe::getHops()
public
# addHop( BeerXML\Record\Hop $hop )

Parameters

$hop
BeerXML\Record\Hop
$hop

Implementation of

BeerXML\Parser\IRecipe::addHop()
public float
# getKegPrimingFactor( )

Returns

float

Implementation of

BeerXML\Generator\IRecipe::getKegPrimingFactor()
public
# setKegPrimingFactor( float $kegPrimingFactor )

Parameters

$kegPrimingFactor
float
$kegPrimingFactor

Implementation of

BeerXML\Parser\IRecipe::setKegPrimingFactor()
public BeerXML\Record\MashProfile
# getMash( )

Returns

BeerXML\Record\MashProfile

Implementation of

BeerXML\Generator\IRecipe::getMash()
public
# setMash( BeerXML\Record\MashProfile $mash )

Parameters

$mash
BeerXML\Record\MashProfile
$mash

Implementation of

BeerXML\Parser\IRecipe::setMash()
public array
# getMiscs( )

Returns

array

Implementation of

BeerXML\Generator\IRecipe::getMiscs()
public
# addMisc( BeerXML\Record\Misc $misc )

Parameters

$misc
BeerXML\Record\Misc

Implementation of

BeerXML\Parser\IRecipe::addMisc()
public string
# getName( )

Returns

string

Implementation of

BeerXML\Generator\IRecipe::getName()
public
# setName( string $name )

Parameters

$name
string
$name

Implementation of

BeerXML\Parser\IRecipe::setName()
public string
# getNotes( )

Returns

string

Implementation of

BeerXML\Generator\IRecipe::getNotes()
public
# setNotes( string $notes )

Parameters

$notes
string
$notes

Implementation of

BeerXML\Parser\IRecipe::setNotes()
public float
# getOg( )

Returns

float

Implementation of

BeerXML\Generator\IRecipe::getOg()
public
# setOg( float $og )

Parameters

$og
float
$og

Implementation of

BeerXML\Parser\IRecipe::setOg()
public number
# getPrimaryAge( )

Returns

number

Implementation of

BeerXML\Generator\IRecipe::getPrimaryAge()
public
# setPrimaryAge( number $primaryAge )

Parameters

$primaryAge
number
$primaryAge

Implementation of

BeerXML\Parser\IRecipe::setPrimaryAge()
public number
# getPrimaryTemp( )

Returns

number

Implementation of

BeerXML\Generator\IRecipe::getPrimaryTemp()
public
# setPrimaryTemp( number $primaryTemp )

Parameters

$primaryTemp
number
$primaryTemp

Implementation of

BeerXML\Parser\IRecipe::setPrimaryTemp()
public float
# getPrimingSugarEquiv( )

Returns

float

Implementation of

BeerXML\Generator\IRecipe::getPrimingSugarEquiv()
public
# setPrimingSugarEquiv( float $primingSugarEquiv )

Parameters

$primingSugarEquiv
float
$primingSugarEquiv

Implementation of

BeerXML\Parser\IRecipe::setPrimingSugarEquiv()
public string
# getPrimingSugarName( )

Returns

string

Implementation of

BeerXML\Generator\IRecipe::getPrimingSugarName()
public
# setPrimingSugarName( string $primingSugarName )

Parameters

$primingSugarName
string
$primingSugarName

Implementation of

BeerXML\Parser\IRecipe::setPrimingSugarName()
public number
# getSecondaryAge( )

Returns

number

Implementation of

BeerXML\Generator\IRecipe::getSecondaryAge()
public
# setSecondaryAge( number $secondaryAge )

Parameters

$secondaryAge
number
$secondaryAge

Implementation of

BeerXML\Parser\IRecipe::setSecondaryAge()
public number
# getSecondaryTemp( )

Returns

number

Implementation of

BeerXML\Generator\IRecipe::getSecondaryTemp()
public
# setSecondaryTemp( number $secondaryTemp )

Parameters

$secondaryTemp
number
$secondaryTemp

Implementation of

BeerXML\Parser\IRecipe::setSecondaryTemp()
public BeerXML\Record\Style
# getStyle( )

Returns

BeerXML\Record\Style

Implementation of

BeerXML\Generator\IRecipe::getStyle()
public
# setStyle( BeerXML\Record\Style $style )

Parameters

$style
BeerXML\Record\Style
$style

Implementation of

BeerXML\Parser\IRecipe::setStyle()
public string
# getTasteNotes( )

Returns

string

Implementation of

BeerXML\Generator\IRecipe::getTasteNotes()
public
# setTasteNotes( string $tasteNotes )

Parameters

$tasteNotes
string
$tasteNotes

Implementation of

BeerXML\Parser\IRecipe::setTasteNotes()
public float
# getTasteRating( )

Returns

float

Implementation of

BeerXML\Generator\IRecipe::getTasteRating()
public
# setTasteRating( float $tasteRating )

Parameters

$tasteRating
float
$tasteRating

Implementation of

BeerXML\Parser\IRecipe::setTasteRating()
public number
# getTertiaryAge( )

Returns

number

Implementation of

BeerXML\Generator\IRecipe::getTertiaryAge()
public
# setTertiaryAge( number $tertiaryAge )

Parameters

$tertiaryAge
number
$tertiaryAge

Implementation of

BeerXML\Parser\IRecipe::setTertiaryAge()
public number
# getTertiaryTemp( )

Returns

number

Implementation of

BeerXML\Generator\IRecipe::getTertiaryTemp()
public
# setTertiaryTemp( number $tertiaryTemp )

Parameters

$tertiaryTemp
number
$tertiaryTemp

Implementation of

BeerXML\Parser\IRecipe::setTertiaryTemp()
public string
# getType( )

Returns

string

Implementation of

BeerXML\Generator\IRecipe::getType()
public
# setType( string $type )

Parameters

$type
string
$type

Implementation of

BeerXML\Parser\IRecipe::setType()
public integer
# getVersion( )

Returns

integer

Implementation of

BeerXML\Generator\IRecipe::getVersion()
public
# setVersion( integer $version )

Parameters

$version
integer
$version

Implementation of

BeerXML\Parser\IRecipe::setVersion()
public array
# getWaters( )

Returns

array

Implementation of

BeerXML\Generator\IRecipe::getWaters()
public
# addWater( BeerXML\Record\Water $water )

Parameters

$water
BeerXML\Record\Water

Implementation of

BeerXML\Parser\IRecipe::addWater()
public array
# getYeasts( )

Returns

array

Implementation of

BeerXML\Generator\IRecipe::getYeasts()
public
# addYeast( BeerXML\Record\Yeast $yeast )

Parameters

$yeast
BeerXML\Record\Yeast

Implementation of

BeerXML\Parser\IRecipe::addYeast()
public
# setAbv( float $abv )

Actual alcohol by volume calculated from the OG and FG measured.

Actual alcohol by volume calculated from the OG and FG measured.

Parameters

$abv
float
$abv Percent

Implementation of

BeerXML\Parser\IRecipeDisplay::setAbv()
public float
# getAbv( )

Actual alcohol by volume calculated from the OG and FG measured.

Actual alcohol by volume calculated from the OG and FG measured.

Returns

float
Percent

Implementation of

BeerXML\Generator\IRecipeDisplay::getAbv()
public
# setActualEfficiency( float $actualEfficiency )

The actual efficiency as calculated using the measured original and final gravity.

The actual efficiency as calculated using the measured original and final gravity.

Parameters

$actualEfficiency
float
$actualEfficiency Percent

Implementation of

BeerXML\Parser\IRecipeDisplay::setActualEfficiency()
public float
# getActualEfficiency( )

The actual efficiency as calculated using the measured original and final gravity.

The actual efficiency as calculated using the measured original and final gravity.

Returns

float
Percent

Implementation of

BeerXML\Generator\IRecipeDisplay::getActualEfficiency()
public
# setCalories( string $calories )

Calorie estimate based on the measured starting and ending gravity.

Calorie estimate based on the measured starting and ending gravity.

Note that calories should be quoted in "Cal" or kilocalories which is the normal dietary measure (i.e. a beer is usually in the range of 100-250 calories per 12 oz). Examples "180 Cal/pint",

Parameters

$calories
string
$calories

Implementation of

BeerXML\Parser\IRecipeDisplay::setCalories()
public string
# getCalories( )

Calorie estimate based on the measured starting and ending gravity.

Calorie estimate based on the measured starting and ending gravity.

Note that calories should be quoted in "Cal" or kilocalories which is the normal dietary measure (i.e. a beer is usually in the range of 100-250 calories per 12 oz). Examples "180 Cal/pint",

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getCalories()
public
# setDisplayAgeTemp( string $displayAgeTemp )

Temperature to use when aging the beer in user units such as "55 F"

Temperature to use when aging the beer in user units such as "55 F"

Parameters

$displayAgeTemp
string
$displayAgeTemp

Implementation of

BeerXML\Parser\IRecipeDisplay::setDisplayAgeTemp()
public string
# getDisplayAgeTemp( )

Temperature to use when aging the beer in user units such as "55 F"

Temperature to use when aging the beer in user units such as "55 F"

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getDisplayAgeTemp()
public
# setDisplayBatchSize( string $displayBatchSize )

Batch size in user defined units along with the units as in "5.0 gal"

Batch size in user defined units along with the units as in "5.0 gal"

Parameters

$displayBatchSize
string
$displayBatchSize

Implementation of

BeerXML\Parser\IRecipeDisplay::setDisplayBatchSize()
public string
# getDisplayBatchSize( )

Batch size in user defined units along with the units as in "5.0 gal"

Batch size in user defined units along with the units as in "5.0 gal"

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getDisplayBatchSize()
public
# setDisplayBoilSize( string $displayBoilSize )

Boil size with user defined units as in "6.3 gal"

Boil size with user defined units as in "6.3 gal"

Parameters

$displayBoilSize
string
$displayBoilSize

Implementation of

BeerXML\Parser\IRecipeDisplay::setDisplayBoilSize()
public string
# getDisplayBoilSize( )

Boil size with user defined units as in "6.3 gal"

Boil size with user defined units as in "6.3 gal"

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getDisplayBoilSize()
public
# setDisplayCarbTemp( string $displayCarbTemp )

Carbonation/Bottling temperature in appropriate units such as "40F" or "32 C"

Carbonation/Bottling temperature in appropriate units such as "40F" or "32 C"

Parameters

$displayCarbTemp
string
$displayCarbTemp

Implementation of

BeerXML\Parser\IRecipeDisplay::setDisplayCarbTemp()
public string
# getDisplayCarbTemp( )

Carbonation/Bottling temperature in appropriate units such as "40F" or "32 C"

Carbonation/Bottling temperature in appropriate units such as "40F" or "32 C"

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getDisplayCarbTemp()
public
# setCarbonationUsed( string $carbonationUsed )

Text description of the carbonation used such as "50g corn sugar" or "Kegged at 20psi"

Text description of the carbonation used such as "50g corn sugar" or "Kegged at 20psi"

Parameters

$carbonationUsed
string
$carbonationUsed

Implementation of

BeerXML\Parser\IRecipeDisplay::setCarbonationUsed()
public string
# getCarbonationUsed( )

Text description of the carbonation used such as "50g corn sugar" or "Kegged at 20psi"

Text description of the carbonation used such as "50g corn sugar" or "Kegged at 20psi"

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getCarbonationUsed()
public
# setDisplayFg( string $displayFg )

Measured final gravity in user defined units as in "1.035 sg"

Measured final gravity in user defined units as in "1.035 sg"

Parameters

$displayFg
string
$displayFg

Implementation of

BeerXML\Parser\IRecipeDisplay::setDisplayFg()
public string
# getDisplayFg( )

Measured final gravity in user defined units as in "1.035 sg"

Measured final gravity in user defined units as in "1.035 sg"

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getDisplayFg()
public
# setDisplayOg( string $displayOg )

Measured original gravity in user defined units as in "6.4 plato"

Measured original gravity in user defined units as in "6.4 plato"

Parameters

$displayOg
string
$displayOg

Implementation of

BeerXML\Parser\IRecipeDisplay::setDisplayOg()
public string
# getDisplayOg( )

Measured original gravity in user defined units as in "6.4 plato"

Measured original gravity in user defined units as in "6.4 plato"

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getDisplayOg()
public
# setDisplayPrimaryTemp( string $displayPrimaryTemp )

Primary fermentation temperature in user defined units such as "64 F"

Primary fermentation temperature in user defined units such as "64 F"

Parameters

$displayPrimaryTemp
string
$displayPrimaryTemp

Implementation of

BeerXML\Parser\IRecipeDisplay::setDisplayPrimaryTemp()
public string
# getDisplayPrimaryTemp( )

Primary fermentation temperature in user defined units such as "64 F"

Primary fermentation temperature in user defined units such as "64 F"

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getDisplayPrimaryTemp()
public
# setDisplaySecondaryTemp( string $displaySecondaryTemp )

Secondary fermentation temperature in user defined units such as "56 F"

Secondary fermentation temperature in user defined units such as "56 F"

Parameters

$displaySecondaryTemp
string
$displaySecondaryTemp

Implementation of

BeerXML\Parser\IRecipeDisplay::setDisplaySecondaryTemp()
public string
# getDisplaySecondaryTemp( )

Secondary fermentation temperature in user defined units such as "56 F"

Secondary fermentation temperature in user defined units such as "56 F"

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getDisplaySecondaryTemp()
public
# setDisplayTertiaryTemp( string $displayTertiaryTemp )

Tertiary temperature in user defined units such as "20 C"

Tertiary temperature in user defined units such as "20 C"

Parameters

$displayTertiaryTemp
string
$displayTertiaryTemp

Implementation of

BeerXML\Parser\IRecipeDisplay::setDisplayTertiaryTemp()
public string
# getDisplayTertiaryTemp( )

Tertiary temperature in user defined units such as "20 C"

Tertiary temperature in user defined units such as "20 C"

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getDisplayTertiaryTemp()
public
# setEstAbv( float $estAbv )

Estimated percent alcohol by volume for this recipe.

Estimated percent alcohol by volume for this recipe.

Parameters

$estAbv
float
$estAbv Percent

Implementation of

BeerXML\Parser\IRecipeDisplay::setEstAbv()
public float
# getEstAbv( )

Estimated percent alcohol by volume for this recipe.

Estimated percent alcohol by volume for this recipe.

Returns

float
Percent

Implementation of

BeerXML\Generator\IRecipeDisplay::getEstAbv()
public
# setEstColor( string $estColor )

The estimated color of the beer in user defined color units.

The estimated color of the beer in user defined color units.

Parameters

$estColor
string
$estColor

Implementation of

BeerXML\Parser\IRecipeDisplay::setEstColor()
public string
# getEstColor( )

The estimated color of the beer in user defined color units.

The estimated color of the beer in user defined color units.

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getEstColor()
public
# setEstFg( string $estFg )

Calculated estimate for the final specific gravity of this recipe along with the units as in "1.015 sg"

Calculated estimate for the final specific gravity of this recipe along with the units as in "1.015 sg"

Parameters

$estFg
string
$estFg

Implementation of

BeerXML\Parser\IRecipeDisplay::setEstFg()
public string
# getEstFg( )

Calculated estimate for the final specific gravity of this recipe along with the units as in "1.015 sg"

Calculated estimate for the final specific gravity of this recipe along with the units as in "1.015 sg"

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getEstFg()
public
# setEstOg( string $estOg )

Calculated estimate of the original gravity for this recipe along with the units.

Calculated estimate of the original gravity for this recipe along with the units.

Parameters

$estOg
string
$estOg

Implementation of

BeerXML\Parser\IRecipeDisplay::setEstOg()
public string
# getEstOg( )

Calculated estimate of the original gravity for this recipe along with the units.

Calculated estimate of the original gravity for this recipe along with the units.

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getEstOg()
public
# setIbu( float $ibu )

The estimated bitterness level of the beer in IBUs

The estimated bitterness level of the beer in IBUs

Parameters

$ibu
float
$ibu

Implementation of

BeerXML\Parser\IRecipeDisplay::setIbu()
public float
# getIbu( )

The estimated bitterness level of the beer in IBUs

The estimated bitterness level of the beer in IBUs

Returns

float

Implementation of

BeerXML\Generator\IRecipeDisplay::getIbu()
public
# setIbuMethod( string $ibuMethod )

May be "Rager", "Tinseth" or "Garetz" corresponding to the method/equation used to estimate IBUs for this recipe.

May be "Rager", "Tinseth" or "Garetz" corresponding to the method/equation used to estimate IBUs for this recipe.

Parameters

$ibuMethod
string
$ibuMethod

Implementation of

BeerXML\Parser\IRecipeDisplay::setIbuMethod()
public string
# getIbuMethod( )

May be "Rager", "Tinseth" or "Garetz" corresponding to the method/equation used to estimate IBUs for this recipe.

May be "Rager", "Tinseth" or "Garetz" corresponding to the method/equation used to estimate IBUs for this recipe.

Returns

string

Implementation of

BeerXML\Generator\IRecipeDisplay::getIbuMethod()
Constants inherited from BeerXML\Parser\IRecipe
TYPE_ALL_GRAIN, TYPE_EXTRACT, TYPE_IBU_METHOD_GARETZ, TYPE_IBU_METHOD_RAGER, TYPE_IBU_METHOD_TINSETH, TYPE_PARTIAL_MASH
php-beerxml API documentation generated by ApiGen 2.8.0