BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
PHP_CodeSniffer\Reporter Class Reference

Public Member Functions

 __construct (Config $config)
 
 printReports ()
 
 printReport ($report)
 
 cacheFileReport (File $phpcsFile)
 
 prepareFileReport (File $phpcsFile)
 

Public Attributes

 $config = null
 
 $totalFiles = 0
 
 $totalErrors = 0
 
 $totalWarnings = 0
 
 $totalFixable = 0
 
 $totalFixed = 0
 

Static Public Attributes

static $startTime = 0
 

Constructor & Destructor Documentation

PHP_CodeSniffer\Reporter::__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.

Parameters
\PHP_CodeSniffer\Config$configThe config data for the run.
Returns
void
Exceptions
RuntimeExceptionIf a report is not available.

Member Function Documentation

PHP_CodeSniffer\Reporter::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$phpcsFileThe file that has been processed.
Returns
void
PHP_CodeSniffer\Reporter::prepareFileReport ( File  $phpcsFile)

Generate summary information to be used during report generation.

Parameters
\PHP_CodeSniffer\Files\File$phpcsFileThe file that has been processed.
Returns
array
PHP_CodeSniffer\Reporter::printReport (   $report)

Generates and prints a single final report.

Parameters
string$reportThe report type to print.
Returns
void
PHP_CodeSniffer\Reporter::printReports ( )

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.

Returns
bool

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