* @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Json report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Jeffrey Fisher * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: @package_version@ * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Json implements PHP_CodeSniffer_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 boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { $filename = str_replace('\\', '\\\\', $report['filename']); $filename = str_replace('"', '\"', $filename); $filename = str_replace('/', '\/', $filename); echo '"'.$filename.'":{'; echo '"errors":'.$report['errors'].',"warnings":'.$report['warnings'].',"messages":['; $messages = ''; foreach ($report['messages'] as $line => $lineErrors) { foreach ($lineErrors as $column => $colErrors) { foreach ($colErrors as $error) { $error['message'] = str_replace('\\', '\\\\', $error['message']); $error['message'] = str_replace('"', '\"', $error['message']); $error['message'] = str_replace('/', '\/', $error['message']); $error['message'] = str_replace("\n", '\n', $error['message']); $error['message'] = str_replace("\r", '\r', $error['message']); $error['message'] = str_replace("\t", '\t', $error['message']); $fixable = 'false'; if ($error['fixable'] === true) { $fixable = 'true'; } $messages .= '{"message":"'.$error['message'].'",'; $messages .= '"source":"'.$error['source'].'",'; $messages .= '"severity":'.$error['severity'].','; $messages .= '"type":"'.$error['type'].'",'; $messages .= '"line":'.$line.','; $messages .= '"column":'.$column.','; $messages .= '"fixable":'.$fixable; $messages .= '},'; }//end foreach }//end foreach }//end foreach echo rtrim($messages, ','); echo ']},'; return true; }//end generateFileReport() /** * Generates a JSON report. * * @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 boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { echo '{"totals":{"errors":'.$totalErrors.',"warnings":'.$totalWarnings.',"fixable":'.$totalFixable.'},"files":{'; echo rtrim($cachedData, ','); echo "}}"; }//end generate() }//end class