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 IMisc
 8: {
 9: 
10:     /**
11:      * Amount of item used.  The default measurements are by weight, but this may be the measurement in volume units if
12:      * AMOUNT_IS_WEIGHT is set to TRUE for this record.  If a liquid it is in liters, if a solid the weight is measured
13:      * in kilograms.
14:      *
15:      * @return number
16:      */
17:     public function getAmount();
18: 
19:     /**
20:      * TRUE if the amount measurement is a weight measurement and FALSE if the amount is a volume measurement.  Default
21:      * value (if not present) is assumed to be FALSE.
22:      *
23:      * @return boolean
24:      */
25:     public function getAmountIsWeight();
26: 
27:     /**
28:      * Name of the misc item.
29:      *
30:      * @return string
31:      */
32:     public function getName();
33: 
34:     /**
35:      * Detailed notes on the item including usage.  May be multiline.
36:      *
37:      * @return string
38:      */
39:     public function getNotes();
40: 
41:     /**
42:      * Amount of time the misc was boiled, steeped, mashed, etc in minutes
43:      *
44:      * @return number
45:      */
46:     public function getTime();
47: 
48:     /**
49:      * May be "Spice", "Fining", "Water Agent", "Herb", "Flavor" or "Other"
50:      *
51:      * @return string
52:      */
53:     public function getType();
54: 
55:     /**
56:      * May be "Boil", "Mash", "Primary", "Secondary", "Bottling"
57:      *
58:      * @return string
59:      */
60:     public function getUse();
61: 
62:     /**
63:      * Short description of what the ingredient is used for in text
64:      *
65:      * @return string
66:      */
67:     public function getUseFor();
68: 
69:     /**
70:      * Version number of this element.  Should be "1" for this version.
71:      *
72:      * @return int
73:      */
74:     public function getVersion();
75: }
php-beerxml API documentation generated by ApiGen 2.8.0