Class: Reporter
Source Location: /PHP_CodeSniffer-3.0.0a1/src/Reporter.php
Manages reporting of errors and warnings.
Author(s):
Copyright:
- 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
Inherited Variables
Inherited Methods
Class Details
[line
17]
Manages reporting of errors and warnings.
Class Variables
$config = null
[line 25]
The config data for the run.
Type:
\PHP_CodeSniffer\Config
$startTime = 0
[line 60]
When the PHPCS run started.
$totalErrors = 0
[line 39]
Total number of errors found during the run.
$totalFiles = 0
[line 32]
Total number of files that contain errors or warnings.
$totalFixable = 0
[line 53]
Total number of errors/warnings that can be fixed.
$totalWarnings = 0
[line 46]
Total number of warnings found during the run.
Method Detail
__construct (Constructor) [line 89]
void __construct(
Config
$config)
Initialise the reporter.
All reports specified in the config will be created and their output file (or a temp file if none is specified) initialised by clearing the current contents.
- Throws: RuntimeException If a report is not available.
- Access: public
Parameters:
\PHP_CodeSniffer\Config
$config
—
The config data for the run.
cacheFileReport [line 236]
void cacheFileReport(
File
$phpcsFile)
Caches the result of a single processed file for all reports.
The report content that is generated is appended to the output file assigned to each report. This content may be an intermediate report format and not reflect the final report output.
Parameters:
\PHP_CodeSniffer\Files\File
$phpcsFile
—
The file that has been processed.
prepareFileReport [line 285]
array prepareFileReport(
File
$phpcsFile)
Generate summary information to be used during report generation.
Parameters:
\PHP_CodeSniffer\Files\File
$phpcsFile
—
The file that has been processed.
printReport [line 166]
void printReport(
string
$report)
Generates and prints a single final report.
Parameters:
string
$report
—
The report type to print.
printReports [line 143]
Generates and prints final versions of all reports.
Returns TRUE if any of the reports output content to the screen or FALSE if all reports were silently printed to a file.
Documentation generated on 2019年3月11日 14:53:38 -0400 by
phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.