Docs For Class Parser

Description

Base parsing class

abstract:
since: 1.0

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

Direct descendents

Class	Description
DeltaParser	Class for parsing delta times
EventParser	Class for parsing MIDI events
FileParser	Class for parsing MIDI files
TrackParser	Class for parsing MIDI tracks

Variable Summary

SplFileObject $file

int $state

Method Summary

Parser __construct ()

void afterLoad ()

void afterSetFile ()

SplFileObject createFileObject (string $file)

int getDelta ()

int getState ()

void load (string|SplFileObject $file)

Chunk parse ()

binary read (int $count, [bool $throwOnEof = false])

void setFile ( $file)

void setState (int $state)

Variables

SplFileObject $file (line 39)

The file to parse

access: protected

int $state (line 32)

The current state of the parser

see: ParseState
access: private

Methods

Constructor __construct (line 46)

Constructor

since: 1.0
access: public

Parser __construct ()

Redefined in descendants as:

EventParser::__construct() : Constructor
FileParser::__construct() : Constructor
TrackParser::__construct() : Constructor

afterLoad (line 173)

Called after load()

since: 1.0
access: protected
usedby: Parser::load()

void afterLoad ()

Redefined in descendants as:

FileParser::afterLoad()

afterSetFile (line 182)

Called after setFile()

since: 1.0
access: protected
usedby: Parser::setFile()

void afterSetFile ()

Redefined in descendants as:

TrackParser::afterSetFile()

createFileObject (line 59)

Creates a file object suitable for load()

since: 1.0
access: public
usedby: Parser::load()

SplFileObject createFileObject (string $file)

string $file

getDelta (line 151)

Reads a delta time from the buffer stream

return: The number of clock ticks in the delta time
since: 1.0
access: protected
usedby: EventParser::parseMetaEvent()
usedby: EventParser::parseSystemExclusiveEvent()
usedby: DeltaParser::parse()
uses: Util::unpack()
uses: Parser::read()
uses: Util::getTicksFromDeltaByteSequence()

int getDelta ()

getState (line 103)

Gets the current parse state

The default is ParseState::EOF.

return: One of the ParseState constants
since: 1.0
access: public
usedby: FileParser::parse()

int getState ()

load (line 72)

Loads a file to be parsed

since: 1.0
access: public
uses: Parser::afterLoad()
uses: Parser::createFileObject()

void load (string|SplFileObject $file)

string|SplFileObject $file: A file path, or an SplFileObject opened in "rb" mode

parse (line 193)

Parses the buffer stream and returns the next chunk

abstract:
since: 1.0
access: public
usedby: Printer::printNext()

Chunk parse ()

Redefined in descendants as:

read (line 128)

Reads $count bytes from the buffer stream

throws: ParseException
since: 1.0
access: protected
usedby: FileParser::getRawFileHeader()
usedby: EventParser::parseSystemExclusiveEvent()
usedby: TrackParser::getRawTrackHeader()
usedby: EventParser::parse()
usedby: Parser::getDelta()
usedby: EventParser::parseMetaEvent()

binary read (int $count, [bool $throwOnEof = false])

int $count
bool $throwOnEof: Whether to throw a ParseException if EOF is encountered

setFile (line 89)

Sets the buffer stream to read from

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

void setFile ( $file)

SplFileObject $file

setState (line 114)

Sets the current parse state

since: 1.0
access: protected
usedby: TrackParser::__construct()
usedby: FileParser::__construct()

void setState (int $state)

int $state: See ParseState