PHP_CodeSniffer_Reports_Junit
in package
implements
PHP_CodeSniffer_Report
JUnit report for PHP_CodeSniffer.
PHP version 5
Tags
Interfaces, Classes and Traits
- PHP_CodeSniffer_Report
- Represents a PHP_CodeSniffer report.
Table of Contents
- $_tests : int
- A count of tests that have been performed.
- generate() : void
- Prints all violations for processed files, in a proprietary XML format.
- generateFileReport() : bool
- Generate a partial report for a single processed file.
Properties
$_tests
A count of tests that have been performed.
private
int
$_tests
= 0
Methods
generate()
Prints all violations for processed files, in a proprietary XML format.
public
generate(string $cachedData, int $totalFiles, int $totalErrors, int $totalWarnings, int $totalFixable[, bool $showSources = false ][, int $width = 80 ][, bool $toScreen = true ]) : void
Parameters
- $cachedData : string
-
Any partial report data that was returned from generateFileReport during the run.
- $totalFiles : int
-
Total number of files processed during the run.
- $totalErrors : int
-
Total number of errors found during the run.
- $totalWarnings : int
-
Total number of warnings found during the run.
- $totalFixable : int
-
Total number of problems that can be fixed.
- $showSources : bool = false
-
Show sources?
- $width : int = 80
-
Maximum allowed line width.
- $toScreen : bool = true
-
Is the report being printed to screen?
Return values
void —generateFileReport()
Generate a partial report for a single processed file.
public
generateFileReport(array<string|int, mixed> $report, PHP_CodeSniffer_File $phpcsFile[, bool $showSources = false ][, int $width = 80 ]) : bool
Function should return TRUE if it printed or stored data about the file and FALSE if it ignored the file. Returning TRUE indicates that the file and its data should be counted in the grand totals.
Parameters
- $report : array<string|int, mixed>
-
Prepared report data.
- $phpcsFile : PHP_CodeSniffer_File
-
The file being reported on.
- $showSources : bool = false
-
Show sources?
- $width : int = 80
-
Maximum allowed line width.