HtmlCoverageReporter Class Reference

Inheritance diagram for HtmlCoverageReporter:

Collaboration diagram for HtmlCoverageReporter:

Public Member Functions
	__construct ($heading="Coverage Report", $style="", $dir="report")
	generateReport (&$data)
Protected Member Functions
	writeIndexFileTableHead ()
	writeIndexFileTableRow ($fileLink, $realFile, $fileCoverage)
	writeIndexFileGrandTotalPercentage ()
	writeIndexFile ()
	markFile ($phpFile, $fileLink, &$coverageLines)
	writeFileTableHead ()
	writeFileTableRow ($type, $lineCnt, $line, $coverageLineCnt)
	preserveSpacing ($string)

---

Detailed Description

Definition at line 26 of file HtmlCoverageReporter.php.

---

Constructor & Destructor Documentation

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

Constructor method (PHP5 only)

Parameters:

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

Reimplemented from CoverageReporter.

Definition at line 49 of file HtmlCoverageReporter.php.

---

Member Function Documentation

generateReport

(

&$

data

)

Implementaion of generateReport abstract function. This is the only function that will be called by the instrumentor.

Parameters:

&$data

Reference to Coverage Data public

Reimplemented from CoverageReporter.

Reimplemented in moodle_coverage_reporter.

Definition at line 68 of file HtmlCoverageReporter.php.

Here is the call graph for this function:

markFile	(	$	phpFile,
		$	fileLink,
		&$	coverageLines
	)		[protected]

Mark a source code file based on the coverage data gathered

Parameters:

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

Returns:

boolean FALSE on failure protected

Reimplemented in moodle_coverage_reporter.

Definition at line 447 of file HtmlCoverageReporter.php.

Here is the call graph for this function:

Here is the caller graph for this function:

preserveSpacing

(

$

string

)

[protected]

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

Parameters:

$string

String containing spaces and tabs.

Returns:

string HTML string with replacements. protected

Definition at line 644 of file HtmlCoverageReporter.php.

Here is the caller graph for this function:

writeFileTableHead

(

)

[protected]

Writes table heading for file details table.

Returns:

string HTML string representing one table row. protected

Definition at line 578 of file HtmlCoverageReporter.php.

Here is the caller graph for this function:

writeFileTableRow	(	$	type,
		$	lineCnt,
		$	line,
		$	coverageLineCnt
	)		[protected]

Write a line for file details table.

Parameters:

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

Returns:

string HTML code for a table row. protected

Definition at line 603 of file HtmlCoverageReporter.php.

Here is the call graph for this function:

Here is the caller graph for this function:

writeIndexFile

(

)

[protected]

Writes index.html file from all coverage recordings.

Returns:

boolean FALSE on failure protected

Definition at line 333 of file HtmlCoverageReporter.php.

Here is the call graph for this function:

Here is the caller graph for this function:

writeIndexFileGrandTotalPercentage

(

)

[protected]

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

Returns:

string HTML code for grand total row protected

Definition at line 274 of file HtmlCoverageReporter.php.

Here is the call graph for this function:

Here is the caller graph for this function:

writeIndexFileTableHead

(

)

[protected]

Writes the table heading for index.html

Returns:

string Table heading row code protected

Definition at line 199 of file HtmlCoverageReporter.php.

Here is the caller graph for this function:

writeIndexFileTableRow	(	$	fileLink,
		$	realFile,
		$	fileCoverage
	)		[protected]

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

Parameters:

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

Returns:

string HTML code for a single row. protected

Reimplemented in moodle_coverage_reporter.

Definition at line 238 of file HtmlCoverageReporter.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/spikephpcoverage/src/reporter/HtmlCoverageReporter.php