Overview

Namespaces

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

Classes

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

Class Misc

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

Implementation of

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

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.

Returns

number

Implementation of

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

Implementation of

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

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.

Returns

boolean

Implementation of

BeerXML\Generator\IMisc::getAmountIsWeight()
public
# setName( string $name )

Name of the misc item.

Name of the misc item.

Parameters

$name
string
$name

Implementation of

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

Name of the misc item.

Name of the misc item.

Returns

string

Implementation of

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

Implementation of

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

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

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

Returns

string

Implementation of

BeerXML\Generator\IMisc::getNotes()
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

Implementation of

BeerXML\Parser\IMisc::setTime()
public number
# getTime( )

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

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

Returns

number

Implementation of

BeerXML\Generator\IMisc::getTime()
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

Implementation of

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

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

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

Returns

string

Implementation of

BeerXML\Generator\IMisc::getType()
public
# setUse( string $use )

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

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

Parameters

$use
string
$use

Implementation of

BeerXML\Parser\IMisc::setUse()
public string
# getUse( )

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

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

Returns

string

Implementation of

BeerXML\Generator\IMisc::getUse()
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

Implementation of

BeerXML\Parser\IMisc::setUseFor()
public string
# getUseFor( )

Short description of what the ingredient is used for in text

Short description of what the ingredient is used for in text

Returns

string

Implementation of

BeerXML\Generator\IMisc::getUseFor()
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

Implementation of

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

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

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

Returns

integer

Implementation of

BeerXML\Generator\IMisc::getVersion()
public
# setDisplayAmount( string $displayAmount )

The amount of the item 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 the item 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\IMiscDisplay::setDisplayAmount()
public string
# getDisplayAmount( )

The amount of the item 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 the item 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\IMiscDisplay::getDisplayAmount()
public
# setDisplayTime( string $displayTime )

Time in appropriate units along with the units as in "10 min" or "3 days".

Time in appropriate units along with the units as in "10 min" or "3 days".

Parameters

$displayTime
string
$displayTime

Implementation of

BeerXML\Parser\IMiscDisplay::setDisplayTime()
public string
# getDisplayTime( )

Time in appropriate units along with the units as in "10 min" or "3 days".

Time in appropriate units along with the units as in "10 min" or "3 days".

Returns

string

Implementation of

BeerXML\Generator\IMiscDisplay::getDisplayTime()
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\IMiscDisplay::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\IMiscDisplay::getInventory()
Constants summary
string TYPE_SPICE 'Spice'
#
string TYPE_FINING 'Fining'
#
string TYPE_WATER_AGENT 'Water Agent'
#
string TYPE_HERB 'Herb'
#
string TYPE_FLAVOR 'Flavor'
#
string TYPE_OTHER 'Other'
#
string USE_BOIL 'Boil'
#
string USE_MASH 'Mash'
#
string USE_PRIMARY 'Primary'
#
string USE_SECONDARY 'Secondary'
#
string USE_BOTTLING 'Bottling'
#
php-beerxml API documentation generated by ApiGen 2.8.0