Docs For Class FileParser

Description

Class for parsing MIDI files

since: 1.0

Located in /Parsing/FileParser.php (line 24)

Parser
   |
   --FileParser

Variable Summary

TrackParser $trackParser

int $tracksExpected

int $tracksParsed

Method Summary

FileParser __construct ([TrackParser $trackParser = null])

void afterLoad ()

binary getRawFileHeader ()

int getTracksExpected ()

int getTracksParsed ()

Chunk parse ()

FileHeader parseFileHeader (binary $header)

Variables

TrackParser $trackParser (line 29)

access: private

int $tracksExpected (line 43)

The number of tracks expected to be parsed

access: private

int $tracksParsed (line 36)

The number of tracks parsed thus far

access: private

Inherited Variables

Inherited from Parser

Parser::$file
Parser::$state

Methods

Constructor __construct (line 55)

Constructor

The parse state is initialized to ParseState::FILE_HEADER.

since: 1.0
access: public
uses: Parser::setState()

FileParser __construct ([TrackParser $trackParser = null])

TrackParser $trackParser

Redefinition of:

Parser::__construct(): Constructor

afterLoad (line 90)

since: 1.0
access: protected
uses: TrackParser::setBuffer()

void afterLoad ()

Redefinition of:

Parser::afterLoad(): Called after load()

getRawFileHeader (line 103)

Gets the raw binary file header

since: 1.0
access: protected
usedby: FileParser::parse()
uses: Parser::read()
uses: FileHeader::LENGTH

binary getRawFileHeader ()

getTracksExpected (line 82)

Gets the number of tracks that should be in the MIDI file

since: 1.0
access: public

int getTracksExpected ()

getTracksParsed (line 71)

Gets the number of tracks that have been parsed so far

since: 1.0
access: public

int getTracksParsed ()

parse (line 160)

since: 1.0
throws: ParseException
access: public
uses: TrackParser::parse()
uses: TrackParser::getState()
uses: FileParser::parseFileHeader()
uses: Chunk::getData()
uses: FileParser::getRawFileHeader()
uses: Parser::getState()

Chunk parse ()

Redefinition of:

Parser::parse(): Parses the buffer stream and returns the next chunk

parseFileHeader (line 119)

Parses the given file header

throws: InvalidArgumentException
since: 1.0
throws: ParseException if the file header is not a valid MIDI file header
access: public
usedby: FileParser::parse()
uses: FileHeader::LENGTH
uses: Util::unpack()

FileHeader parseFileHeader (binary $header)

binary $header

Inherited Methods

Inherited From Parser

Parser::__construct()
Parser::afterLoad()
Parser::afterSetFile()
Parser::createFileObject()
Parser::getDelta()
Parser::getState()
Parser::load()
Parser::parse()
Parser::read()
Parser::setFile()
Parser::setState()