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 IYeast
  8: {
  9: 
 10:     /**
 11:      * Flag denoting that this yeast was added for a secondary (or later) fermentation as opposed to the primary
 12:      * fermentation.  Useful if one uses two or more yeast strains for a single brew (eg: Lambic).  Default value is
 13:      * FALSE.
 14:      *
 15:      * @return boolean
 16:      */
 17:     public function getAddToSecondary();
 18: 
 19:     /**
 20:      * The amount of yeast, measured in liters.  For a starter this is the size of the starter.  If the flag
 21:      * AMOUNT_IS_WEIGHT is set to TRUE then this measurement is in kilograms and not liters.
 22:      *
 23:      * @return number
 24:      */
 25:     public function getAmount();
 26: 
 27:     /**
 28:      * @return boolean
 29:      */
 30:     public function getAmountIsWeight();
 31: 
 32:     /**
 33:      * Average attenuation for this yeast strain.
 34:      *
 35:      * @return number
 36:      */
 37:     public function getAttenuation();
 38: 
 39:     /**
 40:      * Styles or types of beer this yeast strain is best suited for.
 41:      *
 42:      * @return string
 43:      */
 44:     public function getBestFor();
 45: 
 46:     /**
 47:      * May be "Low", "Medium", "High" or "Very High"
 48:      *
 49:      * @return string
 50:      */
 51:     public function getFlocculation();
 52: 
 53:     /**
 54:      * May be "Liquid", "Dry", "Slant" or "Culture"
 55:      *
 56:      * @return string
 57:      */
 58:     public function getForm();
 59: 
 60:     /**
 61:      * The name of the laboratory that produced the yeast.
 62:      *
 63:      * @return string
 64:      */
 65:     public function getLaboratory();
 66: 
 67:     /**
 68:      * Recommended of times this yeast can be reused (recultured from a previous batch)
 69:      *
 70:      * @return int
 71:      */
 72:     public function getMaxReuse();
 73: 
 74:     /**
 75:      * The maximum recommended temperature for fermenting this yeast strain in Celsius.
 76:      *
 77:      * @return number
 78:      */
 79:     public function getMaxTemperature();
 80: 
 81:     /**
 82:      * The minimum recommended temperature for fermenting this yeast strain in degrees Celsius.
 83:      *
 84:      * @return number
 85:      */
 86:     public function getMinTemperature();
 87: 
 88:     /**
 89:      * Name of the yeast.
 90:      *
 91:      * @return string
 92:      */
 93:     public function getName();
 94: 
 95:     /**
 96:      * Notes on this yeast strain.  May be a multiline entry.
 97:      *
 98:      * @return string
 99:      */
100:     public function getNotes();
101: 
102:     /**
103:      * The manufacturer’s product ID label or number that identifies this particular strain of yeast.
104:      *
105:      * @return string
106:      */
107:     public function getProductId();
108: 
109:     /**
110:      * Number of times this yeast has been reused as a harvested culture.  This number should be zero if this is a
111:      * product directly from the manufacturer.
112:      *
113:      * @return int
114:      */
115:     public function getTimesCultured();
116: 
117:     /**
118:      * May be "Ale", "Lager", "Wheat", "Wine" or "Champagne"
119:      *
120:      * @return string
121:      */
122:     public function getType();
123: 
124:     /**
125:      * Version of the standard.  Should be "1" for this version.
126:      *
127:      * @return int
128:      */
129:     public function getVersion();
130: }
php-beerxml API documentation generated by ApiGen 2.8.0