Class HtmlFormatter

Description

Formats parse results into HTML

  • since: 1.0

Located in /Reporting/HtmlFormatter.php (line 31)

Formatter
   |
   --HtmlFormatter
Variable Summary
mixed $delta
bool $multiFile
int $offset
Method Summary
HtmlFormatter __construct ()
string afterChunk (Chunk $chunk)
string afterFile (float $parseTime, float $totalTime)
string afterFileHeader (FileHeader $fileHeader)
string afterTrack ()
string beforeChunk (Chunk $chunk)
string beforeEvent (Event $event)
string beforeFile ()
string beforeFileHeader (FileHeader $fileHeader)
string beforeTrack ()
string formatEvent (Event $event)
string formatFileHeader (FileHeader $fileHeader)
string formatOffset (int $offset)
string formatTrackHeader (TrackHeader $trackHeader)
string getChunkClass (Chunk $chunk)
void setMultiFile (bool $multiFile)
Variables
int $currentTrack (line 38)

The number of the current track

  • access: protected
mixed $delta (line 50)
  • access: private
bool $multiFile (line 48)
  • access: private
int $offset (line 43)
  • access: protected
Methods
Constructor __construct (line 55)
  • since: 1.0
  • access: public
HtmlFormatter __construct ()

Redefinition of:
Formatter::__construct()
Constructor
afterChunk (line 171)
  • since: 1.0
  • access: public
string afterChunk (Chunk $chunk)

Redefinition of:
Formatter::afterChunk()
After a chunk is parsed
afterFile (line 314)
  • since: 1.0
  • access: public
string afterFile (float $parseTime, float $totalTime)
  • float $parseTime
  • float $totalTime

Redefinition of:
Formatter::afterFile()
After a file is parsed
afterFileHeader (line 205)
  • since: 1.0
  • access: public
string afterFileHeader (FileHeader $fileHeader)

Redefinition of:
Formatter::afterFileHeader()
After a file header is parsed
afterTrack (line 303)
  • since: 1.0
  • access: public
string afterTrack ()

Redefinition of:
Formatter::afterTrack()
After a track is parsed
beforeChunk (line 132)
string beforeChunk (Chunk $chunk)

Redefinition of:
Formatter::beforeChunk()
Before a chunk is parsed
beforeEvent (line 256)
string beforeEvent (Event $event)

Redefinition of:
Formatter::beforeEvent()
Before an event is parsed
beforeFile (line 92)
  • since: 1.0
  • access: public
string beforeFile ()

Redefinition of:
Formatter::beforeFile()
Before a file is parsed
beforeFileHeader (line 180)
  • since: 1.0
  • access: public
string beforeFileHeader (FileHeader $fileHeader)

Redefinition of:
Formatter::beforeFileHeader()
Before a file header is parsed
beforeTrack (line 214)
  • since: 1.0
  • access: public
string beforeTrack ()

Redefinition of:
Formatter::beforeTrack()
Before a track is parsed
formatEvent (line 289)
  • since: 1.0
  • access: public
  • uses: Event::__toString()
string formatEvent (Event $event)

Redefinition of:
Formatter::formatEvent()
Formats an event
formatFileHeader (line 191)
string formatFileHeader (FileHeader $fileHeader)

Redefinition of:
Formatter::formatFileHeader()
Formats a file header
formatOffset (line 82)

Formats the file pointer offset

string formatOffset (int $offset)
  • int $offset
formatTrackHeader (line 238)
string formatTrackHeader (TrackHeader $trackHeader)

Redefinition of:
Formatter::formatTrackHeader()
Formats a track header
getChunkClass (line 155)

Gets the CSS class for the chunk type

string getChunkClass (Chunk $chunk)
getPostProcessor (line 347)
  • since: 1.0
  • access: public
HtmlPostProcessor getPostProcessor ()

Redefinition of:
Formatter::getPostProcessor()
Gets the post-print processor for this formatter
setMultiFile (line 70)

Sets whether this formatter is for multiple HTML files or a single HTML file

  • since: 1.0
  • access: public
void setMultiFile (bool $multiFile)
  • bool $multiFile

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()

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