Chris@0: <?php
Chris@0: /**
Chris@0:  * Json report for PHP_CodeSniffer.
Chris@0:  *
Chris@0:  * PHP version 5
Chris@0:  *
Chris@0:  * @category  PHP
Chris@0:  * @package   PHP_CodeSniffer
Chris@0:  * @author    Jeffrey Fisher <jeffslofish@gmail.com>
Chris@0:  * @author    Greg Sherwood <gsherwood@squiz.net>
Chris@0:  * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Chris@0:  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
Chris@0:  * @link      http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * Json report for PHP_CodeSniffer.
Chris@0:  *
Chris@0:  * PHP version 5
Chris@0:  *
Chris@0:  * @category  PHP
Chris@0:  * @package   PHP_CodeSniffer
Chris@0:  * @author    Jeffrey Fisher <jeffslofish@gmail.com>
Chris@0:  * @author    Greg Sherwood <gsherwood@squiz.net>
Chris@0:  * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Chris@0:  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
Chris@0:  * @version   Release: @package_version@
Chris@0:  * @link      http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: class PHP_CodeSniffer_Reports_Json implements PHP_CodeSniffer_Report
Chris@0: {
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Generate a partial report for a single processed file.
Chris@0:      *
Chris@0:      * Function should return TRUE if it printed or stored data about the file
Chris@0:      * and FALSE if it ignored the file. Returning TRUE indicates that the file and
Chris@0:      * its data should be counted in the grand totals.
Chris@0:      *
Chris@0:      * @param array                $report      Prepared report data.
Chris@0:      * @param PHP_CodeSniffer_File $phpcsFile   The file being reported on.
Chris@0:      * @param boolean              $showSources Show sources?
Chris@0:      * @param int                  $width       Maximum allowed line width.
Chris@0:      *
Chris@0:      * @return boolean
Chris@0:      */
Chris@0:     public function generateFileReport(
Chris@0:         $report,
Chris@0:         PHP_CodeSniffer_File $phpcsFile,
Chris@0:         $showSources=false,
Chris@0:         $width=80
Chris@0:     ) {
Chris@0:         $filename = str_replace('\\', '\\\\', $report['filename']);
Chris@0:         $filename = str_replace('"', '\"', $filename);
Chris@0:         $filename = str_replace('/', '\/', $filename);
Chris@0:         echo '"'.$filename.'":{';
Chris@0:         echo '"errors":'.$report['errors'].',"warnings":'.$report['warnings'].',"messages":[';
Chris@0: 
Chris@0:         $messages = '';
Chris@0:         foreach ($report['messages'] as $line => $lineErrors) {
Chris@0:             foreach ($lineErrors as $column => $colErrors) {
Chris@0:                 foreach ($colErrors as $error) {
Chris@0:                     $error['message'] = str_replace('\\', '\\\\', $error['message']);
Chris@0:                     $error['message'] = str_replace('"', '\"', $error['message']);
Chris@0:                     $error['message'] = str_replace('/', '\/', $error['message']);
Chris@0:                     $error['message'] = str_replace("\n", '\n', $error['message']);
Chris@0:                     $error['message'] = str_replace("\r", '\r', $error['message']);
Chris@0:                     $error['message'] = str_replace("\t", '\t', $error['message']);
Chris@0: 
Chris@0:                     $fixable = 'false';
Chris@0:                     if ($error['fixable'] === true) {
Chris@0:                         $fixable = 'true';
Chris@0:                     }
Chris@0: 
Chris@0:                     $messages .= '{"message":"'.$error['message'].'",';
Chris@0:                     $messages .= '"source":"'.$error['source'].'",';
Chris@0:                     $messages .= '"severity":'.$error['severity'].',';
Chris@0:                     $messages .= '"type":"'.$error['type'].'",';
Chris@0:                     $messages .= '"line":'.$line.',';
Chris@0:                     $messages .= '"column":'.$column.',';
Chris@0:                     $messages .= '"fixable":'.$fixable;
Chris@0:                     $messages .= '},';
Chris@0:                 }//end foreach
Chris@0:             }//end foreach
Chris@0:         }//end foreach
Chris@0: 
Chris@0:         echo rtrim($messages, ',');
Chris@0:         echo ']},';
Chris@0: 
Chris@0:         return true;
Chris@0: 
Chris@0:     }//end generateFileReport()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates a JSON report.
Chris@0:      *
Chris@0:      * @param string  $cachedData    Any partial report data that was returned from
Chris@0:      *                               generateFileReport during the run.
Chris@0:      * @param int     $totalFiles    Total number of files processed during the run.
Chris@0:      * @param int     $totalErrors   Total number of errors found during the run.
Chris@0:      * @param int     $totalWarnings Total number of warnings found during the run.
Chris@0:      * @param int     $totalFixable  Total number of problems that can be fixed.
Chris@0:      * @param boolean $showSources   Show sources?
Chris@0:      * @param int     $width         Maximum allowed line width.
Chris@0:      * @param boolean $toScreen      Is the report being printed to screen?
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public function generate(
Chris@0:         $cachedData,
Chris@0:         $totalFiles,
Chris@0:         $totalErrors,
Chris@0:         $totalWarnings,
Chris@0:         $totalFixable,
Chris@0:         $showSources=false,
Chris@0:         $width=80,
Chris@0:         $toScreen=true
Chris@0:     ) {
Chris@0:         echo '{"totals":{"errors":'.$totalErrors.',"warnings":'.$totalWarnings.',"fixable":'.$totalFixable.'},"files":{';
Chris@0:         echo rtrim($cachedData, ',');
Chris@0:         echo "}}";
Chris@0: 
Chris@0:     }//end generate()
Chris@0: 
Chris@0: 
Chris@0: }//end class