Docs For Class HtmlCoverageReporter

Description

Class that implements HTML Coverage Reporter.

version: $Revision: 14665 $
author: Nimish Pachapurkar <npac@spikesource.com>

Located in /reporter/HtmlCoverageReporter.php (line 26)

CoverageReporter
   |
   --HtmlCoverageReporter

Method Summary

HtmlCoverageReporter __construct ([$heading $heading = "Coverage Report"], [$style $style = ""], [$dir $dir = "report"])

void generateReport (&$data &$data)

boolean markFile ($phpFile $phpFile, $fileLink $fileLink, &$coverageLines &$coverageLines)

string preserveSpacing ($string $string)

string writeFileTableHead ()

string writeFileTableRow ($color $type, $bgcolor $lineCnt, $lineCnt $line, $line $coverageLineCnt, $coverageLineCnt 4)

boolean writeIndexFile ()

string writeIndexFileGrandTotalPercentage ()

string writeIndexFileTableHead ()

string writeIndexFileTableRow ($fileLink $fileLink, $realFile $realFile, $fileCoverage $fileCoverage)

Variables

Inherited Variables

Inherited from CoverageReporter

CoverageReporter::$fileCoverage
CoverageReporter::$grandTotalCoveredLines
CoverageReporter::$grandTotalLines
CoverageReporter::$grandTotalUncoveredLines
CoverageReporter::$heading
CoverageReporter::$outputDir
CoverageReporter::$style

Methods

Constructor __construct (line 50)

Constructor method (PHP5 only)

access: public

HtmlCoverageReporter __construct ([$heading $heading = "Coverage Report"], [$style $style = ""], [$dir $dir = "report"])

$heading $heading: Heading of the report (shown as title)
$style $style: Name of the stylesheet file
$dir $dir: Directory where the report files should be dumped

Redefinition of:

CoverageReporter::__construct(): The constructor (PHP5 compatible)

generateReport (line 66)

Implementaion of generateReport abstract function.

This is the only function that will be called by the instrumentor.

access: public

void generateReport (&$data &$data)

&$data &$data: Reference to Coverage Data

Redefinition of:

CoverageReporter::generateReport(): This function generates report using one of the concrete subclasses.

markFile (line 418)

Mark a source code file based on the coverage data gathered

return: FALSE on failure
access: protected

boolean markFile ($phpFile $phpFile, $fileLink $fileLink, &$coverageLines &$coverageLines)

$phpFile $phpFile: Name of the actual source file
$fileLink $fileLink: Link to the html mark-up file for the $phpFile
&$coverageLines &$coverageLines: Coverage recording for $phpFile

preserveSpacing (line 563)

Changes all tabs and spaces with HTML non-breakable spaces.

return: HTML string with replacements.
access: protected

string preserveSpacing ($string $string)

$string $string: String containing spaces and tabs.

writeFileTableHead (line 504)

Writes table heading for file details table.

return: HTML string representing one table row.
access: protected

string writeFileTableHead ()

writeFileTableRow (line 527)

Write a line for file details table.

return: HTML code for a table row.
access: protected

string writeFileTableRow ($color $type, $bgcolor $lineCnt, $lineCnt $line, $line $coverageLineCnt, $coverageLineCnt 4)

$coverageLineCnt 4: Number of time the line was executed.
$color $type: Text color
$bgcolor $lineCnt: Row bgcolor
$lineCnt $line: Line number
$line $coverageLineCnt: The source code line

writeIndexFile (line 308)

Writes index.html file from all coverage recordings.

return: FALSE on failure
access: protected

boolean writeIndexFile ()

writeIndexFileGrandTotalPercentage (line 260)

Writes the grand total for coverage recordings on the index.html

return: HTML code for grand total row
access: protected

string writeIndexFileGrandTotalPercentage ()

writeIndexFileTableHead (line 193)

Writes the table heading for index.html

return: Table heading row code
access: protected

string writeIndexFileTableHead ()

writeIndexFileTableRow (line 225)

Writes one row in the index.html table to display filename and coverage recording.

return: HTML code for a single row.
access: protected

string writeIndexFileTableRow ($fileLink $fileLink, $realFile $realFile, $fileCoverage $fileCoverage)

$fileLink $fileLink: link to html details file.
$realFile $realFile: path to real PHP file.
$fileCoverage $fileCoverage: Coverage recording for that file.

Inherited Methods

Inherited From CoverageReporter

CoverageReporter::__construct()
CoverageReporter::createReportDir()
CoverageReporter::generateReport()
CoverageReporter::getFileCoverageInfo()
CoverageReporter::getGrandCodeCoveragePercentage()
CoverageReporter::getHeading()
CoverageReporter::getOutputDir()
CoverageReporter::getRelativeOutputDirPath()
CoverageReporter::getStyle()
CoverageReporter::makeRelative()
CoverageReporter::printTextSummary()
CoverageReporter::recordFileCoverageInfo()
CoverageReporter::setHeading()
CoverageReporter::setOutputDir()
CoverageReporter::setStyle()
CoverageReporter::updateGrandTotals()