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

Interface IYeast

Direct known implementers

BeerXML\Generator\IYeastDisplay

Indirect known implementers

BeerXML\Record\Yeast
Namespace: BeerXML\Generator
Located at BeerXML/Generator/IYeast.php
Methods summary
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
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
public boolean
# getAmountIsWeight( )

Returns

boolean
public number
# getAttenuation( )

Average attenuation for this yeast strain.

Average attenuation for this yeast strain.

Returns

number
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
public string
# getFlocculation( )

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

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

Returns

string
public string
# getForm( )

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

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

Returns

string
public string
# getLaboratory( )

The name of the laboratory that produced the yeast.

The name of the laboratory that produced the yeast.

Returns

string
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
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
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
public string
# getName( )

Name of the yeast.

Name of the yeast.

Returns

string
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
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
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
public string
# getType( )

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

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

Returns

string
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
php-beerxml API documentation generated by ApiGen 2.8.0