110 lines
3.7 KiB
PHP
110 lines
3.7 KiB
PHP
<?php
|
|
/**
|
|
* Checkstyle report for PHP_CodeSniffer.
|
|
*
|
|
* @author Greg Sherwood <gsherwood@squiz.net>
|
|
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
|
|
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
|
|
*/
|
|
|
|
namespace PHP_CodeSniffer\Reports;
|
|
|
|
use PHP_CodeSniffer\Config;
|
|
use PHP_CodeSniffer\Files\File;
|
|
|
|
class Checkstyle implements Report
|
|
{
|
|
|
|
|
|
/**
|
|
* Generate a partial report for a single processed file.
|
|
*
|
|
* 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.
|
|
*
|
|
* @param array $report Prepared report data.
|
|
* @param \PHP_CodeSniffer\File $phpcsFile The file being reported on.
|
|
* @param bool $showSources Show sources?
|
|
* @param int $width Maximum allowed line width.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)
|
|
{
|
|
$out = new \XMLWriter;
|
|
$out->openMemory();
|
|
$out->setIndent(true);
|
|
|
|
if ($report['errors'] === 0 && $report['warnings'] === 0) {
|
|
// Nothing to print.
|
|
return false;
|
|
}
|
|
|
|
$out->startElement('file');
|
|
$out->writeAttribute('name', $report['filename']);
|
|
|
|
foreach ($report['messages'] as $line => $lineErrors) {
|
|
foreach ($lineErrors as $column => $colErrors) {
|
|
foreach ($colErrors as $error) {
|
|
$error['type'] = strtolower($error['type']);
|
|
if ($phpcsFile->config->encoding !== 'utf-8') {
|
|
$error['message'] = iconv($phpcsFile->config->encoding, 'utf-8', $error['message']);
|
|
}
|
|
|
|
$out->startElement('error');
|
|
$out->writeAttribute('line', $line);
|
|
$out->writeAttribute('column', $column);
|
|
$out->writeAttribute('severity', $error['type']);
|
|
$out->writeAttribute('message', $error['message']);
|
|
$out->writeAttribute('source', $error['source']);
|
|
$out->endElement();
|
|
}
|
|
}
|
|
}//end foreach
|
|
|
|
$out->endElement();
|
|
echo $out->flush();
|
|
|
|
return true;
|
|
|
|
}//end generateFileReport()
|
|
|
|
|
|
/**
|
|
* Prints all violations for processed files, in a Checkstyle format.
|
|
*
|
|
* @param string $cachedData Any partial report data that was returned from
|
|
* generateFileReport during the run.
|
|
* @param int $totalFiles Total number of files processed during the run.
|
|
* @param int $totalErrors Total number of errors found during the run.
|
|
* @param int $totalWarnings Total number of warnings found during the run.
|
|
* @param int $totalFixable Total number of problems that can be fixed.
|
|
* @param bool $showSources Show sources?
|
|
* @param int $width Maximum allowed line width.
|
|
* @param bool $interactive Are we running in interactive mode?
|
|
* @param bool $toScreen Is the report being printed to screen?
|
|
*
|
|
* @return void
|
|
*/
|
|
public function generate(
|
|
$cachedData,
|
|
$totalFiles,
|
|
$totalErrors,
|
|
$totalWarnings,
|
|
$totalFixable,
|
|
$showSources=false,
|
|
$width=80,
|
|
$interactive=false,
|
|
$toScreen=true
|
|
) {
|
|
echo '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL;
|
|
echo '<checkstyle version="'.Config::VERSION.'">'.PHP_EOL;
|
|
echo $cachedData;
|
|
echo '</checkstyle>'.PHP_EOL;
|
|
|
|
}//end generate()
|
|
|
|
|
|
}//end class
|