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 IWater
 8: {
 9: 
10:     /**
11:      * Volume of water to use in a recipe in liters.
12:      *
13:      * @return number
14:      */
15:     public function getAmount();
16: 
17:     /**
18:      * The amount of bicarbonate (HCO3) in parts per million.
19:      *
20:      * @return float
21:      */
22:     public function getBicarbonate();
23: 
24:     /**
25:      * The amount of calcium (Ca) in parts per million.
26:      *
27:      * @return float
28:      */
29:     public function getCalcium();
30: 
31:     /**
32:      * @return float
33:      */
34:     public function getChloride();
35: 
36:     /**
37:      * The amount of Magnesium (Mg) in parts per million.
38:      *
39:      * @return float
40:      */
41:     public function getMagnesium();
42: 
43:     /**
44:      * Name of the water profile – usually the city and country of the water profile.
45:      *
46:      * @return string
47:      */
48:     public function getName();
49: 
50:     /**
51:      * Notes about the water profile.  May be multiline.
52:      *
53:      * @return string
54:      */
55:     public function getNotes();
56: 
57:     /**
58:      * The PH of the water.
59:      *
60:      * @return float
61:      */
62:     public function getPH();
63: 
64:     /**
65:      * The amount of Sodium (Na) in parts per million.
66:      *
67:      * @return float
68:      */
69:     public function getSodium();
70: 
71:     /**
72:      * The amount of Sulfate (SO4) in parts per million.
73:      *
74:      * @return float
75:      */
76:     public function getSulfate();
77: 
78:     /**
79:      * Version of the water record.  Should always be "1" for this version of the XML standard.
80:      *
81:      * @return int
82:      */
83:     public function getVersion();
84: }
php-beerxml API documentation generated by ApiGen 2.8.0