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 IFermentableDisplay

BeerXML\Generator\IFermentableDisplay implements BeerXML\Generator\IFermentable

Direct known implementers

BeerXML\Record\Fermentable
Namespace: BeerXML\Generator
Located at BeerXML/Generator/IFermentableDisplay.php
Methods summary
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
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
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
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
Methods inherited from BeerXML\Generator\IFermentable
getAddAfterBoil(), getAmount(), getCoarseFineDiff(), getColor(), getDiastaticPower(), getIbuGalPerLb(), getMaxInBatch(), getMoisture(), getName(), getNotes(), getOrigin(), getProtein(), getRecommendMash(), getSupplier(), getType(), getVersion(), getYield()
php-beerxml API documentation generated by ApiGen 2.8.0