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 IMashStepDisplay extends IMashStep
 8: {
 9: 
10:     /**
11:      * Calculated volume of mash to decoct.  Only applicable for a decoction step.  Includes the units as in "7.5 l" or
12:      * "2.3 gal"
13:      *
14:      * @param string $decoctionAmt
15:      */
16:     public function setDecoctionAmt($decoctionAmt);
17: 
18:     /**
19:      * Textual description of this step such as "Infuse 4.5 gal of water at 170 F" – may be either generated by the
20:      * program or input by the user.
21:      *
22:      * @param string $description
23:      */
24:     public function setDescription($description);
25: 
26:     /**
27:      * Infusion amount along with the volume units as in "20 l" or "13 qt"
28:      *
29:      * @param string $displayInfuseAmt
30:      */
31:     public function setDisplayInfuseAmt($displayInfuseAmt);
32: 
33:     /**
34:      * Step temperature in user defined temperature units.  For example "154F" or "68 C"
35:      *
36:      * @param string $displayStepTemp
37:      */
38:     public function setDisplayStepTemp($displayStepTemp);
39: 
40:     /**
41:      * The calculated infusion temperature based on the current step, grain, and other settings.  Applicable only for an
42:      * infusion step.  Includes the units as in "154 F" or "68 C"
43:      *
44:      * @param string $infuseTemp
45:      */
46:     public function setInfuseTemp($infuseTemp);
47: 
48:     /**
49:      * The total ratio of water to grain for this step AFTER the infusion along with the units, usually expressed in
50:      * qt/lb or l/kg.
51:      *
52:      * Note this value must be consistent with the required infusion amount and amounts added in earlier steps and is
53:      * only relevant as part of a <MASH> profile.  For example "1.5 qt/lb" or "3.0 l/kg"
54:      *
55:      * @param string $waterGrainRatio
56:      */
57:     public function setWaterGrainRatio($waterGrainRatio);
58: }
php-beerxml API documentation generated by ApiGen 2.8.0