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 IHop

Direct known implementers

BeerXML\Parser\IHopDisplay

Indirect known implementers

BeerXML\Record\Hop
Namespace: BeerXML\Parser
Located at BeerXML/Parser/IHop.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
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
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
public
# setCaryophyllene( number $caryophyllene )

Caryophyllene level in percent.

Caryophyllene level in percent.

Parameters

$caryophyllene
number
$caryophyllene
public
# setCohumulone( number $cohumulone )

Cohumulone level in percent

Cohumulone level in percent

Parameters

$cohumulone
number
$cohumulone
public
# setForm( string $form )

May be "Pellet", "Plug" or "Leaf"

May be "Pellet", "Plug" or "Leaf"

Parameters

$form
string
$form
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
public
# setHumulene( number $humulene )

Humulene level in percent.

Humulene level in percent.

Parameters

$humulene
number
$humulene
public
# setMyrcene( number $myrcene )

Myrcene level in percent

Myrcene level in percent

Parameters

$myrcene
number
$myrcene
public
# setName( string $name )

Name of the hops

Name of the hops

Parameters

$name
string
$name
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
public
# setOrigin( string $origin )

Place of origin for the hops

Place of origin for the hops

Parameters

$origin
string
$origin
public
# setSubstitutes( string $substitutes )

Substitutes that can be used for this hops

Substitutes that can be used for this hops

Parameters

$substitutes
string
$substitutes
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
public
# setType( string $type )

May be "Bittering", "Aroma" or "Both"

May be "Bittering", "Aroma" or "Both"

Parameters

$type
string
$type
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
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
php-beerxml API documentation generated by ApiGen 2.8.0