1: <?php
  2: 
  3: 
  4: namespace BeerXML\Generator;
  5: 
  6: 
  7: interface IHop
  8: {
  9: 
 10:     /**
 11:      * Percent alpha of hops - for example "5.5" represents 5.5% alpha
 12:      *
 13:      * @return number
 14:      */
 15:     public function getAlpha();
 16: 
 17:     /**
 18:      * Weight in Kilograms of the hops used in the recipe
 19:      *
 20:      * @return number
 21:      */
 22:     public function getAmount();
 23: 
 24:     /**
 25:      * Hop beta percentage - for example "4.4" denotes 4.4 % beta
 26:      *
 27:      * @return number
 28:      */
 29:     public function getBeta();
 30: 
 31:     /**
 32:      * Caryophyllene level in percent.
 33:      *
 34:      * @return number
 35:      */
 36:     public function getCaryophyllene();
 37: 
 38:     /**
 39:      * Cohumulone level in percent
 40:      *
 41:      * @return number
 42:      */
 43:     public function getCohumulone();
 44: 
 45:     /**
 46:      * May be "Pellet", "Plug" or "Leaf"
 47:      *
 48:      * @return string
 49:      */
 50:     public function getForm();
 51: 
 52:     /**
 53:      * Hop Stability Index - defined as the percentage of hop alpha lost in 6 months of storage
 54:      *
 55:      * @return number
 56:      */
 57:     public function getHsi();
 58: 
 59:     /**
 60:      * Humulene level in percent.
 61:      *
 62:      * @return number
 63:      */
 64:     public function getHumulene();
 65: 
 66:     /**
 67:      * Myrcene level in percent
 68:      *
 69:      * @return number
 70:      */
 71:     public function getMyrcene();
 72: 
 73:     /**
 74:      * Name of the hops
 75:      *
 76:      * @return string
 77:      */
 78:     public function getName();
 79: 
 80:     /**
 81:      * Textual notes about the hops, usage, substitutes.  May be a multiline entry.
 82:      *
 83:      * @return string
 84:      */
 85:     public function getNotes();
 86: 
 87:     /**
 88:      * Place of origin for the hops
 89:      *
 90:      * @return string
 91:      */
 92:     public function getOrigin();
 93: 
 94:     /**
 95:      * Substitutes that can be used for this hops
 96:      *
 97:      * @return string
 98:      */
 99:     public function getSubstitutes();
100: 
101:     /**
102:      * The time as measured in minutes.  Meaning is dependent on the "USE" field.  For "Boil" this is the boil time.
103:      * For "Mash" this is the mash time.  For "First Wort" this is the boil time.  For "Aroma" this is the steep time.
104:      * For "Dry Hop" this is the amount of time to dry hop.
105:      *
106:      * @return number
107:      */
108:     public function getTime();
109: 
110:     /**
111:      * May be "Bittering", "Aroma" or "Both"
112:      *
113:      * @return string
114:      */
115:     public function getType();
116: 
117:     /**
118:      * May be "Boil", "Dry Hop", "Mash", "First Wort" or "Aroma".  Note that "Aroma" and "Dry Hop" do not contribute to
119:      * the bitterness of the beer while the others do.  Aroma hops are added after the boil and do not contribute
120:      * substantially to beer bitterness.
121:      *
122:      * @return string
123:      */
124:     public function getUse();
125: 
126:     /**
127:      * Should be set to 1 for this version of the XML standard.  May be a higher number for later versions but all later
128:      * versions shall be backward compatible.
129:      *
130:      * @return int
131:      */
132:     public function getVersion();
133: }