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
  1: <?php
  2: 
  3: 
  4: namespace BeerXML\Parser;
  5: 
  6: 
  7: interface IRecipeDisplay extends IRecipe
  8: {
  9: 
 10:     /**
 11:      * Actual alcohol by volume calculated from the OG and FG measured.
 12:      *
 13:      * @param float $abv Percent
 14:      */
 15:     public function setAbv($abv);
 16: 
 17:     /**
 18:      * The actual efficiency as calculated using the measured original and final gravity.
 19:      *
 20:      * @param float $actualEfficiency Percent
 21:      */
 22:     public function setActualEfficiency($actualEfficiency);
 23: 
 24:     /**
 25:      * Calorie estimate based on the measured starting and ending gravity.
 26:      *
 27:      * Note that calories should be quoted in "Cal" or kilocalories which is the normal dietary measure (i.e. a beer is
 28:      * usually in the range of 100-250 calories per 12 oz).  Examples "180 Cal/pint",
 29:      *
 30:      * @param string $calories
 31:      */
 32:     public function setCalories($calories);
 33: 
 34:     /**
 35:      * Temperature to use when aging the beer in user units such as "55 F"
 36:      *
 37:      * @param string $displayAgeTemp
 38:      */
 39:     public function setDisplayAgeTemp($displayAgeTemp);
 40: 
 41:     /**
 42:      * Batch size in user defined units along with the units as in "5.0 gal"
 43:      *
 44:      * @param string $displayBatchSize
 45:      */
 46:     public function setDisplayBatchSize($displayBatchSize);
 47: 
 48:     /**
 49:      * Boil size with user defined units as in "6.3 gal"
 50:      *
 51:      * @param string $displayBoilSize
 52:      */
 53:     public function setDisplayBoilSize($displayBoilSize);
 54: 
 55:     /**
 56:      * Carbonation/Bottling temperature in appropriate units such as "40F" or "32 C"
 57:      *
 58:      * @param string $displayCarbTemp
 59:      */
 60:     public function setDisplayCarbTemp($displayCarbTemp);
 61: 
 62:     /**
 63:      * Text description of the carbonation used such as "50g corn sugar" or "Kegged at 20psi"
 64:      *
 65:      * @param string $carbonationUsed
 66:      */
 67:     public function setCarbonationUsed($carbonationUsed);
 68: 
 69:     /**
 70:      * Measured final gravity in user defined units as in "1.035 sg"
 71:      *
 72:      * @param string $displayFg
 73:      */
 74:     public function setDisplayFg($displayFg);
 75: 
 76:     /**
 77:      * Measured original gravity in user defined units as in "6.4 plato"
 78:      *
 79:      * @param string $displayOg
 80:      */
 81:     public function setDisplayOg($displayOg);
 82: 
 83:     /**
 84:      * Primary fermentation temperature in user defined units such as "64 F"
 85:      *
 86:      * @param string $displayPrimaryTemp
 87:      */
 88:     public function setDisplayPrimaryTemp($displayPrimaryTemp);
 89: 
 90:     /**
 91:      * Secondary fermentation temperature in user defined units such as "56 F"
 92:      *
 93:      * @param string $displaySecondaryTemp
 94:      */
 95:     public function setDisplaySecondaryTemp($displaySecondaryTemp);
 96: 
 97:     /**
 98:      * Tertiary temperature in user defined units such as "20 C"
 99:      *
100:      * @param string $displayTertiaryTemp
101:      */
102:     public function setDisplayTertiaryTemp($displayTertiaryTemp);
103: 
104:     /**
105:      * Estimated percent alcohol by volume for this recipe.
106:      *
107:      * @param float $estAbv Percent
108:      */
109:     public function setEstAbv($estAbv);
110: 
111:     /**
112:      * The estimated color of the beer in user defined color units.
113:      *
114:      * @param string $estColor
115:      */
116:     public function setEstColor($estColor);
117: 
118:     /**
119:      * Calculated estimate for the final specific gravity of this recipe along with the units as in "1.015 sg"
120:      *
121:      * @param string $estFg
122:      */
123:     public function setEstFg($estFg);
124: 
125:     /**
126:      * Calculated estimate of the original gravity for this recipe along with the units.
127:      *
128:      * @param string $estOg
129:      */
130:     public function setEstOg($estOg);
131: 
132:     /**
133:      * The estimated bitterness level of the beer in IBUs
134:      *
135:      * @param float $ibu
136:      */
137:     public function setIbu($ibu);
138: 
139:     /**
140:      * May be "Rager", "Tinseth" or "Garetz" corresponding to the method/equation used to estimate IBUs for this recipe.
141:      *
142:      * @param string $ibuMethod
143:      */
144:     public function setIbuMethod($ibuMethod);
145: }
php-beerxml API documentation generated by ApiGen 2.8.0