Class Hop

BeerXML\Record\Hop implements BeerXML\Generator\IHopDisplay, BeerXML\Parser\IHopDisplay

Namespace: BeerXML\Record
Located at BeerXML/Record/Hop.php

Methods summary
`public`	# `setAlpha( number $alpha )` Percent alpha of hops - for example "5.5" represents 5.5% alpha Percent alpha of hops - for example "5.5" represents 5.5% alpha Parameters `$alpha` `number` $alpha Implementation of `BeerXML\Parser\IHop::setAlpha()`
`public number`	# `getAlpha( )` Percent alpha of hops - for example "5.5" represents 5.5% alpha Percent alpha of hops - for example "5.5" represents 5.5% alpha Returns `number` Implementation of `BeerXML\Generator\IHop::getAlpha()`
`public`	# `setAmount( number $amount )` Weight in Kilograms of the hops used in the recipe Weight in Kilograms of the hops used in the recipe Parameters `$amount` `number` $amount Implementation of `BeerXML\Parser\IHop::setAmount()`
`public number`	# `getAmount( )` Weight in Kilograms of the hops used in the recipe Weight in Kilograms of the hops used in the recipe Returns `number` Implementation of `BeerXML\Generator\IHop::getAmount()`
`public`	# `setBeta( number $beta )` Hop beta percentage - for example "4.4" denotes 4.4 % beta Hop beta percentage - for example "4.4" denotes 4.4 % beta Parameters `$beta` `number` $beta Implementation of `BeerXML\Parser\IHop::setBeta()`
`public number`	# `getBeta( )` Hop beta percentage - for example "4.4" denotes 4.4 % beta Hop beta percentage - for example "4.4" denotes 4.4 % beta Returns `number` Implementation of `BeerXML\Generator\IHop::getBeta()`
`public`	# `setCaryophyllene( number $caryophyllene )` Caryophyllene level in percent. Caryophyllene level in percent. Parameters `$caryophyllene` `number` $caryophyllene Implementation of `BeerXML\Parser\IHop::setCaryophyllene()`
`public number`	# `getCaryophyllene( )` Caryophyllene level in percent. Caryophyllene level in percent. Returns `number` Implementation of `BeerXML\Generator\IHop::getCaryophyllene()`
`public`	# `setCohumulone( number $cohumulone )` Cohumulone level in percent Cohumulone level in percent Parameters `$cohumulone` `number` $cohumulone Implementation of `BeerXML\Parser\IHop::setCohumulone()`
`public number`	# `getCohumulone( )` Cohumulone level in percent Cohumulone level in percent Returns `number` Implementation of `BeerXML\Generator\IHop::getCohumulone()`
`public`	# `setForm( string $form )` May be "Pellet", "Plug" or "Leaf" May be "Pellet", "Plug" or "Leaf" Parameters `$form` `string` $form Implementation of `BeerXML\Parser\IHop::setForm()`
`public string`	# `getForm( )` May be "Pellet", "Plug" or "Leaf" May be "Pellet", "Plug" or "Leaf" Returns `string` Implementation of `BeerXML\Generator\IHop::getForm()`
`public`	# `setHsi( number $hsi )` Hop Stability Index - defined as the percentage of hop alpha lost in 6 months of storage Hop Stability Index - defined as the percentage of hop alpha lost in 6 months of storage Parameters `$hsi` `number` $hsi Implementation of `BeerXML\Parser\IHop::setHsi()`
`public number`	# `getHsi( )` Hop Stability Index - defined as the percentage of hop alpha lost in 6 months of storage Hop Stability Index - defined as the percentage of hop alpha lost in 6 months of storage Returns `number` Implementation of `BeerXML\Generator\IHop::getHsi()`
`public`	# `setHumulene( number $humulene )` Humulene level in percent. Humulene level in percent. Parameters `$humulene` `number` $humulene Implementation of `BeerXML\Parser\IHop::setHumulene()`
`public number`	# `getHumulene( )` Humulene level in percent. Humulene level in percent. Returns `number` Implementation of `BeerXML\Generator\IHop::getHumulene()`
`public`	# `setMyrcene( number $myrcene )` Myrcene level in percent Myrcene level in percent Parameters `$myrcene` `number` $myrcene Implementation of `BeerXML\Parser\IHop::setMyrcene()`
`public number`	# `getMyrcene( )` Myrcene level in percent Myrcene level in percent Returns `number` Implementation of `BeerXML\Generator\IHop::getMyrcene()`
`public`	# `setName( string $name )` Name of the hops Name of the hops Parameters `$name` `string` $name Implementation of `BeerXML\Parser\IHop::setName()`
`public string`	# `getName( )` Name of the hops Name of the hops Returns `string` Implementation of `BeerXML\Generator\IHop::getName()`
`public`	# `setNotes( string $notes )` Textual notes about the hops, usage, substitutes. May be a multiline entry. Textual notes about the hops, usage, substitutes. May be a multiline entry. Parameters `$notes` `string` $notes Implementation of `BeerXML\Parser\IHop::setNotes()`
`public string`	# `getNotes( )` Textual notes about the hops, usage, substitutes. May be a multiline entry. Textual notes about the hops, usage, substitutes. May be a multiline entry. Returns `string` Implementation of `BeerXML\Generator\IHop::getNotes()`
`public`	# `setOrigin( string $origin )` Place of origin for the hops Place of origin for the hops Parameters `$origin` `string` $origin Implementation of `BeerXML\Parser\IHop::setOrigin()`
`public string`	# `getOrigin( )` Place of origin for the hops Place of origin for the hops Returns `string` Implementation of `BeerXML\Generator\IHop::getOrigin()`
`public`	# `setSubstitutes( string $substitutes )` Substitutes that can be used for this hops Substitutes that can be used for this hops Parameters `$substitutes` `string` $substitutes Implementation of `BeerXML\Parser\IHop::setSubstitutes()`
`public string`	# `getSubstitutes( )` Substitutes that can be used for this hops Substitutes that can be used for this hops Returns `string` Implementation of `BeerXML\Generator\IHop::getSubstitutes()`
`public`	# `setTime( number $time )` The time as measured in minutes. Meaning is dependent on the "USE" field. For "Boil" this is the boil time. For "Mash" this is the mash time. For "First Wort" this is the boil time. For "Aroma" this is the steep time. For "Dry Hop" this is the amount of time to dry hop. The time as measured in minutes. Meaning is dependent on the "USE" field. For "Boil" this is the boil time. For "Mash" this is the mash time. For "First Wort" this is the boil time. For "Aroma" this is the steep time. For "Dry Hop" this is the amount of time to dry hop. Parameters `$time` `number` $time Implementation of `BeerXML\Parser\IHop::setTime()`
`public number`	# `getTime( )` The time as measured in minutes. Meaning is dependent on the "USE" field. For "Boil" this is the boil time. For "Mash" this is the mash time. For "First Wort" this is the boil time. For "Aroma" this is the steep time. For "Dry Hop" this is the amount of time to dry hop. The time as measured in minutes. Meaning is dependent on the "USE" field. For "Boil" this is the boil time. For "Mash" this is the mash time. For "First Wort" this is the boil time. For "Aroma" this is the steep time. For "Dry Hop" this is the amount of time to dry hop. Returns `number` Implementation of `BeerXML\Generator\IHop::getTime()`
`public`	# `setType( string $type )` May be "Bittering", "Aroma" or "Both" May be "Bittering", "Aroma" or "Both" Parameters `$type` `string` $type Implementation of `BeerXML\Parser\IHop::setType()`
`public string`	# `getType( )` May be "Bittering", "Aroma" or "Both" May be "Bittering", "Aroma" or "Both" Returns `string` Implementation of `BeerXML\Generator\IHop::getType()`
`public`	# `setUse( string $use )` May be "Boil", "Dry Hop", "Mash", "First Wort" or "Aroma". Note that "Aroma" and "Dry Hop" do not contribute to the bitterness of the beer while the others do. Aroma hops are added after the boil and do not contribute substantially to beer bitterness. May be "Boil", "Dry Hop", "Mash", "First Wort" or "Aroma". Note that "Aroma" and "Dry Hop" do not contribute to the bitterness of the beer while the others do. Aroma hops are added after the boil and do not contribute substantially to beer bitterness. Parameters `$use` `string` $use Implementation of `BeerXML\Parser\IHop::setUse()`
`public string`	# `getUse( )` May be "Boil", "Dry Hop", "Mash", "First Wort" or "Aroma". Note that "Aroma" and "Dry Hop" do not contribute to the bitterness of the beer while the others do. Aroma hops are added after the boil and do not contribute substantially to beer bitterness. May be "Boil", "Dry Hop", "Mash", "First Wort" or "Aroma". Note that "Aroma" and "Dry Hop" do not contribute to the bitterness of the beer while the others do. Aroma hops are added after the boil and do not contribute substantially to beer bitterness. Returns `string` Implementation of `BeerXML\Generator\IHop::getUse()`
`public`	# `setVersion( integer $version )` Should be set to 1 for this version of the XML standard. May be a higher number for later versions but all later versions shall be backward compatible. Should be set to 1 for this version of the XML standard. May be a higher number for later versions but all later versions shall be backward compatible. Parameters `$version` `integer` $version Implementation of `BeerXML\Parser\IHop::setVersion()`
`public integer`	# `getVersion( )` Should be set to 1 for this version of the XML standard. May be a higher number for later versions but all later versions shall be backward compatible. Should be set to 1 for this version of the XML standard. May be a higher number for later versions but all later versions shall be backward compatible. Returns `integer` Implementation of `BeerXML\Generator\IHop::getVersion()`
`public`	# `setDisplayAmount( string $displayAmount )` The amount of hops in this record along with the units formatted for easy display in the current user defined units. For example "100 g" or "1.5 oz". The amount of hops in this record along with the units formatted for easy display in the current user defined units. For example "100 g" or "1.5 oz". Parameters `$displayAmount` `string` $displayAmount Implementation of `BeerXML\Parser\IHopDisplay::setDisplayAmount()`
`public string`	# `getDisplayAmount( )` The amount of hops in this record along with the units formatted for easy display in the current user defined units. For example "100 g" or "1.5 oz". The amount of hops in this record along with the units formatted for easy display in the current user defined units. For example "100 g" or "1.5 oz". Returns `string` Implementation of `BeerXML\Generator\IHopDisplay::getDisplayAmount()`
`public`	# `setDisplayTime( string $displayTime )` Time displayed in minutes for all uses except for the dry hop which is in days. For example "60 min", "3 days". Time displayed in minutes for all uses except for the dry hop which is in days. For example "60 min", "3 days". Parameters `$displayTime` `string` $displayTime Implementation of `BeerXML\Parser\IHopDisplay::setDisplayTime()`
`public string`	# `getDisplayTime( )` Time displayed in minutes for all uses except for the dry hop which is in days. For example "60 min", "3 days". Time displayed in minutes for all uses except for the dry hop which is in days. For example "60 min", "3 days". Returns `string` Implementation of `BeerXML\Generator\IHopDisplay::getDisplayTime()`
`public`	# `setInventory( string $inventory )` Amount in inventory for this item along with the units – for example "10.0 oz" Amount in inventory for this item along with the units – for example "10.0 oz" Parameters `$inventory` `string` $inventory Implementation of `BeerXML\Parser\IHopDisplay::setInventory()`
`public string`	# `getInventory( )` Amount in inventory for this item along with the units – for example "10.0 oz" Amount in inventory for this item along with the units – for example "10.0 oz" Returns `string` Implementation of `BeerXML\Generator\IHopDisplay::getInventory()`

Constants summary
`string`	`USE_BOIL`	`'Boil'`	#
`string`	`USE_DRY_HOP`	`'Dry Hop'`	#
`string`	`USE_MASH`	`'Mash'`	#
`string`	`USE_FIRST_WORT`	`'First Wort'`	#
`string`	`USE_AROMA`	`'Aroma'`	#
`string`	`TYPE_BITTERING`	`'Bittering'`	#
`string`	`TYPE_AROMA`	`'Aroma'`	#
`string`	`TYPE_BOTH`	`'Both'`	#
`string`	`FORM_PELLET`	`'Pellet'`	#
`string`	`FORM_PLUG`	`'Plug'`	#
`string`	`FORM_LEAF`	`'Leaf'`	#

Namespaces

Classes

Class Hop

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters