Overview

Namespaces

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

Classes

  • Equipment
  • Fermentable
  • Hop
  • MashProfile
  • MashStep
  • Misc
  • Recipe
  • Record
  • RecordFactory
  • Style
  • Water
  • Yeast

Interfaces

  • IEquipment
  • IEquipmentDisplay
  • IFermentable
  • IFermentableDisplay
  • IHop
  • IHopDisplay
  • IMashProfile
  • IMashProfileDisplay
  • IMashStep
  • IMashStepDisplay
  • IMisc
  • IMiscDisplay
  • IRecipe
  • IRecipeDisplay
  • IStyle
  • IStyleDisplay
  • IWater
  • IWaterDisplay
  • IYeast
  • IYeastDisplay
  • Overview
  • Namespace
  • Class
  • Tree

Interface IRecipeDisplay

BeerXML\Parser\IRecipeDisplay implements BeerXML\Parser\IRecipe

Direct known implementers

BeerXML\Record\Recipe
Namespace: BeerXML\Parser
Located at BeerXML/Parser/IRecipeDisplay.php
Methods summary
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Methods inherited from BeerXML\Parser\IRecipe
addFermentable(), addHop(), addMisc(), addWater(), addYeast(), setAge(), setAgeTemp(), setAsstBrewer(), setBatchSize(), setBoilSize(), setBoilTime(), setBrewer(), setCarbonation(), setCarbonationTemp(), setDate(), setEfficiency(), setEquipment(), setFermentationStages(), setFg(), setForcedCarbonation(), setKegPrimingFactor(), setMash(), setName(), setNotes(), setOg(), setPrimaryAge(), setPrimaryTemp(), setPrimingSugarEquiv(), setPrimingSugarName(), setSecondaryAge(), setSecondaryTemp(), setStyle(), setTasteNotes(), setTasteRating(), setTertiaryAge(), setTertiaryTemp(), setType(), setVersion()
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