Overview

Namespaces

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

Classes

  • Equipment
  • Fermentable
  • Hop
  • MashProfile
  • MashStep
  • Misc
  • Recipe
  • Record
  • 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\Generator\IHopDisplay

Indirect known implementers

BeerXML\Record\Hop
Namespace: BeerXML\Generator
Located at BeerXML/Generator/IHop.php
Methods summary
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
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
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
public number
# getCaryophyllene( )

Caryophyllene level in percent.

Caryophyllene level in percent.

Returns

number
public number
# getCohumulone( )

Cohumulone level in percent

Cohumulone level in percent

Returns

number
public string
# getForm( )

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

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

Returns

string
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
public number
# getHumulene( )

Humulene level in percent.

Humulene level in percent.

Returns

number
public number
# getMyrcene( )

Myrcene level in percent

Myrcene level in percent

Returns

number
public string
# getName( )

Name of the hops

Name of the hops

Returns

string
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
public string
# getOrigin( )

Place of origin for the hops

Place of origin for the hops

Returns

string
public string
# getSubstitutes( )

Substitutes that can be used for this hops

Substitutes that can be used for this hops

Returns

string
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
public string
# getType( )

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

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

Returns

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