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 IMashStep
 8: {
 9: 
10:     /**
11:      * the temperature you can expect the mash to fall to after a long mash step.  Measured in degrees Celsius.
12:      *
13:      * @param number $endTemp
14:      */
15:     public function setEndTemp($endTemp);
16: 
17:     /**
18:      * The volume of water in liters to infuse in this step.  Required only for infusion steps, though one may also add
19:      * water for temperature mash steps.  One should not have an infusion amount for decoction steps.
20:      *
21:      * @param number $infuseAmount
22:      */
23:     public function setInfuseAmount($infuseAmount);
24: 
25:     /**
26:      * Name of the mash step – usually descriptive text such as "Dough In" or "Conversion"
27:      *
28:      * @param string $name
29:      */
30:     public function setName($name);
31: 
32:     /**
33:      * Time in minutes to achieve the desired step temperature – useful particularly for temperature mashes where it may
34:      * take some time to achieve the step temperature.
35:      *
36:      * @param number $rampTime
37:      */
38:     public function setRampTime($rampTime);
39: 
40:     /**
41:      * The target temperature for this step in degrees Celsius.
42:      *
43:      * @param number $stepTemp
44:      */
45:     public function setStepTemp($stepTemp);
46: 
47:     /**
48:      * The number of minutes to spend at this step – i.e. the amount of time we are to hold this particular step
49:      * temperature.
50:      *
51:      * @param number $stepTime
52:      */
53:     public function setStepTime($stepTime);
54: 
55:     /**
56:      * May be "Infusion", "Temperature" or "Decoction" depending on the type of step.  Infusion denotes adding hot water,
57:      * Temperature denotes heating with an outside heat source, and decoction denotes drawing off some mash for boiling.
58:      *
59:      * @param string $type
60:      */
61:     public function setType($type);
62: 
63:     /**
64:      * Version of the mash step record.  Should always be "1" for this version of the XML standard.
65:      *
66:      * @param int $version
67:      */
68:     public function setVersion($version);
69: }
php-beerxml API documentation generated by ApiGen 2.8.0