Class HtmlCoverageReport
Generates code coverage reports in HTML from data obtained from PHPUnit
- BaseCoverageReport
-
HtmlCoverageReport
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Located at Cake/TestSuite/Coverage/HtmlCoverageReport.php
Method Detail
_guessSubjectNamesource 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
string
Possible test subject name.
_paintLinesource 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
string
string
coverageHeadersource 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
string
string
coverageScriptsource public
coverageScript( )
generate some javascript for the coverage report.
Returns
string
string
generateDiffsource 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
string
HTML diff.
Methods inherited from BaseCoverageReport
__constructsource 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.
_calculateCoveredLinessource 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
Array of covered, total lines.
_setParamssource protected
_setParams( CakeBaseReporter $reporter )
Pulls params out of the reporter.
Parameters
-
CakeBaseReporter
$reporter
- Reporter to suck params out of.
filterCoverageDataByPathsource 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
Array of coverage data for files that match the given path.
getPathFiltersource public
getPathFilter( )
Gets the base path that the files we are interested in live in.
Returns
string
Path
setCoveragesource public
setCoverage( array $coverage )
Set the coverage data array
Parameters
- array
$coverage
- Coverage data to use.
Properties summary
Properties inherited from BaseCoverageReport
$_testNamessource
protected array
Array of test case file names. Used to do basename() matching with files that have coverage to decide which results to show on page load.
array()
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.7/class-HtmlCoverageReport.html