Docs For Class TextFormatter

Description

Textual parse results formatter

since: 1.0

Located in /Reporting/TextFormatter.php (line 26)

Formatter
   |
   --TextFormatter

Variable Summary

int $currentTrack

string $indent

Method Summary

TextFormatter __construct ()

void afterFileHeader (FileHeader $fileHeader)

void afterTrack ()

string beforeFile ()

string beforeFileHeader (FileHeader $fileHeader)

void decreaseIndent ()

string formatDelta (Delta $delta)

string formatEvent (Event $event)

string formatFileHeader (FileHeader $fileHeader)

void formatText (string $text)

string formatTrackHeader (TrackHeader $trackHeader)

void increaseIndent ()

Variables

int $currentTrack (line 40)

The number of the current track

access: protected

string $indent (line 33)

The indentation string

access: protected

Methods

Constructor __construct (line 47)

Constructor

since: 1.0
access: public

TextFormatter __construct ()

Redefinition of:

Formatter::__construct(): Constructor

afterFileHeader (line 128)

since: 1.0
access: public
uses: TextFormatter::decreaseIndent()

void afterFileHeader (FileHeader $fileHeader)

FileHeader $fileHeader

Redefinition of:

Formatter::afterFileHeader(): After a file header is parsed

afterTrack (line 180)

since: 1.0
access: public
uses: TextFormatter::decreaseIndent()

void afterTrack ()

Redefinition of:

Formatter::afterTrack(): After a track is parsed

beforeFile (line 88)

since: 1.0
access: public
uses: TextFormatter::formatText()
uses: TextFormatter::increaseIndent()

string beforeFile ()

Redefinition of:

Formatter::beforeFile(): Before a file is parsed

beforeFileHeader (line 101)

since: 1.0
access: public
uses: TextFormatter::formatText()
uses: TextFormatter::increaseIndent()

string beforeFileHeader (FileHeader $fileHeader)

FileHeader $fileHeader

Redefinition of:

Formatter::beforeFileHeader(): Before a file header is parsed

decreaseIndent (line 77)

Decreases the indentation

since: 1.0
access: protected
usedby: TextFormatter::afterTrack()
usedby: TextFormatter::afterFileHeader()
usedby: TextFormatter::formatTrackHeader()

void decreaseIndent ()

formatDelta (line 159)

since: 1.0
access: public
uses: Delta::getData()
uses: TextFormatter::formatText()

string formatDelta (Delta $delta)

Delta $delta

Redefinition of:

Formatter::formatDelta(): Formts a delta time

formatEvent (line 172)

since: 1.0
access: public
uses: Event::__toString()
uses: TextFormatter::formatText()

string formatEvent (Event $event)

Event $event

Redefinition of:

Formatter::formatEvent(): Formats an event

formatFileHeader (line 115)

since: 1.0
access: public
uses: FileHeader::getData()
uses: TextFormatter::formatText()

string formatFileHeader (FileHeader $fileHeader)

FileHeader $fileHeader

Redefinition of:

Formatter::formatFileHeader(): Formats a file header

formatText (line 59)

Centralized place to output text

since: 1.0
access: protected
usedby: TextFormatter::formatDelta()
usedby: TextFormatter::formatEvent()
usedby: TextFormatter::formatTrackHeader()
usedby: TextFormatter::beforeFileHeader()
usedby: TextFormatter::beforeFile()
usedby: TextFormatter::formatFileHeader()

void formatText (string $text)

string $text

formatTrackHeader (line 141)

string formatTrackHeader (TrackHeader $trackHeader)

TrackHeader $trackHeader

Redefinition of:

Formatter::formatTrackHeader(): Formats a track header

increaseIndent (line 68)

Increases the indentation

since: 1.0
access: protected
usedby: TextFormatter::beforeFileHeader()
usedby: TextFormatter::beforeFile()

void increaseIndent ()

Inherited Methods

Inherited From Formatter

Formatter::__construct()
Formatter::afterChunk()
Formatter::afterDelta()
Formatter::afterEvent()
Formatter::afterFile()
Formatter::afterFileHeader()
Formatter::afterTrack()
Formatter::afterTrackHeader()
Formatter::beforeChunk()
Formatter::beforeDelta()
Formatter::beforeEvent()
Formatter::beforeFile()
Formatter::beforeFileHeader()
Formatter::beforeTrack()
Formatter::beforeTrackHeader()
Formatter::formatDelta()
Formatter::formatEvent()
Formatter::formatFileHeader()
Formatter::formatTrackHeader()
Formatter::getPostProcessor()