Source for file Full.php
Documentation is available at Full.php
* Full 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\Files\File;
use PHP_CodeSniffer\Util;
class Full 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.
public function generateFileReport ($report, File $phpcsFile, $showSources=false , $width=80 )
if ($report['errors'] === 0 && $report['warnings'] === 0 ) {
// The length of the word ERROR or WARNING; used for padding.
if ($report['warnings'] > 0 ) {
// Work out the max line number length for formatting.
// The padding that all lines will require that are
// printing an error message overflow.
$paddingLine2 = str_repeat(' ', ($maxLineNumLength + 1 ));
if ($report['fixable'] > 0 ) {
$paddingLength = strlen($paddingLine2);
// Make sure the report width isn't too big.
foreach ($report['messages'] as $line => $lineErrors) {
foreach ($lineErrors as $column => $colErrors) {
foreach ($colErrors as $error) {
$length = strlen($error['message']);
if ($showSources === true ) {
$length += (strlen($error['source']) + 3 );
$maxErrorLength = max($maxErrorLength, ($length + 1 ));
$file = $report['filename'];
$maxWidth = max(($fileLength + 6 ), ($maxErrorLength + $paddingLength));
$width = min($width, $maxWidth);
echo PHP_EOL. "\033[1mFILE: ";
if ($fileLength <= ($width - 6 )) {
echo '...'. substr($file, ($fileLength - ($width - 6 )));
echo "\033[1m". 'FOUND '. $report['errors']. ' ERROR';
if ($report['errors'] !== 1 ) {
if ($report['warnings'] > 0 ) {
echo ' AND '. $report['warnings']. ' WARNING';
if ($report['warnings'] !== 1 ) {
echo ' AFFECTING '. count($report['messages']). ' LINE';
if (count($report['messages']) !== 1 ) {
// The maximum amount of space an error message can use.
$maxErrorSpace = ($width - $paddingLength - 1 );
if ($showSources === true ) {
// Account for the chars used to print colors.
foreach ($report['messages'] as $line => $lineErrors) {
foreach ($lineErrors as $column => $colErrors) {
foreach ($colErrors as $error) {
$message = $error['message'];
$message = str_replace("\n", "\n". $paddingLine2, $message);
if ($showSources === true ) {
$message = "\033[1m". $message. "\033[0m". ' ('. $error['source']. ')';
// The padding that goes on the front of the line.
$padding = ($maxLineNumLength - strlen($line));
if ($error['type'] === 'ERROR') {
echo "\033[31mERROR\033[0m";
if ($report['warnings'] > 0 ) {
echo "\033[33mWARNING\033[0m";
if ($report['fixable'] > 0 ) {
if ($error['fixable'] === true ) {
if ($report['fixable'] > 0 ) {
echo "\033[1m". 'PHPCBF CAN FIX THE '. $report['fixable']. ' MARKED SNIFF VIOLATIONS AUTOMATICALLY'. "\033[0m".PHP_EOL;
}//end generateFileReport()
* Prints all errors and warnings for each file processed.
* @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?
public function generate (
if ($cachedData === '') {
if ($toScreen === true && $interactive === false ) {
Util\Timing ::printRunTime ();
Documentation generated on Mon, 11 Mar 2019 15:27:30 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|