Class HtmlCoverageReport
Generates code coverage reports in HTML from data obtained from PHPUnit
- BaseCoverageReport
-
HtmlCoverageReport
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/TestSuite/Coverage/HtmlCoverageReport.php
Properties summary
Inherited Properties
Method Summary
-
_guessSubjectName() protected
Guess the class name the test was for based on the test case filename. -
_paintLine() protected
Renders the HTML for a single line in the HTML diff. -
coverageFooter() public
Generate an HTML snippet for coverage footers -
coverageHeader() public
Generate an HTML snippet for coverage headers -
coverageScript() public
generate some javascript for the coverage report. -
generateDiff() public
Generates an HTML diff for $file based on $coverageData. -
report() public
Generates report HTML to display.
Method Detail
_guessSubjectName() protected ¶
_guessSubjectName( ReflectionClass $testReflection )
Guess the class name the test was for based on the test case filename.
Parameters
- ReflectionClass $testReflection
- The class to reflect
Returns
Possible test subject name.
_paintLine() protected ¶
_paintLine( string $line , integer $linenumber , string $class , array $coveringTests )
Renders the HTML for a single line in the HTML diff.
Parameters
- string $line
- The line content.
- integer $linenumber
- The line number
- string $class
- The classname to use.
- array $coveringTests
- The tests covering the line.
Returns
coverageHeader() public ¶
coverageHeader( string $filename , string $percent )
Generate an HTML snippet for coverage headers
Parameters
- string $filename
- The file name being covered
- string $percent
- The percentage covered
Returns
coverageScript() public ¶
coverageScript( )
generate some javascript for the coverage report.
Returns
generateDiff() public ¶
generateDiff( string $filename , array $fileLines , array $coverageData )
Generates an HTML diff for $file based on $coverageData.
Handles both PHPUnit3.5 and 3.6 formats.
3.5 uses -1 for uncovered, and -2 for dead. 3.6 uses array() for uncovered and null for dead.
Parameters
- string $filename
- Name of the file having coverage generated
- array $fileLines
- File data as an array. See file() for how to get one of these.
- array $coverageData
- Array of coverage data to use to generate HTML diffs with
Returns
HTML diff.
Methods inherited from BaseCoverageReport
__construct() public ¶
__construct( array $coverage , CakeBaseReporter $reporter )
Constructor
Parameters
- array $coverage
- Array of coverage data from PHPUnit_Test_Result
-
CakeBaseReporter$reporter - A reporter to use for the coverage report.
_calculateCoveredLines() protected ¶
_calculateCoveredLines( array $fileLines , array $coverageData )
Calculates how many lines are covered and what the total number of executable lines is.
Handles both PHPUnit3.5 and 3.6 formats.
3.5 uses -1 for uncovered, and -2 for dead. 3.6 uses array() for uncovered and null for dead.
Parameters
- array $fileLines
- The lines in the file.
- array $coverageData
- The raw coverage data.
Returns
Array of covered, total lines.
_setParams() protected ¶
_setParams( CakeBaseReporter $reporter )
Pulls params out of the reporter.
Parameters
-
CakeBaseReporter$reporter - Reporter to suck params out of.
filterCoverageDataByPath() public ¶
filterCoverageDataByPath( string $path )
Filters the coverage data by path. Files not in the provided path will be removed.
Parameters
- string $path
- Path to filter files by.
Returns
Array of coverage data for files that match the given path.
getPathFilter() public ¶
getPathFilter( )
Gets the base path that the files we are interested in live in.
Returns
Path
setCoverage() public ¶
setCoverage( array $coverage )
Set the coverage data array
Parameters
- array $coverage
- Coverage data to use.