Class Record

Abstract Record Parser

This sets the stage for all of our parsers. Each subclass can define a map of tags to setter methods. The parser will then call the setter methods with the values from those tags.

Direct known subclasses

BeerXML\Parser\Equipment, BeerXML\Parser\Fermentable, BeerXML\Parser\Hop, BeerXML\Parser\MashProfile, BeerXML\Parser\MashStep, BeerXML\Parser\Misc, BeerXML\Parser\Recipe, BeerXML\Parser\Style, BeerXML\Parser\Water, BeerXML\Parser\Yeast

Abstract
Namespace: BeerXML\Parser
Package: BeerXML\Parser
Located at BeerXML/Parser/Record.php

Methods summary
`public`	# `setRecordFactory( BeerXML\Parser\RecordFactory $recordFactory )` Parameters `$recordFactory` `BeerXML\Parser\RecordFactory` $recordFactory
`public`	# `setXmlReader( XMLReader $xmlReader )` Parameters `$xmlReader` `XMLReader` $xmlReader
`public`	# `setXmlString( string $xmlStr )` Parameters `$xmlStr` `string` $xmlStr BeerXML to parse
`public mixed`	# `parse( )` Returns `mixed` Throws `BeerXML\Exception\BadData`
`abstract protected`	# `createRecord( )`
`protected`	# `otherElementEncountered( BeerXML\Parser\IRecipe\|BeerXML\Parser\IEquipment\|BeerXML\Parser\IFermentable\|BeerXML\Parser\IHop\|BeerXML\Parser\IMashProfile\|BeerXML\Parser\IMisc\|BeerXML\Parser\IStyle\|BeerXML\Parser\IWater\|BeerXML\Parser\IYeast $record )` Called when an unknown element is encountered, useful for edge cases Called when an unknown element is encountered, useful for edge cases Parameters `$record` `BeerXML\Parser\IRecipe\|BeerXML\Parser\IEquipment\|BeerXML\Parser\IFermentable\|BeerXML\Parser\IHop\|BeerXML\Parser\IMashProfile\|BeerXML\Parser\IMisc\|BeerXML\Parser\IStyle\|BeerXML\Parser\IWater\|BeerXML\Parser\IYeast`
`protected`	# `setComplexPropertySet( mixed $record )` Add a set of records to the record Add a set of records to the record Parameters `$record` `mixed` $record Throws `BeerXML\Exception\BadData`
`protected`	# `setComplexProperty( mixed $record )` Set a complex value to the record Set a complex value to the record Parameters `$record` `mixed` $record
`protected BeerXML\Parser\Record`	# `createRecordParser( string $class )` Parameters `$class` `string` $class Returns `BeerXML\Parser\Record`

Properties summary
`protected string`	`$tagName`	`null`	# The <TAG> that a subclass parses The <TAG> that a subclass parses
`protected XMLReader`	`$xmlReader`		#
`protected BeerXML\Parser\RecordFactory`	`$recordFactory`		#
`protected array`	`$simpleProperties`	`array()`	# Tags that map to simple values and the corresponding setter method on the record class Tags that map to simple values and the corresponding setter method on the record class
`protected array`	`$complexProperties`	`array( 'STYLE' => array( 'parser' => '\BeerXML\Parser\Style', 'method' => 'setStyle' ), 'EQUIPMENT' => array( 'parser' => '\BeerXML\Parser\Equipment', 'method' => 'setEquipment' ), 'MASH' => array( 'parser' => '\BeerXML\Parser\MashProfile', 'method' => 'setMash' ), )`	#
`protected array`	`$complexPropertySets`	array( 'HOPS' => array( 'tag' => 'HOP', 'parser' => '\BeerXML\Parser\Hop', 'method' => 'addHop' ), 'FERMENTABLES' => array( 'tag' => 'FERMENTABLE', 'parser' => '\BeerXML\Parser\Fermentable', 'method' => 'addFermentable', ), 'MISCS' => array( 'tag' => 'MISC', 'parser' => '\BeerXML\Parser\Misc', 'method' => 'addMisc', ), 'WATERS' => array( 'tag' => 'WATER', 'parser' => '\BeerXML\Parser\Water', 'method' => 'addWater', ), 'YEASTS' => array( 'tag' => 'YEAST', 'parser' => '\BeerXML\Parser\Yeast', 'method' => 'addYeast', ), 'MASH_STEPS' => array( 'tag' => 'MASH_STEP', 'parser' => '\BeerXML\Parser\MashStep', 'method' => 'addMashStep', ), 'STYLES' => array( 'tag' => 'STYLE', 'parser' => '\BeerXML\Parser\Style', 'method' => 'addSTyle' ), 'EQUIPMENTS' => array( 'tag' => 'EQUIPMENT', 'parser' => '\BeerXML\Parser\Equipment', 'method' => 'addEquipment' ), 'MASHS' => array( 'tag' => 'MASH', 'parser' => '\BeerXML\Parser\MashProfile', 'method' => 'addMash' ), )	#

Namespaces

Classes

Interfaces

Class Record

Direct known subclasses

Parameters

Parameters

Parameters

Returns

Throws

Parameters

Parameters

Throws

Parameters

Parameters

Returns