Overview

Namespaces

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

Classes

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

Class Yeast

BeerXML\Record\Yeast implements BeerXML\Generator\IYeastDisplay, BeerXML\Parser\IYeastDisplay
Namespace: BeerXML\Record
Located at BeerXML/Record/Yeast.php
Methods summary
public
# setAddToSecondary( boolean $addToSecondary )

Flag denoting that this yeast was added for a secondary (or later) fermentation as opposed to the primary fermentation. Useful if one uses two or more yeast strains for a single brew (eg: Lambic). Default value is FALSE.

Flag denoting that this yeast was added for a secondary (or later) fermentation as opposed to the primary fermentation. Useful if one uses two or more yeast strains for a single brew (eg: Lambic). Default value is FALSE.

Parameters

$addToSecondary
boolean
$addToSecondary

Implementation of

BeerXML\Parser\IYeast::setAddToSecondary()
public boolean
# getAddToSecondary( )

Flag denoting that this yeast was added for a secondary (or later) fermentation as opposed to the primary fermentation. Useful if one uses two or more yeast strains for a single brew (eg: Lambic). Default value is FALSE.

Flag denoting that this yeast was added for a secondary (or later) fermentation as opposed to the primary fermentation. Useful if one uses two or more yeast strains for a single brew (eg: Lambic). Default value is FALSE.

Returns

boolean

Implementation of

BeerXML\Generator\IYeast::getAddToSecondary()
public
# setAmount( number $amount )

The amount of yeast, measured in liters. For a starter this is the size of the starter. If the flag AMOUNT_IS_WEIGHT is set to TRUE then this measurement is in kilograms and not liters.

The amount of yeast, measured in liters. For a starter this is the size of the starter. If the flag AMOUNT_IS_WEIGHT is set to TRUE then this measurement is in kilograms and not liters.

Parameters

$amount
number
$amount

Implementation of

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

The amount of yeast, measured in liters. For a starter this is the size of the starter. If the flag AMOUNT_IS_WEIGHT is set to TRUE then this measurement is in kilograms and not liters.

The amount of yeast, measured in liters. For a starter this is the size of the starter. If the flag AMOUNT_IS_WEIGHT is set to TRUE then this measurement is in kilograms and not liters.

Returns

number

Implementation of

BeerXML\Generator\IYeast::getAmount()
public
# setAmountIsWeight( boolean $amountIsWeight )

Parameters

$amountIsWeight
boolean
$amountIsWeight

Implementation of

BeerXML\Parser\IYeast::setAmountIsWeight()
public boolean
# getAmountIsWeight( )

Returns

boolean

Implementation of

BeerXML\Generator\IYeast::getAmountIsWeight()
public
# setAttenuation( number $attenuation )

Average attenuation for this yeast strain.

Average attenuation for this yeast strain.

Parameters

$attenuation
number
$attenuation

Implementation of

BeerXML\Parser\IYeast::setAttenuation()
public number
# getAttenuation( )

Average attenuation for this yeast strain.

Average attenuation for this yeast strain.

Returns

number

Implementation of

BeerXML\Generator\IYeast::getAttenuation()
public
# setBestFor( string $bestFor )

Styles or types of beer this yeast strain is best suited for.

Styles or types of beer this yeast strain is best suited for.

Parameters

$bestFor
string
$bestFor

Implementation of

BeerXML\Parser\IYeast::setBestFor()
public string
# getBestFor( )

Styles or types of beer this yeast strain is best suited for.

Styles or types of beer this yeast strain is best suited for.

Returns

string

Implementation of

BeerXML\Generator\IYeast::getBestFor()
public
# setFlocculation( string $flocculation )

May be "Low", "Medium", "High" or "Very High"

May be "Low", "Medium", "High" or "Very High"

Parameters

$flocculation
string
$flocculation

Implementation of

BeerXML\Parser\IYeast::setFlocculation()
public string
# getFlocculation( )

May be "Low", "Medium", "High" or "Very High"

May be "Low", "Medium", "High" or "Very High"

Returns

string

Implementation of

BeerXML\Generator\IYeast::getFlocculation()
public
# setForm( string $form )

May be "Liquid", "Dry", "Slant" or "Culture"

May be "Liquid", "Dry", "Slant" or "Culture"

Parameters

$form
string
$form

Implementation of

BeerXML\Parser\IYeast::setForm()
public string
# getForm( )

May be "Liquid", "Dry", "Slant" or "Culture"

May be "Liquid", "Dry", "Slant" or "Culture"

Returns

string

Implementation of

BeerXML\Generator\IYeast::getForm()
public
# setLaboratory( string $laboratory )

The name of the laboratory that produced the yeast.

The name of the laboratory that produced the yeast.

Parameters

$laboratory
string
$laboratory

Implementation of

BeerXML\Parser\IYeast::setLaboratory()
public string
# getLaboratory( )

The name of the laboratory that produced the yeast.

The name of the laboratory that produced the yeast.

Returns

string

Implementation of

BeerXML\Generator\IYeast::getLaboratory()
public
# setMaxReuse( integer $maxReuse )

Recommended of times this yeast can be reused (recultured from a previous batch)

Recommended of times this yeast can be reused (recultured from a previous batch)

Parameters

$maxReuse
integer
$maxReuse

Implementation of

BeerXML\Parser\IYeast::setMaxReuse()
public integer
# getMaxReuse( )

Recommended of times this yeast can be reused (recultured from a previous batch)

Recommended of times this yeast can be reused (recultured from a previous batch)

Returns

integer

Implementation of

BeerXML\Generator\IYeast::getMaxReuse()
public
# setMaxTemperature( number $maxTemperature )

The maximum recommended temperature for fermenting this yeast strain in Celsius.

The maximum recommended temperature for fermenting this yeast strain in Celsius.

Parameters

$maxTemperature
number
$maxTemperature

Implementation of

BeerXML\Parser\IYeast::setMaxTemperature()
public number
# getMaxTemperature( )

The maximum recommended temperature for fermenting this yeast strain in Celsius.

The maximum recommended temperature for fermenting this yeast strain in Celsius.

Returns

number

Implementation of

BeerXML\Generator\IYeast::getMaxTemperature()
public
# setMinTemperature( number $minTemperature )

The minimum recommended temperature for fermenting this yeast strain in degrees Celsius.

The minimum recommended temperature for fermenting this yeast strain in degrees Celsius.

Parameters

$minTemperature
number
$minTemperature

Implementation of

BeerXML\Parser\IYeast::setMinTemperature()
public number
# getMinTemperature( )

The minimum recommended temperature for fermenting this yeast strain in degrees Celsius.

The minimum recommended temperature for fermenting this yeast strain in degrees Celsius.

Returns

number

Implementation of

BeerXML\Generator\IYeast::getMinTemperature()
public
# setName( string $name )

Name of the yeast.

Name of the yeast.

Parameters

$name
string
$name

Implementation of

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

Name of the yeast.

Name of the yeast.

Returns

string

Implementation of

BeerXML\Generator\IYeast::getName()
public
# setNotes( string $notes )

Notes on this yeast strain. May be a multiline entry.

Notes on this yeast strain. May be a multiline entry.

Parameters

$notes
string
$notes

Implementation of

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

Notes on this yeast strain. May be a multiline entry.

Notes on this yeast strain. May be a multiline entry.

Returns

string

Implementation of

BeerXML\Generator\IYeast::getNotes()
public
# setProductId( string $productId )

The manufacturer’s product ID label or number that identifies this particular strain of yeast.

The manufacturer’s product ID label or number that identifies this particular strain of yeast.

Parameters

$productId
string
$productId

Implementation of

BeerXML\Parser\IYeast::setProductId()
public string
# getProductId( )

The manufacturer’s product ID label or number that identifies this particular strain of yeast.

The manufacturer’s product ID label or number that identifies this particular strain of yeast.

Returns

string

Implementation of

BeerXML\Generator\IYeast::getProductId()
public
# setTimesCultured( integer $timesCultured )

Number of times this yeast has been reused as a harvested culture. This number should be zero if this is a product directly from the manufacturer.

Number of times this yeast has been reused as a harvested culture. This number should be zero if this is a product directly from the manufacturer.

Parameters

$timesCultured
integer
$timesCultured

Implementation of

BeerXML\Parser\IYeast::setTimesCultured()
public integer
# getTimesCultured( )

Number of times this yeast has been reused as a harvested culture. This number should be zero if this is a product directly from the manufacturer.

Number of times this yeast has been reused as a harvested culture. This number should be zero if this is a product directly from the manufacturer.

Returns

integer

Implementation of

BeerXML\Generator\IYeast::getTimesCultured()
public
# setType( string $type )

May be "Ale", "Lager", "Wheat", "Wine" or "Champagne"

May be "Ale", "Lager", "Wheat", "Wine" or "Champagne"

Parameters

$type
string
$type

Implementation of

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

May be "Ale", "Lager", "Wheat", "Wine" or "Champagne"

May be "Ale", "Lager", "Wheat", "Wine" or "Champagne"

Returns

string

Implementation of

BeerXML\Generator\IYeast::getType()
public
# setVersion( integer $version )

Version of the standard. Should be "1" for this version.

Version of the standard. Should be "1" for this version.

Parameters

$version
integer
$version

Implementation of

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

Version of the standard. Should be "1" for this version.

Version of the standard. Should be "1" for this version.

Returns

integer

Implementation of

BeerXML\Generator\IYeast::getVersion()
public
# setCultureDate( DateTime $cultureDate )

Date sample was last cultured

Date sample was last cultured

Parameters

$cultureDate
DateTime
$cultureDate

Implementation of

BeerXML\Parser\IYeastDisplay::setCultureDate()
public DateTime
# getCultureDate( )

Date sample was last cultured

Date sample was last cultured

Returns

DateTime

Implementation of

BeerXML\Generator\IYeastDisplay::getCultureDate()
public
# setDispMaxTemp( string $dispMaxTemp )

Maximum fermentation temperature converted to current user units along with the units. For example "54.0 F" or "24.2 C"

Maximum fermentation temperature converted to current user units along with the units. For example "54.0 F" or "24.2 C"

Parameters

$dispMaxTemp
string
$dispMaxTemp

Implementation of

BeerXML\Parser\IYeastDisplay::setDispMaxTemp()
public string
# getDispMaxTemp( )

Maximum fermentation temperature converted to current user units along with the units. For example "54.0 F" or "24.2 C"

Maximum fermentation temperature converted to current user units along with the units. For example "54.0 F" or "24.2 C"

Returns

string

Implementation of

BeerXML\Generator\IYeastDisplay::getDispMaxTemp()
public
# setDispMinTemp( string $dispMinTemp )

Minimum fermentation temperature converted to current user units along with the units. For example "54.0 F" or "24.2 C"

Minimum fermentation temperature converted to current user units along with the units. For example "54.0 F" or "24.2 C"

Parameters

$dispMinTemp
string
$dispMinTemp

Implementation of

BeerXML\Parser\IYeastDisplay::setDispMinTemp()
public string
# getDispMinTemp( )

Minimum fermentation temperature converted to current user units along with the units. For example "54.0 F" or "24.2 C"

Minimum fermentation temperature converted to current user units along with the units. For example "54.0 F" or "24.2 C"

Returns

string

Implementation of

BeerXML\Generator\IYeastDisplay::getDispMinTemp()
public
# setDisplayAmount( string $displayAmount )

The amount of yeast or starter in this record along with the units formatted for easy display in the current user defined units. For example "1.5 oz" or "100 g".

The amount of yeast or starter in this record along with the units formatted for easy display in the current user defined units. For example "1.5 oz" or "100 g".

Parameters

$displayAmount
string
$displayAmount

Implementation of

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

The amount of yeast or starter in this record along with the units formatted for easy display in the current user defined units. For example "1.5 oz" or "100 g".

The amount of yeast or starter in this record along with the units formatted for easy display in the current user defined units. For example "1.5 oz" or "100 g".

Returns

string

Implementation of

BeerXML\Generator\IYeastDisplay::getDisplayAmount()
public
# setInventory( string $inventory )

Amount in inventory for this hop along with the units – for example "10.0 pkgs"

Amount in inventory for this hop along with the units – for example "10.0 pkgs"

Parameters

$inventory
string
$inventory

Implementation of

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

Amount in inventory for this hop along with the units – for example "10.0 pkgs"

Amount in inventory for this hop along with the units – for example "10.0 pkgs"

Returns

string

Implementation of

BeerXML\Generator\IYeastDisplay::getInventory()
Constants summary
string TYPE_LAGER 'Lager'
#
string TYPE_ALE 'Ale'
#
string TYPE_WHEAT 'Wheat'
#
string TYPE_WINE 'Wine'
#
string TYPE_CHAMPAGNE 'Champagne'
#
string FORM_LIQUID 'Liquid'
#
string FORM_DRY 'Dry'
#
string FORM_SLANT 'Slant'
#
string FORM_CULTURE 'Culture'
#
string FLOCCULATION_LOW 'Low'
#
string FLOCCULATION_MEDIUM 'Medium'
#
string FLOCCULATION_HIGH 'High'
#
string FLOCCULATION_VERY_HIGH 'Very High'
#
php-beerxml API documentation generated by ApiGen 2.8.0