Docs For Class Formatter

Class Formatter

Description

Default (empty) class for formatting parse results

Use in conjunction with Printer.

since: 1.0

Located in /Reporting/Formatter.php (line 29)

Direct descendents

Class	Description
HtmlFormatter	Formats parse results into HTML
TextFormatter	Textual parse results formatter

Method Summary

Formatter __construct ()

string afterChunk (Chunk $chunk)

string afterDelta (Delta $delta)

string afterEvent (Event $event)

string afterFile (float $parseTime, float $totalTime)

string afterFileHeader (FileHeader $fileHeader)

string afterTrack ()

string afterTrackHeader (TrackHeader $trackHeader)

string beforeChunk (Chunk $chunk)

string beforeDelta (Delta $delta)

string beforeEvent (Event $event)

string beforeFile ()

string beforeFileHeader (FileHeader $fileHeader)

string beforeTrack ()

string beforeTrackHeader (TrackHeader $trackHeader)

string formatDelta (Delta $delta)

string formatEvent (Event $event)

string formatFileHeader (FileHeader $fileHeader)

string formatTrackHeader (TrackHeader $trackHeader)

PostProcessor getPostProcessor ()

Methods

Constructor __construct (line 36)

Constructor

since: 1.0
access: public

Formatter __construct ()

Redefined in descendants as:

HtmlFormatter::__construct()
TextFormatter::__construct() : Constructor

afterChunk (line 65)

After a chunk is parsed

since: 1.0
access: public
usedby: MultiFilePrinter::printFileHeader()

string afterChunk (Chunk $chunk)

Chunk $chunk

Redefined in descendants as:

HtmlFormatter::afterChunk()

afterDelta (line 158)

After a delta time is parsed

since: 1.0
access: public
usedby: Printer::printDelta()

string afterDelta (Delta $delta)

Delta $delta

afterEvent (line 186)

After an event is parsed

since: 1.0
access: public
usedby: Printer::printEvent()

string afterEvent (Event $event)

Event $event

afterFile (line 206)

After a file is parsed

since: 1.0
access: public
usedby: MultiFilePrinter::createIndex()
usedby: Printer::printEof()

string afterFile (float $parseTime, float $totalTime)

float $parseTime: The elapsed time for parsing in seconds
float $totalTime: The total time (parsing + formatting + printing) in seconds

Redefined in descendants as:

HtmlFormatter::afterFile()

afterFileHeader (line 93)

After a file header is parsed

since: 1.0
access: public
usedby: MultiFilePrinter::printFileHeader()
usedby: Printer::printFileHeader()

string afterFileHeader (FileHeader $fileHeader)

FileHeader $fileHeader

Redefined in descendants as:

afterTrack (line 195)

After a track is parsed

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

string afterTrack ()

Redefined in descendants as:

afterTrackHeader (line 130)

After a track header is parsed

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

string afterTrackHeader (TrackHeader $trackHeader)

TrackHeader $trackHeader

beforeChunk (line 55)

Before a chunk is parsed

since: 1.0
access: public
usedby: MultiFilePrinter::printFileHeader()

string beforeChunk (Chunk $chunk)

Chunk $chunk

Redefined in descendants as:

HtmlFormatter::beforeChunk()

beforeDelta (line 139)

Before a delta time is parsed

since: 1.0
access: public
usedby: Printer::printDelta()

string beforeDelta (Delta $delta)

Delta $delta

beforeEvent (line 167)

Before an event is parsed

since: 1.0
access: public
usedby: Printer::printEvent()

string beforeEvent (Event $event)

Event $event

Redefined in descendants as:

HtmlFormatter::beforeEvent()

beforeFile (line 45)

Before a file is parsed

since: 1.0
access: public
usedby: MultiFilePrinter::printFileHeader()
usedby: Printer::printFileHeader()
usedby: MultiFilePrinter::createIndex()

string beforeFile ()

Redefined in descendants as:

beforeFileHeader (line 74)

Before a file header is parsed

since: 1.0
access: public
usedby: MultiFilePrinter::printFileHeader()
usedby: Printer::printFileHeader()

string beforeFileHeader (FileHeader $fileHeader)

FileHeader $fileHeader

Redefined in descendants as:

beforeTrack (line 102)

Before a track is parsed

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

string beforeTrack ()

Redefined in descendants as:

HtmlFormatter::beforeTrack()

beforeTrackHeader (line 111)

Before a track header is parsed

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

string beforeTrackHeader (TrackHeader $trackHeader)

TrackHeader $trackHeader

formatDelta (line 149)

Formts a delta time

since: 1.0
access: public
usedby: Printer::printDelta()

string formatDelta (Delta $delta)

Delta $delta

Redefined in descendants as:

TextFormatter::formatDelta()

formatEvent (line 177)

Formats an event

since: 1.0
access: public
usedby: Printer::printEvent()

string formatEvent (Event $event)

Event $event

Redefined in descendants as:

formatFileHeader (line 84)

Formats a file header

since: 1.0
access: public
usedby: MultiFilePrinter::printFileHeader()
usedby: Printer::printFileHeader()

string formatFileHeader (FileHeader $fileHeader)

FileHeader $fileHeader

Redefined in descendants as:

formatTrackHeader (line 121)

Formats a track header

since: 1.0
access: public

string formatTrackHeader (TrackHeader $trackHeader)

TrackHeader $trackHeader

Redefined in descendants as:

getPostProcessor (line 215)

Gets the post-print processor for this formatter

since: 1.0
access: public
usedby: Printer::doPostProcessing()

PostProcessor getPostProcessor ()

Redefined in descendants as:

HtmlFormatter::getPostProcessor()

Documentation generated on Sun, 25 Oct 2009 22:38:16 -0700 by phpDocumentor 1.4.3