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 IMisc

Direct known implementers

BeerXML\Parser\IMiscDisplay

Indirect known implementers

BeerXML\Record\Misc
Namespace: BeerXML\Parser
Located at BeerXML/Parser/IMisc.php
Methods summary
public
# setAmount( number $amount )

Amount of item used. The default measurements are by weight, but this may be the measurement in volume units if AMOUNT_IS_WEIGHT is set to TRUE for this record. If a liquid it is in liters, if a solid the weight is measured in kilograms.

Amount of item used. The default measurements are by weight, but this may be the measurement in volume units if AMOUNT_IS_WEIGHT is set to TRUE for this record. If a liquid it is in liters, if a solid the weight is measured in kilograms.

Parameters

$amount
number
$amount
public
# setAmountIsWeight( boolean $amountIsWeight )

TRUE if the amount measurement is a weight measurement and FALSE if the amount is a volume measurement. Default value (if not present) is assumed to be FALSE.

TRUE if the amount measurement is a weight measurement and FALSE if the amount is a volume measurement. Default value (if not present) is assumed to be FALSE.

Parameters

$amountIsWeight
boolean
$amountIsWeight
public
# setName( string $name )

Name of the misc item.

Name of the misc item.

Parameters

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

Detailed notes on the item including usage. May be multiline.

Detailed notes on the item including usage. May be multiline.

Parameters

$notes
string
$notes
public
# setTime( number $time )

Amount of time the misc was boiled, steeped, mashed, etc in minutes

Amount of time the misc was boiled, steeped, mashed, etc in minutes

Parameters

$time
number
$time
public
# setType( string $type )

May be "Spice", "Fining", "Water Agent", "Herb", "Flavor" or "Other"

May be "Spice", "Fining", "Water Agent", "Herb", "Flavor" or "Other"

Parameters

$type
string
$type
public
# setUse( string $use )

May be "Boil", "Mash", "Primary", "Secondary", "Bottling"

May be "Boil", "Mash", "Primary", "Secondary", "Bottling"

Parameters

$use
string
$use
public
# setUseFor( string $useFor )

Short description of what the ingredient is used for in text

Short description of what the ingredient is used for in text

Parameters

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

Version number of this element. Should be "1" for this version.

Version number of this element. Should be "1" for this version.

Parameters

$version
integer
$version
php-beerxml API documentation generated by ApiGen 2.8.0