Docs For Class Printer

Description

Default printer for parse results

This class handles the output created by a Formatter.

since: 1.0

Located in /Reporting/Printer.php (line 30)

Direct descendents

Class	Description
FilePrinter	Printer that redirects its output to a file

Variable Summary

Formatter $formatter

bool $isParsingTrack

array $params

Parser $parser

float $parseTime

float $totalTime

Method Summary

Printer __construct (Formatter $formatter, Parser $parser)

void doPostProcessing ([ $params = array()])

bool isParsingTrack ()

void printAll ()

void printData (string $data)

void printDelta (Delta $delta)

void printEof ()

void printEvent (Event $event)

void printFileHeader (FileHeader $fileHeader)

bool printNext ()

void printTrackHeader (TrackHeader $trackHeader)

void setParameter (string $key, string $value)

Variables

Formatter $formatter (line 35)

access: protected

bool $isParsingTrack (line 45)

access: protected

array $params (line 60)

access: protected

Parser $parser (line 40)

access: protected

float $parseTime (line 50)

access: protected

float $totalTime (line 55)

access: protected

Methods

Constructor __construct (line 70)

Constructor

since: 1.0
access: public

Printer __construct (Formatter $formatter, Parser $parser)

Formatter $formatter
Parser $parser

Redefined in descendants as:

doPostProcessing (line 126)

Handles any post processing that the formatter requires

since: 1.0
access: public
usedby: Printer::printAll()
uses: PostProcesor::execute()
uses: Formatter::getPostProcessor()
uses: PostProcesor::setParamter()

void doPostProcessing ([ $params = array()])

array $params: Parameters to set on the post processor

isParsingTrack (line 86)

Gets whether a track is currently being a parsed

since: 1.0
access: public
usedby: Printer::printEof()
usedby: Printer::printTrackHeader()

bool isParsingTrack ()

printAll (line 97)

Prints the formatted results of a complete parse

since: 1.0
access: public
uses: Printer::doPostProcessing()
uses: Printer::printNext()

void printAll ()

printData (line 184)

Prints the data

void printData (string $data)

string $data

Redefined in descendants as:

FilePrinter::printData()

printDelta (line 218)

Prints a delta time

void printDelta (Delta $delta)

Delta $delta

printEof (line 289)

Prints EOF

void printEof ()

Redefined in descendants as:

MultiFilePrinter::printEof()

printEvent (line 199)

Prints an event

void printEvent (Event $event)

Event $event

printFileHeader (line 271)

Prints a file header

void printFileHeader (FileHeader $fileHeader)

FileHeader $fileHeader

Redefined in descendants as:

MultiFilePrinter::printFileHeader()

printNext (line 150)

Parses, formats and prints the next chunk

return: true if there is more to parse, false if EOF has been reached
since: 1.0
access: public
uses: Printer::printTrackHeader()
usedby: MultiFilePrinter::printNext()
usedby: Printer::printAll()
uses: Printer::printFileHeader()
uses: Printer::printEvent()
uses: Parser::parse()
uses: Printer::printData()
uses: Printer::printDelta()
uses: Printer::printEof()

bool printNext ()

Redefined in descendants as:

MultiFilePrinter::printNext()

printTrackHeader (line 240)

Prints a track header

void printTrackHeader (TrackHeader $trackHeader)

TrackHeader $trackHeader

setParameter (line 112)

Sets a custom parameter

since: 1.0
access: public

void setParameter (string $key, string $value)

string $key
string $value