eventespresso / event-espresso-core

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

vendor/squizlabs/php_codesniffer/src/Sniffs/AbstractScopeSniff.php

Spacing +1 added lines, -1 removed lines

@@ -71,7 +71,7 @@
     public function __construct(
         array $scopeTokens,
         array $tokens,
-        $listenOutside=false
+        $listenOutside = false
     ) {
         if (empty($scopeTokens) === true) {
             $error = 'The scope tokens list cannot be empty';

Indentation +154 added lines, -154 removed lines

@@ -32,160 +32,160 @@
 abstract class AbstractScopeSniff implements Sniff
 {
 
-    /**
-     * The token types that this test wishes to listen to within the scope.
-     *
-     * @var array
-     */
-    private $tokens = [];
-
-    /**
-     * The type of scope opener tokens that this test wishes to listen to.
-     *
-     * @var string
-     */
-    private $scopeTokens = [];
-
-    /**
-     * True if this test should fire on tokens outside of the scope.
-     *
-     * @var boolean
-     */
-    private $listenOutside = false;
-
-
-    /**
-     * Constructs a new AbstractScopeTest.
-     *
-     * @param array   $scopeTokens   The type of scope the test wishes to listen to.
-     * @param array   $tokens        The tokens that the test wishes to listen to
-     *                               within the scope.
-     * @param boolean $listenOutside If true this test will also alert the
-     *                               extending class when a token is found outside
-     *                               the scope, by calling the
-     *                               processTokenOutsideScope method.
-     *
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified tokens arrays are empty
-     *                                                      or invalid.
-     */
-    public function __construct(
-        array $scopeTokens,
-        array $tokens,
-        $listenOutside=false
-    ) {
-        if (empty($scopeTokens) === true) {
-            $error = 'The scope tokens list cannot be empty';
-            throw new RuntimeException($error);
-        }
-
-        if (empty($tokens) === true) {
-            $error = 'The tokens list cannot be empty';
-            throw new RuntimeException($error);
-        }
-
-        $invalidScopeTokens = array_intersect($scopeTokens, $tokens);
-        if (empty($invalidScopeTokens) === false) {
-            $invalid = implode(', ', $invalidScopeTokens);
-            $error   = "Scope tokens [$invalid] can't be in the tokens array";
-            throw new RuntimeException($error);
-        }
-
-        $this->listenOutside = $listenOutside;
-        $this->scopeTokens   = array_flip($scopeTokens);
-        $this->tokens        = $tokens;
-
-    }//end __construct()
-
-
-    /**
-     * The method that is called to register the tokens this test wishes to
-     * listen to.
-     *
-     * DO NOT OVERRIDE THIS METHOD. Use the constructor of this class to register
-     * for the desired tokens and scope.
-     *
-     * @return int[]
-     * @see    __constructor()
-     */
-    final public function register()
-    {
-        return $this->tokens;
-
-    }//end register()
-
-
-    /**
-     * Processes the tokens that this test is listening for.
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
-     * @param int                         $stackPtr  The position in the stack where this
-     *                                               token was found.
-     *
-     * @return void|int Optionally returns a stack pointer. The sniff will not be
-     *                  called again on the current file until the returned stack
-     *                  pointer is reached. Return ($phpcsFile->numTokens + 1) to skip
-     *                  the rest of the file.
-     * @see    processTokenWithinScope()
-     */
-    final public function process(File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-
-        $foundScope = false;
-        $skipTokens = [];
-        foreach ($tokens[$stackPtr]['conditions'] as $scope => $code) {
-            if (isset($this->scopeTokens[$code]) === true) {
-                $skipTokens[] = $this->processTokenWithinScope($phpcsFile, $stackPtr, $scope);
-                $foundScope   = true;
-            }
-        }
-
-        if ($this->listenOutside === true && $foundScope === false) {
-            $skipTokens[] = $this->processTokenOutsideScope($phpcsFile, $stackPtr);
-        }
-
-        if (empty($skipTokens) === false) {
-            return min($skipTokens);
-        }
-
-        return;
-
-    }//end process()
-
-
-    /**
-     * Processes a token that is found within the scope that this test is
-     * listening to.
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
-     * @param int                         $stackPtr  The position in the stack where this
-     *                                               token was found.
-     * @param int                         $currScope The position in the tokens array that
-     *                                               opened the scope that this test is
-     *                                               listening for.
-     *
-     * @return void|int Optionally returns a stack pointer. The sniff will not be
-     *                  called again on the current file until the returned stack
-     *                  pointer is reached. Return ($phpcsFile->numTokens + 1) to skip
-     *                  the rest of the file.
-     */
-    abstract protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope);
-
-
-    /**
-     * Processes a token that is found outside the scope that this test is
-     * listening to.
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
-     * @param int                         $stackPtr  The position in the stack where this
-     *                                               token was found.
-     *
-     * @return void|int Optionally returns a stack pointer. The sniff will not be
-     *                  called again on the current file until the returned stack
-     *                  pointer is reached. Return (count($tokens) + 1) to skip
-     *                  the rest of the file.
-     */
-    abstract protected function processTokenOutsideScope(File $phpcsFile, $stackPtr);
+	/**
+	 * The token types that this test wishes to listen to within the scope.
+	 *
+	 * @var array
+	 */
+	private $tokens = [];
+
+	/**
+	 * The type of scope opener tokens that this test wishes to listen to.
+	 *
+	 * @var string
+	 */
+	private $scopeTokens = [];
+
+	/**
+	 * True if this test should fire on tokens outside of the scope.
+	 *
+	 * @var boolean
+	 */
+	private $listenOutside = false;
+
+
+	/**
+	 * Constructs a new AbstractScopeTest.
+	 *
+	 * @param array   $scopeTokens   The type of scope the test wishes to listen to.
+	 * @param array   $tokens        The tokens that the test wishes to listen to
+	 *                               within the scope.
+	 * @param boolean $listenOutside If true this test will also alert the
+	 *                               extending class when a token is found outside
+	 *                               the scope, by calling the
+	 *                               processTokenOutsideScope method.
+	 *
+	 * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified tokens arrays are empty
+	 *                                                      or invalid.
+	 */
+	public function __construct(
+		array $scopeTokens,
+		array $tokens,
+		$listenOutside=false
+	) {
+		if (empty($scopeTokens) === true) {
+			$error = 'The scope tokens list cannot be empty';
+			throw new RuntimeException($error);
+		}
+
+		if (empty($tokens) === true) {
+			$error = 'The tokens list cannot be empty';
+			throw new RuntimeException($error);
+		}
+
+		$invalidScopeTokens = array_intersect($scopeTokens, $tokens);
+		if (empty($invalidScopeTokens) === false) {
+			$invalid = implode(', ', $invalidScopeTokens);
+			$error   = "Scope tokens [$invalid] can't be in the tokens array";
+			throw new RuntimeException($error);
+		}
+
+		$this->listenOutside = $listenOutside;
+		$this->scopeTokens   = array_flip($scopeTokens);
+		$this->tokens        = $tokens;
+
+	}//end __construct()
+
+
+	/**
+	 * The method that is called to register the tokens this test wishes to
+	 * listen to.
+	 *
+	 * DO NOT OVERRIDE THIS METHOD. Use the constructor of this class to register
+	 * for the desired tokens and scope.
+	 *
+	 * @return int[]
+	 * @see    __constructor()
+	 */
+	final public function register()
+	{
+		return $this->tokens;
+
+	}//end register()
+
+
+	/**
+	 * Processes the tokens that this test is listening for.
+	 *
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
+	 * @param int                         $stackPtr  The position in the stack where this
+	 *                                               token was found.
+	 *
+	 * @return void|int Optionally returns a stack pointer. The sniff will not be
+	 *                  called again on the current file until the returned stack
+	 *                  pointer is reached. Return ($phpcsFile->numTokens + 1) to skip
+	 *                  the rest of the file.
+	 * @see    processTokenWithinScope()
+	 */
+	final public function process(File $phpcsFile, $stackPtr)
+	{
+		$tokens = $phpcsFile->getTokens();
+
+		$foundScope = false;
+		$skipTokens = [];
+		foreach ($tokens[$stackPtr]['conditions'] as $scope => $code) {
+			if (isset($this->scopeTokens[$code]) === true) {
+				$skipTokens[] = $this->processTokenWithinScope($phpcsFile, $stackPtr, $scope);
+				$foundScope   = true;
+			}
+		}
+
+		if ($this->listenOutside === true && $foundScope === false) {
+			$skipTokens[] = $this->processTokenOutsideScope($phpcsFile, $stackPtr);
+		}
+
+		if (empty($skipTokens) === false) {
+			return min($skipTokens);
+		}
+
+		return;
+
+	}//end process()
+
+
+	/**
+	 * Processes a token that is found within the scope that this test is
+	 * listening to.
+	 *
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
+	 * @param int                         $stackPtr  The position in the stack where this
+	 *                                               token was found.
+	 * @param int                         $currScope The position in the tokens array that
+	 *                                               opened the scope that this test is
+	 *                                               listening for.
+	 *
+	 * @return void|int Optionally returns a stack pointer. The sniff will not be
+	 *                  called again on the current file until the returned stack
+	 *                  pointer is reached. Return ($phpcsFile->numTokens + 1) to skip
+	 *                  the rest of the file.
+	 */
+	abstract protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope);
+
+
+	/**
+	 * Processes a token that is found outside the scope that this test is
+	 * listening to.
+	 *
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
+	 * @param int                         $stackPtr  The position in the stack where this
+	 *                                               token was found.
+	 *
+	 * @return void|int Optionally returns a stack pointer. The sniff will not be
+	 *                  called again on the current file until the returned stack
+	 *                  pointer is reached. Return (count($tokens) + 1) to skip
+	 *                  the rest of the file.
+	 */
+	abstract protected function processTokenOutsideScope(File $phpcsFile, $stackPtr);
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Sniffs/AbstractPatternSniff.php

Switch Indentation +20 added lines, -20 removed lines

@@ -866,26 +866,26 @@
         $nestedBraces      = 0;
         for ($start = $from; $start >= 0; $start--) {
             switch ($pattern[$start]) {
-            case '(':
-                if ($nestedParenthesis === 0) {
-                    $skip['to'] = 'parenthesis_closer';
-                }
-
-                $nestedParenthesis--;
-                break;
-            case '{':
-                if ($nestedBraces === 0) {
-                    $skip['to'] = 'scope_closer';
-                }
-
-                $nestedBraces--;
-                break;
-            case '}':
-                $nestedBraces++;
-                break;
-            case ')':
-                $nestedParenthesis++;
-                break;
+            	case '(':
+                	if ($nestedParenthesis === 0) {
+                    	$skip['to'] = 'parenthesis_closer';
+                	}
+
+                	$nestedParenthesis--;
+                	break;
+            	case '{':
+                	if ($nestedBraces === 0) {
+                    	$skip['to'] = 'scope_closer';
+                	}
+
+                	$nestedBraces--;
+                	break;
+            	case '}':
+                	$nestedBraces++;
+                	break;
+            	case ')':
+                	$nestedParenthesis++;
+                	break;
             }//end switch
 
             if (isset($skip['to']) === true) {

Spacing +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
      *
      * @param boolean $ignoreComments If true, comments will be ignored.
      */
-    public function __construct($ignoreComments=null)
+    public function __construct($ignoreComments = null)
     {
         // This is here for backwards compatibility.
         if ($ignoreComments !== null) {

Indentation +914 added lines, -914 removed lines

@@ -17,920 +17,920 @@
 abstract class AbstractPatternSniff implements Sniff
 {
 
-    /**
-     * If true, comments will be ignored if they are found in the code.
-     *
-     * @var boolean
-     */
-    public $ignoreComments = false;
-
-    /**
-     * The current file being checked.
-     *
-     * @var string
-     */
-    protected $currFile = '';
-
-    /**
-     * The parsed patterns array.
-     *
-     * @var array
-     */
-    private $parsedPatterns = [];
-
-    /**
-     * Tokens that this sniff wishes to process outside of the patterns.
-     *
-     * @var int[]
-     * @see registerSupplementary()
-     * @see processSupplementary()
-     */
-    private $supplementaryTokens = [];
-
-    /**
-     * Positions in the stack where errors have occurred.
-     *
-     * @var array<int, bool>
-     */
-    private $errorPos = [];
-
-
-    /**
-     * Constructs a AbstractPatternSniff.
-     *
-     * @param boolean $ignoreComments If true, comments will be ignored.
-     */
-    public function __construct($ignoreComments=null)
-    {
-        // This is here for backwards compatibility.
-        if ($ignoreComments !== null) {
-            $this->ignoreComments = $ignoreComments;
-        }
-
-        $this->supplementaryTokens = $this->registerSupplementary();
-
-    }//end __construct()
-
-
-    /**
-     * Registers the tokens to listen to.
-     *
-     * Classes extending <i>AbstractPatternTest</i> should implement the
-     * <i>getPatterns()</i> method to register the patterns they wish to test.
-     *
-     * @return int[]
-     * @see    process()
-     */
-    final public function register()
-    {
-        $listenTypes = [];
-        $patterns    = $this->getPatterns();
-
-        foreach ($patterns as $pattern) {
-            $parsedPattern = $this->parse($pattern);
-
-            // Find a token position in the pattern that we can use
-            // for a listener token.
-            $pos           = $this->getListenerTokenPos($parsedPattern);
-            $tokenType     = $parsedPattern[$pos]['token'];
-            $listenTypes[] = $tokenType;
-
-            $patternArray = [
-                'listen_pos'   => $pos,
-                'pattern'      => $parsedPattern,
-                'pattern_code' => $pattern,
-            ];
-
-            if (isset($this->parsedPatterns[$tokenType]) === false) {
-                $this->parsedPatterns[$tokenType] = [];
-            }
-
-            $this->parsedPatterns[$tokenType][] = $patternArray;
-        }//end foreach
-
-        return array_unique(array_merge($listenTypes, $this->supplementaryTokens));
-
-    }//end register()
-
-
-    /**
-     * Returns the token types that the specified pattern is checking for.
-     *
-     * Returned array is in the format:
-     * <code>
-     *   array(
-     *      T_WHITESPACE => 0, // 0 is the position where the T_WHITESPACE token
-     *                         // should occur in the pattern.
-     *   );
-     * </code>
-     *
-     * @param array $pattern The parsed pattern to find the acquire the token
-     *                       types from.
-     *
-     * @return array<int, int>
-     */
-    private function getPatternTokenTypes($pattern)
-    {
-        $tokenTypes = [];
-        foreach ($pattern as $pos => $patternInfo) {
-            if ($patternInfo['type'] === 'token') {
-                if (isset($tokenTypes[$patternInfo['token']]) === false) {
-                    $tokenTypes[$patternInfo['token']] = $pos;
-                }
-            }
-        }
-
-        return $tokenTypes;
-
-    }//end getPatternTokenTypes()
-
-
-    /**
-     * Returns the position in the pattern that this test should register as
-     * a listener for the pattern.
-     *
-     * @param array $pattern The pattern to acquire the listener for.
-     *
-     * @return int The position in the pattern that this test should register
-     *             as the listener.
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If we could not determine a token to listen for.
-     */
-    private function getListenerTokenPos($pattern)
-    {
-        $tokenTypes = $this->getPatternTokenTypes($pattern);
-        $tokenCodes = array_keys($tokenTypes);
-        $token      = Tokens::getHighestWeightedToken($tokenCodes);
-
-        // If we could not get a token.
-        if ($token === false) {
-            $error = 'Could not determine a token to listen for';
-            throw new RuntimeException($error);
-        }
-
-        return $tokenTypes[$token];
-
-    }//end getListenerTokenPos()
-
-
-    /**
-     * Processes the test.
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where the
-     *                                               token occurred.
-     * @param int                         $stackPtr  The position in the tokens stack
-     *                                               where the listening token type
-     *                                               was found.
-     *
-     * @return void
-     * @see    register()
-     */
-    final public function process(File $phpcsFile, $stackPtr)
-    {
-        $file = $phpcsFile->getFilename();
-        if ($this->currFile !== $file) {
-            // We have changed files, so clean up.
-            $this->errorPos = [];
-            $this->currFile = $file;
-        }
-
-        $tokens = $phpcsFile->getTokens();
-
-        if (in_array($tokens[$stackPtr]['code'], $this->supplementaryTokens, true) === true) {
-            $this->processSupplementary($phpcsFile, $stackPtr);
-        }
-
-        $type = $tokens[$stackPtr]['code'];
-
-        // If the type is not set, then it must have been a token registered
-        // with registerSupplementary().
-        if (isset($this->parsedPatterns[$type]) === false) {
-            return;
-        }
-
-        $allErrors = [];
-
-        // Loop over each pattern that is listening to the current token type
-        // that we are processing.
-        foreach ($this->parsedPatterns[$type] as $patternInfo) {
-            // If processPattern returns false, then the pattern that we are
-            // checking the code with must not be designed to check that code.
-            $errors = $this->processPattern($patternInfo, $phpcsFile, $stackPtr);
-            if ($errors === false) {
-                // The pattern didn't match.
-                continue;
-            } else if (empty($errors) === true) {
-                // The pattern matched, but there were no errors.
-                break;
-            }
-
-            foreach ($errors as $stackPtr => $error) {
-                if (isset($this->errorPos[$stackPtr]) === false) {
-                    $this->errorPos[$stackPtr] = true;
-                    $allErrors[$stackPtr]      = $error;
-                }
-            }
-        }
-
-        foreach ($allErrors as $stackPtr => $error) {
-            $phpcsFile->addError($error, $stackPtr, 'Found');
-        }
-
-    }//end process()
-
-
-    /**
-     * Processes the pattern and verifies the code at $stackPtr.
-     *
-     * @param array                       $patternInfo Information about the pattern used
-     *                                                 for checking, which includes are
-     *                                                 parsed token representation of the
-     *                                                 pattern.
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile   The PHP_CodeSniffer file where the
-     *                                                 token occurred.
-     * @param int                         $stackPtr    The position in the tokens stack where
-     *                                                 the listening token type was found.
-     *
-     * @return array
-     */
-    protected function processPattern($patternInfo, File $phpcsFile, $stackPtr)
-    {
-        $tokens      = $phpcsFile->getTokens();
-        $pattern     = $patternInfo['pattern'];
-        $patternCode = $patternInfo['pattern_code'];
-        $errors      = [];
-        $found       = '';
-
-        $ignoreTokens = [T_WHITESPACE => T_WHITESPACE];
-        if ($this->ignoreComments === true) {
-            $ignoreTokens += Tokens::$commentTokens;
-        }
-
-        $origStackPtr = $stackPtr;
-        $hasError     = false;
-
-        if ($patternInfo['listen_pos'] > 0) {
-            $stackPtr--;
-
-            for ($i = ($patternInfo['listen_pos'] - 1); $i >= 0; $i--) {
-                if ($pattern[$i]['type'] === 'token') {
-                    if ($pattern[$i]['token'] === T_WHITESPACE) {
-                        if ($tokens[$stackPtr]['code'] === T_WHITESPACE) {
-                            $found = $tokens[$stackPtr]['content'].$found;
-                        }
-
-                        // Only check the size of the whitespace if this is not
-                        // the first token. We don't care about the size of
-                        // leading whitespace, just that there is some.
-                        if ($i !== 0) {
-                            if ($tokens[$stackPtr]['content'] !== $pattern[$i]['value']) {
-                                $hasError = true;
-                            }
-                        }
-                    } else {
-                        // Check to see if this important token is the same as the
-                        // previous important token in the pattern. If it is not,
-                        // then the pattern cannot be for this piece of code.
-                        $prev = $phpcsFile->findPrevious(
-                            $ignoreTokens,
-                            $stackPtr,
-                            null,
-                            true
-                        );
-
-                        if ($prev === false
-                            || $tokens[$prev]['code'] !== $pattern[$i]['token']
-                        ) {
-                            return false;
-                        }
-
-                        // If we skipped past some whitespace tokens, then add them
-                        // to the found string.
-                        $tokenContent = $phpcsFile->getTokensAsString(
-                            ($prev + 1),
-                            ($stackPtr - $prev - 1)
-                        );
-
-                        $found = $tokens[$prev]['content'].$tokenContent.$found;
-
-                        if (isset($pattern[($i - 1)]) === true
-                            && $pattern[($i - 1)]['type'] === 'skip'
-                        ) {
-                            $stackPtr = $prev;
-                        } else {
-                            $stackPtr = ($prev - 1);
-                        }
-                    }//end if
-                } else if ($pattern[$i]['type'] === 'skip') {
-                    // Skip to next piece of relevant code.
-                    if ($pattern[$i]['to'] === 'parenthesis_closer') {
-                        $to = 'parenthesis_opener';
-                    } else {
-                        $to = 'scope_opener';
-                    }
-
-                    // Find the previous opener.
-                    $next = $phpcsFile->findPrevious(
-                        $ignoreTokens,
-                        $stackPtr,
-                        null,
-                        true
-                    );
-
-                    if ($next === false || isset($tokens[$next][$to]) === false) {
-                        // If there was not opener, then we must be
-                        // using the wrong pattern.
-                        return false;
-                    }
-
-                    if ($to === 'parenthesis_opener') {
-                        $found = '{'.$found;
-                    } else {
-                        $found = '('.$found;
-                    }
-
-                    $found = '...'.$found;
-
-                    // Skip to the opening token.
-                    $stackPtr = ($tokens[$next][$to] - 1);
-                } else if ($pattern[$i]['type'] === 'string') {
-                    $found = 'abc';
-                } else if ($pattern[$i]['type'] === 'newline') {
-                    if ($this->ignoreComments === true
-                        && isset(Tokens::$commentTokens[$tokens[$stackPtr]['code']]) === true
-                    ) {
-                        $startComment = $phpcsFile->findPrevious(
-                            Tokens::$commentTokens,
-                            ($stackPtr - 1),
-                            null,
-                            true
-                        );
-
-                        if ($tokens[$startComment]['line'] !== $tokens[($startComment + 1)]['line']) {
-                            $startComment++;
-                        }
-
-                        $tokenContent = $phpcsFile->getTokensAsString(
-                            $startComment,
-                            ($stackPtr - $startComment + 1)
-                        );
-
-                        $found    = $tokenContent.$found;
-                        $stackPtr = ($startComment - 1);
-                    }
-
-                    if ($tokens[$stackPtr]['code'] === T_WHITESPACE) {
-                        if ($tokens[$stackPtr]['content'] !== $phpcsFile->eolChar) {
-                            $found = $tokens[$stackPtr]['content'].$found;
-
-                            // This may just be an indent that comes after a newline
-                            // so check the token before to make sure. If it is a newline, we
-                            // can ignore the error here.
-                            if (($tokens[($stackPtr - 1)]['content'] !== $phpcsFile->eolChar)
-                                && ($this->ignoreComments === true
-                                && isset(Tokens::$commentTokens[$tokens[($stackPtr - 1)]['code']]) === false)
-                            ) {
-                                $hasError = true;
-                            } else {
-                                $stackPtr--;
-                            }
-                        } else {
-                            $found = 'EOL'.$found;
-                        }
-                    } else {
-                        $found    = $tokens[$stackPtr]['content'].$found;
-                        $hasError = true;
-                    }//end if
-
-                    if ($hasError === false && $pattern[($i - 1)]['type'] !== 'newline') {
-                        // Make sure they only have 1 newline.
-                        $prev = $phpcsFile->findPrevious($ignoreTokens, ($stackPtr - 1), null, true);
-                        if ($prev !== false && $tokens[$prev]['line'] !== $tokens[$stackPtr]['line']) {
-                            $hasError = true;
-                        }
-                    }
-                }//end if
-            }//end for
-        }//end if
-
-        $stackPtr          = $origStackPtr;
-        $lastAddedStackPtr = null;
-        $patternLen        = count($pattern);
-
-        for ($i = $patternInfo['listen_pos']; $i < $patternLen; $i++) {
-            if (isset($tokens[$stackPtr]) === false) {
-                break;
-            }
-
-            if ($pattern[$i]['type'] === 'token') {
-                if ($pattern[$i]['token'] === T_WHITESPACE) {
-                    if ($this->ignoreComments === true) {
-                        // If we are ignoring comments, check to see if this current
-                        // token is a comment. If so skip it.
-                        if (isset(Tokens::$commentTokens[$tokens[$stackPtr]['code']]) === true) {
-                            continue;
-                        }
-
-                        // If the next token is a comment, the we need to skip the
-                        // current token as we should allow a space before a
-                        // comment for readability.
-                        if (isset($tokens[($stackPtr + 1)]) === true
-                            && isset(Tokens::$commentTokens[$tokens[($stackPtr + 1)]['code']]) === true
-                        ) {
-                            continue;
-                        }
-                    }
-
-                    $tokenContent = '';
-                    if ($tokens[$stackPtr]['code'] === T_WHITESPACE) {
-                        if (isset($pattern[($i + 1)]) === false) {
-                            // This is the last token in the pattern, so just compare
-                            // the next token of content.
-                            $tokenContent = $tokens[$stackPtr]['content'];
-                        } else {
-                            // Get all the whitespace to the next token.
-                            $next = $phpcsFile->findNext(
-                                Tokens::$emptyTokens,
-                                $stackPtr,
-                                null,
-                                true
-                            );
-
-                            $tokenContent = $phpcsFile->getTokensAsString(
-                                $stackPtr,
-                                ($next - $stackPtr)
-                            );
-
-                            $lastAddedStackPtr = $stackPtr;
-                            $stackPtr          = $next;
-                        }//end if
-
-                        if ($stackPtr !== $lastAddedStackPtr) {
-                            $found .= $tokenContent;
-                        }
-                    } else {
-                        if ($stackPtr !== $lastAddedStackPtr) {
-                            $found            .= $tokens[$stackPtr]['content'];
-                            $lastAddedStackPtr = $stackPtr;
-                        }
-                    }//end if
-
-                    if (isset($pattern[($i + 1)]) === true
-                        && $pattern[($i + 1)]['type'] === 'skip'
-                    ) {
-                        // The next token is a skip token, so we just need to make
-                        // sure the whitespace we found has *at least* the
-                        // whitespace required.
-                        if (strpos($tokenContent, $pattern[$i]['value']) !== 0) {
-                            $hasError = true;
-                        }
-                    } else {
-                        if ($tokenContent !== $pattern[$i]['value']) {
-                            $hasError = true;
-                        }
-                    }
-                } else {
-                    // Check to see if this important token is the same as the
-                    // next important token in the pattern. If it is not, then
-                    // the pattern cannot be for this piece of code.
-                    $next = $phpcsFile->findNext(
-                        $ignoreTokens,
-                        $stackPtr,
-                        null,
-                        true
-                    );
-
-                    if ($next === false
-                        || $tokens[$next]['code'] !== $pattern[$i]['token']
-                    ) {
-                        // The next important token did not match the pattern.
-                        return false;
-                    }
-
-                    if ($lastAddedStackPtr !== null) {
-                        if (($tokens[$next]['code'] === T_OPEN_CURLY_BRACKET
-                            || $tokens[$next]['code'] === T_CLOSE_CURLY_BRACKET)
-                            && isset($tokens[$next]['scope_condition']) === true
-                            && $tokens[$next]['scope_condition'] > $lastAddedStackPtr
-                        ) {
-                            // This is a brace, but the owner of it is after the current
-                            // token, which means it does not belong to any token in
-                            // our pattern. This means the pattern is not for us.
-                            return false;
-                        }
-
-                        if (($tokens[$next]['code'] === T_OPEN_PARENTHESIS
-                            || $tokens[$next]['code'] === T_CLOSE_PARENTHESIS)
-                            && isset($tokens[$next]['parenthesis_owner']) === true
-                            && $tokens[$next]['parenthesis_owner'] > $lastAddedStackPtr
-                        ) {
-                            // This is a bracket, but the owner of it is after the current
-                            // token, which means it does not belong to any token in
-                            // our pattern. This means the pattern is not for us.
-                            return false;
-                        }
-                    }//end if
-
-                    // If we skipped past some whitespace tokens, then add them
-                    // to the found string.
-                    if (($next - $stackPtr) > 0) {
-                        $hasComment = false;
-                        for ($j = $stackPtr; $j < $next; $j++) {
-                            $found .= $tokens[$j]['content'];
-                            if (isset(Tokens::$commentTokens[$tokens[$j]['code']]) === true) {
-                                $hasComment = true;
-                            }
-                        }
-
-                        // If we are not ignoring comments, this additional
-                        // whitespace or comment is not allowed. If we are
-                        // ignoring comments, there needs to be at least one
-                        // comment for this to be allowed.
-                        if ($this->ignoreComments === false
-                            || ($this->ignoreComments === true
-                            && $hasComment === false)
-                        ) {
-                            $hasError = true;
-                        }
-
-                        // Even when ignoring comments, we are not allowed to include
-                        // newlines without the pattern specifying them, so
-                        // everything should be on the same line.
-                        if ($tokens[$next]['line'] !== $tokens[$stackPtr]['line']) {
-                            $hasError = true;
-                        }
-                    }//end if
-
-                    if ($next !== $lastAddedStackPtr) {
-                        $found            .= $tokens[$next]['content'];
-                        $lastAddedStackPtr = $next;
-                    }
-
-                    if (isset($pattern[($i + 1)]) === true
-                        && $pattern[($i + 1)]['type'] === 'skip'
-                    ) {
-                        $stackPtr = $next;
-                    } else {
-                        $stackPtr = ($next + 1);
-                    }
-                }//end if
-            } else if ($pattern[$i]['type'] === 'skip') {
-                if ($pattern[$i]['to'] === 'unknown') {
-                    $next = $phpcsFile->findNext(
-                        $pattern[($i + 1)]['token'],
-                        $stackPtr
-                    );
-
-                    if ($next === false) {
-                        // Couldn't find the next token, so we must
-                        // be using the wrong pattern.
-                        return false;
-                    }
-
-                    $found   .= '...';
-                    $stackPtr = $next;
-                } else {
-                    // Find the previous opener.
-                    $next = $phpcsFile->findPrevious(
-                        Tokens::$blockOpeners,
-                        $stackPtr
-                    );
-
-                    if ($next === false
-                        || isset($tokens[$next][$pattern[$i]['to']]) === false
-                    ) {
-                        // If there was not opener, then we must
-                        // be using the wrong pattern.
-                        return false;
-                    }
-
-                    $found .= '...';
-                    if ($pattern[$i]['to'] === 'parenthesis_closer') {
-                        $found .= ')';
-                    } else {
-                        $found .= '}';
-                    }
-
-                    // Skip to the closing token.
-                    $stackPtr = ($tokens[$next][$pattern[$i]['to']] + 1);
-                }//end if
-            } else if ($pattern[$i]['type'] === 'string') {
-                if ($tokens[$stackPtr]['code'] !== T_STRING) {
-                    $hasError = true;
-                }
-
-                if ($stackPtr !== $lastAddedStackPtr) {
-                    $found            .= 'abc';
-                    $lastAddedStackPtr = $stackPtr;
-                }
-
-                $stackPtr++;
-            } else if ($pattern[$i]['type'] === 'newline') {
-                // Find the next token that contains a newline character.
-                $newline = 0;
-                for ($j = $stackPtr; $j < $phpcsFile->numTokens; $j++) {
-                    if (strpos($tokens[$j]['content'], $phpcsFile->eolChar) !== false) {
-                        $newline = $j;
-                        break;
-                    }
-                }
-
-                if ($newline === 0) {
-                    // We didn't find a newline character in the rest of the file.
-                    $next     = ($phpcsFile->numTokens - 1);
-                    $hasError = true;
-                } else {
-                    if ($this->ignoreComments === false) {
-                        // The newline character cannot be part of a comment.
-                        if (isset(Tokens::$commentTokens[$tokens[$newline]['code']]) === true) {
-                            $hasError = true;
-                        }
-                    }
-
-                    if ($newline === $stackPtr) {
-                        $next = ($stackPtr + 1);
-                    } else {
-                        // Check that there were no significant tokens that we
-                        // skipped over to find our newline character.
-                        $next = $phpcsFile->findNext(
-                            $ignoreTokens,
-                            $stackPtr,
-                            null,
-                            true
-                        );
-
-                        if ($next < $newline) {
-                            // We skipped a non-ignored token.
-                            $hasError = true;
-                        } else {
-                            $next = ($newline + 1);
-                        }
-                    }
-                }//end if
-
-                if ($stackPtr !== $lastAddedStackPtr) {
-                    $found .= $phpcsFile->getTokensAsString(
-                        $stackPtr,
-                        ($next - $stackPtr)
-                    );
-
-                    $lastAddedStackPtr = ($next - 1);
-                }
-
-                $stackPtr = $next;
-            }//end if
-        }//end for
-
-        if ($hasError === true) {
-            $error = $this->prepareError($found, $patternCode);
-            $errors[$origStackPtr] = $error;
-        }
-
-        return $errors;
-
-    }//end processPattern()
-
-
-    /**
-     * Prepares an error for the specified patternCode.
-     *
-     * @param string $found       The actual found string in the code.
-     * @param string $patternCode The expected pattern code.
-     *
-     * @return string The error message.
-     */
-    protected function prepareError($found, $patternCode)
-    {
-        $found    = str_replace("\r\n", '\n', $found);
-        $found    = str_replace("\n", '\n', $found);
-        $found    = str_replace("\r", '\n', $found);
-        $found    = str_replace("\t", '\t', $found);
-        $found    = str_replace('EOL', '\n', $found);
-        $expected = str_replace('EOL', '\n', $patternCode);
-
-        $error = "Expected \"$expected\"; found \"$found\"";
-
-        return $error;
-
-    }//end prepareError()
-
-
-    /**
-     * Returns the patterns that should be checked.
-     *
-     * @return string[]
-     */
-    abstract protected function getPatterns();
-
-
-    /**
-     * Registers any supplementary tokens that this test might wish to process.
-     *
-     * A sniff may wish to register supplementary tests when it wishes to group
-     * an arbitrary validation that cannot be performed using a pattern, with
-     * other pattern tests.
-     *
-     * @return int[]
-     * @see    processSupplementary()
-     */
-    protected function registerSupplementary()
-    {
-        return [];
-
-    }//end registerSupplementary()
-
-
-     /**
-      * Processes any tokens registered with registerSupplementary().
-      *
-      * @param \PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where to
-      *                                               process the skip.
-      * @param int                         $stackPtr  The position in the tokens stack to
-      *                                               process.
-      *
-      * @return void
-      * @see    registerSupplementary()
-      */
-    protected function processSupplementary(File $phpcsFile, $stackPtr)
-    {
-
-    }//end processSupplementary()
-
-
-    /**
-     * Parses a pattern string into an array of pattern steps.
-     *
-     * @param string $pattern The pattern to parse.
-     *
-     * @return array The parsed pattern array.
-     * @see    createSkipPattern()
-     * @see    createTokenPattern()
-     */
-    private function parse($pattern)
-    {
-        $patterns   = [];
-        $length     = strlen($pattern);
-        $lastToken  = 0;
-        $firstToken = 0;
-
-        for ($i = 0; $i < $length; $i++) {
-            $specialPattern = false;
-            $isLastChar     = ($i === ($length - 1));
-            $oldFirstToken  = $firstToken;
-
-            if (substr($pattern, $i, 3) === '...') {
-                // It's a skip pattern. The skip pattern requires the
-                // content of the token in the "from" position and the token
-                // to skip to.
-                $specialPattern = $this->createSkipPattern($pattern, ($i - 1));
-                $lastToken      = ($i - $firstToken);
-                $firstToken     = ($i + 3);
-                $i += 2;
-
-                if ($specialPattern['to'] !== 'unknown') {
-                    $firstToken++;
-                }
-            } else if (substr($pattern, $i, 3) === 'abc') {
-                $specialPattern = ['type' => 'string'];
-                $lastToken      = ($i - $firstToken);
-                $firstToken     = ($i + 3);
-                $i += 2;
-            } else if (substr($pattern, $i, 3) === 'EOL') {
-                $specialPattern = ['type' => 'newline'];
-                $lastToken      = ($i - $firstToken);
-                $firstToken     = ($i + 3);
-                $i += 2;
-            }//end if
-
-            if ($specialPattern !== false || $isLastChar === true) {
-                // If we are at the end of the string, don't worry about a limit.
-                if ($isLastChar === true) {
-                    // Get the string from the end of the last skip pattern, if any,
-                    // to the end of the pattern string.
-                    $str = substr($pattern, $oldFirstToken);
-                } else {
-                    // Get the string from the end of the last special pattern,
-                    // if any, to the start of this special pattern.
-                    if ($lastToken === 0) {
-                        // Note that if the last special token was zero characters ago,
-                        // there will be nothing to process so we can skip this bit.
-                        // This happens if you have something like: EOL... in your pattern.
-                        $str = '';
-                    } else {
-                        $str = substr($pattern, $oldFirstToken, $lastToken);
-                    }
-                }
-
-                if ($str !== '') {
-                    $tokenPatterns = $this->createTokenPattern($str);
-                    foreach ($tokenPatterns as $tokenPattern) {
-                        $patterns[] = $tokenPattern;
-                    }
-                }
-
-                // Make sure we don't skip the last token.
-                if ($isLastChar === false && $i === ($length - 1)) {
-                    $i--;
-                }
-            }//end if
-
-            // Add the skip pattern *after* we have processed
-            // all the tokens from the end of the last skip pattern
-            // to the start of this skip pattern.
-            if ($specialPattern !== false) {
-                $patterns[] = $specialPattern;
-            }
-        }//end for
-
-        return $patterns;
-
-    }//end parse()
-
-
-    /**
-     * Creates a skip pattern.
-     *
-     * @param string $pattern The pattern being parsed.
-     * @param string $from    The token content that the skip pattern starts from.
-     *
-     * @return array The pattern step.
-     * @see    createTokenPattern()
-     * @see    parse()
-     */
-    private function createSkipPattern($pattern, $from)
-    {
-        $skip = ['type' => 'skip'];
-
-        $nestedParenthesis = 0;
-        $nestedBraces      = 0;
-        for ($start = $from; $start >= 0; $start--) {
-            switch ($pattern[$start]) {
-            case '(':
-                if ($nestedParenthesis === 0) {
-                    $skip['to'] = 'parenthesis_closer';
-                }
-
-                $nestedParenthesis--;
-                break;
-            case '{':
-                if ($nestedBraces === 0) {
-                    $skip['to'] = 'scope_closer';
-                }
-
-                $nestedBraces--;
-                break;
-            case '}':
-                $nestedBraces++;
-                break;
-            case ')':
-                $nestedParenthesis++;
-                break;
-            }//end switch
-
-            if (isset($skip['to']) === true) {
-                break;
-            }
-        }//end for
-
-        if (isset($skip['to']) === false) {
-            $skip['to'] = 'unknown';
-        }
-
-        return $skip;
-
-    }//end createSkipPattern()
-
-
-    /**
-     * Creates a token pattern.
-     *
-     * @param string $str The tokens string that the pattern should match.
-     *
-     * @return array The pattern step.
-     * @see    createSkipPattern()
-     * @see    parse()
-     */
-    private function createTokenPattern($str)
-    {
-        // Don't add a space after the closing php tag as it will add a new
-        // whitespace token.
-        $tokenizer = new PHP('<?php '.$str.'?>', null);
-
-        // Remove the <?php tag from the front and the end php tag from the back.
-        $tokens = $tokenizer->getTokens();
-        $tokens = array_slice($tokens, 1, (count($tokens) - 2));
-
-        $patterns = [];
-        foreach ($tokens as $patternInfo) {
-            $patterns[] = [
-                'type'  => 'token',
-                'token' => $patternInfo['code'],
-                'value' => $patternInfo['content'],
-            ];
-        }
-
-        return $patterns;
-
-    }//end createTokenPattern()
+	/**
+	 * If true, comments will be ignored if they are found in the code.
+	 *
+	 * @var boolean
+	 */
+	public $ignoreComments = false;
+
+	/**
+	 * The current file being checked.
+	 *
+	 * @var string
+	 */
+	protected $currFile = '';
+
+	/**
+	 * The parsed patterns array.
+	 *
+	 * @var array
+	 */
+	private $parsedPatterns = [];
+
+	/**
+	 * Tokens that this sniff wishes to process outside of the patterns.
+	 *
+	 * @var int[]
+	 * @see registerSupplementary()
+	 * @see processSupplementary()
+	 */
+	private $supplementaryTokens = [];
+
+	/**
+	 * Positions in the stack where errors have occurred.
+	 *
+	 * @var array<int, bool>
+	 */
+	private $errorPos = [];
+
+
+	/**
+	 * Constructs a AbstractPatternSniff.
+	 *
+	 * @param boolean $ignoreComments If true, comments will be ignored.
+	 */
+	public function __construct($ignoreComments=null)
+	{
+		// This is here for backwards compatibility.
+		if ($ignoreComments !== null) {
+			$this->ignoreComments = $ignoreComments;
+		}
+
+		$this->supplementaryTokens = $this->registerSupplementary();
+
+	}//end __construct()
+
+
+	/**
+	 * Registers the tokens to listen to.
+	 *
+	 * Classes extending <i>AbstractPatternTest</i> should implement the
+	 * <i>getPatterns()</i> method to register the patterns they wish to test.
+	 *
+	 * @return int[]
+	 * @see    process()
+	 */
+	final public function register()
+	{
+		$listenTypes = [];
+		$patterns    = $this->getPatterns();
+
+		foreach ($patterns as $pattern) {
+			$parsedPattern = $this->parse($pattern);
+
+			// Find a token position in the pattern that we can use
+			// for a listener token.
+			$pos           = $this->getListenerTokenPos($parsedPattern);
+			$tokenType     = $parsedPattern[$pos]['token'];
+			$listenTypes[] = $tokenType;
+
+			$patternArray = [
+				'listen_pos'   => $pos,
+				'pattern'      => $parsedPattern,
+				'pattern_code' => $pattern,
+			];
+
+			if (isset($this->parsedPatterns[$tokenType]) === false) {
+				$this->parsedPatterns[$tokenType] = [];
+			}
+
+			$this->parsedPatterns[$tokenType][] = $patternArray;
+		}//end foreach
+
+		return array_unique(array_merge($listenTypes, $this->supplementaryTokens));
+
+	}//end register()
+
+
+	/**
+	 * Returns the token types that the specified pattern is checking for.
+	 *
+	 * Returned array is in the format:
+	 * <code>
+	 *   array(
+	 *      T_WHITESPACE => 0, // 0 is the position where the T_WHITESPACE token
+	 *                         // should occur in the pattern.
+	 *   );
+	 * </code>
+	 *
+	 * @param array $pattern The parsed pattern to find the acquire the token
+	 *                       types from.
+	 *
+	 * @return array<int, int>
+	 */
+	private function getPatternTokenTypes($pattern)
+	{
+		$tokenTypes = [];
+		foreach ($pattern as $pos => $patternInfo) {
+			if ($patternInfo['type'] === 'token') {
+				if (isset($tokenTypes[$patternInfo['token']]) === false) {
+					$tokenTypes[$patternInfo['token']] = $pos;
+				}
+			}
+		}
+
+		return $tokenTypes;
+
+	}//end getPatternTokenTypes()
+
+
+	/**
+	 * Returns the position in the pattern that this test should register as
+	 * a listener for the pattern.
+	 *
+	 * @param array $pattern The pattern to acquire the listener for.
+	 *
+	 * @return int The position in the pattern that this test should register
+	 *             as the listener.
+	 * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If we could not determine a token to listen for.
+	 */
+	private function getListenerTokenPos($pattern)
+	{
+		$tokenTypes = $this->getPatternTokenTypes($pattern);
+		$tokenCodes = array_keys($tokenTypes);
+		$token      = Tokens::getHighestWeightedToken($tokenCodes);
+
+		// If we could not get a token.
+		if ($token === false) {
+			$error = 'Could not determine a token to listen for';
+			throw new RuntimeException($error);
+		}
+
+		return $tokenTypes[$token];
+
+	}//end getListenerTokenPos()
+
+
+	/**
+	 * Processes the test.
+	 *
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where the
+	 *                                               token occurred.
+	 * @param int                         $stackPtr  The position in the tokens stack
+	 *                                               where the listening token type
+	 *                                               was found.
+	 *
+	 * @return void
+	 * @see    register()
+	 */
+	final public function process(File $phpcsFile, $stackPtr)
+	{
+		$file = $phpcsFile->getFilename();
+		if ($this->currFile !== $file) {
+			// We have changed files, so clean up.
+			$this->errorPos = [];
+			$this->currFile = $file;
+		}
+
+		$tokens = $phpcsFile->getTokens();
+
+		if (in_array($tokens[$stackPtr]['code'], $this->supplementaryTokens, true) === true) {
+			$this->processSupplementary($phpcsFile, $stackPtr);
+		}
+
+		$type = $tokens[$stackPtr]['code'];
+
+		// If the type is not set, then it must have been a token registered
+		// with registerSupplementary().
+		if (isset($this->parsedPatterns[$type]) === false) {
+			return;
+		}
+
+		$allErrors = [];
+
+		// Loop over each pattern that is listening to the current token type
+		// that we are processing.
+		foreach ($this->parsedPatterns[$type] as $patternInfo) {
+			// If processPattern returns false, then the pattern that we are
+			// checking the code with must not be designed to check that code.
+			$errors = $this->processPattern($patternInfo, $phpcsFile, $stackPtr);
+			if ($errors === false) {
+				// The pattern didn't match.
+				continue;
+			} else if (empty($errors) === true) {
+				// The pattern matched, but there were no errors.
+				break;
+			}
+
+			foreach ($errors as $stackPtr => $error) {
+				if (isset($this->errorPos[$stackPtr]) === false) {
+					$this->errorPos[$stackPtr] = true;
+					$allErrors[$stackPtr]      = $error;
+				}
+			}
+		}
+
+		foreach ($allErrors as $stackPtr => $error) {
+			$phpcsFile->addError($error, $stackPtr, 'Found');
+		}
+
+	}//end process()
+
+
+	/**
+	 * Processes the pattern and verifies the code at $stackPtr.
+	 *
+	 * @param array                       $patternInfo Information about the pattern used
+	 *                                                 for checking, which includes are
+	 *                                                 parsed token representation of the
+	 *                                                 pattern.
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile   The PHP_CodeSniffer file where the
+	 *                                                 token occurred.
+	 * @param int                         $stackPtr    The position in the tokens stack where
+	 *                                                 the listening token type was found.
+	 *
+	 * @return array
+	 */
+	protected function processPattern($patternInfo, File $phpcsFile, $stackPtr)
+	{
+		$tokens      = $phpcsFile->getTokens();
+		$pattern     = $patternInfo['pattern'];
+		$patternCode = $patternInfo['pattern_code'];
+		$errors      = [];
+		$found       = '';
+
+		$ignoreTokens = [T_WHITESPACE => T_WHITESPACE];
+		if ($this->ignoreComments === true) {
+			$ignoreTokens += Tokens::$commentTokens;
+		}
+
+		$origStackPtr = $stackPtr;
+		$hasError     = false;
+
+		if ($patternInfo['listen_pos'] > 0) {
+			$stackPtr--;
+
+			for ($i = ($patternInfo['listen_pos'] - 1); $i >= 0; $i--) {
+				if ($pattern[$i]['type'] === 'token') {
+					if ($pattern[$i]['token'] === T_WHITESPACE) {
+						if ($tokens[$stackPtr]['code'] === T_WHITESPACE) {
+							$found = $tokens[$stackPtr]['content'].$found;
+						}
+
+						// Only check the size of the whitespace if this is not
+						// the first token. We don't care about the size of
+						// leading whitespace, just that there is some.
+						if ($i !== 0) {
+							if ($tokens[$stackPtr]['content'] !== $pattern[$i]['value']) {
+								$hasError = true;
+							}
+						}
+					} else {
+						// Check to see if this important token is the same as the
+						// previous important token in the pattern. If it is not,
+						// then the pattern cannot be for this piece of code.
+						$prev = $phpcsFile->findPrevious(
+							$ignoreTokens,
+							$stackPtr,
+							null,
+							true
+						);
+
+						if ($prev === false
+							|| $tokens[$prev]['code'] !== $pattern[$i]['token']
+						) {
+							return false;
+						}
+
+						// If we skipped past some whitespace tokens, then add them
+						// to the found string.
+						$tokenContent = $phpcsFile->getTokensAsString(
+							($prev + 1),
+							($stackPtr - $prev - 1)
+						);
+
+						$found = $tokens[$prev]['content'].$tokenContent.$found;
+
+						if (isset($pattern[($i - 1)]) === true
+							&& $pattern[($i - 1)]['type'] === 'skip'
+						) {
+							$stackPtr = $prev;
+						} else {
+							$stackPtr = ($prev - 1);
+						}
+					}//end if
+				} else if ($pattern[$i]['type'] === 'skip') {
+					// Skip to next piece of relevant code.
+					if ($pattern[$i]['to'] === 'parenthesis_closer') {
+						$to = 'parenthesis_opener';
+					} else {
+						$to = 'scope_opener';
+					}
+
+					// Find the previous opener.
+					$next = $phpcsFile->findPrevious(
+						$ignoreTokens,
+						$stackPtr,
+						null,
+						true
+					);
+
+					if ($next === false || isset($tokens[$next][$to]) === false) {
+						// If there was not opener, then we must be
+						// using the wrong pattern.
+						return false;
+					}
+
+					if ($to === 'parenthesis_opener') {
+						$found = '{'.$found;
+					} else {
+						$found = '('.$found;
+					}
+
+					$found = '...'.$found;
+
+					// Skip to the opening token.
+					$stackPtr = ($tokens[$next][$to] - 1);
+				} else if ($pattern[$i]['type'] === 'string') {
+					$found = 'abc';
+				} else if ($pattern[$i]['type'] === 'newline') {
+					if ($this->ignoreComments === true
+						&& isset(Tokens::$commentTokens[$tokens[$stackPtr]['code']]) === true
+					) {
+						$startComment = $phpcsFile->findPrevious(
+							Tokens::$commentTokens,
+							($stackPtr - 1),
+							null,
+							true
+						);
+
+						if ($tokens[$startComment]['line'] !== $tokens[($startComment + 1)]['line']) {
+							$startComment++;
+						}
+
+						$tokenContent = $phpcsFile->getTokensAsString(
+							$startComment,
+							($stackPtr - $startComment + 1)
+						);
+
+						$found    = $tokenContent.$found;
+						$stackPtr = ($startComment - 1);
+					}
+
+					if ($tokens[$stackPtr]['code'] === T_WHITESPACE) {
+						if ($tokens[$stackPtr]['content'] !== $phpcsFile->eolChar) {
+							$found = $tokens[$stackPtr]['content'].$found;
+
+							// This may just be an indent that comes after a newline
+							// so check the token before to make sure. If it is a newline, we
+							// can ignore the error here.
+							if (($tokens[($stackPtr - 1)]['content'] !== $phpcsFile->eolChar)
+								&& ($this->ignoreComments === true
+								&& isset(Tokens::$commentTokens[$tokens[($stackPtr - 1)]['code']]) === false)
+							) {
+								$hasError = true;
+							} else {
+								$stackPtr--;
+							}
+						} else {
+							$found = 'EOL'.$found;
+						}
+					} else {
+						$found    = $tokens[$stackPtr]['content'].$found;
+						$hasError = true;
+					}//end if
+
+					if ($hasError === false && $pattern[($i - 1)]['type'] !== 'newline') {
+						// Make sure they only have 1 newline.
+						$prev = $phpcsFile->findPrevious($ignoreTokens, ($stackPtr - 1), null, true);
+						if ($prev !== false && $tokens[$prev]['line'] !== $tokens[$stackPtr]['line']) {
+							$hasError = true;
+						}
+					}
+				}//end if
+			}//end for
+		}//end if
+
+		$stackPtr          = $origStackPtr;
+		$lastAddedStackPtr = null;
+		$patternLen        = count($pattern);
+
+		for ($i = $patternInfo['listen_pos']; $i < $patternLen; $i++) {
+			if (isset($tokens[$stackPtr]) === false) {
+				break;
+			}
+
+			if ($pattern[$i]['type'] === 'token') {
+				if ($pattern[$i]['token'] === T_WHITESPACE) {
+					if ($this->ignoreComments === true) {
+						// If we are ignoring comments, check to see if this current
+						// token is a comment. If so skip it.
+						if (isset(Tokens::$commentTokens[$tokens[$stackPtr]['code']]) === true) {
+							continue;
+						}
+
+						// If the next token is a comment, the we need to skip the
+						// current token as we should allow a space before a
+						// comment for readability.
+						if (isset($tokens[($stackPtr + 1)]) === true
+							&& isset(Tokens::$commentTokens[$tokens[($stackPtr + 1)]['code']]) === true
+						) {
+							continue;
+						}
+					}
+
+					$tokenContent = '';
+					if ($tokens[$stackPtr]['code'] === T_WHITESPACE) {
+						if (isset($pattern[($i + 1)]) === false) {
+							// This is the last token in the pattern, so just compare
+							// the next token of content.
+							$tokenContent = $tokens[$stackPtr]['content'];
+						} else {
+							// Get all the whitespace to the next token.
+							$next = $phpcsFile->findNext(
+								Tokens::$emptyTokens,
+								$stackPtr,
+								null,
+								true
+							);
+
+							$tokenContent = $phpcsFile->getTokensAsString(
+								$stackPtr,
+								($next - $stackPtr)
+							);
+
+							$lastAddedStackPtr = $stackPtr;
+							$stackPtr          = $next;
+						}//end if
+
+						if ($stackPtr !== $lastAddedStackPtr) {
+							$found .= $tokenContent;
+						}
+					} else {
+						if ($stackPtr !== $lastAddedStackPtr) {
+							$found            .= $tokens[$stackPtr]['content'];
+							$lastAddedStackPtr = $stackPtr;
+						}
+					}//end if
+
+					if (isset($pattern[($i + 1)]) === true
+						&& $pattern[($i + 1)]['type'] === 'skip'
+					) {
+						// The next token is a skip token, so we just need to make
+						// sure the whitespace we found has *at least* the
+						// whitespace required.
+						if (strpos($tokenContent, $pattern[$i]['value']) !== 0) {
+							$hasError = true;
+						}
+					} else {
+						if ($tokenContent !== $pattern[$i]['value']) {
+							$hasError = true;
+						}
+					}
+				} else {
+					// Check to see if this important token is the same as the
+					// next important token in the pattern. If it is not, then
+					// the pattern cannot be for this piece of code.
+					$next = $phpcsFile->findNext(
+						$ignoreTokens,
+						$stackPtr,
+						null,
+						true
+					);
+
+					if ($next === false
+						|| $tokens[$next]['code'] !== $pattern[$i]['token']
+					) {
+						// The next important token did not match the pattern.
+						return false;
+					}
+
+					if ($lastAddedStackPtr !== null) {
+						if (($tokens[$next]['code'] === T_OPEN_CURLY_BRACKET
+							|| $tokens[$next]['code'] === T_CLOSE_CURLY_BRACKET)
+							&& isset($tokens[$next]['scope_condition']) === true
+							&& $tokens[$next]['scope_condition'] > $lastAddedStackPtr
+						) {
+							// This is a brace, but the owner of it is after the current
+							// token, which means it does not belong to any token in
+							// our pattern. This means the pattern is not for us.
+							return false;
+						}
+
+						if (($tokens[$next]['code'] === T_OPEN_PARENTHESIS
+							|| $tokens[$next]['code'] === T_CLOSE_PARENTHESIS)
+							&& isset($tokens[$next]['parenthesis_owner']) === true
+							&& $tokens[$next]['parenthesis_owner'] > $lastAddedStackPtr
+						) {
+							// This is a bracket, but the owner of it is after the current
+							// token, which means it does not belong to any token in
+							// our pattern. This means the pattern is not for us.
+							return false;
+						}
+					}//end if
+
+					// If we skipped past some whitespace tokens, then add them
+					// to the found string.
+					if (($next - $stackPtr) > 0) {
+						$hasComment = false;
+						for ($j = $stackPtr; $j < $next; $j++) {
+							$found .= $tokens[$j]['content'];
+							if (isset(Tokens::$commentTokens[$tokens[$j]['code']]) === true) {
+								$hasComment = true;
+							}
+						}
+
+						// If we are not ignoring comments, this additional
+						// whitespace or comment is not allowed. If we are
+						// ignoring comments, there needs to be at least one
+						// comment for this to be allowed.
+						if ($this->ignoreComments === false
+							|| ($this->ignoreComments === true
+							&& $hasComment === false)
+						) {
+							$hasError = true;
+						}
+
+						// Even when ignoring comments, we are not allowed to include
+						// newlines without the pattern specifying them, so
+						// everything should be on the same line.
+						if ($tokens[$next]['line'] !== $tokens[$stackPtr]['line']) {
+							$hasError = true;
+						}
+					}//end if
+
+					if ($next !== $lastAddedStackPtr) {
+						$found            .= $tokens[$next]['content'];
+						$lastAddedStackPtr = $next;
+					}
+
+					if (isset($pattern[($i + 1)]) === true
+						&& $pattern[($i + 1)]['type'] === 'skip'
+					) {
+						$stackPtr = $next;
+					} else {
+						$stackPtr = ($next + 1);
+					}
+				}//end if
+			} else if ($pattern[$i]['type'] === 'skip') {
+				if ($pattern[$i]['to'] === 'unknown') {
+					$next = $phpcsFile->findNext(
+						$pattern[($i + 1)]['token'],
+						$stackPtr
+					);
+
+					if ($next === false) {
+						// Couldn't find the next token, so we must
+						// be using the wrong pattern.
+						return false;
+					}
+
+					$found   .= '...';
+					$stackPtr = $next;
+				} else {
+					// Find the previous opener.
+					$next = $phpcsFile->findPrevious(
+						Tokens::$blockOpeners,
+						$stackPtr
+					);
+
+					if ($next === false
+						|| isset($tokens[$next][$pattern[$i]['to']]) === false
+					) {
+						// If there was not opener, then we must
+						// be using the wrong pattern.
+						return false;
+					}
+
+					$found .= '...';
+					if ($pattern[$i]['to'] === 'parenthesis_closer') {
+						$found .= ')';
+					} else {
+						$found .= '}';
+					}
+
+					// Skip to the closing token.
+					$stackPtr = ($tokens[$next][$pattern[$i]['to']] + 1);
+				}//end if
+			} else if ($pattern[$i]['type'] === 'string') {
+				if ($tokens[$stackPtr]['code'] !== T_STRING) {
+					$hasError = true;
+				}
+
+				if ($stackPtr !== $lastAddedStackPtr) {
+					$found            .= 'abc';
+					$lastAddedStackPtr = $stackPtr;
+				}
+
+				$stackPtr++;
+			} else if ($pattern[$i]['type'] === 'newline') {
+				// Find the next token that contains a newline character.
+				$newline = 0;
+				for ($j = $stackPtr; $j < $phpcsFile->numTokens; $j++) {
+					if (strpos($tokens[$j]['content'], $phpcsFile->eolChar) !== false) {
+						$newline = $j;
+						break;
+					}
+				}
+
+				if ($newline === 0) {
+					// We didn't find a newline character in the rest of the file.
+					$next     = ($phpcsFile->numTokens - 1);
+					$hasError = true;
+				} else {
+					if ($this->ignoreComments === false) {
+						// The newline character cannot be part of a comment.
+						if (isset(Tokens::$commentTokens[$tokens[$newline]['code']]) === true) {
+							$hasError = true;
+						}
+					}
+
+					if ($newline === $stackPtr) {
+						$next = ($stackPtr + 1);
+					} else {
+						// Check that there were no significant tokens that we
+						// skipped over to find our newline character.
+						$next = $phpcsFile->findNext(
+							$ignoreTokens,
+							$stackPtr,
+							null,
+							true
+						);
+
+						if ($next < $newline) {
+							// We skipped a non-ignored token.
+							$hasError = true;
+						} else {
+							$next = ($newline + 1);
+						}
+					}
+				}//end if
+
+				if ($stackPtr !== $lastAddedStackPtr) {
+					$found .= $phpcsFile->getTokensAsString(
+						$stackPtr,
+						($next - $stackPtr)
+					);
+
+					$lastAddedStackPtr = ($next - 1);
+				}
+
+				$stackPtr = $next;
+			}//end if
+		}//end for
+
+		if ($hasError === true) {
+			$error = $this->prepareError($found, $patternCode);
+			$errors[$origStackPtr] = $error;
+		}
+
+		return $errors;
+
+	}//end processPattern()
+
+
+	/**
+	 * Prepares an error for the specified patternCode.
+	 *
+	 * @param string $found       The actual found string in the code.
+	 * @param string $patternCode The expected pattern code.
+	 *
+	 * @return string The error message.
+	 */
+	protected function prepareError($found, $patternCode)
+	{
+		$found    = str_replace("\r\n", '\n', $found);
+		$found    = str_replace("\n", '\n', $found);
+		$found    = str_replace("\r", '\n', $found);
+		$found    = str_replace("\t", '\t', $found);
+		$found    = str_replace('EOL', '\n', $found);
+		$expected = str_replace('EOL', '\n', $patternCode);
+
+		$error = "Expected \"$expected\"; found \"$found\"";
+
+		return $error;
+
+	}//end prepareError()
+
+
+	/**
+	 * Returns the patterns that should be checked.
+	 *
+	 * @return string[]
+	 */
+	abstract protected function getPatterns();
+
+
+	/**
+	 * Registers any supplementary tokens that this test might wish to process.
+	 *
+	 * A sniff may wish to register supplementary tests when it wishes to group
+	 * an arbitrary validation that cannot be performed using a pattern, with
+	 * other pattern tests.
+	 *
+	 * @return int[]
+	 * @see    processSupplementary()
+	 */
+	protected function registerSupplementary()
+	{
+		return [];
+
+	}//end registerSupplementary()
+
+
+	 /**
+	  * Processes any tokens registered with registerSupplementary().
+	  *
+	  * @param \PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where to
+	  *                                               process the skip.
+	  * @param int                         $stackPtr  The position in the tokens stack to
+	  *                                               process.
+	  *
+	  * @return void
+	  * @see    registerSupplementary()
+	  */
+	protected function processSupplementary(File $phpcsFile, $stackPtr)
+	{
+
+	}//end processSupplementary()
+
+
+	/**
+	 * Parses a pattern string into an array of pattern steps.
+	 *
+	 * @param string $pattern The pattern to parse.
+	 *
+	 * @return array The parsed pattern array.
+	 * @see    createSkipPattern()
+	 * @see    createTokenPattern()
+	 */
+	private function parse($pattern)
+	{
+		$patterns   = [];
+		$length     = strlen($pattern);
+		$lastToken  = 0;
+		$firstToken = 0;
+
+		for ($i = 0; $i < $length; $i++) {
+			$specialPattern = false;
+			$isLastChar     = ($i === ($length - 1));
+			$oldFirstToken  = $firstToken;
+
+			if (substr($pattern, $i, 3) === '...') {
+				// It's a skip pattern. The skip pattern requires the
+				// content of the token in the "from" position and the token
+				// to skip to.
+				$specialPattern = $this->createSkipPattern($pattern, ($i - 1));
+				$lastToken      = ($i - $firstToken);
+				$firstToken     = ($i + 3);
+				$i += 2;
+
+				if ($specialPattern['to'] !== 'unknown') {
+					$firstToken++;
+				}
+			} else if (substr($pattern, $i, 3) === 'abc') {
+				$specialPattern = ['type' => 'string'];
+				$lastToken      = ($i - $firstToken);
+				$firstToken     = ($i + 3);
+				$i += 2;
+			} else if (substr($pattern, $i, 3) === 'EOL') {
+				$specialPattern = ['type' => 'newline'];
+				$lastToken      = ($i - $firstToken);
+				$firstToken     = ($i + 3);
+				$i += 2;
+			}//end if
+
+			if ($specialPattern !== false || $isLastChar === true) {
+				// If we are at the end of the string, don't worry about a limit.
+				if ($isLastChar === true) {
+					// Get the string from the end of the last skip pattern, if any,
+					// to the end of the pattern string.
+					$str = substr($pattern, $oldFirstToken);
+				} else {
+					// Get the string from the end of the last special pattern,
+					// if any, to the start of this special pattern.
+					if ($lastToken === 0) {
+						// Note that if the last special token was zero characters ago,
+						// there will be nothing to process so we can skip this bit.
+						// This happens if you have something like: EOL... in your pattern.
+						$str = '';
+					} else {
+						$str = substr($pattern, $oldFirstToken, $lastToken);
+					}
+				}
+
+				if ($str !== '') {
+					$tokenPatterns = $this->createTokenPattern($str);
+					foreach ($tokenPatterns as $tokenPattern) {
+						$patterns[] = $tokenPattern;
+					}
+				}
+
+				// Make sure we don't skip the last token.
+				if ($isLastChar === false && $i === ($length - 1)) {
+					$i--;
+				}
+			}//end if
+
+			// Add the skip pattern *after* we have processed
+			// all the tokens from the end of the last skip pattern
+			// to the start of this skip pattern.
+			if ($specialPattern !== false) {
+				$patterns[] = $specialPattern;
+			}
+		}//end for
+
+		return $patterns;
+
+	}//end parse()
+
+
+	/**
+	 * Creates a skip pattern.
+	 *
+	 * @param string $pattern The pattern being parsed.
+	 * @param string $from    The token content that the skip pattern starts from.
+	 *
+	 * @return array The pattern step.
+	 * @see    createTokenPattern()
+	 * @see    parse()
+	 */
+	private function createSkipPattern($pattern, $from)
+	{
+		$skip = ['type' => 'skip'];
+
+		$nestedParenthesis = 0;
+		$nestedBraces      = 0;
+		for ($start = $from; $start >= 0; $start--) {
+			switch ($pattern[$start]) {
+			case '(':
+				if ($nestedParenthesis === 0) {
+					$skip['to'] = 'parenthesis_closer';
+				}
+
+				$nestedParenthesis--;
+				break;
+			case '{':
+				if ($nestedBraces === 0) {
+					$skip['to'] = 'scope_closer';
+				}
+
+				$nestedBraces--;
+				break;
+			case '}':
+				$nestedBraces++;
+				break;
+			case ')':
+				$nestedParenthesis++;
+				break;
+			}//end switch
+
+			if (isset($skip['to']) === true) {
+				break;
+			}
+		}//end for
+
+		if (isset($skip['to']) === false) {
+			$skip['to'] = 'unknown';
+		}
+
+		return $skip;
+
+	}//end createSkipPattern()
+
+
+	/**
+	 * Creates a token pattern.
+	 *
+	 * @param string $str The tokens string that the pattern should match.
+	 *
+	 * @return array The pattern step.
+	 * @see    createSkipPattern()
+	 * @see    parse()
+	 */
+	private function createTokenPattern($str)
+	{
+		// Don't add a space after the closing php tag as it will add a new
+		// whitespace token.
+		$tokenizer = new PHP('<?php '.$str.'?>', null);
+
+		// Remove the <?php tag from the front and the end php tag from the back.
+		$tokens = $tokenizer->getTokens();
+		$tokens = array_slice($tokens, 1, (count($tokens) - 2));
+
+		$patterns = [];
+		foreach ($tokens as $patternInfo) {
+			$patterns[] = [
+				'type'  => 'token',
+				'token' => $patternInfo['code'],
+				'value' => $patternInfo['content'],
+			];
+		}
+
+		return $patterns;
+
+	}//end createTokenPattern()
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Generators/Generator.php

Indentation +94 added lines, -94 removed lines

@@ -19,100 +19,100 @@
 abstract class Generator
 {
 
-    /**
-     * The ruleset used for the run.
-     *
-     * @var \PHP_CodeSniffer\Ruleset
-     */
-    public $ruleset = null;
-
-    /**
-     * XML documentation files used to produce the final output.
-     *
-     * @var string[]
-     */
-    public $docFiles = [];
-
-
-    /**
-     * Constructs a doc generator.
-     *
-     * @param \PHP_CodeSniffer\Ruleset $ruleset The ruleset used for the run.
-     *
-     * @see generate()
-     */
-    public function __construct(Ruleset $ruleset)
-    {
-        $this->ruleset = $ruleset;
-
-        foreach ($ruleset->sniffs as $className => $sniffClass) {
-            $file    = Autoload::getLoadedFileName($className);
-            $docFile = str_replace(
-                DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR,
-                DIRECTORY_SEPARATOR.'Docs'.DIRECTORY_SEPARATOR,
-                $file
-            );
-            $docFile = str_replace('Sniff.php', 'Standard.xml', $docFile);
-
-            if (is_file($docFile) === true) {
-                $this->docFiles[] = $docFile;
-            }
-        }
-
-    }//end __construct()
-
-
-    /**
-     * Retrieves the title of the sniff from the DOMNode supplied.
-     *
-     * @param \DOMNode $doc The DOMNode object for the sniff.
-     *                      It represents the "documentation" tag in the XML
-     *                      standard file.
-     *
-     * @return string
-     */
-    protected function getTitle(\DOMNode $doc)
-    {
-        return $doc->getAttribute('title');
-
-    }//end getTitle()
-
-
-    /**
-     * Generates the documentation for a standard.
-     *
-     * It's probably wise for doc generators to override this method so they
-     * have control over how the docs are produced. Otherwise, the processSniff
-     * method should be overridden to output content for each sniff.
-     *
-     * @return void
-     * @see    processSniff()
-     */
-    public function generate()
-    {
-        foreach ($this->docFiles as $file) {
-            $doc = new \DOMDocument();
-            $doc->load($file);
-            $documentation = $doc->getElementsByTagName('documentation')->item(0);
-            $this->processSniff($documentation);
-        }
-
-    }//end generate()
-
-
-    /**
-     * Process the documentation for a single sniff.
-     *
-     * Doc generators must implement this function to produce output.
-     *
-     * @param \DOMNode $doc The DOMNode object for the sniff.
-     *                      It represents the "documentation" tag in the XML
-     *                      standard file.
-     *
-     * @return void
-     * @see    generate()
-     */
-    abstract protected function processSniff(\DOMNode $doc);
+	/**
+	 * The ruleset used for the run.
+	 *
+	 * @var \PHP_CodeSniffer\Ruleset
+	 */
+	public $ruleset = null;
+
+	/**
+	 * XML documentation files used to produce the final output.
+	 *
+	 * @var string[]
+	 */
+	public $docFiles = [];
+
+
+	/**
+	 * Constructs a doc generator.
+	 *
+	 * @param \PHP_CodeSniffer\Ruleset $ruleset The ruleset used for the run.
+	 *
+	 * @see generate()
+	 */
+	public function __construct(Ruleset $ruleset)
+	{
+		$this->ruleset = $ruleset;
+
+		foreach ($ruleset->sniffs as $className => $sniffClass) {
+			$file    = Autoload::getLoadedFileName($className);
+			$docFile = str_replace(
+				DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR,
+				DIRECTORY_SEPARATOR.'Docs'.DIRECTORY_SEPARATOR,
+				$file
+			);
+			$docFile = str_replace('Sniff.php', 'Standard.xml', $docFile);
+
+			if (is_file($docFile) === true) {
+				$this->docFiles[] = $docFile;
+			}
+		}
+
+	}//end __construct()
+
+
+	/**
+	 * Retrieves the title of the sniff from the DOMNode supplied.
+	 *
+	 * @param \DOMNode $doc The DOMNode object for the sniff.
+	 *                      It represents the "documentation" tag in the XML
+	 *                      standard file.
+	 *
+	 * @return string
+	 */
+	protected function getTitle(\DOMNode $doc)
+	{
+		return $doc->getAttribute('title');
+
+	}//end getTitle()
+
+
+	/**
+	 * Generates the documentation for a standard.
+	 *
+	 * It's probably wise for doc generators to override this method so they
+	 * have control over how the docs are produced. Otherwise, the processSniff
+	 * method should be overridden to output content for each sniff.
+	 *
+	 * @return void
+	 * @see    processSniff()
+	 */
+	public function generate()
+	{
+		foreach ($this->docFiles as $file) {
+			$doc = new \DOMDocument();
+			$doc->load($file);
+			$documentation = $doc->getElementsByTagName('documentation')->item(0);
+			$this->processSniff($documentation);
+		}
+
+	}//end generate()
+
+
+	/**
+	 * Process the documentation for a single sniff.
+	 *
+	 * Doc generators must implement this function to produce output.
+	 *
+	 * @param \DOMNode $doc The DOMNode object for the sniff.
+	 *                      It represents the "documentation" tag in the XML
+	 *                      standard file.
+	 *
+	 * @return void
+	 * @see    generate()
+	 */
+	abstract protected function processSniff(\DOMNode $doc);
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Generators/HTML.php

Indentation +181 added lines, -181 removed lines

@@ -19,47 +19,47 @@ 
 {
 
 
-    /**
-     * Generates the documentation for a standard.
-     *
-     * @return void
-     * @see    processSniff()
-     */
-    public function generate()
-    {
-        ob_start();
-        $this->printHeader();
-        $this->printToc();
-
-        foreach ($this->docFiles as $file) {
-            $doc = new \DOMDocument();
-            $doc->load($file);
-            $documentation = $doc->getElementsByTagName('documentation')->item(0);
-            $this->processSniff($documentation);
-        }
-
-        $this->printFooter();
-
-        $content = ob_get_contents();
-        ob_end_clean();
-
-        echo $content;
-
-    }//end generate()
-
-
-    /**
-     * Print the header of the HTML page.
-     *
-     * @return void
-     */
-    protected function printHeader()
-    {
-        $standard = $this->ruleset->name;
-        echo '<html>'.PHP_EOL;
-        echo ' <head>'.PHP_EOL;
-        echo "  <title>$standard Coding Standards</title>".PHP_EOL;
-        echo '  <style>
+	/**
+	 * Generates the documentation for a standard.
+	 *
+	 * @return void
+	 * @see    processSniff()
+	 */
+	public function generate()
+	{
+		ob_start();
+		$this->printHeader();
+		$this->printToc();
+
+		foreach ($this->docFiles as $file) {
+			$doc = new \DOMDocument();
+			$doc->load($file);
+			$documentation = $doc->getElementsByTagName('documentation')->item(0);
+			$this->processSniff($documentation);
+		}
+
+		$this->printFooter();
+
+		$content = ob_get_contents();
+		ob_end_clean();
+
+		echo $content;
+
+	}//end generate()
+
+
+	/**
+	 * Print the header of the HTML page.
+	 *
+	 * @return void
+	 */
+	protected function printHeader()
+	{
+		$standard = $this->ruleset->name;
+		echo '<html>'.PHP_EOL;
+		echo ' <head>'.PHP_EOL;
+		echo "  <title>$standard Coding Standards</title>".PHP_EOL;
+		echo '  <style>
                     body {
                         background-color: #FFFFFF;
                         font-size: 14px;
@@ -125,146 +125,146 @@ 
                         color: #000000;
                     }
                 </style>'.PHP_EOL;
-        echo ' </head>'.PHP_EOL;
-        echo ' <body>'.PHP_EOL;
-        echo "  <h1>$standard Coding Standards</h1>".PHP_EOL;
-
-    }//end printHeader()
-
-
-    /**
-     * Print the table of contents for the standard.
-     *
-     * The TOC is just an unordered list of bookmarks to sniffs on the page.
-     *
-     * @return void
-     */
-    protected function printToc()
-    {
-        echo '  <h2>Table of Contents</h2>'.PHP_EOL;
-        echo '  <ul class="toc">'.PHP_EOL;
-
-        foreach ($this->docFiles as $file) {
-            $doc = new \DOMDocument();
-            $doc->load($file);
-            $documentation = $doc->getElementsByTagName('documentation')->item(0);
-            $title         = $this->getTitle($documentation);
-            echo '   <li><a href="#'.str_replace(' ', '-', $title)."\">$title</a></li>".PHP_EOL;
-        }
-
-        echo '  </ul>'.PHP_EOL;
-
-    }//end printToc()
-
-
-    /**
-     * Print the footer of the HTML page.
-     *
-     * @return void
-     */
-    protected function printFooter()
-    {
-        // Turn off errors so we don't get timezone warnings if people
-        // don't have their timezone set.
-        $errorLevel = error_reporting(0);
-        echo '  <div class="tag-line">';
-        echo 'Documentation generated on '.date('r');
-        echo ' by <a href="https://github.com/squizlabs/PHP_CodeSniffer">PHP_CodeSniffer '.Config::VERSION.'</a>';
-        echo '</div>'.PHP_EOL;
-        error_reporting($errorLevel);
-
-        echo ' </body>'.PHP_EOL;
-        echo '</html>'.PHP_EOL;
-
-    }//end printFooter()
-
-
-    /**
-     * Process the documentation for a single sniff.
-     *
-     * @param \DOMNode $doc The DOMNode object for the sniff.
-     *                      It represents the "documentation" tag in the XML
-     *                      standard file.
-     *
-     * @return void
-     */
-    public function processSniff(\DOMNode $doc)
-    {
-        $title = $this->getTitle($doc);
-        echo '  <a name="'.str_replace(' ', '-', $title).'" />'.PHP_EOL;
-        echo "  <h2>$title</h2>".PHP_EOL;
-
-        foreach ($doc->childNodes as $node) {
-            if ($node->nodeName === 'standard') {
-                $this->printTextBlock($node);
-            } else if ($node->nodeName === 'code_comparison') {
-                $this->printCodeComparisonBlock($node);
-            }
-        }
-
-    }//end processSniff()
-
-
-    /**
-     * Print a text block found in a standard.
-     *
-     * @param \DOMNode $node The DOMNode object for the text block.
-     *
-     * @return void
-     */
-    protected function printTextBlock(\DOMNode $node)
-    {
-        $content = trim($node->nodeValue);
-        $content = htmlspecialchars($content);
-
-        // Allow em tags only.
-        $content = str_replace('&lt;em&gt;', '<em>', $content);
-        $content = str_replace('&lt;/em&gt;', '</em>', $content);
-
-        echo "  <p class=\"text\">$content</p>".PHP_EOL;
-
-    }//end printTextBlock()
-
-
-    /**
-     * Print a code comparison block found in a standard.
-     *
-     * @param \DOMNode $node The DOMNode object for the code comparison block.
-     *
-     * @return void
-     */
-    protected function printCodeComparisonBlock(\DOMNode $node)
-    {
-        $codeBlocks = $node->getElementsByTagName('code');
-
-        $firstTitle = $codeBlocks->item(0)->getAttribute('title');
-        $first      = trim($codeBlocks->item(0)->nodeValue);
-        $first      = str_replace('<?php', '&lt;?php', $first);
-        $first      = str_replace("\n", '</br>', $first);
-        $first      = str_replace(' ', '&nbsp;', $first);
-        $first      = str_replace('<em>', '<span class="code-comparison-highlight">', $first);
-        $first      = str_replace('</em>', '</span>', $first);
-
-        $secondTitle = $codeBlocks->item(1)->getAttribute('title');
-        $second      = trim($codeBlocks->item(1)->nodeValue);
-        $second      = str_replace('<?php', '&lt;?php', $second);
-        $second      = str_replace("\n", '</br>', $second);
-        $second      = str_replace(' ', '&nbsp;', $second);
-        $second      = str_replace('<em>', '<span class="code-comparison-highlight">', $second);
-        $second      = str_replace('</em>', '</span>', $second);
-
-        echo '  <table class="code-comparison">'.PHP_EOL;
-        echo '   <tr>'.PHP_EOL;
-        echo "    <td class=\"code-comparison-title\">$firstTitle</td>".PHP_EOL;
-        echo "    <td class=\"code-comparison-title\">$secondTitle</td>".PHP_EOL;
-        echo '   </tr>'.PHP_EOL;
-        echo '   <tr>'.PHP_EOL;
-        echo "    <td class=\"code-comparison-code\">$first</td>".PHP_EOL;
-        echo "    <td class=\"code-comparison-code\">$second</td>".PHP_EOL;
-        echo '   </tr>'.PHP_EOL;
-        echo '  </table>'.PHP_EOL;
-
-    }//end printCodeComparisonBlock()
+		echo ' </head>'.PHP_EOL;
+		echo ' <body>'.PHP_EOL;
+		echo "  <h1>$standard Coding Standards</h1>".PHP_EOL;
+
+	}//end printHeader()
+
+
+	/**
+	 * Print the table of contents for the standard.
+	 *
+	 * The TOC is just an unordered list of bookmarks to sniffs on the page.
+	 *
+	 * @return void
+	 */
+	protected function printToc()
+	{
+		echo '  <h2>Table of Contents</h2>'.PHP_EOL;
+		echo '  <ul class="toc">'.PHP_EOL;
+
+		foreach ($this->docFiles as $file) {
+			$doc = new \DOMDocument();
+			$doc->load($file);
+			$documentation = $doc->getElementsByTagName('documentation')->item(0);
+			$title         = $this->getTitle($documentation);
+			echo '   <li><a href="#'.str_replace(' ', '-', $title)."\">$title</a></li>".PHP_EOL;
+		}
+
+		echo '  </ul>'.PHP_EOL;
+
+	}//end printToc()
+
+
+	/**
+	 * Print the footer of the HTML page.
+	 *
+	 * @return void
+	 */
+	protected function printFooter()
+	{
+		// Turn off errors so we don't get timezone warnings if people
+		// don't have their timezone set.
+		$errorLevel = error_reporting(0);
+		echo '  <div class="tag-line">';
+		echo 'Documentation generated on '.date('r');
+		echo ' by <a href="https://github.com/squizlabs/PHP_CodeSniffer">PHP_CodeSniffer '.Config::VERSION.'</a>';
+		echo '</div>'.PHP_EOL;
+		error_reporting($errorLevel);
+
+		echo ' </body>'.PHP_EOL;
+		echo '</html>'.PHP_EOL;
+
+	}//end printFooter()
+
+
+	/**
+	 * Process the documentation for a single sniff.
+	 *
+	 * @param \DOMNode $doc The DOMNode object for the sniff.
+	 *                      It represents the "documentation" tag in the XML
+	 *                      standard file.
+	 *
+	 * @return void
+	 */
+	public function processSniff(\DOMNode $doc)
+	{
+		$title = $this->getTitle($doc);
+		echo '  <a name="'.str_replace(' ', '-', $title).'" />'.PHP_EOL;
+		echo "  <h2>$title</h2>".PHP_EOL;
+
+		foreach ($doc->childNodes as $node) {
+			if ($node->nodeName === 'standard') {
+				$this->printTextBlock($node);
+			} else if ($node->nodeName === 'code_comparison') {
+				$this->printCodeComparisonBlock($node);
+			}
+		}
+
+	}//end processSniff()
+
+
+	/**
+	 * Print a text block found in a standard.
+	 *
+	 * @param \DOMNode $node The DOMNode object for the text block.
+	 *
+	 * @return void
+	 */
+	protected function printTextBlock(\DOMNode $node)
+	{
+		$content = trim($node->nodeValue);
+		$content = htmlspecialchars($content);
+
+		// Allow em tags only.
+		$content = str_replace('&lt;em&gt;', '<em>', $content);
+		$content = str_replace('&lt;/em&gt;', '</em>', $content);
+
+		echo "  <p class=\"text\">$content</p>".PHP_EOL;
+
+	}//end printTextBlock()
+
+
+	/**
+	 * Print a code comparison block found in a standard.
+	 *
+	 * @param \DOMNode $node The DOMNode object for the code comparison block.
+	 *
+	 * @return void
+	 */
+	protected function printCodeComparisonBlock(\DOMNode $node)
+	{
+		$codeBlocks = $node->getElementsByTagName('code');
+
+		$firstTitle = $codeBlocks->item(0)->getAttribute('title');
+		$first      = trim($codeBlocks->item(0)->nodeValue);
+		$first      = str_replace('<?php', '&lt;?php', $first);
+		$first      = str_replace("\n", '</br>', $first);
+		$first      = str_replace(' ', '&nbsp;', $first);
+		$first      = str_replace('<em>', '<span class="code-comparison-highlight">', $first);
+		$first      = str_replace('</em>', '</span>', $first);
+
+		$secondTitle = $codeBlocks->item(1)->getAttribute('title');
+		$second      = trim($codeBlocks->item(1)->nodeValue);
+		$second      = str_replace('<?php', '&lt;?php', $second);
+		$second      = str_replace("\n", '</br>', $second);
+		$second      = str_replace(' ', '&nbsp;', $second);
+		$second      = str_replace('<em>', '<span class="code-comparison-highlight">', $second);
+		$second      = str_replace('</em>', '</span>', $second);
+
+		echo '  <table class="code-comparison">'.PHP_EOL;
+		echo '   <tr>'.PHP_EOL;
+		echo "    <td class=\"code-comparison-title\">$firstTitle</td>".PHP_EOL;
+		echo "    <td class=\"code-comparison-title\">$secondTitle</td>".PHP_EOL;
+		echo '   </tr>'.PHP_EOL;
+		echo '   <tr>'.PHP_EOL;
+		echo "    <td class=\"code-comparison-code\">$first</td>".PHP_EOL;
+		echo "    <td class=\"code-comparison-code\">$second</td>".PHP_EOL;
+		echo '   </tr>'.PHP_EOL;
+		echo '  </table>'.PHP_EOL;
+
+	}//end printCodeComparisonBlock()
 
 
 }//end class