Chris@0: Chris@0: * @author Greg Sherwood Chris@0: * @copyright 2009-2014 SQLI 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: * Summary 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 Gabriele Santini Chris@0: * @author Greg Sherwood Chris@0: * @copyright 2009-2014 SQLI 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_Summary implements PHP_CodeSniffer_Report Chris@0: { Chris@0: Chris@0: /** Chris@0: * TRUE if this report needs error messages instead of just totals. Chris@0: * Chris@0: * @var boolean Chris@0: */ Chris@0: public $recordErrors = false; Chris@0: Chris@0: /** Chris@0: * An array of process files and their error data. Chris@0: * Chris@0: * @var boolean Chris@0: */ Chris@0: private $_reportFiles = array(); 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: if (PHP_CODESNIFFER_VERBOSITY === 0 Chris@0: && $report['errors'] === 0 Chris@0: && $report['warnings'] === 0 Chris@0: ) { Chris@0: // Nothing to print. Chris@0: return false; Chris@0: } Chris@0: Chris@0: $this->_reportFiles[$report['filename']] = array( Chris@0: 'errors' => $report['errors'], Chris@0: 'warnings' => $report['warnings'], Chris@0: 'strlen' => strlen($report['filename']), Chris@0: ); Chris@0: Chris@0: return true; Chris@0: Chris@0: }//end generateFileReport() Chris@0: Chris@0: Chris@0: /** Chris@0: * Generates a summary of errors and warnings for each file processed. 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: Chris@0: if (empty($this->_reportFiles) === true) { Chris@0: return; Chris@0: } Chris@0: Chris@0: // Make sure the report width isn't too big. Chris@0: $maxLength = 0; Chris@0: foreach ($this->_reportFiles as $file => $data) { Chris@0: $maxLength = max($maxLength, $data['strlen']); Chris@0: } Chris@0: Chris@0: $width = min($width, ($maxLength + 21)); Chris@0: $width = max($width, 70); Chris@0: Chris@0: echo PHP_EOL."\033[1m".'PHP CODE SNIFFER REPORT SUMMARY'."\033[0m".PHP_EOL; Chris@0: echo str_repeat('-', $width).PHP_EOL; Chris@0: echo "\033[1m".'FILE'.str_repeat(' ', ($width - 20)).'ERRORS WARNINGS'."\033[0m".PHP_EOL; Chris@0: echo str_repeat('-', $width).PHP_EOL; Chris@0: Chris@0: foreach ($this->_reportFiles as $file => $data) { Chris@0: $padding = ($width - 18 - $data['strlen']); Chris@0: if ($padding < 0) { Chris@0: $file = '...'.substr($file, (($padding * -1) + 3)); Chris@0: $padding = 0; Chris@0: } Chris@0: Chris@0: echo $file.str_repeat(' ', $padding).' '; Chris@0: if ($data['errors'] !== 0) { Chris@0: echo "\033[31m".$data['errors']."\033[0m"; Chris@0: echo str_repeat(' ', (8 - strlen((string) $data['errors']))); Chris@0: } else { Chris@0: echo '0 '; Chris@0: } Chris@0: Chris@0: if ($data['warnings'] !== 0) { Chris@0: echo "\033[33m".$data['warnings']."\033[0m"; Chris@0: } else { Chris@0: echo '0'; Chris@0: } Chris@0: Chris@0: echo PHP_EOL; Chris@0: }//end foreach Chris@0: Chris@0: echo str_repeat('-', $width).PHP_EOL; Chris@0: echo "\033[1mA TOTAL OF $totalErrors ERROR"; Chris@0: if ($totalErrors !== 1) { Chris@0: echo 'S'; Chris@0: } Chris@0: Chris@0: echo ' AND '.$totalWarnings.' WARNING'; Chris@0: if ($totalWarnings !== 1) { Chris@0: echo 'S'; Chris@0: } Chris@0: Chris@0: echo ' WERE FOUND IN '.$totalFiles.' FILE'; Chris@0: if ($totalFiles !== 1) { Chris@0: echo 'S'; Chris@0: } Chris@0: Chris@0: echo "\033[0m"; Chris@0: Chris@0: if ($totalFixable > 0) { Chris@0: echo PHP_EOL.str_repeat('-', $width).PHP_EOL; Chris@0: echo "\033[1mPHPCBF CAN FIX $totalFixable OF THESE SNIFF VIOLATIONS AUTOMATICALLY\033[0m"; Chris@0: } Chris@0: Chris@0: echo PHP_EOL.str_repeat('-', $width).PHP_EOL.PHP_EOL; Chris@0: Chris@0: if ($toScreen === true && PHP_CODESNIFFER_INTERACTIVE === false) { Chris@0: PHP_CodeSniffer_Reporting::printRunTime(); Chris@0: } Chris@0: Chris@0: }//end generate() Chris@0: Chris@0: Chris@0: }//end class