Overview

Namespaces

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

Classes

  • Equipment
  • Fermentable
  • Hop
  • MashProfile
  • MashStep
  • Misc
  • Recipe
  • Style
  • Water
  • Yeast
  • Overview
  • Namespace
  • Class
  • Tree

Class Fermentable

BeerXML\Record\Fermentable implements BeerXML\Generator\IFermentableDisplay, BeerXML\Parser\IFermentableDisplay
Namespace: BeerXML\Record
Located at BeerXML/Record/Fermentable.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

Implementation of

BeerXML\Parser\IFermentable::setAddAfterBoil()
public boolean
# getAddAfterBoil( )

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.

Returns

boolean

Implementation of

BeerXML\Generator\IFermentable::getAddAfterBoil()
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

Implementation of

BeerXML\Parser\IFermentable::setAmount()
public number
# getAmount( )

Weight of the fermentable, extract or sugar in Kilograms.

Weight of the fermentable, extract or sugar in Kilograms.

Returns

number

Implementation of

BeerXML\Generator\IFermentable::getAmount()
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

Implementation of

BeerXML\Parser\IFermentable::setCoarseFineDiff()
public number
# getCoarseFineDiff( )

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.

Returns

number

Implementation of

BeerXML\Generator\IFermentable::getCoarseFineDiff()
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

Implementation of

BeerXML\Parser\IFermentable::setColor()
public float
# getColor( )

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

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

Returns

float

Implementation of

BeerXML\Generator\IFermentable::getColor()
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

Implementation of

BeerXML\Parser\IFermentable::setDiastaticPower()
public float
# getDiastaticPower( )

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.

Returns

float

Implementation of

BeerXML\Generator\IFermentable::getDiastaticPower()
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

Implementation of

BeerXML\Parser\IFermentable::setIbuGalPerLb()
public float
# getIbuGalPerLb( )

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.

Returns

float

Implementation of

BeerXML\Generator\IFermentable::getIbuGalPerLb()
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

Implementation of

BeerXML\Parser\IFermentable::setMaxInBatch()
public number
# getMaxInBatch( )

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.

Returns

number

Implementation of

BeerXML\Generator\IFermentable::getMaxInBatch()
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

Implementation of

BeerXML\Parser\IFermentable::setMoisture()
public number
# getMoisture( )

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.

Returns

number

Implementation of

BeerXML\Generator\IFermentable::getMoisture()
public
# setName( string $name )

Name of the fermentable.

Name of the fermentable.

Parameters

$name
string
$name

Implementation of

BeerXML\Parser\IFermentable::setName()
public string
# getName( )

Name of the fermentable.

Name of the fermentable.

Returns

string

Implementation of

BeerXML\Generator\IFermentable::getName()
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

Implementation of

BeerXML\Parser\IFermentable::setNotes()
public string
# getNotes( )

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

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

Returns

string

Implementation of

BeerXML\Generator\IFermentable::getNotes()
public
# setOrigin( string $origin )

Country or place of origin

Country or place of origin

Parameters

$origin
string
$origin

Implementation of

BeerXML\Parser\IFermentable::setOrigin()
public string
# getOrigin( )

Country or place of origin

Country or place of origin

Returns

string

Implementation of

BeerXML\Generator\IFermentable::getOrigin()
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

Implementation of

BeerXML\Parser\IFermentable::setProtein()
public number
# getProtein( )

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.

Returns

number

Implementation of

BeerXML\Generator\IFermentable::getProtein()
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

Implementation of

BeerXML\Parser\IFermentable::setRecommendMash()
public boolean
# getRecommendMash( )

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.

Returns

boolean

Implementation of

BeerXML\Generator\IFermentable::getRecommendMash()
public
# setSupplier( string $supplier )

Supplier of the grain/extract/sugar

Supplier of the grain/extract/sugar

Parameters

$supplier
string
$supplier

Implementation of

BeerXML\Parser\IFermentable::setSupplier()
public string
# getSupplier( )

Supplier of the grain/extract/sugar

Supplier of the grain/extract/sugar

Returns

string

Implementation of

BeerXML\Generator\IFermentable::getSupplier()
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

Implementation of

BeerXML\Parser\IFermentable::setType()
public string
# getType( )

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.

Returns

string

Implementation of

BeerXML\Generator\IFermentable::getType()
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

Implementation of

BeerXML\Parser\IFermentable::setVersion()
public integer
# getVersion( )

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.

Returns

integer

Implementation of

BeerXML\Generator\IFermentable::getVersion()
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

Implementation of

BeerXML\Parser\IFermentable::setYield()
public number
# getYield( )

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.

Returns

number

Implementation of

BeerXML\Generator\IFermentable::getYield()
public
# setDisplayAmount( string $displayAmount )

The amount of fermentables in this record along with the units formatted for easy display in the current user defined units. For example "1.5 lbs" or "2.1 kg".

The amount of fermentables in this record along with the units formatted for easy display in the current user defined units. For example "1.5 lbs" or "2.1 kg".

Parameters

$displayAmount
string
$displayAmount

Implementation of

BeerXML\Parser\IFermentableDisplay::setDisplayAmount()
public string
# getDisplayAmount( )

The amount of fermentables in this record along with the units formatted for easy display in the current user defined units. For example "1.5 lbs" or "2.1 kg".

The amount of fermentables in this record along with the units formatted for easy display in the current user defined units. For example "1.5 lbs" or "2.1 kg".

Returns

string

Implementation of

BeerXML\Generator\IFermentableDisplay::getDisplayAmount()
public
# setDisplayColor( string $displayColor )

Color in user defined color units along with the unit identified – for example "200L" or "40 ebc"

Color in user defined color units along with the unit identified – for example "200L" or "40 ebc"

Parameters

$displayColor
string
$displayColor

Implementation of

BeerXML\Parser\IFermentableDisplay::setDisplayColor()
public string
# getDisplayColor( )

Color in user defined color units along with the unit identified – for example "200L" or "40 ebc"

Color in user defined color units along with the unit identified – for example "200L" or "40 ebc"

Returns

string

Implementation of

BeerXML\Generator\IFermentableDisplay::getDisplayColor()
public
# setInventory( string $inventory )

Amount in inventory for this item along with the units – for example "10.0 lb"

Amount in inventory for this item along with the units – for example "10.0 lb"

Parameters

$inventory
string
$inventory

Implementation of

BeerXML\Parser\IFermentableDisplay::setInventory()
public string
# getInventory( )

Amount in inventory for this item along with the units – for example "10.0 lb"

Amount in inventory for this item along with the units – for example "10.0 lb"

Returns

string

Implementation of

BeerXML\Generator\IFermentableDisplay::getInventory()
public
# setPotential( float $potential )

The yield of the fermentable converted to specific gravity units for display. For example "1.036" or "1.040" might be valid potentials.

The yield of the fermentable converted to specific gravity units for display. For example "1.036" or "1.040" might be valid potentials.

Parameters

$potential
float
$potential

Implementation of

BeerXML\Parser\IFermentableDisplay::setPotential()
public float
# getPotential( )

The yield of the fermentable converted to specific gravity units for display. For example "1.036" or "1.040" might be valid potentials.

The yield of the fermentable converted to specific gravity units for display. For example "1.036" or "1.040" might be valid potentials.

Returns

float

Implementation of

BeerXML\Generator\IFermentableDisplay::getPotential()
Constants summary
string TYPE_GRAIN 'Grain'
#
string TYPE_SUGAR 'Sugar'
#
string TYPE_EXTRACT 'Extract'
#
string TYPE_DRY_EXTRACT 'Dry Extract'
#
string TYPE_ADJUNCT 'Adjunct'
#
php-beerxml API documentation generated by ApiGen 2.8.0