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
|
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.
Parameters
|
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
|
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
|
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
|
public
|
#
setUse( string $use )
May be "Boil", "Mash", "Primary", "Secondary", "Bottling"
May be "Boil", "Mash", "Primary", "Secondary", "Bottling"
Parameters
|
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
|
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
|