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
 1: <?php
 2: 
 3: 
 4: namespace BeerXML\Generator;
 5: 
 6: 
 7: interface IEquipmentDisplay extends IEquipment
 8: {
 9: 
10:     /**
11:      * The target volume of the batch at the start of fermentation in display volume units such as "5.0 gal"
12:      *
13:      * @return string
14:      */
15:     public function getDisplayBatchSize();
16: 
17:     /**
18:      * The pre-boil volume normally used for a batch of this size shown in display volume units such as "5.5 gal"
19:      *
20:      * @return string
21:      */
22:     public function getDisplayBoilSize();
23: 
24:     /**
25:      * Amount lost to the lauter tun and equipment associated with the lautering process. Ex: "2.0 gal" or "1.0 l"
26:      *
27:      * @return string
28:      */
29:     public function getDisplayLauterDeadspace();
30: 
31:     /**
32:      * Amount normally added to the boil kettle before the boil. Ex: "1.0 gal"
33:      *
34:      * @return string
35:      */
36:     public function getDisplayTopUpKettle();
37: 
38:     /**
39:      * The amount of top up water normally added just prior to starting fermentation in display volume such as "1.0 gal"
40:      *
41:      * @return string
42:      */
43:     public function getDisplayTopUpWater();
44: 
45:     /**
46:      * The amount of wort normally lost during transition from the boiler to the fermentation vessel.
47:      *
48:      * Includes both unusable wort due to trub and wort lost to the chiller and transfer systems.  Expressed in user
49:      * units - Ex: "1.5 qt"
50:      *
51:      * @return string
52:      */
53:     public function getDisplayTrubChillerLoss();
54: 
55:     /**
56:      * Volume of the mash tun in display units such as "10.0 gal" or "20.0 l"
57:      *
58:      * @return string
59:      */
60:     public function getDisplayTunVolume();
61: 
62:     /**
63:      * Weight of the mash tun in display units such as "3.0 kg" or "6.0 lb"
64:      *
65:      * @return string
66:      */
67:     public function getDisplayTunWeight();
68: }
php-beerxml API documentation generated by ApiGen 2.8.0