eventespresso / event-espresso-core

vendor/squizlabs/php_codesniffer/src/Reports/Json.php

Spacing +5 added lines, -5 removed lines

@@ -30,7 +30,7 @@ 
      *
      * @return bool
      */
-    public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)
+    public function generateFileReport($report, File $phpcsFile, $showSources = false, $width = 80)
     {
         $filename = str_replace('\\', '\\\\', $report['filename']);
         $filename = str_replace('"', '\"', $filename);
@@ -96,10 +96,10 @@ 
         $totalErrors,
         $totalWarnings,
         $totalFixable,
-        $showSources=false,
-        $width=80,
-        $interactive=false,
-        $toScreen=true
+        $showSources = false,
+        $width = 80,
+        $interactive = false,
+        $toScreen = true
     ) {
         echo '{"totals":{"errors":'.$totalErrors.',"warnings":'.$totalWarnings.',"fixable":'.$totalFixable.'},"files":{';
         echo rtrim($cachedData, ',');

Indentation +85 added lines, -85 removed lines

@@ -16,91 +16,91 @@
 {
 
 
-    /**
-     * 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)
-    {
-        $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("\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;
-                    }
-
-                    $messagesObject          = (object) $error;
-                    $messagesObject->line    = $line;
-                    $messagesObject->column  = $column;
-                    $messagesObject->fixable = $fixable;
-
-                    $messages .= json_encode($messagesObject).",";
-                }
-            }
-        }//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 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 '{"totals":{"errors":'.$totalErrors.',"warnings":'.$totalWarnings.',"fixable":'.$totalFixable.'},"files":{';
-        echo rtrim($cachedData, ',');
-        echo "}}".PHP_EOL;
-
-    }//end generate()
+	/**
+	 * 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)
+	{
+		$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("\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;
+					}
+
+					$messagesObject          = (object) $error;
+					$messagesObject->line    = $line;
+					$messagesObject->column  = $column;
+					$messagesObject->fixable = $fixable;
+
+					$messages .= json_encode($messagesObject).",";
+				}
+			}
+		}//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 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 '{"totals":{"errors":'.$totalErrors.',"warnings":'.$totalWarnings.',"fixable":'.$totalFixable.'},"files":{';
+		echo rtrim($cachedData, ',');
+		echo "}}".PHP_EOL;
+
+	}//end generate()
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Reports/Csv.php

Indentation +65 added lines, -65 removed lines

@@ -15,77 +15,77 @@
 {
 
 
-    /**
-     * 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)
-    {
-        if ($report['errors'] === 0 && $report['warnings'] === 0) {
-            // Nothing to print.
-            return false;
-        }
+	/**
+	 * 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)
+	{
+		if ($report['errors'] === 0 && $report['warnings'] === 0) {
+			// Nothing to print.
+			return false;
+		}
 
-        foreach ($report['messages'] as $line => $lineErrors) {
-            foreach ($lineErrors as $column => $colErrors) {
-                foreach ($colErrors as $error) {
-                    $filename = str_replace('"', '\"', $report['filename']);
-                    $message  = str_replace('"', '\"', $error['message']);
-                    $type     = strtolower($error['type']);
-                    $source   = $error['source'];
-                    $severity = $error['severity'];
-                    $fixable  = (int) $error['fixable'];
-                    echo "\"$filename\",$line,$column,$type,\"$message\",$source,$severity,$fixable".PHP_EOL;
-                }
-            }
-        }
+		foreach ($report['messages'] as $line => $lineErrors) {
+			foreach ($lineErrors as $column => $colErrors) {
+				foreach ($colErrors as $error) {
+					$filename = str_replace('"', '\"', $report['filename']);
+					$message  = str_replace('"', '\"', $error['message']);
+					$type     = strtolower($error['type']);
+					$source   = $error['source'];
+					$severity = $error['severity'];
+					$fixable  = (int) $error['fixable'];
+					echo "\"$filename\",$line,$column,$type,\"$message\",$source,$severity,$fixable".PHP_EOL;
+				}
+			}
+		}
 
-        return true;
+		return true;
 
-    }//end generateFileReport()
+	}//end generateFileReport()
 
 
-    /**
-     * Generates a csv 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 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 'File,Line,Column,Type,Message,Source,Severity,Fixable'.PHP_EOL;
-        echo $cachedData;
+	/**
+	 * Generates a csv 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 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 'File,Line,Column,Type,Message,Source,Severity,Fixable'.PHP_EOL;
+		echo $cachedData;
 
-    }//end generate()
+	}//end generate()
 
 
 }//end class

Spacing +5 added lines, -5 removed lines

@@ -29,7 +29,7 @@ 
      *
      * @return bool
      */
-    public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)
+    public function generateFileReport($report, File $phpcsFile, $showSources = false, $width = 80)
     {
         if ($report['errors'] === 0 && $report['warnings'] === 0) {
             // Nothing to print.
@@ -77,10 +77,10 @@ 
         $totalErrors,
         $totalWarnings,
         $totalFixable,
-        $showSources=false,
-        $width=80,
-        $interactive=false,
-        $toScreen=true
+        $showSources = false,
+        $width = 80,
+        $interactive = false,
+        $toScreen = true
     ) {
         echo 'File,Line,Column,Type,Message,Source,Severity,Fixable'.PHP_EOL;
         echo $cachedData;

vendor/squizlabs/php_codesniffer/src/Reports/Code.php

Spacing +5 added lines, -5 removed lines

@@ -30,7 +30,7 @@ 
      *
      * @return bool
      */
-    public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)
+    public function generateFileReport($report, File $phpcsFile, $showSources = false, $width = 80)
     {
         if ($report['errors'] === 0 && $report['warnings'] === 0) {
             // Nothing to print.
@@ -341,10 +341,10 @@ 
         $totalErrors,
         $totalWarnings,
         $totalFixable,
-        $showSources=false,
-        $width=80,
-        $interactive=false,
-        $toScreen=true
+        $showSources = false,
+        $width = 80,
+        $interactive = false,
+        $toScreen = true
     ) {
         if ($cachedData === '') {
             return;

Indentation +341 added lines, -341 removed lines

@@ -16,347 +16,347 @@
 {
 
 
-    /**
-     * 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)
-    {
-        if ($report['errors'] === 0 && $report['warnings'] === 0) {
-            // Nothing to print.
-            return false;
-        }
-
-        // How many lines to show about and below the error line.
-        $surroundingLines = 2;
-
-        $file   = $report['filename'];
-        $tokens = $phpcsFile->getTokens();
-        if (empty($tokens) === true) {
-            if (PHP_CODESNIFFER_VERBOSITY === 1) {
-                $startTime = microtime(true);
-                echo 'CODE report is parsing '.basename($file).' ';
-            } else if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo "CODE report is forcing parse of $file".PHP_EOL;
-            }
-
-            try {
-                $phpcsFile->parse();
-            } catch (\Exception $e) {
-                // This is a second parse, so ignore exceptions.
-                // They would have been added to the file's error list already.
-            }
-
-            if (PHP_CODESNIFFER_VERBOSITY === 1) {
-                $timeTaken = ((microtime(true) - $startTime) * 1000);
-                if ($timeTaken < 1000) {
-                    $timeTaken = round($timeTaken);
-                    echo "DONE in {$timeTaken}ms";
-                } else {
-                    $timeTaken = round(($timeTaken / 1000), 2);
-                    echo "DONE in $timeTaken secs";
-                }
-
-                echo PHP_EOL;
-            }
-
-            $tokens = $phpcsFile->getTokens();
-        }//end if
-
-        // Create an array that maps lines to the first token on the line.
-        $lineTokens = [];
-        $lastLine   = 0;
-        $stackPtr   = 0;
-        foreach ($tokens as $stackPtr => $token) {
-            if ($token['line'] !== $lastLine) {
-                if ($lastLine > 0) {
-                    $lineTokens[$lastLine]['end'] = ($stackPtr - 1);
-                }
-
-                $lastLine++;
-                $lineTokens[$lastLine] = [
-                    'start' => $stackPtr,
-                    'end'   => null,
-                ];
-            }
-        }
-
-        // Make sure the last token in the file sits on an imaginary
-        // last line so it is easier to generate code snippets at the
-        // end of the file.
-        $lineTokens[$lastLine]['end'] = $stackPtr;
-
-        // Determine the longest code line we will be showing.
-        $maxSnippetLength = 0;
-        $eolLen           = strlen($phpcsFile->eolChar);
-        foreach ($report['messages'] as $line => $lineErrors) {
-            $startLine = max(($line - $surroundingLines), 1);
-            $endLine   = min(($line + $surroundingLines), $lastLine);
-
-            $maxLineNumLength = strlen($endLine);
-
-            for ($i = $startLine; $i <= $endLine; $i++) {
-                if ($i === 1) {
-                    continue;
-                }
-
-                $lineLength       = ($tokens[($lineTokens[$i]['start'] - 1)]['column'] + $tokens[($lineTokens[$i]['start'] - 1)]['length'] - $eolLen);
-                $maxSnippetLength = max($lineLength, $maxSnippetLength);
-            }
-        }
-
-        $maxSnippetLength += ($maxLineNumLength + 8);
-
-        // Determine the longest error message we will be showing.
-        $maxErrorLength = 0;
-        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));
-                }
-            }
-        }
-
-        // The padding that all lines will require that are printing an error message overflow.
-        if ($report['warnings'] > 0) {
-            $typeLength = 7;
-        } else {
-            $typeLength = 5;
-        }
-
-        $errorPadding  = str_repeat(' ', ($maxLineNumLength + 7));
-        $errorPadding .= str_repeat(' ', $typeLength);
-        $errorPadding .= ' ';
-        if ($report['fixable'] > 0) {
-            $errorPadding .= '    ';
-        }
-
-        $errorPaddingLength = strlen($errorPadding);
-
-        // The maximum amount of space an error message can use.
-        $maxErrorSpace = ($width - $errorPaddingLength);
-        if ($showSources === true) {
-            // Account for the chars used to print colors.
-            $maxErrorSpace += 8;
-        }
-
-        // Figure out the max report width we need and can use.
-        $fileLength = strlen($file);
-        $maxWidth   = max(($fileLength + 6), ($maxErrorLength + $errorPaddingLength));
-        $width      = max(min($width, $maxWidth), $maxSnippetLength);
-        if ($width < 70) {
-            $width = 70;
-        }
-
-        // Print the file header.
-        echo PHP_EOL."\033[1mFILE: ";
-        if ($fileLength <= ($width - 6)) {
-            echo $file;
-        } else {
-            echo '...'.substr($file, ($fileLength - ($width - 6)));
-        }
-
-        echo "\033[0m".PHP_EOL;
-        echo str_repeat('-', $width).PHP_EOL;
-
-        echo "\033[1m".'FOUND '.$report['errors'].' ERROR';
-        if ($report['errors'] !== 1) {
-            echo 'S';
-        }
-
-        if ($report['warnings'] > 0) {
-            echo ' AND '.$report['warnings'].' WARNING';
-            if ($report['warnings'] !== 1) {
-                echo 'S';
-            }
-        }
-
-        echo ' AFFECTING '.count($report['messages']).' LINE';
-        if (count($report['messages']) !== 1) {
-            echo 'S';
-        }
-
-        echo "\033[0m".PHP_EOL;
-
-        foreach ($report['messages'] as $line => $lineErrors) {
-            $startLine = max(($line - $surroundingLines), 1);
-            $endLine   = min(($line + $surroundingLines), $lastLine);
-
-            $snippet = '';
-            if (isset($lineTokens[$startLine]) === true) {
-                for ($i = $lineTokens[$startLine]['start']; $i <= $lineTokens[$endLine]['end']; $i++) {
-                    $snippetLine = $tokens[$i]['line'];
-                    if ($lineTokens[$snippetLine]['start'] === $i) {
-                        // Starting a new line.
-                        if ($snippetLine === $line) {
-                            $snippet .= "\033[1m".'>> ';
-                        } else {
-                            $snippet .= '   ';
-                        }
-
-                        $snippet .= str_repeat(' ', ($maxLineNumLength - strlen($snippetLine)));
-                        $snippet .= $snippetLine.':  ';
-                        if ($snippetLine === $line) {
-                            $snippet .= "\033[0m";
-                        }
-                    }
-
-                    if (isset($tokens[$i]['orig_content']) === true) {
-                        $tokenContent = $tokens[$i]['orig_content'];
-                    } else {
-                        $tokenContent = $tokens[$i]['content'];
-                    }
-
-                    if (strpos($tokenContent, "\t") !== false) {
-                        $token            = $tokens[$i];
-                        $token['content'] = $tokenContent;
-                        if (stripos(PHP_OS, 'WIN') === 0) {
-                            $tab = "\000";
-                        } else {
-                            $tab = "\033[30;1m»\033[0m";
-                        }
-
-                        $phpcsFile->tokenizer->replaceTabsInToken($token, $tab, "\000");
-                        $tokenContent = $token['content'];
-                    }
-
-                    $tokenContent = Util\Common::prepareForOutput($tokenContent, ["\r", "\n", "\t"]);
-                    $tokenContent = str_replace("\000", ' ', $tokenContent);
-
-                    $underline = false;
-                    if ($snippetLine === $line && isset($lineErrors[$tokens[$i]['column']]) === true) {
-                        $underline = true;
-                    }
-
-                    // Underline invisible characters as well.
-                    if ($underline === true && trim($tokenContent) === '') {
-                        $snippet .= "\033[4m".' '."\033[0m".$tokenContent;
-                    } else {
-                        if ($underline === true) {
-                            $snippet .= "\033[4m";
-                        }
-
-                        $snippet .= $tokenContent;
-
-                        if ($underline === true) {
-                            $snippet .= "\033[0m";
-                        }
-                    }
-                }//end for
-            }//end if
-
-            echo str_repeat('-', $width).PHP_EOL;
-
-            foreach ($lineErrors as $column => $colErrors) {
-                foreach ($colErrors as $error) {
-                    $padding = ($maxLineNumLength - strlen($line));
-                    echo 'LINE '.str_repeat(' ', $padding).$line.': ';
-
-                    if ($error['type'] === 'ERROR') {
-                        echo "\033[31mERROR\033[0m";
-                        if ($report['warnings'] > 0) {
-                            echo '  ';
-                        }
-                    } else {
-                        echo "\033[33mWARNING\033[0m";
-                    }
-
-                    echo ' ';
-                    if ($report['fixable'] > 0) {
-                        echo '[';
-                        if ($error['fixable'] === true) {
-                            echo 'x';
-                        } else {
-                            echo ' ';
-                        }
-
-                        echo '] ';
-                    }
-
-                    $message = $error['message'];
-                    $message = str_replace("\n", "\n".$errorPadding, $message);
-                    if ($showSources === true) {
-                        $message = "\033[1m".$message."\033[0m".' ('.$error['source'].')';
-                    }
-
-                    $errorMsg = wordwrap(
-                        $message,
-                        $maxErrorSpace,
-                        PHP_EOL.$errorPadding
-                    );
-
-                    echo $errorMsg.PHP_EOL;
-                }//end foreach
-            }//end foreach
-
-            echo str_repeat('-', $width).PHP_EOL;
-            echo rtrim($snippet).PHP_EOL;
-        }//end foreach
-
-        echo str_repeat('-', $width).PHP_EOL;
-        if ($report['fixable'] > 0) {
-            echo "\033[1m".'PHPCBF CAN FIX THE '.$report['fixable'].' MARKED SNIFF VIOLATIONS AUTOMATICALLY'."\033[0m".PHP_EOL;
-            echo str_repeat('-', $width).PHP_EOL;
-        }
-
-        return true;
-
-    }//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?
-     *
-     * @return void
-     */
-    public function generate(
-        $cachedData,
-        $totalFiles,
-        $totalErrors,
-        $totalWarnings,
-        $totalFixable,
-        $showSources=false,
-        $width=80,
-        $interactive=false,
-        $toScreen=true
-    ) {
-        if ($cachedData === '') {
-            return;
-        }
-
-        echo $cachedData;
-
-        if ($toScreen === true && $interactive === false) {
-            Util\Timing::printRunTime();
-        }
-
-    }//end generate()
+	/**
+	 * 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)
+	{
+		if ($report['errors'] === 0 && $report['warnings'] === 0) {
+			// Nothing to print.
+			return false;
+		}
+
+		// How many lines to show about and below the error line.
+		$surroundingLines = 2;
+
+		$file   = $report['filename'];
+		$tokens = $phpcsFile->getTokens();
+		if (empty($tokens) === true) {
+			if (PHP_CODESNIFFER_VERBOSITY === 1) {
+				$startTime = microtime(true);
+				echo 'CODE report is parsing '.basename($file).' ';
+			} else if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				echo "CODE report is forcing parse of $file".PHP_EOL;
+			}
+
+			try {
+				$phpcsFile->parse();
+			} catch (\Exception $e) {
+				// This is a second parse, so ignore exceptions.
+				// They would have been added to the file's error list already.
+			}
+
+			if (PHP_CODESNIFFER_VERBOSITY === 1) {
+				$timeTaken = ((microtime(true) - $startTime) * 1000);
+				if ($timeTaken < 1000) {
+					$timeTaken = round($timeTaken);
+					echo "DONE in {$timeTaken}ms";
+				} else {
+					$timeTaken = round(($timeTaken / 1000), 2);
+					echo "DONE in $timeTaken secs";
+				}
+
+				echo PHP_EOL;
+			}
+
+			$tokens = $phpcsFile->getTokens();
+		}//end if
+
+		// Create an array that maps lines to the first token on the line.
+		$lineTokens = [];
+		$lastLine   = 0;
+		$stackPtr   = 0;
+		foreach ($tokens as $stackPtr => $token) {
+			if ($token['line'] !== $lastLine) {
+				if ($lastLine > 0) {
+					$lineTokens[$lastLine]['end'] = ($stackPtr - 1);
+				}
+
+				$lastLine++;
+				$lineTokens[$lastLine] = [
+					'start' => $stackPtr,
+					'end'   => null,
+				];
+			}
+		}
+
+		// Make sure the last token in the file sits on an imaginary
+		// last line so it is easier to generate code snippets at the
+		// end of the file.
+		$lineTokens[$lastLine]['end'] = $stackPtr;
+
+		// Determine the longest code line we will be showing.
+		$maxSnippetLength = 0;
+		$eolLen           = strlen($phpcsFile->eolChar);
+		foreach ($report['messages'] as $line => $lineErrors) {
+			$startLine = max(($line - $surroundingLines), 1);
+			$endLine   = min(($line + $surroundingLines), $lastLine);
+
+			$maxLineNumLength = strlen($endLine);
+
+			for ($i = $startLine; $i <= $endLine; $i++) {
+				if ($i === 1) {
+					continue;
+				}
+
+				$lineLength       = ($tokens[($lineTokens[$i]['start'] - 1)]['column'] + $tokens[($lineTokens[$i]['start'] - 1)]['length'] - $eolLen);
+				$maxSnippetLength = max($lineLength, $maxSnippetLength);
+			}
+		}
+
+		$maxSnippetLength += ($maxLineNumLength + 8);
+
+		// Determine the longest error message we will be showing.
+		$maxErrorLength = 0;
+		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));
+				}
+			}
+		}
+
+		// The padding that all lines will require that are printing an error message overflow.
+		if ($report['warnings'] > 0) {
+			$typeLength = 7;
+		} else {
+			$typeLength = 5;
+		}
+
+		$errorPadding  = str_repeat(' ', ($maxLineNumLength + 7));
+		$errorPadding .= str_repeat(' ', $typeLength);
+		$errorPadding .= ' ';
+		if ($report['fixable'] > 0) {
+			$errorPadding .= '    ';
+		}
+
+		$errorPaddingLength = strlen($errorPadding);
+
+		// The maximum amount of space an error message can use.
+		$maxErrorSpace = ($width - $errorPaddingLength);
+		if ($showSources === true) {
+			// Account for the chars used to print colors.
+			$maxErrorSpace += 8;
+		}
+
+		// Figure out the max report width we need and can use.
+		$fileLength = strlen($file);
+		$maxWidth   = max(($fileLength + 6), ($maxErrorLength + $errorPaddingLength));
+		$width      = max(min($width, $maxWidth), $maxSnippetLength);
+		if ($width < 70) {
+			$width = 70;
+		}
+
+		// Print the file header.
+		echo PHP_EOL."\033[1mFILE: ";
+		if ($fileLength <= ($width - 6)) {
+			echo $file;
+		} else {
+			echo '...'.substr($file, ($fileLength - ($width - 6)));
+		}
+
+		echo "\033[0m".PHP_EOL;
+		echo str_repeat('-', $width).PHP_EOL;
+
+		echo "\033[1m".'FOUND '.$report['errors'].' ERROR';
+		if ($report['errors'] !== 1) {
+			echo 'S';
+		}
+
+		if ($report['warnings'] > 0) {
+			echo ' AND '.$report['warnings'].' WARNING';
+			if ($report['warnings'] !== 1) {
+				echo 'S';
+			}
+		}
+
+		echo ' AFFECTING '.count($report['messages']).' LINE';
+		if (count($report['messages']) !== 1) {
+			echo 'S';
+		}
+
+		echo "\033[0m".PHP_EOL;
+
+		foreach ($report['messages'] as $line => $lineErrors) {
+			$startLine = max(($line - $surroundingLines), 1);
+			$endLine   = min(($line + $surroundingLines), $lastLine);
+
+			$snippet = '';
+			if (isset($lineTokens[$startLine]) === true) {
+				for ($i = $lineTokens[$startLine]['start']; $i <= $lineTokens[$endLine]['end']; $i++) {
+					$snippetLine = $tokens[$i]['line'];
+					if ($lineTokens[$snippetLine]['start'] === $i) {
+						// Starting a new line.
+						if ($snippetLine === $line) {
+							$snippet .= "\033[1m".'>> ';
+						} else {
+							$snippet .= '   ';
+						}
+
+						$snippet .= str_repeat(' ', ($maxLineNumLength - strlen($snippetLine)));
+						$snippet .= $snippetLine.':  ';
+						if ($snippetLine === $line) {
+							$snippet .= "\033[0m";
+						}
+					}
+
+					if (isset($tokens[$i]['orig_content']) === true) {
+						$tokenContent = $tokens[$i]['orig_content'];
+					} else {
+						$tokenContent = $tokens[$i]['content'];
+					}
+
+					if (strpos($tokenContent, "\t") !== false) {
+						$token            = $tokens[$i];
+						$token['content'] = $tokenContent;
+						if (stripos(PHP_OS, 'WIN') === 0) {
+							$tab = "\000";
+						} else {
+							$tab = "\033[30;1m»\033[0m";
+						}
+
+						$phpcsFile->tokenizer->replaceTabsInToken($token, $tab, "\000");
+						$tokenContent = $token['content'];
+					}
+
+					$tokenContent = Util\Common::prepareForOutput($tokenContent, ["\r", "\n", "\t"]);
+					$tokenContent = str_replace("\000", ' ', $tokenContent);
+
+					$underline = false;
+					if ($snippetLine === $line && isset($lineErrors[$tokens[$i]['column']]) === true) {
+						$underline = true;
+					}
+
+					// Underline invisible characters as well.
+					if ($underline === true && trim($tokenContent) === '') {
+						$snippet .= "\033[4m".' '."\033[0m".$tokenContent;
+					} else {
+						if ($underline === true) {
+							$snippet .= "\033[4m";
+						}
+
+						$snippet .= $tokenContent;
+
+						if ($underline === true) {
+							$snippet .= "\033[0m";
+						}
+					}
+				}//end for
+			}//end if
+
+			echo str_repeat('-', $width).PHP_EOL;
+
+			foreach ($lineErrors as $column => $colErrors) {
+				foreach ($colErrors as $error) {
+					$padding = ($maxLineNumLength - strlen($line));
+					echo 'LINE '.str_repeat(' ', $padding).$line.': ';
+
+					if ($error['type'] === 'ERROR') {
+						echo "\033[31mERROR\033[0m";
+						if ($report['warnings'] > 0) {
+							echo '  ';
+						}
+					} else {
+						echo "\033[33mWARNING\033[0m";
+					}
+
+					echo ' ';
+					if ($report['fixable'] > 0) {
+						echo '[';
+						if ($error['fixable'] === true) {
+							echo 'x';
+						} else {
+							echo ' ';
+						}
+
+						echo '] ';
+					}
+
+					$message = $error['message'];
+					$message = str_replace("\n", "\n".$errorPadding, $message);
+					if ($showSources === true) {
+						$message = "\033[1m".$message."\033[0m".' ('.$error['source'].')';
+					}
+
+					$errorMsg = wordwrap(
+						$message,
+						$maxErrorSpace,
+						PHP_EOL.$errorPadding
+					);
+
+					echo $errorMsg.PHP_EOL;
+				}//end foreach
+			}//end foreach
+
+			echo str_repeat('-', $width).PHP_EOL;
+			echo rtrim($snippet).PHP_EOL;
+		}//end foreach
+
+		echo str_repeat('-', $width).PHP_EOL;
+		if ($report['fixable'] > 0) {
+			echo "\033[1m".'PHPCBF CAN FIX THE '.$report['fixable'].' MARKED SNIFF VIOLATIONS AUTOMATICALLY'."\033[0m".PHP_EOL;
+			echo str_repeat('-', $width).PHP_EOL;
+		}
+
+		return true;
+
+	}//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?
+	 *
+	 * @return void
+	 */
+	public function generate(
+		$cachedData,
+		$totalFiles,
+		$totalErrors,
+		$totalWarnings,
+		$totalFixable,
+		$showSources=false,
+		$width=80,
+		$interactive=false,
+		$toScreen=true
+	) {
+		if ($cachedData === '') {
+			return;
+		}
+
+		echo $cachedData;
+
+		if ($toScreen === true && $interactive === false) {
+			Util\Timing::printRunTime();
+		}
+
+	}//end generate()
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Reports/Checkstyle.php

Indentation +88 added lines, -88 removed lines

@@ -16,94 +16,94 @@
 {
 
 
-    /**
-     * 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()
+	/**
+	 * 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

Spacing +5 added lines, -5 removed lines

@@ -30,7 +30,7 @@ 
      *
      * @return bool
      */
-    public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)
+    public function generateFileReport($report, File $phpcsFile, $showSources = false, $width = 80)
     {
         $out = new \XMLWriter;
         $out->openMemory();
@@ -93,10 +93,10 @@ 
         $totalErrors,
         $totalWarnings,
         $totalFixable,
-        $showSources=false,
-        $width=80,
-        $interactive=false,
-        $toScreen=true
+        $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;

vendor/squizlabs/php_codesniffer/src/Reports/Info.php

Spacing +5 added lines, -5 removed lines

@@ -30,7 +30,7 @@ 
      *
      * @return bool
      */
-    public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)
+    public function generateFileReport($report, File $phpcsFile, $showSources = false, $width = 80)
     {
         $metrics = $phpcsFile->getMetrics();
         foreach ($metrics as $metric => $data) {
@@ -66,10 +66,10 @@ 
         $totalErrors,
         $totalWarnings,
         $totalFixable,
-        $showSources=false,
-        $width=80,
-        $interactive=false,
-        $toScreen=true
+        $showSources = false,
+        $width = 80,
+        $interactive = false,
+        $toScreen = true
     ) {
         $lines = explode(PHP_EOL, $cachedData);
         array_pop($lines);

Indentation +151 added lines, -151 removed lines

@@ -16,157 +16,157 @@
 {
 
 
-    /**
-     * 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)
-    {
-        $metrics = $phpcsFile->getMetrics();
-        foreach ($metrics as $metric => $data) {
-            foreach ($data['values'] as $value => $count) {
-                echo "$metric>>$value>>$count".PHP_EOL;
-            }
-        }
-
-        return true;
-
-    }//end generateFileReport()
-
-
-    /**
-     * Prints the source of all errors and warnings.
-     *
-     * @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
-    ) {
-        $lines = explode(PHP_EOL, $cachedData);
-        array_pop($lines);
-
-        if (empty($lines) === true) {
-            return;
-        }
-
-        $metrics = [];
-        foreach ($lines as $line) {
-            $parts  = explode('>>', $line);
-            $metric = $parts[0];
-            $value  = $parts[1];
-            $count  = $parts[2];
-            if (isset($metrics[$metric]) === false) {
-                $metrics[$metric] = [];
-            }
-
-            if (isset($metrics[$metric][$value]) === false) {
-                $metrics[$metric][$value] = $count;
-            } else {
-                $metrics[$metric][$value] += $count;
-            }
-        }
-
-        ksort($metrics);
-
-        echo PHP_EOL."\033[1m".'PHP CODE SNIFFER INFORMATION REPORT'."\033[0m".PHP_EOL;
-        echo str_repeat('-', 70).PHP_EOL;
-
-        foreach ($metrics as $metric => $values) {
-            if (count($values) === 1) {
-                $count = reset($values);
-                $value = key($values);
-
-                echo "$metric: \033[4m$value\033[0m [$count/$count, 100%]".PHP_EOL;
-            } else {
-                $totalCount = 0;
-                $valueWidth = 0;
-                foreach ($values as $value => $count) {
-                    $totalCount += $count;
-                    $valueWidth  = max($valueWidth, strlen($value));
-                }
-
-                // Length of the total string, plus however many
-                // thousands separators there are.
-                $countWidth = strlen($totalCount);
-                $thousandSeparatorCount = floor($countWidth / 3);
-                $countWidth            += $thousandSeparatorCount;
-
-                // Account for 'total' line.
-                $valueWidth = max(5, $valueWidth);
-
-                echo "$metric:".PHP_EOL;
-
-                ksort($values, SORT_NATURAL);
-                arsort($values);
-
-                $percentPrefixWidth = 0;
-                $percentWidth       = 6;
-                foreach ($values as $value => $count) {
-                    $percent       = round(($count / $totalCount * 100), 2);
-                    $percentPrefix = '';
-                    if ($percent === 0.00) {
-                        $percent            = 0.01;
-                        $percentPrefix      = '<';
-                        $percentPrefixWidth = 2;
-                        $percentWidth       = 4;
-                    }
-
-                    printf(
-                        "\t%-{$valueWidth}s => %{$countWidth}s (%{$percentPrefixWidth}s%{$percentWidth}.2f%%)".PHP_EOL,
-                        $value,
-                        number_format($count),
-                        $percentPrefix,
-                        $percent
-                    );
-                }
-
-                echo "\t".str_repeat('-', ($valueWidth + $countWidth + 15)).PHP_EOL;
-                printf(
-                    "\t%-{$valueWidth}s => %{$countWidth}s (100.00%%)".PHP_EOL,
-                    'total',
-                    number_format($totalCount)
-                );
-            }//end if
-
-            echo PHP_EOL;
-        }//end foreach
-
-        echo str_repeat('-', 70).PHP_EOL;
-
-        if ($toScreen === true && $interactive === false) {
-            Timing::printRunTime();
-        }
-
-    }//end generate()
+	/**
+	 * 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)
+	{
+		$metrics = $phpcsFile->getMetrics();
+		foreach ($metrics as $metric => $data) {
+			foreach ($data['values'] as $value => $count) {
+				echo "$metric>>$value>>$count".PHP_EOL;
+			}
+		}
+
+		return true;
+
+	}//end generateFileReport()
+
+
+	/**
+	 * Prints the source of all errors and warnings.
+	 *
+	 * @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
+	) {
+		$lines = explode(PHP_EOL, $cachedData);
+		array_pop($lines);
+
+		if (empty($lines) === true) {
+			return;
+		}
+
+		$metrics = [];
+		foreach ($lines as $line) {
+			$parts  = explode('>>', $line);
+			$metric = $parts[0];
+			$value  = $parts[1];
+			$count  = $parts[2];
+			if (isset($metrics[$metric]) === false) {
+				$metrics[$metric] = [];
+			}
+
+			if (isset($metrics[$metric][$value]) === false) {
+				$metrics[$metric][$value] = $count;
+			} else {
+				$metrics[$metric][$value] += $count;
+			}
+		}
+
+		ksort($metrics);
+
+		echo PHP_EOL."\033[1m".'PHP CODE SNIFFER INFORMATION REPORT'."\033[0m".PHP_EOL;
+		echo str_repeat('-', 70).PHP_EOL;
+
+		foreach ($metrics as $metric => $values) {
+			if (count($values) === 1) {
+				$count = reset($values);
+				$value = key($values);
+
+				echo "$metric: \033[4m$value\033[0m [$count/$count, 100%]".PHP_EOL;
+			} else {
+				$totalCount = 0;
+				$valueWidth = 0;
+				foreach ($values as $value => $count) {
+					$totalCount += $count;
+					$valueWidth  = max($valueWidth, strlen($value));
+				}
+
+				// Length of the total string, plus however many
+				// thousands separators there are.
+				$countWidth = strlen($totalCount);
+				$thousandSeparatorCount = floor($countWidth / 3);
+				$countWidth            += $thousandSeparatorCount;
+
+				// Account for 'total' line.
+				$valueWidth = max(5, $valueWidth);
+
+				echo "$metric:".PHP_EOL;
+
+				ksort($values, SORT_NATURAL);
+				arsort($values);
+
+				$percentPrefixWidth = 0;
+				$percentWidth       = 6;
+				foreach ($values as $value => $count) {
+					$percent       = round(($count / $totalCount * 100), 2);
+					$percentPrefix = '';
+					if ($percent === 0.00) {
+						$percent            = 0.01;
+						$percentPrefix      = '<';
+						$percentPrefixWidth = 2;
+						$percentWidth       = 4;
+					}
+
+					printf(
+						"\t%-{$valueWidth}s => %{$countWidth}s (%{$percentPrefixWidth}s%{$percentWidth}.2f%%)".PHP_EOL,
+						$value,
+						number_format($count),
+						$percentPrefix,
+						$percent
+					);
+				}
+
+				echo "\t".str_repeat('-', ($valueWidth + $countWidth + 15)).PHP_EOL;
+				printf(
+					"\t%-{$valueWidth}s => %{$countWidth}s (100.00%%)".PHP_EOL,
+					'total',
+					number_format($totalCount)
+				);
+			}//end if
+
+			echo PHP_EOL;
+		}//end foreach
+
+		echo str_repeat('-', 70).PHP_EOL;
+
+		if ($toScreen === true && $interactive === false) {
+			Timing::printRunTime();
+		}
+
+	}//end generate()
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Reports/Diff.php

Indentation +110 added lines, -110 removed lines

@@ -16,116 +16,116 @@
 {
 
 
-    /**
-     * 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)
-    {
-        $errors = $phpcsFile->getFixableCount();
-        if ($errors === 0) {
-            return false;
-        }
-
-        $phpcsFile->disableCaching();
-        $tokens = $phpcsFile->getTokens();
-        if (empty($tokens) === true) {
-            if (PHP_CODESNIFFER_VERBOSITY === 1) {
-                $startTime = microtime(true);
-                echo 'DIFF report is parsing '.basename($report['filename']).' ';
-            } else if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo 'DIFF report is forcing parse of '.$report['filename'].PHP_EOL;
-            }
-
-            $phpcsFile->parse();
-
-            if (PHP_CODESNIFFER_VERBOSITY === 1) {
-                $timeTaken = ((microtime(true) - $startTime) * 1000);
-                if ($timeTaken < 1000) {
-                    $timeTaken = round($timeTaken);
-                    echo "DONE in {$timeTaken}ms";
-                } else {
-                    $timeTaken = round(($timeTaken / 1000), 2);
-                    echo "DONE in $timeTaken secs";
-                }
-
-                echo PHP_EOL;
-            }
-
-            $phpcsFile->fixer->startFile($phpcsFile);
-        }//end if
-
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            ob_end_clean();
-            echo "\t*** START FILE FIXING ***".PHP_EOL;
-        }
-
-        $fixed = $phpcsFile->fixer->fixFile();
-
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            echo "\t*** END FILE FIXING ***".PHP_EOL;
-            ob_start();
-        }
-
-        if ($fixed === false) {
-            return false;
-        }
-
-        $diff = $phpcsFile->fixer->generateDiff();
-        if ($diff === '') {
-            // Nothing to print.
-            return false;
-        }
-
-        echo $diff.PHP_EOL;
-        return true;
-
-    }//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?
-     *
-     * @return void
-     */
-    public function generate(
-        $cachedData,
-        $totalFiles,
-        $totalErrors,
-        $totalWarnings,
-        $totalFixable,
-        $showSources=false,
-        $width=80,
-        $interactive=false,
-        $toScreen=true
-    ) {
-        echo $cachedData;
-        if ($toScreen === true && $cachedData !== '') {
-            echo PHP_EOL;
-        }
-
-    }//end generate()
+	/**
+	 * 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)
+	{
+		$errors = $phpcsFile->getFixableCount();
+		if ($errors === 0) {
+			return false;
+		}
+
+		$phpcsFile->disableCaching();
+		$tokens = $phpcsFile->getTokens();
+		if (empty($tokens) === true) {
+			if (PHP_CODESNIFFER_VERBOSITY === 1) {
+				$startTime = microtime(true);
+				echo 'DIFF report is parsing '.basename($report['filename']).' ';
+			} else if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				echo 'DIFF report is forcing parse of '.$report['filename'].PHP_EOL;
+			}
+
+			$phpcsFile->parse();
+
+			if (PHP_CODESNIFFER_VERBOSITY === 1) {
+				$timeTaken = ((microtime(true) - $startTime) * 1000);
+				if ($timeTaken < 1000) {
+					$timeTaken = round($timeTaken);
+					echo "DONE in {$timeTaken}ms";
+				} else {
+					$timeTaken = round(($timeTaken / 1000), 2);
+					echo "DONE in $timeTaken secs";
+				}
+
+				echo PHP_EOL;
+			}
+
+			$phpcsFile->fixer->startFile($phpcsFile);
+		}//end if
+
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			ob_end_clean();
+			echo "\t*** START FILE FIXING ***".PHP_EOL;
+		}
+
+		$fixed = $phpcsFile->fixer->fixFile();
+
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			echo "\t*** END FILE FIXING ***".PHP_EOL;
+			ob_start();
+		}
+
+		if ($fixed === false) {
+			return false;
+		}
+
+		$diff = $phpcsFile->fixer->generateDiff();
+		if ($diff === '') {
+			// Nothing to print.
+			return false;
+		}
+
+		echo $diff.PHP_EOL;
+		return true;
+
+	}//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?
+	 *
+	 * @return void
+	 */
+	public function generate(
+		$cachedData,
+		$totalFiles,
+		$totalErrors,
+		$totalWarnings,
+		$totalFixable,
+		$showSources=false,
+		$width=80,
+		$interactive=false,
+		$toScreen=true
+	) {
+		echo $cachedData;
+		if ($toScreen === true && $cachedData !== '') {
+			echo PHP_EOL;
+		}
+
+	}//end generate()
 
 
 }//end class

Spacing +5 added lines, -5 removed lines

@@ -30,7 +30,7 @@ 
      *
      * @return bool
      */
-    public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)
+    public function generateFileReport($report, File $phpcsFile, $showSources = false, $width = 80)
     {
         $errors = $phpcsFile->getFixableCount();
         if ($errors === 0) {
@@ -115,10 +115,10 @@ 
         $totalErrors,
         $totalWarnings,
         $totalFixable,
-        $showSources=false,
-        $width=80,
-        $interactive=false,
-        $toScreen=true
+        $showSources = false,
+        $width = 80,
+        $interactive = false,
+        $toScreen = true
     ) {
         echo $cachedData;
         if ($toScreen === true && $cachedData !== '') {

vendor/squizlabs/php_codesniffer/src/Reports/VersionControl.php

Indentation +355 added lines, -355 removed lines

@@ -16,361 +16,361 @@
 abstract class VersionControl implements Report
 {
 
-    /**
-     * The name of the report we want in the output.
-     *
-     * @var string
-     */
-    protected $reportName = 'VERSION CONTROL';
-
-
-    /**
-     * 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)
-    {
-        $blames = $this->getBlameContent($report['filename']);
-
-        $authorCache = [];
-        $praiseCache = [];
-        $sourceCache = [];
-
-        foreach ($report['messages'] as $line => $lineErrors) {
-            $author = 'Unknown';
-            if (isset($blames[($line - 1)]) === true) {
-                $blameAuthor = $this->getAuthor($blames[($line - 1)]);
-                if ($blameAuthor !== false) {
-                    $author = $blameAuthor;
-                }
-            }
-
-            if (isset($authorCache[$author]) === false) {
-                $authorCache[$author] = 0;
-                $praiseCache[$author] = [
-                    'good' => 0,
-                    'bad'  => 0,
-                ];
-            }
-
-            $praiseCache[$author]['bad']++;
-
-            foreach ($lineErrors as $column => $colErrors) {
-                foreach ($colErrors as $error) {
-                    $authorCache[$author]++;
-
-                    if ($showSources === true) {
-                        $source = $error['source'];
-                        if (isset($sourceCache[$author][$source]) === false) {
-                            $sourceCache[$author][$source] = [
-                                'count'   => 1,
-                                'fixable' => $error['fixable'],
-                            ];
-                        } else {
-                            $sourceCache[$author][$source]['count']++;
-                        }
-                    }
-                }
-            }
-
-            unset($blames[($line - 1)]);
-        }//end foreach
-
-        // Now go through and give the authors some credit for
-        // all the lines that do not have errors.
-        foreach ($blames as $line) {
-            $author = $this->getAuthor($line);
-            if ($author === false) {
-                $author = 'Unknown';
-            }
-
-            if (isset($authorCache[$author]) === false) {
-                // This author doesn't have any errors.
-                if (PHP_CODESNIFFER_VERBOSITY === 0) {
-                    continue;
-                }
-
-                $authorCache[$author] = 0;
-                $praiseCache[$author] = [
-                    'good' => 0,
-                    'bad'  => 0,
-                ];
-            }
-
-            $praiseCache[$author]['good']++;
-        }//end foreach
-
-        foreach ($authorCache as $author => $errors) {
-            echo "AUTHOR>>$author>>$errors".PHP_EOL;
-        }
-
-        foreach ($praiseCache as $author => $praise) {
-            echo "PRAISE>>$author>>".$praise['good'].'>>'.$praise['bad'].PHP_EOL;
-        }
-
-        foreach ($sourceCache as $author => $sources) {
-            foreach ($sources as $source => $sourceData) {
-                $count   = $sourceData['count'];
-                $fixable = (int) $sourceData['fixable'];
-                echo "SOURCE>>$author>>$source>>$count>>$fixable".PHP_EOL;
-            }
-        }
-
-        return true;
-
-    }//end generateFileReport()
-
-
-    /**
-     * Prints the author of all errors and warnings, as given by "version control blame".
-     *
-     * @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
-    ) {
-        $errorsShown = ($totalErrors + $totalWarnings);
-        if ($errorsShown === 0) {
-            // Nothing to show.
-            return;
-        }
-
-        $lines = explode(PHP_EOL, $cachedData);
-        array_pop($lines);
-
-        if (empty($lines) === true) {
-            return;
-        }
-
-        $authorCache = [];
-        $praiseCache = [];
-        $sourceCache = [];
-
-        foreach ($lines as $line) {
-            $parts = explode('>>', $line);
-            switch ($parts[0]) {
-            case 'AUTHOR':
-                if (isset($authorCache[$parts[1]]) === false) {
-                    $authorCache[$parts[1]] = $parts[2];
-                } else {
-                    $authorCache[$parts[1]] += $parts[2];
-                }
-                break;
-            case 'PRAISE':
-                if (isset($praiseCache[$parts[1]]) === false) {
-                    $praiseCache[$parts[1]] = [
-                        'good' => $parts[2],
-                        'bad'  => $parts[3],
-                    ];
-                } else {
-                    $praiseCache[$parts[1]]['good'] += $parts[2];
-                    $praiseCache[$parts[1]]['bad']  += $parts[3];
-                }
-                break;
-            case 'SOURCE':
-                if (isset($praiseCache[$parts[1]]) === false) {
-                    $praiseCache[$parts[1]] = [];
-                }
-
-                if (isset($sourceCache[$parts[1]][$parts[2]]) === false) {
-                    $sourceCache[$parts[1]][$parts[2]] = [
-                        'count'   => $parts[3],
-                        'fixable' => (bool) $parts[4],
-                    ];
-                } else {
-                    $sourceCache[$parts[1]][$parts[2]]['count'] += $parts[3];
-                }
-                break;
-            default:
-                break;
-            }//end switch
-        }//end foreach
-
-        // Make sure the report width isn't too big.
-        $maxLength = 0;
-        foreach ($authorCache as $author => $count) {
-            $maxLength = max($maxLength, strlen($author));
-            if ($showSources === true && isset($sourceCache[$author]) === true) {
-                foreach ($sourceCache[$author] as $source => $sourceData) {
-                    if ($source === 'count') {
-                        continue;
-                    }
-
-                    $maxLength = max($maxLength, (strlen($source) + 9));
-                }
-            }
-        }
-
-        $width = min($width, ($maxLength + 30));
-        $width = max($width, 70);
-        arsort($authorCache);
-
-        echo PHP_EOL."\033[1m".'PHP CODE SNIFFER '.$this->reportName.' BLAME SUMMARY'."\033[0m".PHP_EOL;
-        echo str_repeat('-', $width).PHP_EOL."\033[1m";
-        if ($showSources === true) {
-            echo 'AUTHOR   SOURCE'.str_repeat(' ', ($width - 43)).'(Author %) (Overall %) COUNT'.PHP_EOL;
-            echo str_repeat('-', $width).PHP_EOL;
-        } else {
-            echo 'AUTHOR'.str_repeat(' ', ($width - 34)).'(Author %) (Overall %) COUNT'.PHP_EOL;
-            echo str_repeat('-', $width).PHP_EOL;
-        }
-
-        echo "\033[0m";
-
-        if ($showSources === true) {
-            $maxSniffWidth = ($width - 15);
-
-            if ($totalFixable > 0) {
-                $maxSniffWidth -= 4;
-            }
-        }
-
-        $fixableSources = 0;
-
-        foreach ($authorCache as $author => $count) {
-            if ($praiseCache[$author]['good'] === 0) {
-                $percent = 0;
-            } else {
-                $total   = ($praiseCache[$author]['bad'] + $praiseCache[$author]['good']);
-                $percent = round(($praiseCache[$author]['bad'] / $total * 100), 2);
-            }
-
-            $overallPercent = '('.round((($count / $errorsShown) * 100), 2).')';
-            $authorPercent  = '('.$percent.')';
-            $line           = str_repeat(' ', (6 - strlen($count))).$count;
-            $line           = str_repeat(' ', (12 - strlen($overallPercent))).$overallPercent.$line;
-            $line           = str_repeat(' ', (11 - strlen($authorPercent))).$authorPercent.$line;
-            $line           = $author.str_repeat(' ', ($width - strlen($author) - strlen($line))).$line;
-
-            if ($showSources === true) {
-                $line = "\033[1m$line\033[0m";
-            }
-
-            echo $line.PHP_EOL;
-
-            if ($showSources === true && isset($sourceCache[$author]) === true) {
-                $errors = $sourceCache[$author];
-                asort($errors);
-                $errors = array_reverse($errors);
-
-                foreach ($errors as $source => $sourceData) {
-                    if ($source === 'count') {
-                        continue;
-                    }
-
-                    $count = $sourceData['count'];
-
-                    $srcLength = strlen($source);
-                    if ($srcLength > $maxSniffWidth) {
-                        $source = substr($source, 0, $maxSniffWidth);
-                    }
-
-                    $line = str_repeat(' ', (5 - strlen($count))).$count;
-
-                    echo '         ';
-                    if ($totalFixable > 0) {
-                        echo '[';
-                        if ($sourceData['fixable'] === true) {
-                            echo 'x';
-                            $fixableSources++;
-                        } else {
-                            echo ' ';
-                        }
-
-                        echo '] ';
-                    }
-
-                    echo $source;
-                    if ($totalFixable > 0) {
-                        echo str_repeat(' ', ($width - 18 - strlen($source)));
-                    } else {
-                        echo str_repeat(' ', ($width - 14 - strlen($source)));
-                    }
-
-                    echo $line.PHP_EOL;
-                }//end foreach
-            }//end if
-        }//end foreach
-
-        echo str_repeat('-', $width).PHP_EOL;
-        echo "\033[1m".'A TOTAL OF '.$errorsShown.' SNIFF VIOLATION';
-        if ($errorsShown !== 1) {
-            echo 'S';
-        }
-
-        echo ' WERE COMMITTED BY '.count($authorCache).' AUTHOR';
-        if (count($authorCache) !== 1) {
-            echo 'S';
-        }
-
-        echo "\033[0m";
-
-        if ($totalFixable > 0) {
-            if ($showSources === true) {
-                echo PHP_EOL.str_repeat('-', $width).PHP_EOL;
-                echo "\033[1mPHPCBF CAN FIX THE $fixableSources MARKED SOURCES AUTOMATICALLY ($totalFixable VIOLATIONS IN TOTAL)\033[0m";
-            } else {
-                echo PHP_EOL.str_repeat('-', $width).PHP_EOL;
-                echo "\033[1mPHPCBF CAN FIX $totalFixable OF THESE SNIFF VIOLATIONS AUTOMATICALLY\033[0m";
-            }
-        }
-
-        echo PHP_EOL.str_repeat('-', $width).PHP_EOL.PHP_EOL;
-
-        if ($toScreen === true && $interactive === false) {
-            Timing::printRunTime();
-        }
-
-    }//end generate()
-
-
-    /**
-     * Extract the author from a blame line.
-     *
-     * @param string $line Line to parse.
-     *
-     * @return mixed string or false if impossible to recover.
-     */
-    abstract protected function getAuthor($line);
-
-
-    /**
-     * Gets the blame output.
-     *
-     * @param string $filename File to blame.
-     *
-     * @return array
-     */
-    abstract protected function getBlameContent($filename);
+	/**
+	 * The name of the report we want in the output.
+	 *
+	 * @var string
+	 */
+	protected $reportName = 'VERSION CONTROL';
+
+
+	/**
+	 * 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)
+	{
+		$blames = $this->getBlameContent($report['filename']);
+
+		$authorCache = [];
+		$praiseCache = [];
+		$sourceCache = [];
+
+		foreach ($report['messages'] as $line => $lineErrors) {
+			$author = 'Unknown';
+			if (isset($blames[($line - 1)]) === true) {
+				$blameAuthor = $this->getAuthor($blames[($line - 1)]);
+				if ($blameAuthor !== false) {
+					$author = $blameAuthor;
+				}
+			}
+
+			if (isset($authorCache[$author]) === false) {
+				$authorCache[$author] = 0;
+				$praiseCache[$author] = [
+					'good' => 0,
+					'bad'  => 0,
+				];
+			}
+
+			$praiseCache[$author]['bad']++;
+
+			foreach ($lineErrors as $column => $colErrors) {
+				foreach ($colErrors as $error) {
+					$authorCache[$author]++;
+
+					if ($showSources === true) {
+						$source = $error['source'];
+						if (isset($sourceCache[$author][$source]) === false) {
+							$sourceCache[$author][$source] = [
+								'count'   => 1,
+								'fixable' => $error['fixable'],
+							];
+						} else {
+							$sourceCache[$author][$source]['count']++;
+						}
+					}
+				}
+			}
+
+			unset($blames[($line - 1)]);
+		}//end foreach
+
+		// Now go through and give the authors some credit for
+		// all the lines that do not have errors.
+		foreach ($blames as $line) {
+			$author = $this->getAuthor($line);
+			if ($author === false) {
+				$author = 'Unknown';
+			}
+
+			if (isset($authorCache[$author]) === false) {
+				// This author doesn't have any errors.
+				if (PHP_CODESNIFFER_VERBOSITY === 0) {
+					continue;
+				}
+
+				$authorCache[$author] = 0;
+				$praiseCache[$author] = [
+					'good' => 0,
+					'bad'  => 0,
+				];
+			}
+
+			$praiseCache[$author]['good']++;
+		}//end foreach
+
+		foreach ($authorCache as $author => $errors) {
+			echo "AUTHOR>>$author>>$errors".PHP_EOL;
+		}
+
+		foreach ($praiseCache as $author => $praise) {
+			echo "PRAISE>>$author>>".$praise['good'].'>>'.$praise['bad'].PHP_EOL;
+		}
+
+		foreach ($sourceCache as $author => $sources) {
+			foreach ($sources as $source => $sourceData) {
+				$count   = $sourceData['count'];
+				$fixable = (int) $sourceData['fixable'];
+				echo "SOURCE>>$author>>$source>>$count>>$fixable".PHP_EOL;
+			}
+		}
+
+		return true;
+
+	}//end generateFileReport()
+
+
+	/**
+	 * Prints the author of all errors and warnings, as given by "version control blame".
+	 *
+	 * @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
+	) {
+		$errorsShown = ($totalErrors + $totalWarnings);
+		if ($errorsShown === 0) {
+			// Nothing to show.
+			return;
+		}
+
+		$lines = explode(PHP_EOL, $cachedData);
+		array_pop($lines);
+
+		if (empty($lines) === true) {
+			return;
+		}
+
+		$authorCache = [];
+		$praiseCache = [];
+		$sourceCache = [];
+
+		foreach ($lines as $line) {
+			$parts = explode('>>', $line);
+			switch ($parts[0]) {
+			case 'AUTHOR':
+				if (isset($authorCache[$parts[1]]) === false) {
+					$authorCache[$parts[1]] = $parts[2];
+				} else {
+					$authorCache[$parts[1]] += $parts[2];
+				}
+				break;
+			case 'PRAISE':
+				if (isset($praiseCache[$parts[1]]) === false) {
+					$praiseCache[$parts[1]] = [
+						'good' => $parts[2],
+						'bad'  => $parts[3],
+					];
+				} else {
+					$praiseCache[$parts[1]]['good'] += $parts[2];
+					$praiseCache[$parts[1]]['bad']  += $parts[3];
+				}
+				break;
+			case 'SOURCE':
+				if (isset($praiseCache[$parts[1]]) === false) {
+					$praiseCache[$parts[1]] = [];
+				}
+
+				if (isset($sourceCache[$parts[1]][$parts[2]]) === false) {
+					$sourceCache[$parts[1]][$parts[2]] = [
+						'count'   => $parts[3],
+						'fixable' => (bool) $parts[4],
+					];
+				} else {
+					$sourceCache[$parts[1]][$parts[2]]['count'] += $parts[3];
+				}
+				break;
+			default:
+				break;
+			}//end switch
+		}//end foreach
+
+		// Make sure the report width isn't too big.
+		$maxLength = 0;
+		foreach ($authorCache as $author => $count) {
+			$maxLength = max($maxLength, strlen($author));
+			if ($showSources === true && isset($sourceCache[$author]) === true) {
+				foreach ($sourceCache[$author] as $source => $sourceData) {
+					if ($source === 'count') {
+						continue;
+					}
+
+					$maxLength = max($maxLength, (strlen($source) + 9));
+				}
+			}
+		}
+
+		$width = min($width, ($maxLength + 30));
+		$width = max($width, 70);
+		arsort($authorCache);
+
+		echo PHP_EOL."\033[1m".'PHP CODE SNIFFER '.$this->reportName.' BLAME SUMMARY'."\033[0m".PHP_EOL;
+		echo str_repeat('-', $width).PHP_EOL."\033[1m";
+		if ($showSources === true) {
+			echo 'AUTHOR   SOURCE'.str_repeat(' ', ($width - 43)).'(Author %) (Overall %) COUNT'.PHP_EOL;
+			echo str_repeat('-', $width).PHP_EOL;
+		} else {
+			echo 'AUTHOR'.str_repeat(' ', ($width - 34)).'(Author %) (Overall %) COUNT'.PHP_EOL;
+			echo str_repeat('-', $width).PHP_EOL;
+		}
+
+		echo "\033[0m";
+
+		if ($showSources === true) {
+			$maxSniffWidth = ($width - 15);
+
+			if ($totalFixable > 0) {
+				$maxSniffWidth -= 4;
+			}
+		}
+
+		$fixableSources = 0;
+
+		foreach ($authorCache as $author => $count) {
+			if ($praiseCache[$author]['good'] === 0) {
+				$percent = 0;
+			} else {
+				$total   = ($praiseCache[$author]['bad'] + $praiseCache[$author]['good']);
+				$percent = round(($praiseCache[$author]['bad'] / $total * 100), 2);
+			}
+
+			$overallPercent = '('.round((($count / $errorsShown) * 100), 2).')';
+			$authorPercent  = '('.$percent.')';
+			$line           = str_repeat(' ', (6 - strlen($count))).$count;
+			$line           = str_repeat(' ', (12 - strlen($overallPercent))).$overallPercent.$line;
+			$line           = str_repeat(' ', (11 - strlen($authorPercent))).$authorPercent.$line;
+			$line           = $author.str_repeat(' ', ($width - strlen($author) - strlen($line))).$line;
+
+			if ($showSources === true) {
+				$line = "\033[1m$line\033[0m";
+			}
+
+			echo $line.PHP_EOL;
+
+			if ($showSources === true && isset($sourceCache[$author]) === true) {
+				$errors = $sourceCache[$author];
+				asort($errors);
+				$errors = array_reverse($errors);
+
+				foreach ($errors as $source => $sourceData) {
+					if ($source === 'count') {
+						continue;
+					}
+
+					$count = $sourceData['count'];
+
+					$srcLength = strlen($source);
+					if ($srcLength > $maxSniffWidth) {
+						$source = substr($source, 0, $maxSniffWidth);
+					}
+
+					$line = str_repeat(' ', (5 - strlen($count))).$count;
+
+					echo '         ';
+					if ($totalFixable > 0) {
+						echo '[';
+						if ($sourceData['fixable'] === true) {
+							echo 'x';
+							$fixableSources++;
+						} else {
+							echo ' ';
+						}
+
+						echo '] ';
+					}
+
+					echo $source;
+					if ($totalFixable > 0) {
+						echo str_repeat(' ', ($width - 18 - strlen($source)));
+					} else {
+						echo str_repeat(' ', ($width - 14 - strlen($source)));
+					}
+
+					echo $line.PHP_EOL;
+				}//end foreach
+			}//end if
+		}//end foreach
+
+		echo str_repeat('-', $width).PHP_EOL;
+		echo "\033[1m".'A TOTAL OF '.$errorsShown.' SNIFF VIOLATION';
+		if ($errorsShown !== 1) {
+			echo 'S';
+		}
+
+		echo ' WERE COMMITTED BY '.count($authorCache).' AUTHOR';
+		if (count($authorCache) !== 1) {
+			echo 'S';
+		}
+
+		echo "\033[0m";
+
+		if ($totalFixable > 0) {
+			if ($showSources === true) {
+				echo PHP_EOL.str_repeat('-', $width).PHP_EOL;
+				echo "\033[1mPHPCBF CAN FIX THE $fixableSources MARKED SOURCES AUTOMATICALLY ($totalFixable VIOLATIONS IN TOTAL)\033[0m";
+			} else {
+				echo PHP_EOL.str_repeat('-', $width).PHP_EOL;
+				echo "\033[1mPHPCBF CAN FIX $totalFixable OF THESE SNIFF VIOLATIONS AUTOMATICALLY\033[0m";
+			}
+		}
+
+		echo PHP_EOL.str_repeat('-', $width).PHP_EOL.PHP_EOL;
+
+		if ($toScreen === true && $interactive === false) {
+			Timing::printRunTime();
+		}
+
+	}//end generate()
+
+
+	/**
+	 * Extract the author from a blame line.
+	 *
+	 * @param string $line Line to parse.
+	 *
+	 * @return mixed string or false if impossible to recover.
+	 */
+	abstract protected function getAuthor($line);
+
+
+	/**
+	 * Gets the blame output.
+	 *
+	 * @param string $filename File to blame.
+	 *
+	 * @return array
+	 */
+	abstract protected function getBlameContent($filename);
 
 
 }//end class

Switch Indentation +34 added lines, -34 removed lines

@@ -178,40 +178,40 @@
         foreach ($lines as $line) {
             $parts = explode('>>', $line);
             switch ($parts[0]) {
-            case 'AUTHOR':
-                if (isset($authorCache[$parts[1]]) === false) {
-                    $authorCache[$parts[1]] = $parts[2];
-                } else {
-                    $authorCache[$parts[1]] += $parts[2];
-                }
-                break;
-            case 'PRAISE':
-                if (isset($praiseCache[$parts[1]]) === false) {
-                    $praiseCache[$parts[1]] = [
-                        'good' => $parts[2],
-                        'bad'  => $parts[3],
-                    ];
-                } else {
-                    $praiseCache[$parts[1]]['good'] += $parts[2];
-                    $praiseCache[$parts[1]]['bad']  += $parts[3];
-                }
-                break;
-            case 'SOURCE':
-                if (isset($praiseCache[$parts[1]]) === false) {
-                    $praiseCache[$parts[1]] = [];
-                }
-
-                if (isset($sourceCache[$parts[1]][$parts[2]]) === false) {
-                    $sourceCache[$parts[1]][$parts[2]] = [
-                        'count'   => $parts[3],
-                        'fixable' => (bool) $parts[4],
-                    ];
-                } else {
-                    $sourceCache[$parts[1]][$parts[2]]['count'] += $parts[3];
-                }
-                break;
-            default:
-                break;
+            	case 'AUTHOR':
+                	if (isset($authorCache[$parts[1]]) === false) {
+                    	$authorCache[$parts[1]] = $parts[2];
+                	} else {
+                    	$authorCache[$parts[1]] += $parts[2];
+                	}
+                	break;
+            	case 'PRAISE':
+                	if (isset($praiseCache[$parts[1]]) === false) {
+                    	$praiseCache[$parts[1]] = [
+                        	'good' => $parts[2],
+                        	'bad'  => $parts[3],
+                    	];
+                	} else {
+                    	$praiseCache[$parts[1]]['good'] += $parts[2];
+                    	$praiseCache[$parts[1]]['bad']  += $parts[3];
+                	}
+                	break;
+            	case 'SOURCE':
+                	if (isset($praiseCache[$parts[1]]) === false) {
+                    	$praiseCache[$parts[1]] = [];
+                	}
+
+                	if (isset($sourceCache[$parts[1]][$parts[2]]) === false) {
+                    	$sourceCache[$parts[1]][$parts[2]] = [
+                        	'count'   => $parts[3],
+                        	'fixable' => (bool) $parts[4],
+                    	];
+                	} else {
+                    	$sourceCache[$parts[1]][$parts[2]]['count'] += $parts[3];
+                	}
+                	break;
+            	default:
+                	break;
             }//end switch
         }//end foreach
 

Spacing +5 added lines, -5 removed lines

@@ -38,7 +38,7 @@ 
      *
      * @return bool
      */
-    public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)
+    public function generateFileReport($report, File $phpcsFile, $showSources = false, $width = 80)
     {
         $blames = $this->getBlameContent($report['filename']);
 
@@ -153,10 +153,10 @@ 
         $totalErrors,
         $totalWarnings,
         $totalFixable,
-        $showSources=false,
-        $width=80,
-        $interactive=false,
-        $toScreen=true
+        $showSources = false,
+        $width = 80,
+        $interactive = false,
+        $toScreen = true
     ) {
         $errorsShown = ($totalErrors + $totalWarnings);
         if ($errorsShown === 0) {

vendor/squizlabs/php_codesniffer/src/Fixer.php

Switch Indentation +8 added lines, -8 removed lines

@@ -269,14 +269,14 @@
         foreach ($diffLines as $line) {
             if (isset($line[0]) === true) {
                 switch ($line[0]) {
-                case '-':
-                    $diff[] = "\033[31m$line\033[0m";
-                    break;
-                case '+':
-                    $diff[] = "\033[32m$line\033[0m";
-                    break;
-                default:
-                    $diff[] = $line;
+                	case '-':
+                    	$diff[] = "\033[31m$line\033[0m";
+                    	break;
+                	case '+':
+                    	$diff[] = "\033[32m$line\033[0m";
+                    	break;
+                	default:
+                    	$diff[] = $line;
                 }
             }
         }

Spacing +2 added lines, -2 removed lines

@@ -224,7 +224,7 @@ 
      *
      * @return string
      */
-    public function generateDiff($filePath=null, $colors=true)
+    public function generateDiff($filePath = null, $colors = true)
     {
         if ($filePath === null) {
             $filePath = $this->currentFile->getFilename();
@@ -643,7 +643,7 @@ 
      *
      * @return bool If the change was accepted.
      */
-    public function substrToken($stackPtr, $start, $length=null)
+    public function substrToken($stackPtr, $start, $length = null)
     {
         $current = $this->getTokenContent($stackPtr);
 

Indentation +783 added lines, -783 removed lines

@@ -18,789 +18,789 @@
 class Fixer
 {
 
-    /**
-     * Is the fixer enabled and fixing a file?
-     *
-     * Sniffs should check this value to ensure they are not
-     * doing extra processing to prepare for a fix when fixing is
-     * not required.
-     *
-     * @var boolean
-     */
-    public $enabled = false;
-
-    /**
-     * The number of times we have looped over a file.
-     *
-     * @var integer
-     */
-    public $loops = 0;
-
-    /**
-     * The file being fixed.
-     *
-     * @var \PHP_CodeSniffer\Files\File
-     */
-    private $currentFile = null;
-
-    /**
-     * The list of tokens that make up the file contents.
-     *
-     * This is a simplified list which just contains the token content and nothing
-     * else. This is the array that is updated as fixes are made, not the file's
-     * token array. Imploding this array will give you the file content back.
-     *
-     * @var array<int, string>
-     */
-    private $tokens = [];
-
-    /**
-     * A list of tokens that have already been fixed.
-     *
-     * We don't allow the same token to be fixed more than once each time
-     * through a file as this can easily cause conflicts between sniffs.
-     *
-     * @var int[]
-     */
-    private $fixedTokens = [];
-
-    /**
-     * The last value of each fixed token.
-     *
-     * If a token is being "fixed" back to its last value, the fix is
-     * probably conflicting with another.
-     *
-     * @var array<int, string>
-     */
-    private $oldTokenValues = [];
-
-    /**
-     * A list of tokens that have been fixed during a changeset.
-     *
-     * All changes in changeset must be able to be applied, or else
-     * the entire changeset is rejected.
-     *
-     * @var array
-     */
-    private $changeset = [];
-
-    /**
-     * Is there an open changeset.
-     *
-     * @var boolean
-     */
-    private $inChangeset = false;
-
-    /**
-     * Is the current fixing loop in conflict?
-     *
-     * @var boolean
-     */
-    private $inConflict = false;
-
-    /**
-     * The number of fixes that have been performed.
-     *
-     * @var integer
-     */
-    private $numFixes = 0;
-
-
-    /**
-     * Starts fixing a new file.
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being fixed.
-     *
-     * @return void
-     */
-    public function startFile(File $phpcsFile)
-    {
-        $this->currentFile = $phpcsFile;
-        $this->numFixes    = 0;
-        $this->fixedTokens = [];
-
-        $tokens       = $phpcsFile->getTokens();
-        $this->tokens = [];
-        foreach ($tokens as $index => $token) {
-            if (isset($token['orig_content']) === true) {
-                $this->tokens[$index] = $token['orig_content'];
-            } else {
-                $this->tokens[$index] = $token['content'];
-            }
-        }
-
-    }//end startFile()
-
-
-    /**
-     * Attempt to fix the file by processing it until no fixes are made.
-     *
-     * @return boolean
-     */
-    public function fixFile()
-    {
-        $fixable = $this->currentFile->getFixableCount();
-        if ($fixable === 0) {
-            // Nothing to fix.
-            return false;
-        }
-
-        $this->enabled = true;
-
-        $this->loops = 0;
-        while ($this->loops < 50) {
-            ob_start();
-
-            // Only needed once file content has changed.
-            $contents = $this->getContents();
-
-            if (PHP_CODESNIFFER_VERBOSITY > 2) {
-                @ob_end_clean();
-                echo '---START FILE CONTENT---'.PHP_EOL;
-                $lines = explode($this->currentFile->eolChar, $contents);
-                $max   = strlen(count($lines));
-                foreach ($lines as $lineNum => $line) {
-                    $lineNum++;
-                    echo str_pad($lineNum, $max, ' ', STR_PAD_LEFT).'|'.$line.PHP_EOL;
-                }
-
-                echo '--- END FILE CONTENT ---'.PHP_EOL;
-                ob_start();
-            }
-
-            $this->inConflict = false;
-            $this->currentFile->ruleset->populateTokenListeners();
-            $this->currentFile->setContent($contents);
-            $this->currentFile->process();
-            ob_end_clean();
-
-            $this->loops++;
-
-            if (PHP_CODESNIFFER_CBF === true && PHP_CODESNIFFER_VERBOSITY > 0) {
-                echo "\r".str_repeat(' ', 80)."\r";
-                echo "\t=> Fixing file: $this->numFixes/$fixable violations remaining [made $this->loops pass";
-                if ($this->loops > 1) {
-                    echo 'es';
-                }
-
-                echo ']... ';
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo PHP_EOL;
-                }
-            }
-
-            if ($this->numFixes === 0 && $this->inConflict === false) {
-                // Nothing left to do.
-                break;
-            } else if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo "\t* fixed $this->numFixes violations, starting loop ".($this->loops + 1).' *'.PHP_EOL;
-            }
-        }//end while
-
-        $this->enabled = false;
-
-        if ($this->numFixes > 0) {
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                if (ob_get_level() > 0) {
-                    ob_end_clean();
-                }
-
-                echo "\t*** Reached maximum number of loops with $this->numFixes violations left unfixed ***".PHP_EOL;
-                ob_start();
-            }
-
-            return false;
-        }
-
-        return true;
-
-    }//end fixFile()
-
-
-    /**
-     * Generates a text diff of the original file and the new content.
-     *
-     * @param string  $filePath Optional file path to diff the file against.
-     *                          If not specified, the original version of the
-     *                          file will be used.
-     * @param boolean $colors   Print coloured output or not.
-     *
-     * @return string
-     */
-    public function generateDiff($filePath=null, $colors=true)
-    {
-        if ($filePath === null) {
-            $filePath = $this->currentFile->getFilename();
-        }
-
-        $cwd = getcwd().DIRECTORY_SEPARATOR;
-        if (strpos($filePath, $cwd) === 0) {
-            $filename = substr($filePath, strlen($cwd));
-        } else {
-            $filename = $filePath;
-        }
-
-        $contents = $this->getContents();
-
-        $tempName  = tempnam(sys_get_temp_dir(), 'phpcs-fixer');
-        $fixedFile = fopen($tempName, 'w');
-        fwrite($fixedFile, $contents);
-
-        // We must use something like shell_exec() because whitespace at the end
-        // of lines is critical to diff files.
-        $filename = escapeshellarg($filename);
-        $cmd      = "diff -u -L$filename -LPHP_CodeSniffer $filename \"$tempName\"";
-
-        $diff = shell_exec($cmd);
-
-        fclose($fixedFile);
-        if (is_file($tempName) === true) {
-            unlink($tempName);
-        }
-
-        if ($diff === null) {
-            return '';
-        }
-
-        if ($colors === false) {
-            return $diff;
-        }
-
-        $diffLines = explode(PHP_EOL, $diff);
-        if (count($diffLines) === 1) {
-            // Seems to be required for cygwin.
-            $diffLines = explode("\n", $diff);
-        }
-
-        $diff = [];
-        foreach ($diffLines as $line) {
-            if (isset($line[0]) === true) {
-                switch ($line[0]) {
-                case '-':
-                    $diff[] = "\033[31m$line\033[0m";
-                    break;
-                case '+':
-                    $diff[] = "\033[32m$line\033[0m";
-                    break;
-                default:
-                    $diff[] = $line;
-                }
-            }
-        }
-
-        $diff = implode(PHP_EOL, $diff);
-
-        return $diff;
-
-    }//end generateDiff()
-
-
-    /**
-     * Get a count of fixes that have been performed on the file.
-     *
-     * This value is reset every time a new file is started, or an existing
-     * file is restarted.
-     *
-     * @return int
-     */
-    public function getFixCount()
-    {
-        return $this->numFixes;
-
-    }//end getFixCount()
-
-
-    /**
-     * Get the current content of the file, as a string.
-     *
-     * @return string
-     */
-    public function getContents()
-    {
-        $contents = implode($this->tokens);
-        return $contents;
-
-    }//end getContents()
-
-
-    /**
-     * Get the current fixed content of a token.
-     *
-     * This function takes changesets into account so should be used
-     * instead of directly accessing the token array.
-     *
-     * @param int $stackPtr The position of the token in the token stack.
-     *
-     * @return string
-     */
-    public function getTokenContent($stackPtr)
-    {
-        if ($this->inChangeset === true
-            && isset($this->changeset[$stackPtr]) === true
-        ) {
-            return $this->changeset[$stackPtr];
-        } else {
-            return $this->tokens[$stackPtr];
-        }
-
-    }//end getTokenContent()
-
-
-    /**
-     * Start recording actions for a changeset.
-     *
-     * @return void
-     */
-    public function beginChangeset()
-    {
-        if ($this->inConflict === true) {
-            return false;
-        }
-
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            $bt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
-            if ($bt[1]['class'] === __CLASS__) {
-                $sniff = 'Fixer';
-            } else {
-                $sniff = Util\Common::getSniffCode($bt[1]['class']);
-            }
-
-            $line = $bt[0]['line'];
-
-            @ob_end_clean();
-            echo "\t=> Changeset started by $sniff:$line".PHP_EOL;
-            ob_start();
-        }
-
-        $this->changeset   = [];
-        $this->inChangeset = true;
-
-    }//end beginChangeset()
-
-
-    /**
-     * Stop recording actions for a changeset, and apply logged changes.
-     *
-     * @return boolean
-     */
-    public function endChangeset()
-    {
-        if ($this->inConflict === true) {
-            return false;
-        }
-
-        $this->inChangeset = false;
-
-        $success = true;
-        $applied = [];
-        foreach ($this->changeset as $stackPtr => $content) {
-            $success = $this->replaceToken($stackPtr, $content);
-            if ($success === false) {
-                break;
-            } else {
-                $applied[] = $stackPtr;
-            }
-        }
-
-        if ($success === false) {
-            // Rolling back all changes.
-            foreach ($applied as $stackPtr) {
-                $this->revertToken($stackPtr);
-            }
-
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                @ob_end_clean();
-                echo "\t=> Changeset failed to apply".PHP_EOL;
-                ob_start();
-            }
-        } else if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            $fixes = count($this->changeset);
-            @ob_end_clean();
-            echo "\t=> Changeset ended: $fixes changes applied".PHP_EOL;
-            ob_start();
-        }
-
-        $this->changeset = [];
-        return true;
-
-    }//end endChangeset()
-
-
-    /**
-     * Stop recording actions for a changeset, and discard logged changes.
-     *
-     * @return void
-     */
-    public function rollbackChangeset()
-    {
-        $this->inChangeset = false;
-        $this->inConflict  = false;
-
-        if (empty($this->changeset) === false) {
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                $bt = debug_backtrace();
-                if ($bt[1]['class'] === 'PHP_CodeSniffer\Fixer') {
-                    $sniff = $bt[2]['class'];
-                    $line  = $bt[1]['line'];
-                } else {
-                    $sniff = $bt[1]['class'];
-                    $line  = $bt[0]['line'];
-                }
-
-                $sniff = Util\Common::getSniffCode($sniff);
-
-                $numChanges = count($this->changeset);
-
-                @ob_end_clean();
-                echo "\t\tR: $sniff:$line rolled back the changeset ($numChanges changes)".PHP_EOL;
-                echo "\t=> Changeset rolled back".PHP_EOL;
-                ob_start();
-            }
-
-            $this->changeset = [];
-        }//end if
-
-    }//end rollbackChangeset()
-
-
-    /**
-     * Replace the entire contents of a token.
-     *
-     * @param int    $stackPtr The position of the token in the token stack.
-     * @param string $content  The new content of the token.
-     *
-     * @return bool If the change was accepted.
-     */
-    public function replaceToken($stackPtr, $content)
-    {
-        if ($this->inConflict === true) {
-            return false;
-        }
-
-        if ($this->inChangeset === false
-            && isset($this->fixedTokens[$stackPtr]) === true
-        ) {
-            $indent = "\t";
-            if (empty($this->changeset) === false) {
-                $indent .= "\t";
-            }
-
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                @ob_end_clean();
-                echo "$indent* token $stackPtr has already been modified, skipping *".PHP_EOL;
-                ob_start();
-            }
-
-            return false;
-        }
-
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            $bt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
-            if ($bt[1]['class'] === 'PHP_CodeSniffer\Fixer') {
-                $sniff = $bt[2]['class'];
-                $line  = $bt[1]['line'];
-            } else {
-                $sniff = $bt[1]['class'];
-                $line  = $bt[0]['line'];
-            }
-
-            $sniff = Util\Common::getSniffCode($sniff);
-
-            $tokens     = $this->currentFile->getTokens();
-            $type       = $tokens[$stackPtr]['type'];
-            $tokenLine  = $tokens[$stackPtr]['line'];
-            $oldContent = Common::prepareForOutput($this->tokens[$stackPtr]);
-            $newContent = Common::prepareForOutput($content);
-            if (trim($this->tokens[$stackPtr]) === '' && isset($this->tokens[($stackPtr + 1)]) === true) {
-                // Add some context for whitespace only changes.
-                $append      = Common::prepareForOutput($this->tokens[($stackPtr + 1)]);
-                $oldContent .= $append;
-                $newContent .= $append;
-            }
-        }//end if
-
-        if ($this->inChangeset === true) {
-            $this->changeset[$stackPtr] = $content;
-
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                @ob_end_clean();
-                echo "\t\tQ: $sniff:$line replaced token $stackPtr ($type on line $tokenLine) \"$oldContent\" => \"$newContent\"".PHP_EOL;
-                ob_start();
-            }
-
-            return true;
-        }
-
-        if (isset($this->oldTokenValues[$stackPtr]) === false) {
-            $this->oldTokenValues[$stackPtr] = [
-                'curr' => $content,
-                'prev' => $this->tokens[$stackPtr],
-                'loop' => $this->loops,
-            ];
-        } else {
-            if ($this->oldTokenValues[$stackPtr]['prev'] === $content
-                && $this->oldTokenValues[$stackPtr]['loop'] === ($this->loops - 1)
-            ) {
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    $indent = "\t";
-                    if (empty($this->changeset) === false) {
-                        $indent .= "\t";
-                    }
-
-                    $loop = $this->oldTokenValues[$stackPtr]['loop'];
-
-                    @ob_end_clean();
-                    echo "$indent**** $sniff:$line has possible conflict with another sniff on loop $loop; caused by the following change ****".PHP_EOL;
-                    echo "$indent**** replaced token $stackPtr ($type on line $tokenLine) \"$oldContent\" => \"$newContent\" ****".PHP_EOL;
-                }
-
-                if ($this->oldTokenValues[$stackPtr]['loop'] >= ($this->loops - 1)) {
-                    $this->inConflict = true;
-                    if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                        echo "$indent**** ignoring all changes until next loop ****".PHP_EOL;
-                    }
-                }
-
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    ob_start();
-                }
-
-                return false;
-            }//end if
-
-            $this->oldTokenValues[$stackPtr]['prev'] = $this->oldTokenValues[$stackPtr]['curr'];
-            $this->oldTokenValues[$stackPtr]['curr'] = $content;
-            $this->oldTokenValues[$stackPtr]['loop'] = $this->loops;
-        }//end if
-
-        $this->fixedTokens[$stackPtr] = $this->tokens[$stackPtr];
-        $this->tokens[$stackPtr]      = $content;
-        $this->numFixes++;
-
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            $indent = "\t";
-            if (empty($this->changeset) === false) {
-                $indent .= "\tA: ";
-            }
-
-            if (ob_get_level() > 0) {
-                ob_end_clean();
-            }
-
-            echo "$indent$sniff:$line replaced token $stackPtr ($type on line $tokenLine) \"$oldContent\" => \"$newContent\"".PHP_EOL;
-            ob_start();
-        }
-
-        return true;
-
-    }//end replaceToken()
-
-
-    /**
-     * Reverts the previous fix made to a token.
-     *
-     * @param int $stackPtr The position of the token in the token stack.
-     *
-     * @return bool If a change was reverted.
-     */
-    public function revertToken($stackPtr)
-    {
-        if (isset($this->fixedTokens[$stackPtr]) === false) {
-            return false;
-        }
-
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            $bt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
-            if ($bt[1]['class'] === 'PHP_CodeSniffer\Fixer') {
-                $sniff = $bt[2]['class'];
-                $line  = $bt[1]['line'];
-            } else {
-                $sniff = $bt[1]['class'];
-                $line  = $bt[0]['line'];
-            }
-
-            $sniff = Util\Common::getSniffCode($sniff);
-
-            $tokens     = $this->currentFile->getTokens();
-            $type       = $tokens[$stackPtr]['type'];
-            $tokenLine  = $tokens[$stackPtr]['line'];
-            $oldContent = Common::prepareForOutput($this->tokens[$stackPtr]);
-            $newContent = Common::prepareForOutput($this->fixedTokens[$stackPtr]);
-            if (trim($this->tokens[$stackPtr]) === '' && isset($tokens[($stackPtr + 1)]) === true) {
-                // Add some context for whitespace only changes.
-                $append      = Common::prepareForOutput($this->tokens[($stackPtr + 1)]);
-                $oldContent .= $append;
-                $newContent .= $append;
-            }
-        }//end if
-
-        $this->tokens[$stackPtr] = $this->fixedTokens[$stackPtr];
-        unset($this->fixedTokens[$stackPtr]);
-        $this->numFixes--;
-
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            $indent = "\t";
-            if (empty($this->changeset) === false) {
-                $indent .= "\tR: ";
-            }
-
-            @ob_end_clean();
-            echo "$indent$sniff:$line reverted token $stackPtr ($type on line $tokenLine) \"$oldContent\" => \"$newContent\"".PHP_EOL;
-            ob_start();
-        }
-
-        return true;
-
-    }//end revertToken()
-
-
-    /**
-     * Replace the content of a token with a part of its current content.
-     *
-     * @param int $stackPtr The position of the token in the token stack.
-     * @param int $start    The first character to keep.
-     * @param int $length   The number of characters to keep. If NULL, the content of
-     *                      the token from $start to the end of the content is kept.
-     *
-     * @return bool If the change was accepted.
-     */
-    public function substrToken($stackPtr, $start, $length=null)
-    {
-        $current = $this->getTokenContent($stackPtr);
-
-        if ($length === null) {
-            $newContent = substr($current, $start);
-        } else {
-            $newContent = substr($current, $start, $length);
-        }
-
-        return $this->replaceToken($stackPtr, $newContent);
-
-    }//end substrToken()
-
-
-    /**
-     * Adds a newline to end of a token's content.
-     *
-     * @param int $stackPtr The position of the token in the token stack.
-     *
-     * @return bool If the change was accepted.
-     */
-    public function addNewline($stackPtr)
-    {
-        $current = $this->getTokenContent($stackPtr);
-        return $this->replaceToken($stackPtr, $current.$this->currentFile->eolChar);
-
-    }//end addNewline()
-
-
-    /**
-     * Adds a newline to the start of a token's content.
-     *
-     * @param int $stackPtr The position of the token in the token stack.
-     *
-     * @return bool If the change was accepted.
-     */
-    public function addNewlineBefore($stackPtr)
-    {
-        $current = $this->getTokenContent($stackPtr);
-        return $this->replaceToken($stackPtr, $this->currentFile->eolChar.$current);
-
-    }//end addNewlineBefore()
-
-
-    /**
-     * Adds content to the end of a token's current content.
-     *
-     * @param int    $stackPtr The position of the token in the token stack.
-     * @param string $content  The content to add.
-     *
-     * @return bool If the change was accepted.
-     */
-    public function addContent($stackPtr, $content)
-    {
-        $current = $this->getTokenContent($stackPtr);
-        return $this->replaceToken($stackPtr, $current.$content);
-
-    }//end addContent()
-
-
-    /**
-     * Adds content to the start of a token's current content.
-     *
-     * @param int    $stackPtr The position of the token in the token stack.
-     * @param string $content  The content to add.
-     *
-     * @return bool If the change was accepted.
-     */
-    public function addContentBefore($stackPtr, $content)
-    {
-        $current = $this->getTokenContent($stackPtr);
-        return $this->replaceToken($stackPtr, $content.$current);
-
-    }//end addContentBefore()
-
-
-    /**
-     * Adjust the indent of a code block.
-     *
-     * @param int $start  The position of the token in the token stack
-     *                    to start adjusting the indent from.
-     * @param int $end    The position of the token in the token stack
-     *                    to end adjusting the indent.
-     * @param int $change The number of spaces to adjust the indent by
-     *                    (positive or negative).
-     *
-     * @return void
-     */
-    public function changeCodeBlockIndent($start, $end, $change)
-    {
-        $tokens = $this->currentFile->getTokens();
-
-        $baseIndent = '';
-        if ($change > 0) {
-            $baseIndent = str_repeat(' ', $change);
-        }
-
-        $useChangeset = false;
-        if ($this->inChangeset === false) {
-            $this->beginChangeset();
-            $useChangeset = true;
-        }
-
-        for ($i = $start; $i <= $end; $i++) {
-            if ($tokens[$i]['column'] !== 1
-                || $tokens[($i + 1)]['line'] !== $tokens[$i]['line']
-            ) {
-                continue;
-            }
-
-            $length = 0;
-            if ($tokens[$i]['code'] === T_WHITESPACE
-                || $tokens[$i]['code'] === T_DOC_COMMENT_WHITESPACE
-            ) {
-                $length = $tokens[$i]['length'];
-
-                $padding = ($length + $change);
-                if ($padding > 0) {
-                    $padding = str_repeat(' ', $padding);
-                } else {
-                    $padding = '';
-                }
-
-                $newContent = $padding.ltrim($tokens[$i]['content']);
-            } else {
-                $newContent = $baseIndent.$tokens[$i]['content'];
-            }
-
-            $this->replaceToken($i, $newContent);
-        }//end for
-
-        if ($useChangeset === true) {
-            $this->endChangeset();
-        }
-
-    }//end changeCodeBlockIndent()
+	/**
+	 * Is the fixer enabled and fixing a file?
+	 *
+	 * Sniffs should check this value to ensure they are not
+	 * doing extra processing to prepare for a fix when fixing is
+	 * not required.
+	 *
+	 * @var boolean
+	 */
+	public $enabled = false;
+
+	/**
+	 * The number of times we have looped over a file.
+	 *
+	 * @var integer
+	 */
+	public $loops = 0;
+
+	/**
+	 * The file being fixed.
+	 *
+	 * @var \PHP_CodeSniffer\Files\File
+	 */
+	private $currentFile = null;
+
+	/**
+	 * The list of tokens that make up the file contents.
+	 *
+	 * This is a simplified list which just contains the token content and nothing
+	 * else. This is the array that is updated as fixes are made, not the file's
+	 * token array. Imploding this array will give you the file content back.
+	 *
+	 * @var array<int, string>
+	 */
+	private $tokens = [];
+
+	/**
+	 * A list of tokens that have already been fixed.
+	 *
+	 * We don't allow the same token to be fixed more than once each time
+	 * through a file as this can easily cause conflicts between sniffs.
+	 *
+	 * @var int[]
+	 */
+	private $fixedTokens = [];
+
+	/**
+	 * The last value of each fixed token.
+	 *
+	 * If a token is being "fixed" back to its last value, the fix is
+	 * probably conflicting with another.
+	 *
+	 * @var array<int, string>
+	 */
+	private $oldTokenValues = [];
+
+	/**
+	 * A list of tokens that have been fixed during a changeset.
+	 *
+	 * All changes in changeset must be able to be applied, or else
+	 * the entire changeset is rejected.
+	 *
+	 * @var array
+	 */
+	private $changeset = [];
+
+	/**
+	 * Is there an open changeset.
+	 *
+	 * @var boolean
+	 */
+	private $inChangeset = false;
+
+	/**
+	 * Is the current fixing loop in conflict?
+	 *
+	 * @var boolean
+	 */
+	private $inConflict = false;
+
+	/**
+	 * The number of fixes that have been performed.
+	 *
+	 * @var integer
+	 */
+	private $numFixes = 0;
+
+
+	/**
+	 * Starts fixing a new file.
+	 *
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being fixed.
+	 *
+	 * @return void
+	 */
+	public function startFile(File $phpcsFile)
+	{
+		$this->currentFile = $phpcsFile;
+		$this->numFixes    = 0;
+		$this->fixedTokens = [];
+
+		$tokens       = $phpcsFile->getTokens();
+		$this->tokens = [];
+		foreach ($tokens as $index => $token) {
+			if (isset($token['orig_content']) === true) {
+				$this->tokens[$index] = $token['orig_content'];
+			} else {
+				$this->tokens[$index] = $token['content'];
+			}
+		}
+
+	}//end startFile()
+
+
+	/**
+	 * Attempt to fix the file by processing it until no fixes are made.
+	 *
+	 * @return boolean
+	 */
+	public function fixFile()
+	{
+		$fixable = $this->currentFile->getFixableCount();
+		if ($fixable === 0) {
+			// Nothing to fix.
+			return false;
+		}
+
+		$this->enabled = true;
+
+		$this->loops = 0;
+		while ($this->loops < 50) {
+			ob_start();
+
+			// Only needed once file content has changed.
+			$contents = $this->getContents();
+
+			if (PHP_CODESNIFFER_VERBOSITY > 2) {
+				@ob_end_clean();
+				echo '---START FILE CONTENT---'.PHP_EOL;
+				$lines = explode($this->currentFile->eolChar, $contents);
+				$max   = strlen(count($lines));
+				foreach ($lines as $lineNum => $line) {
+					$lineNum++;
+					echo str_pad($lineNum, $max, ' ', STR_PAD_LEFT).'|'.$line.PHP_EOL;
+				}
+
+				echo '--- END FILE CONTENT ---'.PHP_EOL;
+				ob_start();
+			}
+
+			$this->inConflict = false;
+			$this->currentFile->ruleset->populateTokenListeners();
+			$this->currentFile->setContent($contents);
+			$this->currentFile->process();
+			ob_end_clean();
+
+			$this->loops++;
+
+			if (PHP_CODESNIFFER_CBF === true && PHP_CODESNIFFER_VERBOSITY > 0) {
+				echo "\r".str_repeat(' ', 80)."\r";
+				echo "\t=> Fixing file: $this->numFixes/$fixable violations remaining [made $this->loops pass";
+				if ($this->loops > 1) {
+					echo 'es';
+				}
+
+				echo ']... ';
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo PHP_EOL;
+				}
+			}
+
+			if ($this->numFixes === 0 && $this->inConflict === false) {
+				// Nothing left to do.
+				break;
+			} else if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				echo "\t* fixed $this->numFixes violations, starting loop ".($this->loops + 1).' *'.PHP_EOL;
+			}
+		}//end while
+
+		$this->enabled = false;
+
+		if ($this->numFixes > 0) {
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				if (ob_get_level() > 0) {
+					ob_end_clean();
+				}
+
+				echo "\t*** Reached maximum number of loops with $this->numFixes violations left unfixed ***".PHP_EOL;
+				ob_start();
+			}
+
+			return false;
+		}
+
+		return true;
+
+	}//end fixFile()
+
+
+	/**
+	 * Generates a text diff of the original file and the new content.
+	 *
+	 * @param string  $filePath Optional file path to diff the file against.
+	 *                          If not specified, the original version of the
+	 *                          file will be used.
+	 * @param boolean $colors   Print coloured output or not.
+	 *
+	 * @return string
+	 */
+	public function generateDiff($filePath=null, $colors=true)
+	{
+		if ($filePath === null) {
+			$filePath = $this->currentFile->getFilename();
+		}
+
+		$cwd = getcwd().DIRECTORY_SEPARATOR;
+		if (strpos($filePath, $cwd) === 0) {
+			$filename = substr($filePath, strlen($cwd));
+		} else {
+			$filename = $filePath;
+		}
+
+		$contents = $this->getContents();
+
+		$tempName  = tempnam(sys_get_temp_dir(), 'phpcs-fixer');
+		$fixedFile = fopen($tempName, 'w');
+		fwrite($fixedFile, $contents);
+
+		// We must use something like shell_exec() because whitespace at the end
+		// of lines is critical to diff files.
+		$filename = escapeshellarg($filename);
+		$cmd      = "diff -u -L$filename -LPHP_CodeSniffer $filename \"$tempName\"";
+
+		$diff = shell_exec($cmd);
+
+		fclose($fixedFile);
+		if (is_file($tempName) === true) {
+			unlink($tempName);
+		}
+
+		if ($diff === null) {
+			return '';
+		}
+
+		if ($colors === false) {
+			return $diff;
+		}
+
+		$diffLines = explode(PHP_EOL, $diff);
+		if (count($diffLines) === 1) {
+			// Seems to be required for cygwin.
+			$diffLines = explode("\n", $diff);
+		}
+
+		$diff = [];
+		foreach ($diffLines as $line) {
+			if (isset($line[0]) === true) {
+				switch ($line[0]) {
+				case '-':
+					$diff[] = "\033[31m$line\033[0m";
+					break;
+				case '+':
+					$diff[] = "\033[32m$line\033[0m";
+					break;
+				default:
+					$diff[] = $line;
+				}
+			}
+		}
+
+		$diff = implode(PHP_EOL, $diff);
+
+		return $diff;
+
+	}//end generateDiff()
+
+
+	/**
+	 * Get a count of fixes that have been performed on the file.
+	 *
+	 * This value is reset every time a new file is started, or an existing
+	 * file is restarted.
+	 *
+	 * @return int
+	 */
+	public function getFixCount()
+	{
+		return $this->numFixes;
+
+	}//end getFixCount()
+
+
+	/**
+	 * Get the current content of the file, as a string.
+	 *
+	 * @return string
+	 */
+	public function getContents()
+	{
+		$contents = implode($this->tokens);
+		return $contents;
+
+	}//end getContents()
+
+
+	/**
+	 * Get the current fixed content of a token.
+	 *
+	 * This function takes changesets into account so should be used
+	 * instead of directly accessing the token array.
+	 *
+	 * @param int $stackPtr The position of the token in the token stack.
+	 *
+	 * @return string
+	 */
+	public function getTokenContent($stackPtr)
+	{
+		if ($this->inChangeset === true
+			&& isset($this->changeset[$stackPtr]) === true
+		) {
+			return $this->changeset[$stackPtr];
+		} else {
+			return $this->tokens[$stackPtr];
+		}
+
+	}//end getTokenContent()
+
+
+	/**
+	 * Start recording actions for a changeset.
+	 *
+	 * @return void
+	 */
+	public function beginChangeset()
+	{
+		if ($this->inConflict === true) {
+			return false;
+		}
+
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			$bt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
+			if ($bt[1]['class'] === __CLASS__) {
+				$sniff = 'Fixer';
+			} else {
+				$sniff = Util\Common::getSniffCode($bt[1]['class']);
+			}
+
+			$line = $bt[0]['line'];
+
+			@ob_end_clean();
+			echo "\t=> Changeset started by $sniff:$line".PHP_EOL;
+			ob_start();
+		}
+
+		$this->changeset   = [];
+		$this->inChangeset = true;
+
+	}//end beginChangeset()
+
+
+	/**
+	 * Stop recording actions for a changeset, and apply logged changes.
+	 *
+	 * @return boolean
+	 */
+	public function endChangeset()
+	{
+		if ($this->inConflict === true) {
+			return false;
+		}
+
+		$this->inChangeset = false;
+
+		$success = true;
+		$applied = [];
+		foreach ($this->changeset as $stackPtr => $content) {
+			$success = $this->replaceToken($stackPtr, $content);
+			if ($success === false) {
+				break;
+			} else {
+				$applied[] = $stackPtr;
+			}
+		}
+
+		if ($success === false) {
+			// Rolling back all changes.
+			foreach ($applied as $stackPtr) {
+				$this->revertToken($stackPtr);
+			}
+
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				@ob_end_clean();
+				echo "\t=> Changeset failed to apply".PHP_EOL;
+				ob_start();
+			}
+		} else if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			$fixes = count($this->changeset);
+			@ob_end_clean();
+			echo "\t=> Changeset ended: $fixes changes applied".PHP_EOL;
+			ob_start();
+		}
+
+		$this->changeset = [];
+		return true;
+
+	}//end endChangeset()
+
+
+	/**
+	 * Stop recording actions for a changeset, and discard logged changes.
+	 *
+	 * @return void
+	 */
+	public function rollbackChangeset()
+	{
+		$this->inChangeset = false;
+		$this->inConflict  = false;
+
+		if (empty($this->changeset) === false) {
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				$bt = debug_backtrace();
+				if ($bt[1]['class'] === 'PHP_CodeSniffer\Fixer') {
+					$sniff = $bt[2]['class'];
+					$line  = $bt[1]['line'];
+				} else {
+					$sniff = $bt[1]['class'];
+					$line  = $bt[0]['line'];
+				}
+
+				$sniff = Util\Common::getSniffCode($sniff);
+
+				$numChanges = count($this->changeset);
+
+				@ob_end_clean();
+				echo "\t\tR: $sniff:$line rolled back the changeset ($numChanges changes)".PHP_EOL;
+				echo "\t=> Changeset rolled back".PHP_EOL;
+				ob_start();
+			}
+
+			$this->changeset = [];
+		}//end if
+
+	}//end rollbackChangeset()
+
+
+	/**
+	 * Replace the entire contents of a token.
+	 *
+	 * @param int    $stackPtr The position of the token in the token stack.
+	 * @param string $content  The new content of the token.
+	 *
+	 * @return bool If the change was accepted.
+	 */
+	public function replaceToken($stackPtr, $content)
+	{
+		if ($this->inConflict === true) {
+			return false;
+		}
+
+		if ($this->inChangeset === false
+			&& isset($this->fixedTokens[$stackPtr]) === true
+		) {
+			$indent = "\t";
+			if (empty($this->changeset) === false) {
+				$indent .= "\t";
+			}
+
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				@ob_end_clean();
+				echo "$indent* token $stackPtr has already been modified, skipping *".PHP_EOL;
+				ob_start();
+			}
+
+			return false;
+		}
+
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			$bt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
+			if ($bt[1]['class'] === 'PHP_CodeSniffer\Fixer') {
+				$sniff = $bt[2]['class'];
+				$line  = $bt[1]['line'];
+			} else {
+				$sniff = $bt[1]['class'];
+				$line  = $bt[0]['line'];
+			}
+
+			$sniff = Util\Common::getSniffCode($sniff);
+
+			$tokens     = $this->currentFile->getTokens();
+			$type       = $tokens[$stackPtr]['type'];
+			$tokenLine  = $tokens[$stackPtr]['line'];
+			$oldContent = Common::prepareForOutput($this->tokens[$stackPtr]);
+			$newContent = Common::prepareForOutput($content);
+			if (trim($this->tokens[$stackPtr]) === '' && isset($this->tokens[($stackPtr + 1)]) === true) {
+				// Add some context for whitespace only changes.
+				$append      = Common::prepareForOutput($this->tokens[($stackPtr + 1)]);
+				$oldContent .= $append;
+				$newContent .= $append;
+			}
+		}//end if
+
+		if ($this->inChangeset === true) {
+			$this->changeset[$stackPtr] = $content;
+
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				@ob_end_clean();
+				echo "\t\tQ: $sniff:$line replaced token $stackPtr ($type on line $tokenLine) \"$oldContent\" => \"$newContent\"".PHP_EOL;
+				ob_start();
+			}
+
+			return true;
+		}
+
+		if (isset($this->oldTokenValues[$stackPtr]) === false) {
+			$this->oldTokenValues[$stackPtr] = [
+				'curr' => $content,
+				'prev' => $this->tokens[$stackPtr],
+				'loop' => $this->loops,
+			];
+		} else {
+			if ($this->oldTokenValues[$stackPtr]['prev'] === $content
+				&& $this->oldTokenValues[$stackPtr]['loop'] === ($this->loops - 1)
+			) {
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					$indent = "\t";
+					if (empty($this->changeset) === false) {
+						$indent .= "\t";
+					}
+
+					$loop = $this->oldTokenValues[$stackPtr]['loop'];
+
+					@ob_end_clean();
+					echo "$indent**** $sniff:$line has possible conflict with another sniff on loop $loop; caused by the following change ****".PHP_EOL;
+					echo "$indent**** replaced token $stackPtr ($type on line $tokenLine) \"$oldContent\" => \"$newContent\" ****".PHP_EOL;
+				}
+
+				if ($this->oldTokenValues[$stackPtr]['loop'] >= ($this->loops - 1)) {
+					$this->inConflict = true;
+					if (PHP_CODESNIFFER_VERBOSITY > 1) {
+						echo "$indent**** ignoring all changes until next loop ****".PHP_EOL;
+					}
+				}
+
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					ob_start();
+				}
+
+				return false;
+			}//end if
+
+			$this->oldTokenValues[$stackPtr]['prev'] = $this->oldTokenValues[$stackPtr]['curr'];
+			$this->oldTokenValues[$stackPtr]['curr'] = $content;
+			$this->oldTokenValues[$stackPtr]['loop'] = $this->loops;
+		}//end if
+
+		$this->fixedTokens[$stackPtr] = $this->tokens[$stackPtr];
+		$this->tokens[$stackPtr]      = $content;
+		$this->numFixes++;
+
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			$indent = "\t";
+			if (empty($this->changeset) === false) {
+				$indent .= "\tA: ";
+			}
+
+			if (ob_get_level() > 0) {
+				ob_end_clean();
+			}
+
+			echo "$indent$sniff:$line replaced token $stackPtr ($type on line $tokenLine) \"$oldContent\" => \"$newContent\"".PHP_EOL;
+			ob_start();
+		}
+
+		return true;
+
+	}//end replaceToken()
+
+
+	/**
+	 * Reverts the previous fix made to a token.
+	 *
+	 * @param int $stackPtr The position of the token in the token stack.
+	 *
+	 * @return bool If a change was reverted.
+	 */
+	public function revertToken($stackPtr)
+	{
+		if (isset($this->fixedTokens[$stackPtr]) === false) {
+			return false;
+		}
+
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			$bt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
+			if ($bt[1]['class'] === 'PHP_CodeSniffer\Fixer') {
+				$sniff = $bt[2]['class'];
+				$line  = $bt[1]['line'];
+			} else {
+				$sniff = $bt[1]['class'];
+				$line  = $bt[0]['line'];
+			}
+
+			$sniff = Util\Common::getSniffCode($sniff);
+
+			$tokens     = $this->currentFile->getTokens();
+			$type       = $tokens[$stackPtr]['type'];
+			$tokenLine  = $tokens[$stackPtr]['line'];
+			$oldContent = Common::prepareForOutput($this->tokens[$stackPtr]);
+			$newContent = Common::prepareForOutput($this->fixedTokens[$stackPtr]);
+			if (trim($this->tokens[$stackPtr]) === '' && isset($tokens[($stackPtr + 1)]) === true) {
+				// Add some context for whitespace only changes.
+				$append      = Common::prepareForOutput($this->tokens[($stackPtr + 1)]);
+				$oldContent .= $append;
+				$newContent .= $append;
+			}
+		}//end if
+
+		$this->tokens[$stackPtr] = $this->fixedTokens[$stackPtr];
+		unset($this->fixedTokens[$stackPtr]);
+		$this->numFixes--;
+
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			$indent = "\t";
+			if (empty($this->changeset) === false) {
+				$indent .= "\tR: ";
+			}
+
+			@ob_end_clean();
+			echo "$indent$sniff:$line reverted token $stackPtr ($type on line $tokenLine) \"$oldContent\" => \"$newContent\"".PHP_EOL;
+			ob_start();
+		}
+
+		return true;
+
+	}//end revertToken()
+
+
+	/**
+	 * Replace the content of a token with a part of its current content.
+	 *
+	 * @param int $stackPtr The position of the token in the token stack.
+	 * @param int $start    The first character to keep.
+	 * @param int $length   The number of characters to keep. If NULL, the content of
+	 *                      the token from $start to the end of the content is kept.
+	 *
+	 * @return bool If the change was accepted.
+	 */
+	public function substrToken($stackPtr, $start, $length=null)
+	{
+		$current = $this->getTokenContent($stackPtr);
+
+		if ($length === null) {
+			$newContent = substr($current, $start);
+		} else {
+			$newContent = substr($current, $start, $length);
+		}
+
+		return $this->replaceToken($stackPtr, $newContent);
+
+	}//end substrToken()
+
+
+	/**
+	 * Adds a newline to end of a token's content.
+	 *
+	 * @param int $stackPtr The position of the token in the token stack.
+	 *
+	 * @return bool If the change was accepted.
+	 */
+	public function addNewline($stackPtr)
+	{
+		$current = $this->getTokenContent($stackPtr);
+		return $this->replaceToken($stackPtr, $current.$this->currentFile->eolChar);
+
+	}//end addNewline()
+
+
+	/**
+	 * Adds a newline to the start of a token's content.
+	 *
+	 * @param int $stackPtr The position of the token in the token stack.
+	 *
+	 * @return bool If the change was accepted.
+	 */
+	public function addNewlineBefore($stackPtr)
+	{
+		$current = $this->getTokenContent($stackPtr);
+		return $this->replaceToken($stackPtr, $this->currentFile->eolChar.$current);
+
+	}//end addNewlineBefore()
+
+
+	/**
+	 * Adds content to the end of a token's current content.
+	 *
+	 * @param int    $stackPtr The position of the token in the token stack.
+	 * @param string $content  The content to add.
+	 *
+	 * @return bool If the change was accepted.
+	 */
+	public function addContent($stackPtr, $content)
+	{
+		$current = $this->getTokenContent($stackPtr);
+		return $this->replaceToken($stackPtr, $current.$content);
+
+	}//end addContent()
+
+
+	/**
+	 * Adds content to the start of a token's current content.
+	 *
+	 * @param int    $stackPtr The position of the token in the token stack.
+	 * @param string $content  The content to add.
+	 *
+	 * @return bool If the change was accepted.
+	 */
+	public function addContentBefore($stackPtr, $content)
+	{
+		$current = $this->getTokenContent($stackPtr);
+		return $this->replaceToken($stackPtr, $content.$current);
+
+	}//end addContentBefore()
+
+
+	/**
+	 * Adjust the indent of a code block.
+	 *
+	 * @param int $start  The position of the token in the token stack
+	 *                    to start adjusting the indent from.
+	 * @param int $end    The position of the token in the token stack
+	 *                    to end adjusting the indent.
+	 * @param int $change The number of spaces to adjust the indent by
+	 *                    (positive or negative).
+	 *
+	 * @return void
+	 */
+	public function changeCodeBlockIndent($start, $end, $change)
+	{
+		$tokens = $this->currentFile->getTokens();
+
+		$baseIndent = '';
+		if ($change > 0) {
+			$baseIndent = str_repeat(' ', $change);
+		}
+
+		$useChangeset = false;
+		if ($this->inChangeset === false) {
+			$this->beginChangeset();
+			$useChangeset = true;
+		}
+
+		for ($i = $start; $i <= $end; $i++) {
+			if ($tokens[$i]['column'] !== 1
+				|| $tokens[($i + 1)]['line'] !== $tokens[$i]['line']
+			) {
+				continue;
+			}
+
+			$length = 0;
+			if ($tokens[$i]['code'] === T_WHITESPACE
+				|| $tokens[$i]['code'] === T_DOC_COMMENT_WHITESPACE
+			) {
+				$length = $tokens[$i]['length'];
+
+				$padding = ($length + $change);
+				if ($padding > 0) {
+					$padding = str_repeat(' ', $padding);
+				} else {
+					$padding = '';
+				}
+
+				$newContent = $padding.ltrim($tokens[$i]['content']);
+			} else {
+				$newContent = $baseIndent.$tokens[$i]['content'];
+			}
+
+			$this->replaceToken($i, $newContent);
+		}//end for
+
+		if ($useChangeset === true) {
+			$this->endChangeset();
+		}
+
+	}//end changeCodeBlockIndent()
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Tokenizers/Comment.php

Indentation +238 added lines, -238 removed lines

@@ -15,263 +15,263 @@
 {
 
 
-    /**
-     * Creates an array of tokens when given some PHP code.
-     *
-     * Starts by using token_get_all() but does a lot of extra processing
-     * to insert information about the context of the token.
-     *
-     * @param string $string   The string to tokenize.
-     * @param string $eolChar  The EOL character to use for splitting strings.
-     * @param int    $stackPtr The position of the first token in the file.
-     *
-     * @return array
-     */
-    public function tokenizeString($string, $eolChar, $stackPtr)
-    {
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            echo "\t\t*** START COMMENT TOKENIZING ***".PHP_EOL;
-        }
-
-        $tokens   = [];
-        $numChars = strlen($string);
-
-        /*
+	/**
+	 * Creates an array of tokens when given some PHP code.
+	 *
+	 * Starts by using token_get_all() but does a lot of extra processing
+	 * to insert information about the context of the token.
+	 *
+	 * @param string $string   The string to tokenize.
+	 * @param string $eolChar  The EOL character to use for splitting strings.
+	 * @param int    $stackPtr The position of the first token in the file.
+	 *
+	 * @return array
+	 */
+	public function tokenizeString($string, $eolChar, $stackPtr)
+	{
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			echo "\t\t*** START COMMENT TOKENIZING ***".PHP_EOL;
+		}
+
+		$tokens   = [];
+		$numChars = strlen($string);
+
+		/*
             Doc block comments start with /*, but typically contain an
             extra star when they are used for function and class comments.
         */
 
-        $char    = ($numChars - strlen(ltrim($string, '/*')));
-        $openTag = substr($string, 0, $char);
-        $string  = ltrim($string, '/*');
+		$char    = ($numChars - strlen(ltrim($string, '/*')));
+		$openTag = substr($string, 0, $char);
+		$string  = ltrim($string, '/*');
 
-        $tokens[$stackPtr] = [
-            'content'      => $openTag,
-            'code'         => T_DOC_COMMENT_OPEN_TAG,
-            'type'         => 'T_DOC_COMMENT_OPEN_TAG',
-            'comment_tags' => [],
-        ];
+		$tokens[$stackPtr] = [
+			'content'      => $openTag,
+			'code'         => T_DOC_COMMENT_OPEN_TAG,
+			'type'         => 'T_DOC_COMMENT_OPEN_TAG',
+			'comment_tags' => [],
+		];
 
-        $openPtr = $stackPtr;
-        $stackPtr++;
+		$openPtr = $stackPtr;
+		$stackPtr++;
 
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            $content = Util\Common::prepareForOutput($openTag);
-            echo "\t\tCreate comment token: T_DOC_COMMENT_OPEN_TAG => $content".PHP_EOL;
-        }
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			$content = Util\Common::prepareForOutput($openTag);
+			echo "\t\tCreate comment token: T_DOC_COMMENT_OPEN_TAG => $content".PHP_EOL;
+		}
 
-        /*
+		/*
             Strip off the close tag so it doesn't interfere with any
             of our comment line processing. The token will be added to the
             stack just before we return it.
         */
 
-        $closeTag = [
-            'content'        => substr($string, strlen(rtrim($string, '/*'))),
-            'code'           => T_DOC_COMMENT_CLOSE_TAG,
-            'type'           => 'T_DOC_COMMENT_CLOSE_TAG',
-            'comment_opener' => $openPtr,
-        ];
+		$closeTag = [
+			'content'        => substr($string, strlen(rtrim($string, '/*'))),
+			'code'           => T_DOC_COMMENT_CLOSE_TAG,
+			'type'           => 'T_DOC_COMMENT_CLOSE_TAG',
+			'comment_opener' => $openPtr,
+		];
 
-        if ($closeTag['content'] === false) {
-            $closeTag['content'] = '';
-        }
+		if ($closeTag['content'] === false) {
+			$closeTag['content'] = '';
+		}
 
-        $string = rtrim($string, '/*');
+		$string = rtrim($string, '/*');
 
-        /*
+		/*
             Process each line of the comment.
         */
 
-        $lines    = explode($eolChar, $string);
-        $numLines = count($lines);
-        foreach ($lines as $lineNum => $string) {
-            if ($lineNum !== ($numLines - 1)) {
-                $string .= $eolChar;
-            }
-
-            $char     = 0;
-            $numChars = strlen($string);
-
-            // We've started a new line, so process the indent.
-            $space = $this->collectWhitespace($string, $char, $numChars);
-            if ($space !== null) {
-                $tokens[$stackPtr] = $space;
-                $stackPtr++;
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    $content = Util\Common::prepareForOutput($space['content']);
-                    echo "\t\tCreate comment token: T_DOC_COMMENT_WHITESPACE => $content".PHP_EOL;
-                }
-
-                $char += strlen($space['content']);
-                if ($char === $numChars) {
-                    break;
-                }
-            }
-
-            if ($string === '') {
-                continue;
-            }
-
-            if ($lineNum > 0 && $string[$char] === '*') {
-                // This is a function or class doc block line.
-                $char++;
-                $tokens[$stackPtr] = [
-                    'content' => '*',
-                    'code'    => T_DOC_COMMENT_STAR,
-                    'type'    => 'T_DOC_COMMENT_STAR',
-                ];
-
-                $stackPtr++;
-
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo "\t\tCreate comment token: T_DOC_COMMENT_STAR => *".PHP_EOL;
-                }
-            }
-
-            // Now we are ready to process the actual content of the line.
-            $lineTokens = $this->processLine($string, $eolChar, $char, $numChars);
-            foreach ($lineTokens as $lineToken) {
-                $tokens[$stackPtr] = $lineToken;
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    $content = Util\Common::prepareForOutput($lineToken['content']);
-                    $type    = $lineToken['type'];
-                    echo "\t\tCreate comment token: $type => $content".PHP_EOL;
-                }
-
-                if ($lineToken['code'] === T_DOC_COMMENT_TAG) {
-                    $tokens[$openPtr]['comment_tags'][] = $stackPtr;
-                }
-
-                $stackPtr++;
-            }
-        }//end foreach
-
-        $tokens[$stackPtr] = $closeTag;
-        $tokens[$openPtr]['comment_closer'] = $stackPtr;
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            $content = Util\Common::prepareForOutput($closeTag['content']);
-            echo "\t\tCreate comment token: T_DOC_COMMENT_CLOSE_TAG => $content".PHP_EOL;
-        }
-
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            echo "\t\t*** END COMMENT TOKENIZING ***".PHP_EOL;
-        }
-
-        return $tokens;
-
-    }//end tokenizeString()
-
-
-    /**
-     * Process a single line of a comment.
-     *
-     * @param string $string  The comment string being tokenized.
-     * @param string $eolChar The EOL character to use for splitting strings.
-     * @param int    $start   The position in the string to start processing.
-     * @param int    $end     The position in the string to end processing.
-     *
-     * @return array
-     */
-    private function processLine($string, $eolChar, $start, $end)
-    {
-        $tokens = [];
-
-        // Collect content padding.
-        $space = $this->collectWhitespace($string, $start, $end);
-        if ($space !== null) {
-            $tokens[] = $space;
-            $start   += strlen($space['content']);
-        }
-
-        if (isset($string[$start]) === false) {
-            return $tokens;
-        }
-
-        if ($string[$start] === '@') {
-            // The content up until the first whitespace is the tag name.
-            $matches = [];
-            preg_match('/@[^\s]+/', $string, $matches, 0, $start);
-            if (isset($matches[0]) === true
-                && substr(strtolower($matches[0]), 0, 7) !== '@phpcs:'
-            ) {
-                $tagName  = $matches[0];
-                $start   += strlen($tagName);
-                $tokens[] = [
-                    'content' => $tagName,
-                    'code'    => T_DOC_COMMENT_TAG,
-                    'type'    => 'T_DOC_COMMENT_TAG',
-                ];
-
-                // Then there will be some whitespace.
-                $space = $this->collectWhitespace($string, $start, $end);
-                if ($space !== null) {
-                    $tokens[] = $space;
-                    $start   += strlen($space['content']);
-                }
-            }
-        }//end if
-
-        // Process the rest of the line.
-        $eol = strpos($string, $eolChar, $start);
-        if ($eol === false) {
-            $eol = $end;
-        }
-
-        if ($eol > $start) {
-            $tokens[] = [
-                'content' => substr($string, $start, ($eol - $start)),
-                'code'    => T_DOC_COMMENT_STRING,
-                'type'    => 'T_DOC_COMMENT_STRING',
-            ];
-        }
-
-        if ($eol !== $end) {
-            $tokens[] = [
-                'content' => substr($string, $eol, strlen($eolChar)),
-                'code'    => T_DOC_COMMENT_WHITESPACE,
-                'type'    => 'T_DOC_COMMENT_WHITESPACE',
-            ];
-        }
-
-        return $tokens;
-
-    }//end processLine()
-
-
-    /**
-     * Collect consecutive whitespace into a single token.
-     *
-     * @param string $string The comment string being tokenized.
-     * @param int    $start  The position in the string to start processing.
-     * @param int    $end    The position in the string to end processing.
-     *
-     * @return array|null
-     */
-    private function collectWhitespace($string, $start, $end)
-    {
-        $space = '';
-        for ($start; $start < $end; $start++) {
-            if ($string[$start] !== ' ' && $string[$start] !== "\t") {
-                break;
-            }
-
-            $space .= $string[$start];
-        }
-
-        if ($space === '') {
-            return null;
-        }
-
-        $token = [
-            'content' => $space,
-            'code'    => T_DOC_COMMENT_WHITESPACE,
-            'type'    => 'T_DOC_COMMENT_WHITESPACE',
-        ];
-
-        return $token;
-
-    }//end collectWhitespace()
+		$lines    = explode($eolChar, $string);
+		$numLines = count($lines);
+		foreach ($lines as $lineNum => $string) {
+			if ($lineNum !== ($numLines - 1)) {
+				$string .= $eolChar;
+			}
+
+			$char     = 0;
+			$numChars = strlen($string);
+
+			// We've started a new line, so process the indent.
+			$space = $this->collectWhitespace($string, $char, $numChars);
+			if ($space !== null) {
+				$tokens[$stackPtr] = $space;
+				$stackPtr++;
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					$content = Util\Common::prepareForOutput($space['content']);
+					echo "\t\tCreate comment token: T_DOC_COMMENT_WHITESPACE => $content".PHP_EOL;
+				}
+
+				$char += strlen($space['content']);
+				if ($char === $numChars) {
+					break;
+				}
+			}
+
+			if ($string === '') {
+				continue;
+			}
+
+			if ($lineNum > 0 && $string[$char] === '*') {
+				// This is a function or class doc block line.
+				$char++;
+				$tokens[$stackPtr] = [
+					'content' => '*',
+					'code'    => T_DOC_COMMENT_STAR,
+					'type'    => 'T_DOC_COMMENT_STAR',
+				];
+
+				$stackPtr++;
+
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo "\t\tCreate comment token: T_DOC_COMMENT_STAR => *".PHP_EOL;
+				}
+			}
+
+			// Now we are ready to process the actual content of the line.
+			$lineTokens = $this->processLine($string, $eolChar, $char, $numChars);
+			foreach ($lineTokens as $lineToken) {
+				$tokens[$stackPtr] = $lineToken;
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					$content = Util\Common::prepareForOutput($lineToken['content']);
+					$type    = $lineToken['type'];
+					echo "\t\tCreate comment token: $type => $content".PHP_EOL;
+				}
+
+				if ($lineToken['code'] === T_DOC_COMMENT_TAG) {
+					$tokens[$openPtr]['comment_tags'][] = $stackPtr;
+				}
+
+				$stackPtr++;
+			}
+		}//end foreach
+
+		$tokens[$stackPtr] = $closeTag;
+		$tokens[$openPtr]['comment_closer'] = $stackPtr;
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			$content = Util\Common::prepareForOutput($closeTag['content']);
+			echo "\t\tCreate comment token: T_DOC_COMMENT_CLOSE_TAG => $content".PHP_EOL;
+		}
+
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			echo "\t\t*** END COMMENT TOKENIZING ***".PHP_EOL;
+		}
+
+		return $tokens;
+
+	}//end tokenizeString()
+
+
+	/**
+	 * Process a single line of a comment.
+	 *
+	 * @param string $string  The comment string being tokenized.
+	 * @param string $eolChar The EOL character to use for splitting strings.
+	 * @param int    $start   The position in the string to start processing.
+	 * @param int    $end     The position in the string to end processing.
+	 *
+	 * @return array
+	 */
+	private function processLine($string, $eolChar, $start, $end)
+	{
+		$tokens = [];
+
+		// Collect content padding.
+		$space = $this->collectWhitespace($string, $start, $end);
+		if ($space !== null) {
+			$tokens[] = $space;
+			$start   += strlen($space['content']);
+		}
+
+		if (isset($string[$start]) === false) {
+			return $tokens;
+		}
+
+		if ($string[$start] === '@') {
+			// The content up until the first whitespace is the tag name.
+			$matches = [];
+			preg_match('/@[^\s]+/', $string, $matches, 0, $start);
+			if (isset($matches[0]) === true
+				&& substr(strtolower($matches[0]), 0, 7) !== '@phpcs:'
+			) {
+				$tagName  = $matches[0];
+				$start   += strlen($tagName);
+				$tokens[] = [
+					'content' => $tagName,
+					'code'    => T_DOC_COMMENT_TAG,
+					'type'    => 'T_DOC_COMMENT_TAG',
+				];
+
+				// Then there will be some whitespace.
+				$space = $this->collectWhitespace($string, $start, $end);
+				if ($space !== null) {
+					$tokens[] = $space;
+					$start   += strlen($space['content']);
+				}
+			}
+		}//end if
+
+		// Process the rest of the line.
+		$eol = strpos($string, $eolChar, $start);
+		if ($eol === false) {
+			$eol = $end;
+		}
+
+		if ($eol > $start) {
+			$tokens[] = [
+				'content' => substr($string, $start, ($eol - $start)),
+				'code'    => T_DOC_COMMENT_STRING,
+				'type'    => 'T_DOC_COMMENT_STRING',
+			];
+		}
+
+		if ($eol !== $end) {
+			$tokens[] = [
+				'content' => substr($string, $eol, strlen($eolChar)),
+				'code'    => T_DOC_COMMENT_WHITESPACE,
+				'type'    => 'T_DOC_COMMENT_WHITESPACE',
+			];
+		}
+
+		return $tokens;
+
+	}//end processLine()
+
+
+	/**
+	 * Collect consecutive whitespace into a single token.
+	 *
+	 * @param string $string The comment string being tokenized.
+	 * @param int    $start  The position in the string to start processing.
+	 * @param int    $end    The position in the string to end processing.
+	 *
+	 * @return array|null
+	 */
+	private function collectWhitespace($string, $start, $end)
+	{
+		$space = '';
+		for ($start; $start < $end; $start++) {
+			if ($string[$start] !== ' ' && $string[$start] !== "\t") {
+				break;
+			}
+
+			$space .= $string[$start];
+		}
+
+		if ($space === '') {
+			return null;
+		}
+
+		$token = [
+			'content' => $space,
+			'code'    => T_DOC_COMMENT_WHITESPACE,
+			'type'    => 'T_DOC_COMMENT_WHITESPACE',
+		];
+
+		return $token;
+
+	}//end collectWhitespace()
 
 
 }//end class