Overview

Namespaces

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

Classes

  • Equipment
  • Fermentable
  • Hop
  • MashProfile
  • MashStep
  • Misc
  • Recipe
  • Record
  • 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

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

BeerXML\Generator\IRecipeDisplay implements BeerXML\Generator\IRecipe

Direct known implementers

BeerXML\Record\Recipe
Namespace: BeerXML\Generator
Package: BeerXML\Generator
Located at BeerXML/Generator/IRecipeDisplay.php
Methods summary
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
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
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
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
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
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
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
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
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
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
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
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
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
public float
# getEstAbv( )

Estimated percent alcohol by volume for this recipe.

Estimated percent alcohol by volume for this recipe.

Returns

float
Percent
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
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
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
public float
# getIbu( )

The estimated bitterness level of the beer in IBUs

The estimated bitterness level of the beer in IBUs

Returns

float
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
Methods inherited from BeerXML\Generator\IRecipe
getAge(), getAgeTemp(), getAsstBrewer(), getBatchSize(), getBoilSize(), getBoilTime(), getBrewer(), getCarbonation(), getCarbonationTemp(), getDate(), getEfficiency(), getEquipment(), getFermentables(), getFermentationStages(), getFg(), getForcedCarbonation(), getHops(), getKegPrimingFactor(), getMash(), getMiscs(), getName(), getNotes(), getOg(), getPrimaryAge(), getPrimaryTemp(), getPrimingSugarEquiv(), getPrimingSugarName(), getSecondaryAge(), getSecondaryTemp(), getStyle(), getTasteNotes(), getTasteRating(), getTertiaryAge(), getTertiaryTemp(), getType(), getVersion(), getWaters(), getYeasts()
php-beerxml API documentation generated by ApiGen 2.8.0