Overview

Namespaces

  • BeerXML
    • Exception
    • Generator
    • Parser
    • Record
  • PHP

Classes

  • Equipment
  • Fermentable
  • Hop
  • MashProfile
  • MashStep
  • Misc
  • Recipe
  • Record
  • RecordFactory
  • 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

Interface IFermentable

Direct known implementers

BeerXML\Parser\IFermentableDisplay

Indirect known implementers

BeerXML\Record\Fermentable
Namespace: BeerXML\Parser
Located at BeerXML/Parser/IFermentable.php
Methods summary
public
# setAddAfterBoil( boolean $addAfterBoil )

May be TRUE if this item is normally added after the boil. The default value is FALSE since most grains are added during the mash or boil.

May be TRUE if this item is normally added after the boil. The default value is FALSE since most grains are added during the mash or boil.

Parameters

$addAfterBoil
boolean
$addAfterBoil
public
# setAmount( number $amount )

Weight of the fermentable, extract or sugar in Kilograms.

Weight of the fermentable, extract or sugar in Kilograms.

Parameters

$amount
number
$amount
public
# setCoarseFineDiff( number $coarseFineDiff )

Percent difference between the coarse grain yield and fine grain yield. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored.

Percent difference between the coarse grain yield and fine grain yield. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored.

Parameters

$coarseFineDiff
number
$coarseFineDiff
public
# setColor( float $color )

The color of the item in Lovibond Units (SRM for liquid extracts).

The color of the item in Lovibond Units (SRM for liquid extracts).

Parameters

$color
float
$color
public
# setDiastaticPower( float $diastaticPower )

The diastatic power of the grain as measured in "Lintner" units. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored.

The diastatic power of the grain as measured in "Lintner" units. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored.

Parameters

$diastaticPower
float
$diastaticPower
public
# setIbuGalPerLb( float $ibuGalPerLb )

For hopped extracts only - an estimate of the number of IBUs per pound of extract in a gallon of water. To convert to IBUs we multiply this number by the "AMOUNT" field (in pounds) and divide by the number of gallons in the batch. Based on a sixty minute boil. Only suitable for use with an "Extract" type, otherwise this value is ignored.

For hopped extracts only - an estimate of the number of IBUs per pound of extract in a gallon of water. To convert to IBUs we multiply this number by the "AMOUNT" field (in pounds) and divide by the number of gallons in the batch. Based on a sixty minute boil. Only suitable for use with an "Extract" type, otherwise this value is ignored.

Parameters

$ibuGalPerLb
float
$ibuGalPerLb
public
# setMaxInBatch( number $maxInBatch )

The recommended maximum percentage (by weight) this ingredient should represent in a batch of beer.

The recommended maximum percentage (by weight) this ingredient should represent in a batch of beer.

Parameters

$maxInBatch
number
$maxInBatch
public
# setMoisture( number $moisture )

Percent moisture in the grain. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored.

Percent moisture in the grain. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored.

Parameters

$moisture
number
$moisture
public
# setName( string $name )

Name of the fermentable.

Name of the fermentable.

Parameters

$name
string
$name
public
# setNotes( string $notes )

Textual noted describing this ingredient and its use. May be multiline.

Textual noted describing this ingredient and its use. May be multiline.

Parameters

$notes
string
$notes
public
# setOrigin( string $origin )

Country or place of origin

Country or place of origin

Parameters

$origin
string
$origin
public
# setProtein( number $protein )

The percent protein in the grain. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored.

The percent protein in the grain. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored.

Parameters

$protein
number
$protein
public
# setRecommendMash( boolean $recommendMash )

TRUE if it is recommended the grain be mashed, FALSE if it can be steeped. A value of TRUE is only appropriate for a "Grain" or "Adjunct" types. The default value is FALSE. Note that this does NOT indicate whether the grain is mashed or not – it is only a recommendation used in recipe formulation.

TRUE if it is recommended the grain be mashed, FALSE if it can be steeped. A value of TRUE is only appropriate for a "Grain" or "Adjunct" types. The default value is FALSE. Note that this does NOT indicate whether the grain is mashed or not – it is only a recommendation used in recipe formulation.

Parameters

$recommendMash
boolean
$recommendMash
public
# setSupplier( string $supplier )

Supplier of the grain/extract/sugar

Supplier of the grain/extract/sugar

Parameters

$supplier
string
$supplier
public
# setType( string $type )

May be "Grain", "Sugar", "Extract", "Dry Extract" or "Adjunct". Extract refers to liquid extract.

May be "Grain", "Sugar", "Extract", "Dry Extract" or "Adjunct". Extract refers to liquid extract.

Parameters

$type
string
$type
public
# setVersion( integer $version )

Should be set to 1 for this version of the XML standard. May be a higher number for later versions but all later versions shall be backward compatible.

Should be set to 1 for this version of the XML standard. May be a higher number for later versions but all later versions shall be backward compatible.

Parameters

$version
integer
$version
public
# setYield( number $yield )

Percent dry yield (fine grain) for the grain, or the raw yield by weight if this is an extract adjunct or sugar.

Percent dry yield (fine grain) for the grain, or the raw yield by weight if this is an extract adjunct or sugar.

Parameters

$yield
number
$yield
php-beerxml API documentation generated by ApiGen 2.8.0