gravityview / GravityView

vendor/squizlabs/php_codesniffer/src/Files/File.php

Indentation +2461 added lines, -2461 removed lines

@@ -19,2467 +19,2467 @@
 class File
 {
 
-    /**
-     * The absolute path to the file associated with this object.
-     *
-     * @var string
-     */
-    public $path = '';
-
-    /**
-     * The content of the file.
-     *
-     * @var string
-     */
-    protected $content = '';
-
-    /**
-     * The config data for the run.
-     *
-     * @var \PHP_CodeSniffer\Config
-     */
-    public $config = null;
-
-    /**
-     * The ruleset used for the run.
-     *
-     * @var \PHP_CodeSniffer\Ruleset
-     */
-    public $ruleset = null;
-
-    /**
-     * If TRUE, the entire file is being ignored.
-     *
-     * @var boolean
-     */
-    public $ignored = false;
-
-    /**
-     * The EOL character this file uses.
-     *
-     * @var string
-     */
-    public $eolChar = '';
-
-    /**
-     * The Fixer object to control fixing errors.
-     *
-     * @var \PHP_CodeSniffer\Fixer
-     */
-    public $fixer = null;
-
-    /**
-     * The tokenizer being used for this file.
-     *
-     * @var \PHP_CodeSniffer\Tokenizers\Tokenizer
-     */
-    public $tokenizer = null;
-
-    /**
-     * The name of the tokenizer being used for this file.
-     *
-     * @var string
-     */
-    public $tokenizerType = 'PHP';
-
-    /**
-     * Was the file loaded from cache?
-     *
-     * If TRUE, the file was loaded from a local cache.
-     * If FALSE, the file was tokenized and processed fully.
-     *
-     * @var boolean
-     */
-    public $fromCache = false;
-
-    /**
-     * The number of tokens in this file.
-     *
-     * Stored here to save calling count() everywhere.
-     *
-     * @var integer
-     */
-    public $numTokens = 0;
-
-    /**
-     * The tokens stack map.
-     *
-     * @var array
-     */
-    protected $tokens = [];
-
-    /**
-     * The errors raised from sniffs.
-     *
-     * @var array
-     * @see getErrors()
-     */
-    protected $errors = [];
-
-    /**
-     * The warnings raised from sniffs.
-     *
-     * @var array
-     * @see getWarnings()
-     */
-    protected $warnings = [];
-
-    /**
-     * The metrics recorded by sniffs.
-     *
-     * @var array
-     * @see getMetrics()
-     */
-    protected $metrics = [];
-
-    /**
-     * The metrics recorded for each token.
-     *
-     * Stops the same metric being recorded for the same token twice.
-     *
-     * @var array
-     * @see getMetrics()
-     */
-    private $metricTokens = [];
-
-    /**
-     * The total number of errors raised.
-     *
-     * @var integer
-     */
-    protected $errorCount = 0;
-
-    /**
-     * The total number of warnings raised.
-     *
-     * @var integer
-     */
-    protected $warningCount = 0;
-
-    /**
-     * The total number of errors and warnings that can be fixed.
-     *
-     * @var integer
-     */
-    protected $fixableCount = 0;
-
-    /**
-     * The total number of errors and warnings that were fixed.
-     *
-     * @var integer
-     */
-    protected $fixedCount = 0;
-
-    /**
-     * An array of sniffs that are being ignored.
-     *
-     * @var array
-     */
-    protected $ignoredListeners = [];
-
-    /**
-     * An array of message codes that are being ignored.
-     *
-     * @var array
-     */
-    protected $ignoredCodes = [];
-
-    /**
-     * An array of sniffs listening to this file's processing.
-     *
-     * @var \PHP_CodeSniffer\Sniffs\Sniff[]
-     */
-    protected $listeners = [];
-
-    /**
-     * The class name of the sniff currently processing the file.
-     *
-     * @var string
-     */
-    protected $activeListener = '';
-
-    /**
-     * An array of sniffs being processed and how long they took.
-     *
-     * @var array
-     */
-    protected $listenerTimes = [];
-
-    /**
-     * A cache of often used config settings to improve performance.
-     *
-     * Storing them here saves 10k+ calls to __get() in the Config class.
-     *
-     * @var array
-     */
-    protected $configCache = [];
-
-
-    /**
-     * Constructs a file.
-     *
-     * @param string                   $path    The absolute path to the file to process.
-     * @param \PHP_CodeSniffer\Ruleset $ruleset The ruleset used for the run.
-     * @param \PHP_CodeSniffer\Config  $config  The config data for the run.
-     *
-     * @return void
-     */
-    public function __construct($path, Ruleset $ruleset, Config $config)
-    {
-        $this->path    = $path;
-        $this->ruleset = $ruleset;
-        $this->config  = $config;
-        $this->fixer   = new Fixer();
-
-        $parts     = explode('.', $path);
-        $extension = array_pop($parts);
-        if (isset($config->extensions[$extension]) === true) {
-            $this->tokenizerType = $config->extensions[$extension];
-        } else {
-            // Revert to default.
-            $this->tokenizerType = 'PHP';
-        }
-
-        $this->configCache['cache']           = $this->config->cache;
-        $this->configCache['sniffs']          = array_map('strtolower', $this->config->sniffs);
-        $this->configCache['exclude']         = array_map('strtolower', $this->config->exclude);
-        $this->configCache['errorSeverity']   = $this->config->errorSeverity;
-        $this->configCache['warningSeverity'] = $this->config->warningSeverity;
-        $this->configCache['recordErrors']    = $this->config->recordErrors;
-        $this->configCache['ignorePatterns']  = $this->ruleset->ignorePatterns;
-        $this->configCache['includePatterns'] = $this->ruleset->includePatterns;
-
-    }//end __construct()
-
-
-    /**
-     * Set the content of the file.
-     *
-     * Setting the content also calculates the EOL char being used.
-     *
-     * @param string $content The file content.
-     *
-     * @return void
-     */
-    public function setContent($content)
-    {
-        $this->content = $content;
-        $this->tokens  = [];
-
-        try {
-            $this->eolChar = Util\Common::detectLineEndings($content);
-        } catch (RuntimeException $e) {
-            $this->addWarningOnLine($e->getMessage(), 1, 'Internal.DetectLineEndings');
-            return;
-        }
-
-    }//end setContent()
-
-
-    /**
-     * Reloads the content of the file.
-     *
-     * By default, we have no idea where our content comes from,
-     * so we can't do anything.
-     *
-     * @return void
-     */
-    public function reloadContent()
-    {
-
-    }//end reloadContent()
-
-
-    /**
-     * Disables caching of this file.
-     *
-     * @return void
-     */
-    public function disableCaching()
-    {
-        $this->configCache['cache'] = false;
-
-    }//end disableCaching()
-
-
-    /**
-     * Starts the stack traversal and tells listeners when tokens are found.
-     *
-     * @return void
-     */
-    public function process()
-    {
-        if ($this->ignored === true) {
-            return;
-        }
-
-        $this->errors       = [];
-        $this->warnings     = [];
-        $this->errorCount   = 0;
-        $this->warningCount = 0;
-        $this->fixableCount = 0;
-
-        $this->parse();
-
-        // Check if tokenizer errors cause this file to be ignored.
-        if ($this->ignored === true) {
-            return;
-        }
-
-        $this->fixer->startFile($this);
-
-        if (PHP_CODESNIFFER_VERBOSITY > 2) {
-            echo "\t*** START TOKEN PROCESSING ***".PHP_EOL;
-        }
-
-        $foundCode        = false;
-        $listenerIgnoreTo = [];
-        $inTests          = defined('PHP_CODESNIFFER_IN_TESTS');
-        $checkAnnotations = $this->config->annotations;
-
-        // Foreach of the listeners that have registered to listen for this
-        // token, get them to process it.
-        foreach ($this->tokens as $stackPtr => $token) {
-            // Check for ignored lines.
-            if ($checkAnnotations === true
-                && ($token['code'] === T_COMMENT
-                || $token['code'] === T_PHPCS_IGNORE_FILE
-                || $token['code'] === T_PHPCS_SET
-                || $token['code'] === T_DOC_COMMENT_STRING
-                || $token['code'] === T_DOC_COMMENT_TAG
-                || ($inTests === true && $token['code'] === T_INLINE_HTML))
-            ) {
-                $commentText      = ltrim($this->tokens[$stackPtr]['content'], ' /*');
-                $commentTextLower = strtolower($commentText);
-                if (strpos($commentText, '@codingStandards') !== false) {
-                    if (strpos($commentText, '@codingStandardsIgnoreFile') !== false) {
-                        // Ignoring the whole file, just a little late.
-                        $this->errors       = [];
-                        $this->warnings     = [];
-                        $this->errorCount   = 0;
-                        $this->warningCount = 0;
-                        $this->fixableCount = 0;
-                        return;
-                    } else if (strpos($commentText, '@codingStandardsChangeSetting') !== false) {
-                        $start   = strpos($commentText, '@codingStandardsChangeSetting');
-                        $comment = substr($commentText, ($start + 30));
-                        $parts   = explode(' ', $comment);
-                        if (count($parts) >= 2) {
-                            $sniffParts = explode('.', $parts[0]);
-                            if (count($sniffParts) >= 3) {
-                                // If the sniff code is not known to us, it has not been registered in this run.
-                                // But don't throw an error as it could be there for a different standard to use.
-                                if (isset($this->ruleset->sniffCodes[$parts[0]]) === true) {
-                                    $listenerCode  = array_shift($parts);
-                                    $propertyCode  = array_shift($parts);
-                                    $propertyValue = rtrim(implode(' ', $parts), " */\r\n");
-                                    $listenerClass = $this->ruleset->sniffCodes[$listenerCode];
-                                    $this->ruleset->setSniffProperty($listenerClass, $propertyCode, $propertyValue);
-                                }
-                            }
-                        }
-                    }//end if
-                } else if (substr($commentTextLower, 0, 16) === 'phpcs:ignorefile'
-                    || substr($commentTextLower, 0, 17) === '@phpcs:ignorefile'
-                ) {
-                    // Ignoring the whole file, just a little late.
-                    $this->errors       = [];
-                    $this->warnings     = [];
-                    $this->errorCount   = 0;
-                    $this->warningCount = 0;
-                    $this->fixableCount = 0;
-                    return;
-                } else if (substr($commentTextLower, 0, 9) === 'phpcs:set'
-                    || substr($commentTextLower, 0, 10) === '@phpcs:set'
-                ) {
-                    if (isset($token['sniffCode']) === true) {
-                        $listenerCode = $token['sniffCode'];
-                        if (isset($this->ruleset->sniffCodes[$listenerCode]) === true) {
-                            $propertyCode  = $token['sniffProperty'];
-                            $propertyValue = $token['sniffPropertyValue'];
-                            $listenerClass = $this->ruleset->sniffCodes[$listenerCode];
-                            $this->ruleset->setSniffProperty($listenerClass, $propertyCode, $propertyValue);
-                        }
-                    }
-                }//end if
-            }//end if
-
-            if (PHP_CODESNIFFER_VERBOSITY > 2) {
-                $type    = $token['type'];
-                $content = Util\Common::prepareForOutput($token['content']);
-                echo "\t\tProcess token $stackPtr: $type => $content".PHP_EOL;
-            }
-
-            if ($token['code'] !== T_INLINE_HTML) {
-                $foundCode = true;
-            }
-
-            if (isset($this->ruleset->tokenListeners[$token['code']]) === false) {
-                continue;
-            }
-
-            foreach ($this->ruleset->tokenListeners[$token['code']] as $listenerData) {
-                if (isset($this->ignoredListeners[$listenerData['class']]) === true
-                    || (isset($listenerIgnoreTo[$listenerData['class']]) === true
-                    && $listenerIgnoreTo[$listenerData['class']] > $stackPtr)
-                ) {
-                    // This sniff is ignoring past this token, or the whole file.
-                    continue;
-                }
-
-                // Make sure this sniff supports the tokenizer
-                // we are currently using.
-                $class = $listenerData['class'];
-
-                if (isset($listenerData['tokenizers'][$this->tokenizerType]) === false) {
-                    continue;
-                }
-
-                // If the file path matches one of our ignore patterns, skip it.
-                // While there is support for a type of each pattern
-                // (absolute or relative) we don't actually support it here.
-                foreach ($listenerData['ignore'] as $pattern) {
-                    // We assume a / directory separator, as do the exclude rules
-                    // most developers write, so we need a special case for any system
-                    // that is different.
-                    if (DIRECTORY_SEPARATOR === '\\') {
-                        $pattern = str_replace('/', '\\\\', $pattern);
-                    }
-
-                    $pattern = '`'.$pattern.'`i';
-                    if (preg_match($pattern, $this->path) === 1) {
-                        $this->ignoredListeners[$class] = true;
-                        continue(2);
-                    }
-                }
-
-                // If the file path does not match one of our include patterns, skip it.
-                // While there is support for a type of each pattern
-                // (absolute or relative) we don't actually support it here.
-                if (empty($listenerData['include']) === false) {
-                    $included = false;
-                    foreach ($listenerData['include'] as $pattern) {
-                        // We assume a / directory separator, as do the exclude rules
-                        // most developers write, so we need a special case for any system
-                        // that is different.
-                        if (DIRECTORY_SEPARATOR === '\\') {
-                            $pattern = str_replace('/', '\\\\', $pattern);
-                        }
-
-                        $pattern = '`'.$pattern.'`i';
-                        if (preg_match($pattern, $this->path) === 1) {
-                            $included = true;
-                            break;
-                        }
-                    }
-
-                    if ($included === false) {
-                        $this->ignoredListeners[$class] = true;
-                        continue;
-                    }
-                }//end if
-
-                $this->activeListener = $class;
-
-                if (PHP_CODESNIFFER_VERBOSITY > 2) {
-                    $startTime = microtime(true);
-                    echo "\t\t\tProcessing ".$this->activeListener.'... ';
-                }
-
-                $ignoreTo = $this->ruleset->sniffs[$class]->process($this, $stackPtr);
-                if ($ignoreTo !== null) {
-                    $listenerIgnoreTo[$this->activeListener] = $ignoreTo;
-                }
-
-                if (PHP_CODESNIFFER_VERBOSITY > 2) {
-                    $timeTaken = (microtime(true) - $startTime);
-                    if (isset($this->listenerTimes[$this->activeListener]) === false) {
-                        $this->listenerTimes[$this->activeListener] = 0;
-                    }
-
-                    $this->listenerTimes[$this->activeListener] += $timeTaken;
-
-                    $timeTaken = round(($timeTaken), 4);
-                    echo "DONE in $timeTaken seconds".PHP_EOL;
-                }
-
-                $this->activeListener = '';
-            }//end foreach
-        }//end foreach
-
-        // If short open tags are off but the file being checked uses
-        // short open tags, the whole content will be inline HTML
-        // and nothing will be checked. So try and handle this case.
-        // We don't show this error for STDIN because we can't be sure the content
-        // actually came directly from the user. It could be something like
-        // refs from a Git pre-push hook.
-        if ($foundCode === false && $this->tokenizerType === 'PHP' && $this->path !== 'STDIN') {
-            $shortTags = (bool) ini_get('short_open_tag');
-            if ($shortTags === false) {
-                $error = 'No PHP code was found in this file and short open tags are not allowed by this install of PHP. This file may be using short open tags but PHP does not allow them.';
-                $this->addWarning($error, null, 'Internal.NoCodeFound');
-            }
-        }
-
-        if (PHP_CODESNIFFER_VERBOSITY > 2) {
-            echo "\t*** END TOKEN PROCESSING ***".PHP_EOL;
-            echo "\t*** START SNIFF PROCESSING REPORT ***".PHP_EOL;
-
-            asort($this->listenerTimes, SORT_NUMERIC);
-            $this->listenerTimes = array_reverse($this->listenerTimes, true);
-            foreach ($this->listenerTimes as $listener => $timeTaken) {
-                echo "\t$listener: ".round(($timeTaken), 4).' secs'.PHP_EOL;
-            }
-
-            echo "\t*** END SNIFF PROCESSING REPORT ***".PHP_EOL;
-        }
-
-        $this->fixedCount += $this->fixer->getFixCount();
-
-    }//end process()
-
-
-    /**
-     * Tokenizes the file and prepares it for the test run.
-     *
-     * @return void
-     */
-    public function parse()
-    {
-        if (empty($this->tokens) === false) {
-            // File has already been parsed.
-            return;
-        }
-
-        try {
-            $tokenizerClass  = 'PHP_CodeSniffer\Tokenizers\\'.$this->tokenizerType;
-            $this->tokenizer = new $tokenizerClass($this->content, $this->config, $this->eolChar);
-            $this->tokens    = $this->tokenizer->getTokens();
-        } catch (TokenizerException $e) {
-            $this->ignored = true;
-            $this->addWarning($e->getMessage(), null, 'Internal.Tokenizer.Exception');
-            if (PHP_CODESNIFFER_VERBOSITY > 0) {
-                echo "[$this->tokenizerType => tokenizer error]... ";
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo PHP_EOL;
-                }
-            }
-
-            return;
-        }
-
-        $this->numTokens = count($this->tokens);
-
-        // Check for mixed line endings as these can cause tokenizer errors and we
-        // should let the user know that the results they get may be incorrect.
-        // This is done by removing all backslashes, removing the newline char we
-        // detected, then converting newlines chars into text. If any backslashes
-        // are left at the end, we have additional newline chars in use.
-        $contents = str_replace('\\', '', $this->content);
-        $contents = str_replace($this->eolChar, '', $contents);
-        $contents = str_replace("\n", '\n', $contents);
-        $contents = str_replace("\r", '\r', $contents);
-        if (strpos($contents, '\\') !== false) {
-            $error = 'File has mixed line endings; this may cause incorrect results';
-            $this->addWarningOnLine($error, 1, 'Internal.LineEndings.Mixed');
-        }
-
-        if (PHP_CODESNIFFER_VERBOSITY > 0) {
-            if ($this->numTokens === 0) {
-                $numLines = 0;
-            } else {
-                $numLines = $this->tokens[($this->numTokens - 1)]['line'];
-            }
-
-            echo "[$this->tokenizerType => $this->numTokens tokens in $numLines lines]... ";
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo PHP_EOL;
-            }
-        }
-
-    }//end parse()
-
-
-    /**
-     * Returns the token stack for this file.
-     *
-     * @return array
-     */
-    public function getTokens()
-    {
-        return $this->tokens;
-
-    }//end getTokens()
-
-
-    /**
-     * Remove vars stored in this file that are no longer required.
-     *
-     * @return void
-     */
-    public function cleanUp()
-    {
-        $this->listenerTimes = null;
-        $this->content       = null;
-        $this->tokens        = null;
-        $this->metricTokens  = null;
-        $this->tokenizer     = null;
-        $this->fixer         = null;
-        $this->config        = null;
-        $this->ruleset       = null;
-
-    }//end cleanUp()
-
-
-    /**
-     * Records an error against a specific token in the file.
-     *
-     * @param string  $error    The error message.
-     * @param int     $stackPtr The stack position where the error occurred.
-     * @param string  $code     A violation code unique to the sniff message.
-     * @param array   $data     Replacements for the error message.
-     * @param int     $severity The severity level for this error. A value of 0
-     *                          will be converted into the default severity level.
-     * @param boolean $fixable  Can the error be fixed by the sniff?
-     *
-     * @return boolean
-     */
-    public function addError(
-        $error,
-        $stackPtr,
-        $code,
-        $data=[],
-        $severity=0,
-        $fixable=false
-    ) {
-        if ($stackPtr === null) {
-            $line   = 1;
-            $column = 1;
-        } else {
-            $line   = $this->tokens[$stackPtr]['line'];
-            $column = $this->tokens[$stackPtr]['column'];
-        }
-
-        return $this->addMessage(true, $error, $line, $column, $code, $data, $severity, $fixable);
-
-    }//end addError()
-
-
-    /**
-     * Records a warning against a specific token in the file.
-     *
-     * @param string  $warning  The error message.
-     * @param int     $stackPtr The stack position where the error occurred.
-     * @param string  $code     A violation code unique to the sniff message.
-     * @param array   $data     Replacements for the warning message.
-     * @param int     $severity The severity level for this warning. A value of 0
-     *                          will be converted into the default severity level.
-     * @param boolean $fixable  Can the warning be fixed by the sniff?
-     *
-     * @return boolean
-     */
-    public function addWarning(
-        $warning,
-        $stackPtr,
-        $code,
-        $data=[],
-        $severity=0,
-        $fixable=false
-    ) {
-        if ($stackPtr === null) {
-            $line   = 1;
-            $column = 1;
-        } else {
-            $line   = $this->tokens[$stackPtr]['line'];
-            $column = $this->tokens[$stackPtr]['column'];
-        }
-
-        return $this->addMessage(false, $warning, $line, $column, $code, $data, $severity, $fixable);
-
-    }//end addWarning()
-
-
-    /**
-     * Records an error against a specific line in the file.
-     *
-     * @param string $error    The error message.
-     * @param int    $line     The line on which the error occurred.
-     * @param string $code     A violation code unique to the sniff message.
-     * @param array  $data     Replacements for the error message.
-     * @param int    $severity The severity level for this error. A value of 0
-     *                         will be converted into the default severity level.
-     *
-     * @return boolean
-     */
-    public function addErrorOnLine(
-        $error,
-        $line,
-        $code,
-        $data=[],
-        $severity=0
-    ) {
-        return $this->addMessage(true, $error, $line, 1, $code, $data, $severity, false);
-
-    }//end addErrorOnLine()
-
-
-    /**
-     * Records a warning against a specific token in the file.
-     *
-     * @param string $warning  The error message.
-     * @param int    $line     The line on which the warning occurred.
-     * @param string $code     A violation code unique to the sniff message.
-     * @param array  $data     Replacements for the warning message.
-     * @param int    $severity The severity level for this warning. A value of 0 will
-     *                         will be converted into the default severity level.
-     *
-     * @return boolean
-     */
-    public function addWarningOnLine(
-        $warning,
-        $line,
-        $code,
-        $data=[],
-        $severity=0
-    ) {
-        return $this->addMessage(false, $warning, $line, 1, $code, $data, $severity, false);
-
-    }//end addWarningOnLine()
-
-
-    /**
-     * Records a fixable error against a specific token in the file.
-     *
-     * Returns true if the error was recorded and should be fixed.
-     *
-     * @param string $error    The error message.
-     * @param int    $stackPtr The stack position where the error occurred.
-     * @param string $code     A violation code unique to the sniff message.
-     * @param array  $data     Replacements for the error message.
-     * @param int    $severity The severity level for this error. A value of 0
-     *                         will be converted into the default severity level.
-     *
-     * @return boolean
-     */
-    public function addFixableError(
-        $error,
-        $stackPtr,
-        $code,
-        $data=[],
-        $severity=0
-    ) {
-        $recorded = $this->addError($error, $stackPtr, $code, $data, $severity, true);
-        if ($recorded === true && $this->fixer->enabled === true) {
-            return true;
-        }
-
-        return false;
-
-    }//end addFixableError()
-
-
-    /**
-     * Records a fixable warning against a specific token in the file.
-     *
-     * Returns true if the warning was recorded and should be fixed.
-     *
-     * @param string $warning  The error message.
-     * @param int    $stackPtr The stack position where the error occurred.
-     * @param string $code     A violation code unique to the sniff message.
-     * @param array  $data     Replacements for the warning message.
-     * @param int    $severity The severity level for this warning. A value of 0
-     *                         will be converted into the default severity level.
-     *
-     * @return boolean
-     */
-    public function addFixableWarning(
-        $warning,
-        $stackPtr,
-        $code,
-        $data=[],
-        $severity=0
-    ) {
-        $recorded = $this->addWarning($warning, $stackPtr, $code, $data, $severity, true);
-        if ($recorded === true && $this->fixer->enabled === true) {
-            return true;
-        }
-
-        return false;
-
-    }//end addFixableWarning()
-
-
-    /**
-     * Adds an error to the error stack.
-     *
-     * @param boolean $error    Is this an error message?
-     * @param string  $message  The text of the message.
-     * @param int     $line     The line on which the message occurred.
-     * @param int     $column   The column at which the message occurred.
-     * @param string  $code     A violation code unique to the sniff message.
-     * @param array   $data     Replacements for the message.
-     * @param int     $severity The severity level for this message. A value of 0
-     *                          will be converted into the default severity level.
-     * @param boolean $fixable  Can the problem be fixed by the sniff?
-     *
-     * @return boolean
-     */
-    protected function addMessage($error, $message, $line, $column, $code, $data, $severity, $fixable)
-    {
-        // Check if this line is ignoring all message codes.
-        if (isset($this->tokenizer->ignoredLines[$line]['.all']) === true) {
-            return false;
-        }
-
-        // Work out which sniff generated the message.
-        $parts = explode('.', $code);
-        if ($parts[0] === 'Internal') {
-            // An internal message.
-            $listenerCode = Util\Common::getSniffCode($this->activeListener);
-            $sniffCode    = $code;
-            $checkCodes   = [$sniffCode];
-        } else {
-            if ($parts[0] !== $code) {
-                // The full message code has been passed in.
-                $sniffCode    = $code;
-                $listenerCode = substr($sniffCode, 0, strrpos($sniffCode, '.'));
-            } else {
-                $listenerCode = Util\Common::getSniffCode($this->activeListener);
-                $sniffCode    = $listenerCode.'.'.$code;
-                $parts        = explode('.', $sniffCode);
-            }
-
-            $checkCodes = [
-                $sniffCode,
-                $parts[0].'.'.$parts[1].'.'.$parts[2],
-                $parts[0].'.'.$parts[1],
-                $parts[0],
-            ];
-        }//end if
-
-        if (isset($this->tokenizer->ignoredLines[$line]) === true) {
-            // Check if this line is ignoring this specific message.
-            $ignored = false;
-            foreach ($checkCodes as $checkCode) {
-                if (isset($this->tokenizer->ignoredLines[$line][$checkCode]) === true) {
-                    $ignored = true;
-                    break;
-                }
-            }
-
-            // If it is ignored, make sure it's not whitelisted.
-            if ($ignored === true
-                && isset($this->tokenizer->ignoredLines[$line]['.except']) === true
-            ) {
-                foreach ($checkCodes as $checkCode) {
-                    if (isset($this->tokenizer->ignoredLines[$line]['.except'][$checkCode]) === true) {
-                        $ignored = false;
-                        break;
-                    }
-                }
-            }
-
-            if ($ignored === true) {
-                return false;
-            }
-        }//end if
-
-        $includeAll = true;
-        if ($this->configCache['cache'] === false
-            || $this->configCache['recordErrors'] === false
-        ) {
-            $includeAll = false;
-        }
-
-        // Filter out any messages for sniffs that shouldn't have run
-        // due to the use of the --sniffs command line argument.
-        if ($includeAll === false
-            && ((empty($this->configCache['sniffs']) === false
-            && in_array(strtolower($listenerCode), $this->configCache['sniffs'], true) === false)
-            || (empty($this->configCache['exclude']) === false
-            && in_array(strtolower($listenerCode), $this->configCache['exclude'], true) === true))
-        ) {
-            return false;
-        }
-
-        // If we know this sniff code is being ignored for this file, return early.
-        foreach ($checkCodes as $checkCode) {
-            if (isset($this->ignoredCodes[$checkCode]) === true) {
-                return false;
-            }
-        }
-
-        $oppositeType = 'warning';
-        if ($error === false) {
-            $oppositeType = 'error';
-        }
-
-        foreach ($checkCodes as $checkCode) {
-            // Make sure this message type has not been set to the opposite message type.
-            if (isset($this->ruleset->ruleset[$checkCode]['type']) === true
-                && $this->ruleset->ruleset[$checkCode]['type'] === $oppositeType
-            ) {
-                $error = !$error;
-                break;
-            }
-        }
-
-        if ($error === true) {
-            $configSeverity = $this->configCache['errorSeverity'];
-            $messageCount   = &$this->errorCount;
-            $messages       = &$this->errors;
-        } else {
-            $configSeverity = $this->configCache['warningSeverity'];
-            $messageCount   = &$this->warningCount;
-            $messages       = &$this->warnings;
-        }
-
-        if ($includeAll === false && $configSeverity === 0) {
-            // Don't bother doing any processing as these messages are just going to
-            // be hidden in the reports anyway.
-            return false;
-        }
-
-        if ($severity === 0) {
-            $severity = 5;
-        }
-
-        foreach ($checkCodes as $checkCode) {
-            // Make sure we are interested in this severity level.
-            if (isset($this->ruleset->ruleset[$checkCode]['severity']) === true) {
-                $severity = $this->ruleset->ruleset[$checkCode]['severity'];
-                break;
-            }
-        }
-
-        if ($includeAll === false && $configSeverity > $severity) {
-            return false;
-        }
-
-        // Make sure we are not ignoring this file.
-        $included = null;
-        foreach ($checkCodes as $checkCode) {
-            $patterns = null;
-
-            if (isset($this->configCache['includePatterns'][$checkCode]) === true) {
-                $patterns  = $this->configCache['includePatterns'][$checkCode];
-                $excluding = false;
-            } else if (isset($this->configCache['ignorePatterns'][$checkCode]) === true) {
-                $patterns  = $this->configCache['ignorePatterns'][$checkCode];
-                $excluding = true;
-            }
-
-            if ($patterns === null) {
-                continue;
-            }
-
-            foreach ($patterns as $pattern => $type) {
-                // While there is support for a type of each pattern
-                // (absolute or relative) we don't actually support it here.
-                $replacements = [
-                    '\\,' => ',',
-                    '*'   => '.*',
-                ];
-
-                // We assume a / directory separator, as do the exclude rules
-                // most developers write, so we need a special case for any system
-                // that is different.
-                if (DIRECTORY_SEPARATOR === '\\') {
-                    $replacements['/'] = '\\\\';
-                }
-
-                $pattern = '`'.strtr($pattern, $replacements).'`i';
-                $matched = preg_match($pattern, $this->path);
-
-                if ($matched === 0) {
-                    if ($excluding === false && $included === null) {
-                        // This file path is not being included.
-                        $included = false;
-                    }
-
-                    continue;
-                }
-
-                if ($excluding === true) {
-                    // This file path is being excluded.
-                    $this->ignoredCodes[$checkCode] = true;
-                    return false;
-                }
-
-                // This file path is being included.
-                $included = true;
-                break;
-            }//end foreach
-        }//end foreach
-
-        if ($included === false) {
-            // There were include rules set, but this file
-            // path didn't match any of them.
-            return false;
-        }
-
-        $messageCount++;
-        if ($fixable === true) {
-            $this->fixableCount++;
-        }
-
-        if ($this->configCache['recordErrors'] === false
-            && $includeAll === false
-        ) {
-            return true;
-        }
-
-        // Work out the error message.
-        if (isset($this->ruleset->ruleset[$sniffCode]['message']) === true) {
-            $message = $this->ruleset->ruleset[$sniffCode]['message'];
-        }
-
-        if (empty($data) === false) {
-            $message = vsprintf($message, $data);
-        }
-
-        if (isset($messages[$line]) === false) {
-            $messages[$line] = [];
-        }
-
-        if (isset($messages[$line][$column]) === false) {
-            $messages[$line][$column] = [];
-        }
-
-        $messages[$line][$column][] = [
-            'message'  => $message,
-            'source'   => $sniffCode,
-            'listener' => $this->activeListener,
-            'severity' => $severity,
-            'fixable'  => $fixable,
-        ];
-
-        if (PHP_CODESNIFFER_VERBOSITY > 1
-            && $this->fixer->enabled === true
-            && $fixable === true
-        ) {
-            @ob_end_clean();
-            echo "\tE: [Line $line] $message ($sniffCode)".PHP_EOL;
-            ob_start();
-        }
-
-        return true;
-
-    }//end addMessage()
-
-
-    /**
-     * Record a metric about the file being examined.
-     *
-     * @param int    $stackPtr The stack position where the metric was recorded.
-     * @param string $metric   The name of the metric being recorded.
-     * @param string $value    The value of the metric being recorded.
-     *
-     * @return boolean
-     */
-    public function recordMetric($stackPtr, $metric, $value)
-    {
-        if (isset($this->metrics[$metric]) === false) {
-            $this->metrics[$metric] = ['values' => [$value => 1]];
-            $this->metricTokens[$metric][$stackPtr] = true;
-        } else if (isset($this->metricTokens[$metric][$stackPtr]) === false) {
-            $this->metricTokens[$metric][$stackPtr] = true;
-            if (isset($this->metrics[$metric]['values'][$value]) === false) {
-                $this->metrics[$metric]['values'][$value] = 1;
-            } else {
-                $this->metrics[$metric]['values'][$value]++;
-            }
-        }
-
-        return true;
-
-    }//end recordMetric()
-
-
-    /**
-     * Returns the number of errors raised.
-     *
-     * @return int
-     */
-    public function getErrorCount()
-    {
-        return $this->errorCount;
-
-    }//end getErrorCount()
-
-
-    /**
-     * Returns the number of warnings raised.
-     *
-     * @return int
-     */
-    public function getWarningCount()
-    {
-        return $this->warningCount;
-
-    }//end getWarningCount()
-
-
-    /**
-     * Returns the number of fixable errors/warnings raised.
-     *
-     * @return int
-     */
-    public function getFixableCount()
-    {
-        return $this->fixableCount;
-
-    }//end getFixableCount()
-
-
-    /**
-     * Returns the number of fixed errors/warnings.
-     *
-     * @return int
-     */
-    public function getFixedCount()
-    {
-        return $this->fixedCount;
-
-    }//end getFixedCount()
-
-
-    /**
-     * Returns the list of ignored lines.
-     *
-     * @return array
-     */
-    public function getIgnoredLines()
-    {
-        return $this->tokenizer->ignoredLines;
-
-    }//end getIgnoredLines()
-
-
-    /**
-     * Returns the errors raised from processing this file.
-     *
-     * @return array
-     */
-    public function getErrors()
-    {
-        return $this->errors;
-
-    }//end getErrors()
-
-
-    /**
-     * Returns the warnings raised from processing this file.
-     *
-     * @return array
-     */
-    public function getWarnings()
-    {
-        return $this->warnings;
-
-    }//end getWarnings()
-
-
-    /**
-     * Returns the metrics found while processing this file.
-     *
-     * @return array
-     */
-    public function getMetrics()
-    {
-        return $this->metrics;
-
-    }//end getMetrics()
-
-
-    /**
-     * Returns the absolute filename of this file.
-     *
-     * @return string
-     */
-    public function getFilename()
-    {
-        return $this->path;
-
-    }//end getFilename()
-
-
-    /**
-     * Returns the declaration names for classes, interfaces, traits, and functions.
-     *
-     * @param int $stackPtr The position of the declaration token which
-     *                      declared the class, interface, trait, or function.
-     *
-     * @return string|null The name of the class, interface, trait, or function;
-     *                     or NULL if the function or class is anonymous.
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified token is not of type
-     *                                                      T_FUNCTION, T_CLASS, T_ANON_CLASS,
-     *                                                      T_CLOSURE, T_TRAIT, or T_INTERFACE.
-     */
-    public function getDeclarationName($stackPtr)
-    {
-        $tokenCode = $this->tokens[$stackPtr]['code'];
-
-        if ($tokenCode === T_ANON_CLASS || $tokenCode === T_CLOSURE) {
-            return null;
-        }
-
-        if ($tokenCode !== T_FUNCTION
-            && $tokenCode !== T_CLASS
-            && $tokenCode !== T_INTERFACE
-            && $tokenCode !== T_TRAIT
-        ) {
-            throw new RuntimeException('Token type "'.$this->tokens[$stackPtr]['type'].'" is not T_FUNCTION, T_CLASS, T_INTERFACE or T_TRAIT');
-        }
-
-        if ($tokenCode === T_FUNCTION
-            && strtolower($this->tokens[$stackPtr]['content']) !== 'function'
-        ) {
-            // This is a function declared without the "function" keyword.
-            // So this token is the function name.
-            return $this->tokens[$stackPtr]['content'];
-        }
-
-        $content = null;
-        for ($i = $stackPtr; $i < $this->numTokens; $i++) {
-            if ($this->tokens[$i]['code'] === T_STRING) {
-                $content = $this->tokens[$i]['content'];
-                break;
-            }
-        }
-
-        return $content;
-
-    }//end getDeclarationName()
-
-
-    /**
-     * Returns the method parameters for the specified function token.
-     *
-     * Each parameter is in the following format:
-     *
-     * <code>
-     *   0 => array(
-     *         'name'              => '$var',  // The variable name.
-     *         'token'             => integer, // The stack pointer to the variable name.
-     *         'content'           => string,  // The full content of the variable definition.
-     *         'pass_by_reference' => boolean, // Is the variable passed by reference?
-     *         'variable_length'   => boolean, // Is the param of variable length through use of `...` ?
-     *         'type_hint'         => string,  // The type hint for the variable.
-     *         'type_hint_token'   => integer, // The stack pointer to the type hint
-     *                                         // or false if there is no type hint.
-     *         'nullable_type'     => boolean, // Is the variable using a nullable type?
-     *        )
-     * </code>
-     *
-     * Parameters with default values have an additional array index of
-     * 'default' with the value of the default as a string.
-     *
-     * @param int $stackPtr The position in the stack of the function token
-     *                      to acquire the parameters for.
-     *
-     * @return array
-     * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified $stackPtr is not of
-     *                                                        type T_FUNCTION or T_CLOSURE.
-     */
-    public function getMethodParameters($stackPtr)
-    {
-        if ($this->tokens[$stackPtr]['code'] !== T_FUNCTION
-            && $this->tokens[$stackPtr]['code'] !== T_CLOSURE
-        ) {
-            throw new TokenizerException('$stackPtr must be of type T_FUNCTION or T_CLOSURE');
-        }
-
-        $opener = $this->tokens[$stackPtr]['parenthesis_opener'];
-        $closer = $this->tokens[$stackPtr]['parenthesis_closer'];
-
-        $vars            = [];
-        $currVar         = null;
-        $paramStart      = ($opener + 1);
-        $defaultStart    = null;
-        $paramCount      = 0;
-        $passByReference = false;
-        $variableLength  = false;
-        $typeHint        = '';
-        $typeHintToken   = false;
-        $nullableType    = false;
-
-        for ($i = $paramStart; $i <= $closer; $i++) {
-            // Check to see if this token has a parenthesis or bracket opener. If it does
-            // it's likely to be an array which might have arguments in it. This
-            // could cause problems in our parsing below, so lets just skip to the
-            // end of it.
-            if (isset($this->tokens[$i]['parenthesis_opener']) === true) {
-                // Don't do this if it's the close parenthesis for the method.
-                if ($i !== $this->tokens[$i]['parenthesis_closer']) {
-                    $i = ($this->tokens[$i]['parenthesis_closer'] + 1);
-                }
-            }
-
-            if (isset($this->tokens[$i]['bracket_opener']) === true) {
-                // Don't do this if it's the close parenthesis for the method.
-                if ($i !== $this->tokens[$i]['bracket_closer']) {
-                    $i = ($this->tokens[$i]['bracket_closer'] + 1);
-                }
-            }
-
-            switch ($this->tokens[$i]['code']) {
-            case T_BITWISE_AND:
-                if ($defaultStart === null) {
-                    $passByReference = true;
-                }
-                break;
-            case T_VARIABLE:
-                $currVar = $i;
-                break;
-            case T_ELLIPSIS:
-                $variableLength = true;
-                break;
-            case T_CALLABLE:
-                if ($typeHintToken === false) {
-                    $typeHintToken = $i;
-                }
-
-                $typeHint .= $this->tokens[$i]['content'];
-                break;
-            case T_SELF:
-            case T_PARENT:
-            case T_STATIC:
-                // Self and parent are valid, static invalid, but was probably intended as type hint.
-                if (isset($defaultStart) === false) {
-                    if ($typeHintToken === false) {
-                        $typeHintToken = $i;
-                    }
-
-                    $typeHint .= $this->tokens[$i]['content'];
-                }
-                break;
-            case T_STRING:
-                // This is a string, so it may be a type hint, but it could
-                // also be a constant used as a default value.
-                $prevComma = false;
-                for ($t = $i; $t >= $opener; $t--) {
-                    if ($this->tokens[$t]['code'] === T_COMMA) {
-                        $prevComma = $t;
-                        break;
-                    }
-                }
-
-                if ($prevComma !== false) {
-                    $nextEquals = false;
-                    for ($t = $prevComma; $t < $i; $t++) {
-                        if ($this->tokens[$t]['code'] === T_EQUAL) {
-                            $nextEquals = $t;
-                            break;
-                        }
-                    }
-
-                    if ($nextEquals !== false) {
-                        break;
-                    }
-                }
-
-                if ($defaultStart === null) {
-                    if ($typeHintToken === false) {
-                        $typeHintToken = $i;
-                    }
-
-                    $typeHint .= $this->tokens[$i]['content'];
-                }
-                break;
-            case T_NS_SEPARATOR:
-                // Part of a type hint or default value.
-                if ($defaultStart === null) {
-                    if ($typeHintToken === false) {
-                        $typeHintToken = $i;
-                    }
-
-                    $typeHint .= $this->tokens[$i]['content'];
-                }
-                break;
-            case T_NULLABLE:
-                if ($defaultStart === null) {
-                    $nullableType = true;
-                    $typeHint    .= $this->tokens[$i]['content'];
-                }
-                break;
-            case T_CLOSE_PARENTHESIS:
-            case T_COMMA:
-                // If it's null, then there must be no parameters for this
-                // method.
-                if ($currVar === null) {
-                    continue 2;
-                }
-
-                $vars[$paramCount]            = [];
-                $vars[$paramCount]['token']   = $currVar;
-                $vars[$paramCount]['name']    = $this->tokens[$currVar]['content'];
-                $vars[$paramCount]['content'] = trim($this->getTokensAsString($paramStart, ($i - $paramStart)));
-
-                if ($defaultStart !== null) {
-                    $vars[$paramCount]['default'] = trim($this->getTokensAsString($defaultStart, ($i - $defaultStart)));
-                }
-
-                $vars[$paramCount]['pass_by_reference'] = $passByReference;
-                $vars[$paramCount]['variable_length']   = $variableLength;
-                $vars[$paramCount]['type_hint']         = $typeHint;
-                $vars[$paramCount]['type_hint_token']   = $typeHintToken;
-                $vars[$paramCount]['nullable_type']     = $nullableType;
-
-                // Reset the vars, as we are about to process the next parameter.
-                $defaultStart    = null;
-                $paramStart      = ($i + 1);
-                $passByReference = false;
-                $variableLength  = false;
-                $typeHint        = '';
-                $typeHintToken   = false;
-                $nullableType    = false;
-
-                $paramCount++;
-                break;
-            case T_EQUAL:
-                $defaultStart = ($i + 1);
-                break;
-            }//end switch
-        }//end for
-
-        return $vars;
-
-    }//end getMethodParameters()
-
-
-    /**
-     * Returns the visibility and implementation properties of a method.
-     *
-     * The format of the array is:
-     * <code>
-     *   array(
-     *    'scope'                => 'public', // public protected or protected
-     *    'scope_specified'      => true,     // true is scope keyword was found.
-     *    'return_type'          => '',       // the return type of the method.
-     *    'return_type_token'    => integer,  // The stack pointer to the start of the return type
-     *                                        // or false if there is no return type.
-     *    'nullable_return_type' => false,    // true if the return type is nullable.
-     *    'is_abstract'          => false,    // true if the abstract keyword was found.
-     *    'is_final'             => false,    // true if the final keyword was found.
-     *    'is_static'            => false,    // true if the static keyword was found.
-     *    'has_body'             => false,    // true if the method has a body
-     *   );
-     * </code>
-     *
-     * @param int $stackPtr The position in the stack of the function token to
-     *                      acquire the properties for.
-     *
-     * @return array
-     * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified position is not a
-     *                                                        T_FUNCTION token.
-     */
-    public function getMethodProperties($stackPtr)
-    {
-        if ($this->tokens[$stackPtr]['code'] !== T_FUNCTION
-            && $this->tokens[$stackPtr]['code'] !== T_CLOSURE
-        ) {
-            throw new TokenizerException('$stackPtr must be of type T_FUNCTION or T_CLOSURE');
-        }
-
-        if ($this->tokens[$stackPtr]['code'] === T_FUNCTION) {
-            $valid = [
-                T_PUBLIC      => T_PUBLIC,
-                T_PRIVATE     => T_PRIVATE,
-                T_PROTECTED   => T_PROTECTED,
-                T_STATIC      => T_STATIC,
-                T_FINAL       => T_FINAL,
-                T_ABSTRACT    => T_ABSTRACT,
-                T_WHITESPACE  => T_WHITESPACE,
-                T_COMMENT     => T_COMMENT,
-                T_DOC_COMMENT => T_DOC_COMMENT,
-            ];
-        } else {
-            $valid = [
-                T_STATIC      => T_STATIC,
-                T_WHITESPACE  => T_WHITESPACE,
-                T_COMMENT     => T_COMMENT,
-                T_DOC_COMMENT => T_DOC_COMMENT,
-            ];
-        }
-
-        $scope          = 'public';
-        $scopeSpecified = false;
-        $isAbstract     = false;
-        $isFinal        = false;
-        $isStatic       = false;
-
-        for ($i = ($stackPtr - 1); $i > 0; $i--) {
-            if (isset($valid[$this->tokens[$i]['code']]) === false) {
-                break;
-            }
-
-            switch ($this->tokens[$i]['code']) {
-            case T_PUBLIC:
-                $scope          = 'public';
-                $scopeSpecified = true;
-                break;
-            case T_PRIVATE:
-                $scope          = 'private';
-                $scopeSpecified = true;
-                break;
-            case T_PROTECTED:
-                $scope          = 'protected';
-                $scopeSpecified = true;
-                break;
-            case T_ABSTRACT:
-                $isAbstract = true;
-                break;
-            case T_FINAL:
-                $isFinal = true;
-                break;
-            case T_STATIC:
-                $isStatic = true;
-                break;
-            }//end switch
-        }//end for
-
-        $returnType         = '';
-        $returnTypeToken    = false;
-        $nullableReturnType = false;
-        $hasBody            = true;
-
-        if (isset($this->tokens[$stackPtr]['parenthesis_closer']) === true) {
-            $scopeOpener = null;
-            if (isset($this->tokens[$stackPtr]['scope_opener']) === true) {
-                $scopeOpener = $this->tokens[$stackPtr]['scope_opener'];
-            }
-
-            $valid = [
-                T_STRING       => T_STRING,
-                T_CALLABLE     => T_CALLABLE,
-                T_SELF         => T_SELF,
-                T_PARENT       => T_PARENT,
-                T_NS_SEPARATOR => T_NS_SEPARATOR,
-            ];
-
-            for ($i = $this->tokens[$stackPtr]['parenthesis_closer']; $i < $this->numTokens; $i++) {
-                if (($scopeOpener === null && $this->tokens[$i]['code'] === T_SEMICOLON)
-                    || ($scopeOpener !== null && $i === $scopeOpener)
-                ) {
-                    // End of function definition.
-                    break;
-                }
-
-                if ($this->tokens[$i]['code'] === T_NULLABLE) {
-                    $nullableReturnType = true;
-                }
-
-                if (isset($valid[$this->tokens[$i]['code']]) === true) {
-                    if ($returnTypeToken === false) {
-                        $returnTypeToken = $i;
-                    }
-
-                    $returnType .= $this->tokens[$i]['content'];
-                }
-            }
-
-            $end     = $this->findNext([T_OPEN_CURLY_BRACKET, T_SEMICOLON], $this->tokens[$stackPtr]['parenthesis_closer']);
-            $hasBody = $this->tokens[$end]['code'] === T_OPEN_CURLY_BRACKET;
-        }//end if
-
-        if ($returnType !== '' && $nullableReturnType === true) {
-            $returnType = '?'.$returnType;
-        }
-
-        return [
-            'scope'                => $scope,
-            'scope_specified'      => $scopeSpecified,
-            'return_type'          => $returnType,
-            'return_type_token'    => $returnTypeToken,
-            'nullable_return_type' => $nullableReturnType,
-            'is_abstract'          => $isAbstract,
-            'is_final'             => $isFinal,
-            'is_static'            => $isStatic,
-            'has_body'             => $hasBody,
-        ];
-
-    }//end getMethodProperties()
-
-
-    /**
-     * Returns the visibility and implementation properties of the class member
-     * variable found at the specified position in the stack.
-     *
-     * The format of the array is:
-     *
-     * <code>
-     *   array(
-     *    'scope'           => 'public', // public protected or protected.
-     *    'scope_specified' => false,    // true if the scope was explicitly specified.
-     *    'is_static'       => false,    // true if the static keyword was found.
-     *   );
-     * </code>
-     *
-     * @param int $stackPtr The position in the stack of the T_VARIABLE token to
-     *                      acquire the properties for.
-     *
-     * @return array
-     * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified position is not a
-     *                                                        T_VARIABLE token, or if the position is not
-     *                                                        a class member variable.
-     */
-    public function getMemberProperties($stackPtr)
-    {
-        if ($this->tokens[$stackPtr]['code'] !== T_VARIABLE) {
-            throw new TokenizerException('$stackPtr must be of type T_VARIABLE');
-        }
-
-        $conditions = array_keys($this->tokens[$stackPtr]['conditions']);
-        $ptr        = array_pop($conditions);
-        if (isset($this->tokens[$ptr]) === false
-            || ($this->tokens[$ptr]['code'] !== T_CLASS
-            && $this->tokens[$ptr]['code'] !== T_ANON_CLASS
-            && $this->tokens[$ptr]['code'] !== T_TRAIT)
-        ) {
-            if (isset($this->tokens[$ptr]) === true
-                && $this->tokens[$ptr]['code'] === T_INTERFACE
-            ) {
-                // T_VARIABLEs in interfaces can actually be method arguments
-                // but they wont be seen as being inside the method because there
-                // are no scope openers and closers for abstract methods. If it is in
-                // parentheses, we can be pretty sure it is a method argument.
-                if (isset($this->tokens[$stackPtr]['nested_parenthesis']) === false
-                    || empty($this->tokens[$stackPtr]['nested_parenthesis']) === true
-                ) {
-                    $error = 'Possible parse error: interfaces may not include member vars';
-                    $this->addWarning($error, $stackPtr, 'Internal.ParseError.InterfaceHasMemberVar');
-                    return [];
-                }
-            } else {
-                throw new TokenizerException('$stackPtr is not a class member var');
-            }
-        }
-
-        // Make sure it's not a method parameter.
-        if (empty($this->tokens[$stackPtr]['nested_parenthesis']) === false) {
-            $parenthesis = array_keys($this->tokens[$stackPtr]['nested_parenthesis']);
-            $deepestOpen = array_pop($parenthesis);
-            if ($deepestOpen > $ptr
-                && isset($this->tokens[$deepestOpen]['parenthesis_owner']) === true
-                && $this->tokens[$this->tokens[$deepestOpen]['parenthesis_owner']]['code'] === T_FUNCTION
-            ) {
-                throw new TokenizerException('$stackPtr is not a class member var');
-            }
-        }
-
-        $valid = [
-            T_PUBLIC    => T_PUBLIC,
-            T_PRIVATE   => T_PRIVATE,
-            T_PROTECTED => T_PROTECTED,
-            T_STATIC    => T_STATIC,
-            T_VAR       => T_VAR,
-        ];
-
-        $valid += Util\Tokens::$emptyTokens;
-
-        $scope          = 'public';
-        $scopeSpecified = false;
-        $isStatic       = false;
-
-        $startOfStatement = $this->findPrevious(
-            [
-                T_SEMICOLON,
-                T_OPEN_CURLY_BRACKET,
-                T_CLOSE_CURLY_BRACKET,
-            ],
-            ($stackPtr - 1)
-        );
-
-        for ($i = ($startOfStatement + 1); $i < $stackPtr; $i++) {
-            if (isset($valid[$this->tokens[$i]['code']]) === false) {
-                break;
-            }
-
-            switch ($this->tokens[$i]['code']) {
-            case T_PUBLIC:
-                $scope          = 'public';
-                $scopeSpecified = true;
-                break;
-            case T_PRIVATE:
-                $scope          = 'private';
-                $scopeSpecified = true;
-                break;
-            case T_PROTECTED:
-                $scope          = 'protected';
-                $scopeSpecified = true;
-                break;
-            case T_STATIC:
-                $isStatic = true;
-                break;
-            }
-        }//end for
-
-        return [
-            'scope'           => $scope,
-            'scope_specified' => $scopeSpecified,
-            'is_static'       => $isStatic,
-        ];
-
-    }//end getMemberProperties()
-
-
-    /**
-     * Returns the visibility and implementation properties of a class.
-     *
-     * The format of the array is:
-     * <code>
-     *   array(
-     *    'is_abstract' => false, // true if the abstract keyword was found.
-     *    'is_final'    => false, // true if the final keyword was found.
-     *   );
-     * </code>
-     *
-     * @param int $stackPtr The position in the stack of the T_CLASS token to
-     *                      acquire the properties for.
-     *
-     * @return array
-     * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified position is not a
-     *                                                        T_CLASS token.
-     */
-    public function getClassProperties($stackPtr)
-    {
-        if ($this->tokens[$stackPtr]['code'] !== T_CLASS) {
-            throw new TokenizerException('$stackPtr must be of type T_CLASS');
-        }
-
-        $valid = [
-            T_FINAL       => T_FINAL,
-            T_ABSTRACT    => T_ABSTRACT,
-            T_WHITESPACE  => T_WHITESPACE,
-            T_COMMENT     => T_COMMENT,
-            T_DOC_COMMENT => T_DOC_COMMENT,
-        ];
-
-        $isAbstract = false;
-        $isFinal    = false;
-
-        for ($i = ($stackPtr - 1); $i > 0; $i--) {
-            if (isset($valid[$this->tokens[$i]['code']]) === false) {
-                break;
-            }
-
-            switch ($this->tokens[$i]['code']) {
-            case T_ABSTRACT:
-                $isAbstract = true;
-                break;
-
-            case T_FINAL:
-                $isFinal = true;
-                break;
-            }
-        }//end for
-
-        return [
-            'is_abstract' => $isAbstract,
-            'is_final'    => $isFinal,
-        ];
-
-    }//end getClassProperties()
-
-
-    /**
-     * Determine if the passed token is a reference operator.
-     *
-     * Returns true if the specified token position represents a reference.
-     * Returns false if the token represents a bitwise operator.
-     *
-     * @param int $stackPtr The position of the T_BITWISE_AND token.
-     *
-     * @return boolean
-     */
-    public function isReference($stackPtr)
-    {
-        if ($this->tokens[$stackPtr]['code'] !== T_BITWISE_AND) {
-            return false;
-        }
-
-        $tokenBefore = $this->findPrevious(
-            Util\Tokens::$emptyTokens,
-            ($stackPtr - 1),
-            null,
-            true
-        );
-
-        if ($this->tokens[$tokenBefore]['code'] === T_FUNCTION) {
-            // Function returns a reference.
-            return true;
-        }
-
-        if ($this->tokens[$tokenBefore]['code'] === T_DOUBLE_ARROW) {
-            // Inside a foreach loop or array assignment, this is a reference.
-            return true;
-        }
-
-        if ($this->tokens[$tokenBefore]['code'] === T_AS) {
-            // Inside a foreach loop, this is a reference.
-            return true;
-        }
-
-        if (isset(Util\Tokens::$assignmentTokens[$this->tokens[$tokenBefore]['code']]) === true) {
-            // This is directly after an assignment. It's a reference. Even if
-            // it is part of an operation, the other tests will handle it.
-            return true;
-        }
-
-        $tokenAfter = $this->findNext(
-            Util\Tokens::$emptyTokens,
-            ($stackPtr + 1),
-            null,
-            true
-        );
-
-        if ($this->tokens[$tokenAfter]['code'] === T_NEW) {
-            return true;
-        }
-
-        if (isset($this->tokens[$stackPtr]['nested_parenthesis']) === true) {
-            $brackets    = $this->tokens[$stackPtr]['nested_parenthesis'];
-            $lastBracket = array_pop($brackets);
-            if (isset($this->tokens[$lastBracket]['parenthesis_owner']) === true) {
-                $owner = $this->tokens[$this->tokens[$lastBracket]['parenthesis_owner']];
-                if ($owner['code'] === T_FUNCTION
-                    || $owner['code'] === T_CLOSURE
-                ) {
-                    $params = $this->getMethodParameters($this->tokens[$lastBracket]['parenthesis_owner']);
-                    foreach ($params as $param) {
-                        $varToken = $tokenAfter;
-                        if ($param['variable_length'] === true) {
-                            $varToken = $this->findNext(
-                                (Util\Tokens::$emptyTokens + [T_ELLIPSIS]),
-                                ($stackPtr + 1),
-                                null,
-                                true
-                            );
-                        }
-
-                        if ($param['token'] === $varToken
-                            && $param['pass_by_reference'] === true
-                        ) {
-                            // Function parameter declared to be passed by reference.
-                            return true;
-                        }
-                    }
-                }//end if
-            } else {
-                $prev = false;
-                for ($t = ($this->tokens[$lastBracket]['parenthesis_opener'] - 1); $t >= 0; $t--) {
-                    if ($this->tokens[$t]['code'] !== T_WHITESPACE) {
-                        $prev = $t;
-                        break;
-                    }
-                }
-
-                if ($prev !== false && $this->tokens[$prev]['code'] === T_USE) {
-                    // Closure use by reference.
-                    return true;
-                }
-            }//end if
-        }//end if
-
-        // Pass by reference in function calls and assign by reference in arrays.
-        if ($this->tokens[$tokenBefore]['code'] === T_OPEN_PARENTHESIS
-            || $this->tokens[$tokenBefore]['code'] === T_COMMA
-            || $this->tokens[$tokenBefore]['code'] === T_OPEN_SHORT_ARRAY
-        ) {
-            if ($this->tokens[$tokenAfter]['code'] === T_VARIABLE) {
-                return true;
-            } else {
-                $skip   = Util\Tokens::$emptyTokens;
-                $skip[] = T_NS_SEPARATOR;
-                $skip[] = T_SELF;
-                $skip[] = T_PARENT;
-                $skip[] = T_STATIC;
-                $skip[] = T_STRING;
-                $skip[] = T_NAMESPACE;
-                $skip[] = T_DOUBLE_COLON;
-
-                $nextSignificantAfter = $this->findNext(
-                    $skip,
-                    ($stackPtr + 1),
-                    null,
-                    true
-                );
-                if ($this->tokens[$nextSignificantAfter]['code'] === T_VARIABLE) {
-                    return true;
-                }
-            }//end if
-        }//end if
-
-        return false;
-
-    }//end isReference()
-
-
-    /**
-     * Returns the content of the tokens from the specified start position in
-     * the token stack for the specified length.
-     *
-     * @param int  $start       The position to start from in the token stack.
-     * @param int  $length      The length of tokens to traverse from the start pos.
-     * @param bool $origContent Whether the original content or the tab replaced
-     *                          content should be used.
-     *
-     * @return string The token contents.
-     */
-    public function getTokensAsString($start, $length, $origContent=false)
-    {
-        if (is_int($start) === false || isset($this->tokens[$start]) === false) {
-            throw new RuntimeException('The $start position for getTokensAsString() must exist in the token stack');
-        }
-
-        if (is_int($length) === false || $length <= 0) {
-            return '';
-        }
-
-        $str = '';
-        $end = ($start + $length);
-        if ($end > $this->numTokens) {
-            $end = $this->numTokens;
-        }
-
-        for ($i = $start; $i < $end; $i++) {
-            // If tabs are being converted to spaces by the tokeniser, the
-            // original content should be used instead of the converted content.
-            if ($origContent === true && isset($this->tokens[$i]['orig_content']) === true) {
-                $str .= $this->tokens[$i]['orig_content'];
-            } else {
-                $str .= $this->tokens[$i]['content'];
-            }
-        }
-
-        return $str;
-
-    }//end getTokensAsString()
-
-
-    /**
-     * Returns the position of the previous specified token(s).
-     *
-     * If a value is specified, the previous token of the specified type(s)
-     * containing the specified value will be returned.
-     *
-     * Returns false if no token can be found.
-     *
-     * @param int|string|array $types   The type(s) of tokens to search for.
-     * @param int              $start   The position to start searching from in the
-     *                                  token stack.
-     * @param int              $end     The end position to fail if no token is found.
-     *                                  if not specified or null, end will default to
-     *                                  the start of the token stack.
-     * @param bool             $exclude If true, find the previous token that is NOT of
-     *                                  the types specified in $types.
-     * @param string           $value   The value that the token(s) must be equal to.
-     *                                  If value is omitted, tokens with any value will
-     *                                  be returned.
-     * @param bool             $local   If true, tokens outside the current statement
-     *                                  will not be checked. IE. checking will stop
-     *                                  at the previous semi-colon found.
-     *
-     * @return int|bool
-     * @see    findNext()
-     */
-    public function findPrevious(
-        $types,
-        $start,
-        $end=null,
-        $exclude=false,
-        $value=null,
-        $local=false
-    ) {
-        $types = (array) $types;
-
-        if ($end === null) {
-            $end = 0;
-        }
-
-        for ($i = $start; $i >= $end; $i--) {
-            $found = (bool) $exclude;
-            foreach ($types as $type) {
-                if ($this->tokens[$i]['code'] === $type) {
-                    $found = !$exclude;
-                    break;
-                }
-            }
-
-            if ($found === true) {
-                if ($value === null) {
-                    return $i;
-                } else if ($this->tokens[$i]['content'] === $value) {
-                    return $i;
-                }
-            }
-
-            if ($local === true) {
-                if (isset($this->tokens[$i]['scope_opener']) === true
-                    && $i === $this->tokens[$i]['scope_closer']
-                ) {
-                    $i = $this->tokens[$i]['scope_opener'];
-                } else if (isset($this->tokens[$i]['bracket_opener']) === true
-                    && $i === $this->tokens[$i]['bracket_closer']
-                ) {
-                    $i = $this->tokens[$i]['bracket_opener'];
-                } else if (isset($this->tokens[$i]['parenthesis_opener']) === true
-                    && $i === $this->tokens[$i]['parenthesis_closer']
-                ) {
-                    $i = $this->tokens[$i]['parenthesis_opener'];
-                } else if ($this->tokens[$i]['code'] === T_SEMICOLON) {
-                    break;
-                }
-            }
-        }//end for
-
-        return false;
-
-    }//end findPrevious()
-
-
-    /**
-     * Returns the position of the next specified token(s).
-     *
-     * If a value is specified, the next token of the specified type(s)
-     * containing the specified value will be returned.
-     *
-     * Returns false if no token can be found.
-     *
-     * @param int|string|array $types   The type(s) of tokens to search for.
-     * @param int              $start   The position to start searching from in the
-     *                                  token stack.
-     * @param int              $end     The end position to fail if no token is found.
-     *                                  if not specified or null, end will default to
-     *                                  the end of the token stack.
-     * @param bool             $exclude If true, find the next token that is NOT of
-     *                                  a type specified in $types.
-     * @param string           $value   The value that the token(s) must be equal to.
-     *                                  If value is omitted, tokens with any value will
-     *                                  be returned.
-     * @param bool             $local   If true, tokens outside the current statement
-     *                                  will not be checked. i.e., checking will stop
-     *                                  at the next semi-colon found.
-     *
-     * @return int|bool
-     * @see    findPrevious()
-     */
-    public function findNext(
-        $types,
-        $start,
-        $end=null,
-        $exclude=false,
-        $value=null,
-        $local=false
-    ) {
-        $types = (array) $types;
-
-        if ($end === null || $end > $this->numTokens) {
-            $end = $this->numTokens;
-        }
-
-        for ($i = $start; $i < $end; $i++) {
-            $found = (bool) $exclude;
-            foreach ($types as $type) {
-                if ($this->tokens[$i]['code'] === $type) {
-                    $found = !$exclude;
-                    break;
-                }
-            }
-
-            if ($found === true) {
-                if ($value === null) {
-                    return $i;
-                } else if ($this->tokens[$i]['content'] === $value) {
-                    return $i;
-                }
-            }
-
-            if ($local === true && $this->tokens[$i]['code'] === T_SEMICOLON) {
-                break;
-            }
-        }//end for
-
-        return false;
-
-    }//end findNext()
-
-
-    /**
-     * Returns the position of the first non-whitespace token in a statement.
-     *
-     * @param int       $start  The position to start searching from in the token stack.
-     * @param int|array $ignore Token types that should not be considered stop points.
-     *
-     * @return int
-     */
-    public function findStartOfStatement($start, $ignore=null)
-    {
-        $endTokens = Util\Tokens::$blockOpeners;
-
-        $endTokens[T_COLON]            = true;
-        $endTokens[T_COMMA]            = true;
-        $endTokens[T_DOUBLE_ARROW]     = true;
-        $endTokens[T_SEMICOLON]        = true;
-        $endTokens[T_OPEN_TAG]         = true;
-        $endTokens[T_CLOSE_TAG]        = true;
-        $endTokens[T_OPEN_SHORT_ARRAY] = true;
-
-        if ($ignore !== null) {
-            $ignore = (array) $ignore;
-            foreach ($ignore as $code) {
-                unset($endTokens[$code]);
-            }
-        }
-
-        $lastNotEmpty = $start;
-
-        for ($i = $start; $i >= 0; $i--) {
-            if (isset($endTokens[$this->tokens[$i]['code']]) === true) {
-                // Found the end of the previous statement.
-                return $lastNotEmpty;
-            }
-
-            if (isset($this->tokens[$i]['scope_opener']) === true
-                && $i === $this->tokens[$i]['scope_closer']
-            ) {
-                // Found the end of the previous scope block.
-                return $lastNotEmpty;
-            }
-
-            // Skip nested statements.
-            if (isset($this->tokens[$i]['bracket_opener']) === true
-                && $i === $this->tokens[$i]['bracket_closer']
-            ) {
-                $i = $this->tokens[$i]['bracket_opener'];
-            } else if (isset($this->tokens[$i]['parenthesis_opener']) === true
-                && $i === $this->tokens[$i]['parenthesis_closer']
-            ) {
-                $i = $this->tokens[$i]['parenthesis_opener'];
-            }
-
-            if (isset(Util\Tokens::$emptyTokens[$this->tokens[$i]['code']]) === false) {
-                $lastNotEmpty = $i;
-            }
-        }//end for
-
-        return 0;
-
-    }//end findStartOfStatement()
-
-
-    /**
-     * Returns the position of the last non-whitespace token in a statement.
-     *
-     * @param int       $start  The position to start searching from in the token stack.
-     * @param int|array $ignore Token types that should not be considered stop points.
-     *
-     * @return int
-     */
-    public function findEndOfStatement($start, $ignore=null)
-    {
-        $endTokens = [
-            T_COLON                => true,
-            T_COMMA                => true,
-            T_DOUBLE_ARROW         => true,
-            T_SEMICOLON            => true,
-            T_CLOSE_PARENTHESIS    => true,
-            T_CLOSE_SQUARE_BRACKET => true,
-            T_CLOSE_CURLY_BRACKET  => true,
-            T_CLOSE_SHORT_ARRAY    => true,
-            T_OPEN_TAG             => true,
-            T_CLOSE_TAG            => true,
-        ];
-
-        if ($ignore !== null) {
-            $ignore = (array) $ignore;
-            foreach ($ignore as $code) {
-                unset($endTokens[$code]);
-            }
-        }
-
-        $lastNotEmpty = $start;
-
-        for ($i = $start; $i < $this->numTokens; $i++) {
-            if ($i !== $start && isset($endTokens[$this->tokens[$i]['code']]) === true) {
-                // Found the end of the statement.
-                if ($this->tokens[$i]['code'] === T_CLOSE_PARENTHESIS
-                    || $this->tokens[$i]['code'] === T_CLOSE_SQUARE_BRACKET
-                    || $this->tokens[$i]['code'] === T_CLOSE_CURLY_BRACKET
-                    || $this->tokens[$i]['code'] === T_CLOSE_SHORT_ARRAY
-                    || $this->tokens[$i]['code'] === T_OPEN_TAG
-                    || $this->tokens[$i]['code'] === T_CLOSE_TAG
-                ) {
-                    return $lastNotEmpty;
-                }
-
-                return $i;
-            }
-
-            // Skip nested statements.
-            if (isset($this->tokens[$i]['scope_closer']) === true
-                && ($i === $this->tokens[$i]['scope_opener']
-                || $i === $this->tokens[$i]['scope_condition'])
-            ) {
-                if ($i === $start && isset(Util\Tokens::$scopeOpeners[$this->tokens[$i]['code']]) === true) {
-                    return $this->tokens[$i]['scope_closer'];
-                }
-
-                $i = $this->tokens[$i]['scope_closer'];
-            } else if (isset($this->tokens[$i]['bracket_closer']) === true
-                && $i === $this->tokens[$i]['bracket_opener']
-            ) {
-                $i = $this->tokens[$i]['bracket_closer'];
-            } else if (isset($this->tokens[$i]['parenthesis_closer']) === true
-                && $i === $this->tokens[$i]['parenthesis_opener']
-            ) {
-                $i = $this->tokens[$i]['parenthesis_closer'];
-            }
-
-            if (isset(Util\Tokens::$emptyTokens[$this->tokens[$i]['code']]) === false) {
-                $lastNotEmpty = $i;
-            }
-        }//end for
-
-        return ($this->numTokens - 1);
-
-    }//end findEndOfStatement()
-
-
-    /**
-     * Returns the position of the first token on a line, matching given type.
-     *
-     * Returns false if no token can be found.
-     *
-     * @param int|string|array $types   The type(s) of tokens to search for.
-     * @param int              $start   The position to start searching from in the
-     *                                  token stack. The first token matching on
-     *                                  this line before this token will be returned.
-     * @param bool             $exclude If true, find the token that is NOT of
-     *                                  the types specified in $types.
-     * @param string           $value   The value that the token must be equal to.
-     *                                  If value is omitted, tokens with any value will
-     *                                  be returned.
-     *
-     * @return int | bool
-     */
-    public function findFirstOnLine($types, $start, $exclude=false, $value=null)
-    {
-        if (is_array($types) === false) {
-            $types = [$types];
-        }
-
-        $foundToken = false;
-
-        for ($i = $start; $i >= 0; $i--) {
-            if ($this->tokens[$i]['line'] < $this->tokens[$start]['line']) {
-                break;
-            }
-
-            $found = $exclude;
-            foreach ($types as $type) {
-                if ($exclude === false) {
-                    if ($this->tokens[$i]['code'] === $type) {
-                        $found = true;
-                        break;
-                    }
-                } else {
-                    if ($this->tokens[$i]['code'] === $type) {
-                        $found = false;
-                        break;
-                    }
-                }
-            }
-
-            if ($found === true) {
-                if ($value === null) {
-                    $foundToken = $i;
-                } else if ($this->tokens[$i]['content'] === $value) {
-                    $foundToken = $i;
-                }
-            }
-        }//end for
-
-        return $foundToken;
-
-    }//end findFirstOnLine()
-
-
-    /**
-     * Determine if the passed token has a condition of one of the passed types.
-     *
-     * @param int              $stackPtr The position of the token we are checking.
-     * @param int|string|array $types    The type(s) of tokens to search for.
-     *
-     * @return boolean
-     */
-    public function hasCondition($stackPtr, $types)
-    {
-        // Check for the existence of the token.
-        if (isset($this->tokens[$stackPtr]) === false) {
-            return false;
-        }
-
-        // Make sure the token has conditions.
-        if (isset($this->tokens[$stackPtr]['conditions']) === false) {
-            return false;
-        }
-
-        $types      = (array) $types;
-        $conditions = $this->tokens[$stackPtr]['conditions'];
-
-        foreach ($types as $type) {
-            if (in_array($type, $conditions, true) === true) {
-                // We found a token with the required type.
-                return true;
-            }
-        }
-
-        return false;
-
-    }//end hasCondition()
-
-
-    /**
-     * Return the position of the condition for the passed token.
-     *
-     * Returns FALSE if the token does not have the condition.
-     *
-     * @param int        $stackPtr The position of the token we are checking.
-     * @param int|string $type     The type of token to search for.
-     *
-     * @return int
-     */
-    public function getCondition($stackPtr, $type)
-    {
-        // Check for the existence of the token.
-        if (isset($this->tokens[$stackPtr]) === false) {
-            return false;
-        }
-
-        // Make sure the token has conditions.
-        if (isset($this->tokens[$stackPtr]['conditions']) === false) {
-            return false;
-        }
-
-        $conditions = $this->tokens[$stackPtr]['conditions'];
-        foreach ($conditions as $token => $condition) {
-            if ($condition === $type) {
-                return $token;
-            }
-        }
-
-        return false;
-
-    }//end getCondition()
-
-
-    /**
-     * Returns the name of the class that the specified class extends.
-     * (works for classes, anonymous classes and interfaces)
-     *
-     * Returns FALSE on error or if there is no extended class name.
-     *
-     * @param int $stackPtr The stack position of the class.
-     *
-     * @return string|false
-     */
-    public function findExtendedClassName($stackPtr)
-    {
-        // Check for the existence of the token.
-        if (isset($this->tokens[$stackPtr]) === false) {
-            return false;
-        }
-
-        if ($this->tokens[$stackPtr]['code'] !== T_CLASS
-            && $this->tokens[$stackPtr]['code'] !== T_ANON_CLASS
-            && $this->tokens[$stackPtr]['code'] !== T_INTERFACE
-        ) {
-            return false;
-        }
-
-        if (isset($this->tokens[$stackPtr]['scope_opener']) === false) {
-            return false;
-        }
-
-        $classOpenerIndex = $this->tokens[$stackPtr]['scope_opener'];
-        $extendsIndex     = $this->findNext(T_EXTENDS, $stackPtr, $classOpenerIndex);
-        if (false === $extendsIndex) {
-            return false;
-        }
-
-        $find = [
-            T_NS_SEPARATOR,
-            T_STRING,
-            T_WHITESPACE,
-        ];
-
-        $end  = $this->findNext($find, ($extendsIndex + 1), ($classOpenerIndex + 1), true);
-        $name = $this->getTokensAsString(($extendsIndex + 1), ($end - $extendsIndex - 1));
-        $name = trim($name);
-
-        if ($name === '') {
-            return false;
-        }
-
-        return $name;
-
-    }//end findExtendedClassName()
-
-
-    /**
-     * Returns the names of the interfaces that the specified class implements.
-     *
-     * Returns FALSE on error or if there are no implemented interface names.
-     *
-     * @param int $stackPtr The stack position of the class.
-     *
-     * @return array|false
-     */
-    public function findImplementedInterfaceNames($stackPtr)
-    {
-        // Check for the existence of the token.
-        if (isset($this->tokens[$stackPtr]) === false) {
-            return false;
-        }
-
-        if ($this->tokens[$stackPtr]['code'] !== T_CLASS
-            && $this->tokens[$stackPtr]['code'] !== T_ANON_CLASS
-        ) {
-            return false;
-        }
-
-        if (isset($this->tokens[$stackPtr]['scope_closer']) === false) {
-            return false;
-        }
-
-        $classOpenerIndex = $this->tokens[$stackPtr]['scope_opener'];
-        $implementsIndex  = $this->findNext(T_IMPLEMENTS, $stackPtr, $classOpenerIndex);
-        if ($implementsIndex === false) {
-            return false;
-        }
-
-        $find = [
-            T_NS_SEPARATOR,
-            T_STRING,
-            T_WHITESPACE,
-            T_COMMA,
-        ];
-
-        $end  = $this->findNext($find, ($implementsIndex + 1), ($classOpenerIndex + 1), true);
-        $name = $this->getTokensAsString(($implementsIndex + 1), ($end - $implementsIndex - 1));
-        $name = trim($name);
-
-        if ($name === '') {
-            return false;
-        } else {
-            $names = explode(',', $name);
-            $names = array_map('trim', $names);
-            return $names;
-        }
-
-    }//end findImplementedInterfaceNames()
+	/**
+	 * The absolute path to the file associated with this object.
+	 *
+	 * @var string
+	 */
+	public $path = '';
+
+	/**
+	 * The content of the file.
+	 *
+	 * @var string
+	 */
+	protected $content = '';
+
+	/**
+	 * The config data for the run.
+	 *
+	 * @var \PHP_CodeSniffer\Config
+	 */
+	public $config = null;
+
+	/**
+	 * The ruleset used for the run.
+	 *
+	 * @var \PHP_CodeSniffer\Ruleset
+	 */
+	public $ruleset = null;
+
+	/**
+	 * If TRUE, the entire file is being ignored.
+	 *
+	 * @var boolean
+	 */
+	public $ignored = false;
+
+	/**
+	 * The EOL character this file uses.
+	 *
+	 * @var string
+	 */
+	public $eolChar = '';
+
+	/**
+	 * The Fixer object to control fixing errors.
+	 *
+	 * @var \PHP_CodeSniffer\Fixer
+	 */
+	public $fixer = null;
+
+	/**
+	 * The tokenizer being used for this file.
+	 *
+	 * @var \PHP_CodeSniffer\Tokenizers\Tokenizer
+	 */
+	public $tokenizer = null;
+
+	/**
+	 * The name of the tokenizer being used for this file.
+	 *
+	 * @var string
+	 */
+	public $tokenizerType = 'PHP';
+
+	/**
+	 * Was the file loaded from cache?
+	 *
+	 * If TRUE, the file was loaded from a local cache.
+	 * If FALSE, the file was tokenized and processed fully.
+	 *
+	 * @var boolean
+	 */
+	public $fromCache = false;
+
+	/**
+	 * The number of tokens in this file.
+	 *
+	 * Stored here to save calling count() everywhere.
+	 *
+	 * @var integer
+	 */
+	public $numTokens = 0;
+
+	/**
+	 * The tokens stack map.
+	 *
+	 * @var array
+	 */
+	protected $tokens = [];
+
+	/**
+	 * The errors raised from sniffs.
+	 *
+	 * @var array
+	 * @see getErrors()
+	 */
+	protected $errors = [];
+
+	/**
+	 * The warnings raised from sniffs.
+	 *
+	 * @var array
+	 * @see getWarnings()
+	 */
+	protected $warnings = [];
+
+	/**
+	 * The metrics recorded by sniffs.
+	 *
+	 * @var array
+	 * @see getMetrics()
+	 */
+	protected $metrics = [];
+
+	/**
+	 * The metrics recorded for each token.
+	 *
+	 * Stops the same metric being recorded for the same token twice.
+	 *
+	 * @var array
+	 * @see getMetrics()
+	 */
+	private $metricTokens = [];
+
+	/**
+	 * The total number of errors raised.
+	 *
+	 * @var integer
+	 */
+	protected $errorCount = 0;
+
+	/**
+	 * The total number of warnings raised.
+	 *
+	 * @var integer
+	 */
+	protected $warningCount = 0;
+
+	/**
+	 * The total number of errors and warnings that can be fixed.
+	 *
+	 * @var integer
+	 */
+	protected $fixableCount = 0;
+
+	/**
+	 * The total number of errors and warnings that were fixed.
+	 *
+	 * @var integer
+	 */
+	protected $fixedCount = 0;
+
+	/**
+	 * An array of sniffs that are being ignored.
+	 *
+	 * @var array
+	 */
+	protected $ignoredListeners = [];
+
+	/**
+	 * An array of message codes that are being ignored.
+	 *
+	 * @var array
+	 */
+	protected $ignoredCodes = [];
+
+	/**
+	 * An array of sniffs listening to this file's processing.
+	 *
+	 * @var \PHP_CodeSniffer\Sniffs\Sniff[]
+	 */
+	protected $listeners = [];
+
+	/**
+	 * The class name of the sniff currently processing the file.
+	 *
+	 * @var string
+	 */
+	protected $activeListener = '';
+
+	/**
+	 * An array of sniffs being processed and how long they took.
+	 *
+	 * @var array
+	 */
+	protected $listenerTimes = [];
+
+	/**
+	 * A cache of often used config settings to improve performance.
+	 *
+	 * Storing them here saves 10k+ calls to __get() in the Config class.
+	 *
+	 * @var array
+	 */
+	protected $configCache = [];
+
+
+	/**
+	 * Constructs a file.
+	 *
+	 * @param string                   $path    The absolute path to the file to process.
+	 * @param \PHP_CodeSniffer\Ruleset $ruleset The ruleset used for the run.
+	 * @param \PHP_CodeSniffer\Config  $config  The config data for the run.
+	 *
+	 * @return void
+	 */
+	public function __construct($path, Ruleset $ruleset, Config $config)
+	{
+		$this->path    = $path;
+		$this->ruleset = $ruleset;
+		$this->config  = $config;
+		$this->fixer   = new Fixer();
+
+		$parts     = explode('.', $path);
+		$extension = array_pop($parts);
+		if (isset($config->extensions[$extension]) === true) {
+			$this->tokenizerType = $config->extensions[$extension];
+		} else {
+			// Revert to default.
+			$this->tokenizerType = 'PHP';
+		}
+
+		$this->configCache['cache']           = $this->config->cache;
+		$this->configCache['sniffs']          = array_map('strtolower', $this->config->sniffs);
+		$this->configCache['exclude']         = array_map('strtolower', $this->config->exclude);
+		$this->configCache['errorSeverity']   = $this->config->errorSeverity;
+		$this->configCache['warningSeverity'] = $this->config->warningSeverity;
+		$this->configCache['recordErrors']    = $this->config->recordErrors;
+		$this->configCache['ignorePatterns']  = $this->ruleset->ignorePatterns;
+		$this->configCache['includePatterns'] = $this->ruleset->includePatterns;
+
+	}//end __construct()
+
+
+	/**
+	 * Set the content of the file.
+	 *
+	 * Setting the content also calculates the EOL char being used.
+	 *
+	 * @param string $content The file content.
+	 *
+	 * @return void
+	 */
+	public function setContent($content)
+	{
+		$this->content = $content;
+		$this->tokens  = [];
+
+		try {
+			$this->eolChar = Util\Common::detectLineEndings($content);
+		} catch (RuntimeException $e) {
+			$this->addWarningOnLine($e->getMessage(), 1, 'Internal.DetectLineEndings');
+			return;
+		}
+
+	}//end setContent()
+
+
+	/**
+	 * Reloads the content of the file.
+	 *
+	 * By default, we have no idea where our content comes from,
+	 * so we can't do anything.
+	 *
+	 * @return void
+	 */
+	public function reloadContent()
+	{
+
+	}//end reloadContent()
+
+
+	/**
+	 * Disables caching of this file.
+	 *
+	 * @return void
+	 */
+	public function disableCaching()
+	{
+		$this->configCache['cache'] = false;
+
+	}//end disableCaching()
+
+
+	/**
+	 * Starts the stack traversal and tells listeners when tokens are found.
+	 *
+	 * @return void
+	 */
+	public function process()
+	{
+		if ($this->ignored === true) {
+			return;
+		}
+
+		$this->errors       = [];
+		$this->warnings     = [];
+		$this->errorCount   = 0;
+		$this->warningCount = 0;
+		$this->fixableCount = 0;
+
+		$this->parse();
+
+		// Check if tokenizer errors cause this file to be ignored.
+		if ($this->ignored === true) {
+			return;
+		}
+
+		$this->fixer->startFile($this);
+
+		if (PHP_CODESNIFFER_VERBOSITY > 2) {
+			echo "\t*** START TOKEN PROCESSING ***".PHP_EOL;
+		}
+
+		$foundCode        = false;
+		$listenerIgnoreTo = [];
+		$inTests          = defined('PHP_CODESNIFFER_IN_TESTS');
+		$checkAnnotations = $this->config->annotations;
+
+		// Foreach of the listeners that have registered to listen for this
+		// token, get them to process it.
+		foreach ($this->tokens as $stackPtr => $token) {
+			// Check for ignored lines.
+			if ($checkAnnotations === true
+				&& ($token['code'] === T_COMMENT
+				|| $token['code'] === T_PHPCS_IGNORE_FILE
+				|| $token['code'] === T_PHPCS_SET
+				|| $token['code'] === T_DOC_COMMENT_STRING
+				|| $token['code'] === T_DOC_COMMENT_TAG
+				|| ($inTests === true && $token['code'] === T_INLINE_HTML))
+			) {
+				$commentText      = ltrim($this->tokens[$stackPtr]['content'], ' /*');
+				$commentTextLower = strtolower($commentText);
+				if (strpos($commentText, '@codingStandards') !== false) {
+					if (strpos($commentText, '@codingStandardsIgnoreFile') !== false) {
+						// Ignoring the whole file, just a little late.
+						$this->errors       = [];
+						$this->warnings     = [];
+						$this->errorCount   = 0;
+						$this->warningCount = 0;
+						$this->fixableCount = 0;
+						return;
+					} else if (strpos($commentText, '@codingStandardsChangeSetting') !== false) {
+						$start   = strpos($commentText, '@codingStandardsChangeSetting');
+						$comment = substr($commentText, ($start + 30));
+						$parts   = explode(' ', $comment);
+						if (count($parts) >= 2) {
+							$sniffParts = explode('.', $parts[0]);
+							if (count($sniffParts) >= 3) {
+								// If the sniff code is not known to us, it has not been registered in this run.
+								// But don't throw an error as it could be there for a different standard to use.
+								if (isset($this->ruleset->sniffCodes[$parts[0]]) === true) {
+									$listenerCode  = array_shift($parts);
+									$propertyCode  = array_shift($parts);
+									$propertyValue = rtrim(implode(' ', $parts), " */\r\n");
+									$listenerClass = $this->ruleset->sniffCodes[$listenerCode];
+									$this->ruleset->setSniffProperty($listenerClass, $propertyCode, $propertyValue);
+								}
+							}
+						}
+					}//end if
+				} else if (substr($commentTextLower, 0, 16) === 'phpcs:ignorefile'
+					|| substr($commentTextLower, 0, 17) === '@phpcs:ignorefile'
+				) {
+					// Ignoring the whole file, just a little late.
+					$this->errors       = [];
+					$this->warnings     = [];
+					$this->errorCount   = 0;
+					$this->warningCount = 0;
+					$this->fixableCount = 0;
+					return;
+				} else if (substr($commentTextLower, 0, 9) === 'phpcs:set'
+					|| substr($commentTextLower, 0, 10) === '@phpcs:set'
+				) {
+					if (isset($token['sniffCode']) === true) {
+						$listenerCode = $token['sniffCode'];
+						if (isset($this->ruleset->sniffCodes[$listenerCode]) === true) {
+							$propertyCode  = $token['sniffProperty'];
+							$propertyValue = $token['sniffPropertyValue'];
+							$listenerClass = $this->ruleset->sniffCodes[$listenerCode];
+							$this->ruleset->setSniffProperty($listenerClass, $propertyCode, $propertyValue);
+						}
+					}
+				}//end if
+			}//end if
+
+			if (PHP_CODESNIFFER_VERBOSITY > 2) {
+				$type    = $token['type'];
+				$content = Util\Common::prepareForOutput($token['content']);
+				echo "\t\tProcess token $stackPtr: $type => $content".PHP_EOL;
+			}
+
+			if ($token['code'] !== T_INLINE_HTML) {
+				$foundCode = true;
+			}
+
+			if (isset($this->ruleset->tokenListeners[$token['code']]) === false) {
+				continue;
+			}
+
+			foreach ($this->ruleset->tokenListeners[$token['code']] as $listenerData) {
+				if (isset($this->ignoredListeners[$listenerData['class']]) === true
+					|| (isset($listenerIgnoreTo[$listenerData['class']]) === true
+					&& $listenerIgnoreTo[$listenerData['class']] > $stackPtr)
+				) {
+					// This sniff is ignoring past this token, or the whole file.
+					continue;
+				}
+
+				// Make sure this sniff supports the tokenizer
+				// we are currently using.
+				$class = $listenerData['class'];
+
+				if (isset($listenerData['tokenizers'][$this->tokenizerType]) === false) {
+					continue;
+				}
+
+				// If the file path matches one of our ignore patterns, skip it.
+				// While there is support for a type of each pattern
+				// (absolute or relative) we don't actually support it here.
+				foreach ($listenerData['ignore'] as $pattern) {
+					// We assume a / directory separator, as do the exclude rules
+					// most developers write, so we need a special case for any system
+					// that is different.
+					if (DIRECTORY_SEPARATOR === '\\') {
+						$pattern = str_replace('/', '\\\\', $pattern);
+					}
+
+					$pattern = '`'.$pattern.'`i';
+					if (preg_match($pattern, $this->path) === 1) {
+						$this->ignoredListeners[$class] = true;
+						continue(2);
+					}
+				}
+
+				// If the file path does not match one of our include patterns, skip it.
+				// While there is support for a type of each pattern
+				// (absolute or relative) we don't actually support it here.
+				if (empty($listenerData['include']) === false) {
+					$included = false;
+					foreach ($listenerData['include'] as $pattern) {
+						// We assume a / directory separator, as do the exclude rules
+						// most developers write, so we need a special case for any system
+						// that is different.
+						if (DIRECTORY_SEPARATOR === '\\') {
+							$pattern = str_replace('/', '\\\\', $pattern);
+						}
+
+						$pattern = '`'.$pattern.'`i';
+						if (preg_match($pattern, $this->path) === 1) {
+							$included = true;
+							break;
+						}
+					}
+
+					if ($included === false) {
+						$this->ignoredListeners[$class] = true;
+						continue;
+					}
+				}//end if
+
+				$this->activeListener = $class;
+
+				if (PHP_CODESNIFFER_VERBOSITY > 2) {
+					$startTime = microtime(true);
+					echo "\t\t\tProcessing ".$this->activeListener.'... ';
+				}
+
+				$ignoreTo = $this->ruleset->sniffs[$class]->process($this, $stackPtr);
+				if ($ignoreTo !== null) {
+					$listenerIgnoreTo[$this->activeListener] = $ignoreTo;
+				}
+
+				if (PHP_CODESNIFFER_VERBOSITY > 2) {
+					$timeTaken = (microtime(true) - $startTime);
+					if (isset($this->listenerTimes[$this->activeListener]) === false) {
+						$this->listenerTimes[$this->activeListener] = 0;
+					}
+
+					$this->listenerTimes[$this->activeListener] += $timeTaken;
+
+					$timeTaken = round(($timeTaken), 4);
+					echo "DONE in $timeTaken seconds".PHP_EOL;
+				}
+
+				$this->activeListener = '';
+			}//end foreach
+		}//end foreach
+
+		// If short open tags are off but the file being checked uses
+		// short open tags, the whole content will be inline HTML
+		// and nothing will be checked. So try and handle this case.
+		// We don't show this error for STDIN because we can't be sure the content
+		// actually came directly from the user. It could be something like
+		// refs from a Git pre-push hook.
+		if ($foundCode === false && $this->tokenizerType === 'PHP' && $this->path !== 'STDIN') {
+			$shortTags = (bool) ini_get('short_open_tag');
+			if ($shortTags === false) {
+				$error = 'No PHP code was found in this file and short open tags are not allowed by this install of PHP. This file may be using short open tags but PHP does not allow them.';
+				$this->addWarning($error, null, 'Internal.NoCodeFound');
+			}
+		}
+
+		if (PHP_CODESNIFFER_VERBOSITY > 2) {
+			echo "\t*** END TOKEN PROCESSING ***".PHP_EOL;
+			echo "\t*** START SNIFF PROCESSING REPORT ***".PHP_EOL;
+
+			asort($this->listenerTimes, SORT_NUMERIC);
+			$this->listenerTimes = array_reverse($this->listenerTimes, true);
+			foreach ($this->listenerTimes as $listener => $timeTaken) {
+				echo "\t$listener: ".round(($timeTaken), 4).' secs'.PHP_EOL;
+			}
+
+			echo "\t*** END SNIFF PROCESSING REPORT ***".PHP_EOL;
+		}
+
+		$this->fixedCount += $this->fixer->getFixCount();
+
+	}//end process()
+
+
+	/**
+	 * Tokenizes the file and prepares it for the test run.
+	 *
+	 * @return void
+	 */
+	public function parse()
+	{
+		if (empty($this->tokens) === false) {
+			// File has already been parsed.
+			return;
+		}
+
+		try {
+			$tokenizerClass  = 'PHP_CodeSniffer\Tokenizers\\'.$this->tokenizerType;
+			$this->tokenizer = new $tokenizerClass($this->content, $this->config, $this->eolChar);
+			$this->tokens    = $this->tokenizer->getTokens();
+		} catch (TokenizerException $e) {
+			$this->ignored = true;
+			$this->addWarning($e->getMessage(), null, 'Internal.Tokenizer.Exception');
+			if (PHP_CODESNIFFER_VERBOSITY > 0) {
+				echo "[$this->tokenizerType => tokenizer error]... ";
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo PHP_EOL;
+				}
+			}
+
+			return;
+		}
+
+		$this->numTokens = count($this->tokens);
+
+		// Check for mixed line endings as these can cause tokenizer errors and we
+		// should let the user know that the results they get may be incorrect.
+		// This is done by removing all backslashes, removing the newline char we
+		// detected, then converting newlines chars into text. If any backslashes
+		// are left at the end, we have additional newline chars in use.
+		$contents = str_replace('\\', '', $this->content);
+		$contents = str_replace($this->eolChar, '', $contents);
+		$contents = str_replace("\n", '\n', $contents);
+		$contents = str_replace("\r", '\r', $contents);
+		if (strpos($contents, '\\') !== false) {
+			$error = 'File has mixed line endings; this may cause incorrect results';
+			$this->addWarningOnLine($error, 1, 'Internal.LineEndings.Mixed');
+		}
+
+		if (PHP_CODESNIFFER_VERBOSITY > 0) {
+			if ($this->numTokens === 0) {
+				$numLines = 0;
+			} else {
+				$numLines = $this->tokens[($this->numTokens - 1)]['line'];
+			}
+
+			echo "[$this->tokenizerType => $this->numTokens tokens in $numLines lines]... ";
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				echo PHP_EOL;
+			}
+		}
+
+	}//end parse()
+
+
+	/**
+	 * Returns the token stack for this file.
+	 *
+	 * @return array
+	 */
+	public function getTokens()
+	{
+		return $this->tokens;
+
+	}//end getTokens()
+
+
+	/**
+	 * Remove vars stored in this file that are no longer required.
+	 *
+	 * @return void
+	 */
+	public function cleanUp()
+	{
+		$this->listenerTimes = null;
+		$this->content       = null;
+		$this->tokens        = null;
+		$this->metricTokens  = null;
+		$this->tokenizer     = null;
+		$this->fixer         = null;
+		$this->config        = null;
+		$this->ruleset       = null;
+
+	}//end cleanUp()
+
+
+	/**
+	 * Records an error against a specific token in the file.
+	 *
+	 * @param string  $error    The error message.
+	 * @param int     $stackPtr The stack position where the error occurred.
+	 * @param string  $code     A violation code unique to the sniff message.
+	 * @param array   $data     Replacements for the error message.
+	 * @param int     $severity The severity level for this error. A value of 0
+	 *                          will be converted into the default severity level.
+	 * @param boolean $fixable  Can the error be fixed by the sniff?
+	 *
+	 * @return boolean
+	 */
+	public function addError(
+		$error,
+		$stackPtr,
+		$code,
+		$data=[],
+		$severity=0,
+		$fixable=false
+	) {
+		if ($stackPtr === null) {
+			$line   = 1;
+			$column = 1;
+		} else {
+			$line   = $this->tokens[$stackPtr]['line'];
+			$column = $this->tokens[$stackPtr]['column'];
+		}
+
+		return $this->addMessage(true, $error, $line, $column, $code, $data, $severity, $fixable);
+
+	}//end addError()
+
+
+	/**
+	 * Records a warning against a specific token in the file.
+	 *
+	 * @param string  $warning  The error message.
+	 * @param int     $stackPtr The stack position where the error occurred.
+	 * @param string  $code     A violation code unique to the sniff message.
+	 * @param array   $data     Replacements for the warning message.
+	 * @param int     $severity The severity level for this warning. A value of 0
+	 *                          will be converted into the default severity level.
+	 * @param boolean $fixable  Can the warning be fixed by the sniff?
+	 *
+	 * @return boolean
+	 */
+	public function addWarning(
+		$warning,
+		$stackPtr,
+		$code,
+		$data=[],
+		$severity=0,
+		$fixable=false
+	) {
+		if ($stackPtr === null) {
+			$line   = 1;
+			$column = 1;
+		} else {
+			$line   = $this->tokens[$stackPtr]['line'];
+			$column = $this->tokens[$stackPtr]['column'];
+		}
+
+		return $this->addMessage(false, $warning, $line, $column, $code, $data, $severity, $fixable);
+
+	}//end addWarning()
+
+
+	/**
+	 * Records an error against a specific line in the file.
+	 *
+	 * @param string $error    The error message.
+	 * @param int    $line     The line on which the error occurred.
+	 * @param string $code     A violation code unique to the sniff message.
+	 * @param array  $data     Replacements for the error message.
+	 * @param int    $severity The severity level for this error. A value of 0
+	 *                         will be converted into the default severity level.
+	 *
+	 * @return boolean
+	 */
+	public function addErrorOnLine(
+		$error,
+		$line,
+		$code,
+		$data=[],
+		$severity=0
+	) {
+		return $this->addMessage(true, $error, $line, 1, $code, $data, $severity, false);
+
+	}//end addErrorOnLine()
+
+
+	/**
+	 * Records a warning against a specific token in the file.
+	 *
+	 * @param string $warning  The error message.
+	 * @param int    $line     The line on which the warning occurred.
+	 * @param string $code     A violation code unique to the sniff message.
+	 * @param array  $data     Replacements for the warning message.
+	 * @param int    $severity The severity level for this warning. A value of 0 will
+	 *                         will be converted into the default severity level.
+	 *
+	 * @return boolean
+	 */
+	public function addWarningOnLine(
+		$warning,
+		$line,
+		$code,
+		$data=[],
+		$severity=0
+	) {
+		return $this->addMessage(false, $warning, $line, 1, $code, $data, $severity, false);
+
+	}//end addWarningOnLine()
+
+
+	/**
+	 * Records a fixable error against a specific token in the file.
+	 *
+	 * Returns true if the error was recorded and should be fixed.
+	 *
+	 * @param string $error    The error message.
+	 * @param int    $stackPtr The stack position where the error occurred.
+	 * @param string $code     A violation code unique to the sniff message.
+	 * @param array  $data     Replacements for the error message.
+	 * @param int    $severity The severity level for this error. A value of 0
+	 *                         will be converted into the default severity level.
+	 *
+	 * @return boolean
+	 */
+	public function addFixableError(
+		$error,
+		$stackPtr,
+		$code,
+		$data=[],
+		$severity=0
+	) {
+		$recorded = $this->addError($error, $stackPtr, $code, $data, $severity, true);
+		if ($recorded === true && $this->fixer->enabled === true) {
+			return true;
+		}
+
+		return false;
+
+	}//end addFixableError()
+
+
+	/**
+	 * Records a fixable warning against a specific token in the file.
+	 *
+	 * Returns true if the warning was recorded and should be fixed.
+	 *
+	 * @param string $warning  The error message.
+	 * @param int    $stackPtr The stack position where the error occurred.
+	 * @param string $code     A violation code unique to the sniff message.
+	 * @param array  $data     Replacements for the warning message.
+	 * @param int    $severity The severity level for this warning. A value of 0
+	 *                         will be converted into the default severity level.
+	 *
+	 * @return boolean
+	 */
+	public function addFixableWarning(
+		$warning,
+		$stackPtr,
+		$code,
+		$data=[],
+		$severity=0
+	) {
+		$recorded = $this->addWarning($warning, $stackPtr, $code, $data, $severity, true);
+		if ($recorded === true && $this->fixer->enabled === true) {
+			return true;
+		}
+
+		return false;
+
+	}//end addFixableWarning()
+
+
+	/**
+	 * Adds an error to the error stack.
+	 *
+	 * @param boolean $error    Is this an error message?
+	 * @param string  $message  The text of the message.
+	 * @param int     $line     The line on which the message occurred.
+	 * @param int     $column   The column at which the message occurred.
+	 * @param string  $code     A violation code unique to the sniff message.
+	 * @param array   $data     Replacements for the message.
+	 * @param int     $severity The severity level for this message. A value of 0
+	 *                          will be converted into the default severity level.
+	 * @param boolean $fixable  Can the problem be fixed by the sniff?
+	 *
+	 * @return boolean
+	 */
+	protected function addMessage($error, $message, $line, $column, $code, $data, $severity, $fixable)
+	{
+		// Check if this line is ignoring all message codes.
+		if (isset($this->tokenizer->ignoredLines[$line]['.all']) === true) {
+			return false;
+		}
+
+		// Work out which sniff generated the message.
+		$parts = explode('.', $code);
+		if ($parts[0] === 'Internal') {
+			// An internal message.
+			$listenerCode = Util\Common::getSniffCode($this->activeListener);
+			$sniffCode    = $code;
+			$checkCodes   = [$sniffCode];
+		} else {
+			if ($parts[0] !== $code) {
+				// The full message code has been passed in.
+				$sniffCode    = $code;
+				$listenerCode = substr($sniffCode, 0, strrpos($sniffCode, '.'));
+			} else {
+				$listenerCode = Util\Common::getSniffCode($this->activeListener);
+				$sniffCode    = $listenerCode.'.'.$code;
+				$parts        = explode('.', $sniffCode);
+			}
+
+			$checkCodes = [
+				$sniffCode,
+				$parts[0].'.'.$parts[1].'.'.$parts[2],
+				$parts[0].'.'.$parts[1],
+				$parts[0],
+			];
+		}//end if
+
+		if (isset($this->tokenizer->ignoredLines[$line]) === true) {
+			// Check if this line is ignoring this specific message.
+			$ignored = false;
+			foreach ($checkCodes as $checkCode) {
+				if (isset($this->tokenizer->ignoredLines[$line][$checkCode]) === true) {
+					$ignored = true;
+					break;
+				}
+			}
+
+			// If it is ignored, make sure it's not whitelisted.
+			if ($ignored === true
+				&& isset($this->tokenizer->ignoredLines[$line]['.except']) === true
+			) {
+				foreach ($checkCodes as $checkCode) {
+					if (isset($this->tokenizer->ignoredLines[$line]['.except'][$checkCode]) === true) {
+						$ignored = false;
+						break;
+					}
+				}
+			}
+
+			if ($ignored === true) {
+				return false;
+			}
+		}//end if
+
+		$includeAll = true;
+		if ($this->configCache['cache'] === false
+			|| $this->configCache['recordErrors'] === false
+		) {
+			$includeAll = false;
+		}
+
+		// Filter out any messages for sniffs that shouldn't have run
+		// due to the use of the --sniffs command line argument.
+		if ($includeAll === false
+			&& ((empty($this->configCache['sniffs']) === false
+			&& in_array(strtolower($listenerCode), $this->configCache['sniffs'], true) === false)
+			|| (empty($this->configCache['exclude']) === false
+			&& in_array(strtolower($listenerCode), $this->configCache['exclude'], true) === true))
+		) {
+			return false;
+		}
+
+		// If we know this sniff code is being ignored for this file, return early.
+		foreach ($checkCodes as $checkCode) {
+			if (isset($this->ignoredCodes[$checkCode]) === true) {
+				return false;
+			}
+		}
+
+		$oppositeType = 'warning';
+		if ($error === false) {
+			$oppositeType = 'error';
+		}
+
+		foreach ($checkCodes as $checkCode) {
+			// Make sure this message type has not been set to the opposite message type.
+			if (isset($this->ruleset->ruleset[$checkCode]['type']) === true
+				&& $this->ruleset->ruleset[$checkCode]['type'] === $oppositeType
+			) {
+				$error = !$error;
+				break;
+			}
+		}
+
+		if ($error === true) {
+			$configSeverity = $this->configCache['errorSeverity'];
+			$messageCount   = &$this->errorCount;
+			$messages       = &$this->errors;
+		} else {
+			$configSeverity = $this->configCache['warningSeverity'];
+			$messageCount   = &$this->warningCount;
+			$messages       = &$this->warnings;
+		}
+
+		if ($includeAll === false && $configSeverity === 0) {
+			// Don't bother doing any processing as these messages are just going to
+			// be hidden in the reports anyway.
+			return false;
+		}
+
+		if ($severity === 0) {
+			$severity = 5;
+		}
+
+		foreach ($checkCodes as $checkCode) {
+			// Make sure we are interested in this severity level.
+			if (isset($this->ruleset->ruleset[$checkCode]['severity']) === true) {
+				$severity = $this->ruleset->ruleset[$checkCode]['severity'];
+				break;
+			}
+		}
+
+		if ($includeAll === false && $configSeverity > $severity) {
+			return false;
+		}
+
+		// Make sure we are not ignoring this file.
+		$included = null;
+		foreach ($checkCodes as $checkCode) {
+			$patterns = null;
+
+			if (isset($this->configCache['includePatterns'][$checkCode]) === true) {
+				$patterns  = $this->configCache['includePatterns'][$checkCode];
+				$excluding = false;
+			} else if (isset($this->configCache['ignorePatterns'][$checkCode]) === true) {
+				$patterns  = $this->configCache['ignorePatterns'][$checkCode];
+				$excluding = true;
+			}
+
+			if ($patterns === null) {
+				continue;
+			}
+
+			foreach ($patterns as $pattern => $type) {
+				// While there is support for a type of each pattern
+				// (absolute or relative) we don't actually support it here.
+				$replacements = [
+					'\\,' => ',',
+					'*'   => '.*',
+				];
+
+				// We assume a / directory separator, as do the exclude rules
+				// most developers write, so we need a special case for any system
+				// that is different.
+				if (DIRECTORY_SEPARATOR === '\\') {
+					$replacements['/'] = '\\\\';
+				}
+
+				$pattern = '`'.strtr($pattern, $replacements).'`i';
+				$matched = preg_match($pattern, $this->path);
+
+				if ($matched === 0) {
+					if ($excluding === false && $included === null) {
+						// This file path is not being included.
+						$included = false;
+					}
+
+					continue;
+				}
+
+				if ($excluding === true) {
+					// This file path is being excluded.
+					$this->ignoredCodes[$checkCode] = true;
+					return false;
+				}
+
+				// This file path is being included.
+				$included = true;
+				break;
+			}//end foreach
+		}//end foreach
+
+		if ($included === false) {
+			// There were include rules set, but this file
+			// path didn't match any of them.
+			return false;
+		}
+
+		$messageCount++;
+		if ($fixable === true) {
+			$this->fixableCount++;
+		}
+
+		if ($this->configCache['recordErrors'] === false
+			&& $includeAll === false
+		) {
+			return true;
+		}
+
+		// Work out the error message.
+		if (isset($this->ruleset->ruleset[$sniffCode]['message']) === true) {
+			$message = $this->ruleset->ruleset[$sniffCode]['message'];
+		}
+
+		if (empty($data) === false) {
+			$message = vsprintf($message, $data);
+		}
+
+		if (isset($messages[$line]) === false) {
+			$messages[$line] = [];
+		}
+
+		if (isset($messages[$line][$column]) === false) {
+			$messages[$line][$column] = [];
+		}
+
+		$messages[$line][$column][] = [
+			'message'  => $message,
+			'source'   => $sniffCode,
+			'listener' => $this->activeListener,
+			'severity' => $severity,
+			'fixable'  => $fixable,
+		];
+
+		if (PHP_CODESNIFFER_VERBOSITY > 1
+			&& $this->fixer->enabled === true
+			&& $fixable === true
+		) {
+			@ob_end_clean();
+			echo "\tE: [Line $line] $message ($sniffCode)".PHP_EOL;
+			ob_start();
+		}
+
+		return true;
+
+	}//end addMessage()
+
+
+	/**
+	 * Record a metric about the file being examined.
+	 *
+	 * @param int    $stackPtr The stack position where the metric was recorded.
+	 * @param string $metric   The name of the metric being recorded.
+	 * @param string $value    The value of the metric being recorded.
+	 *
+	 * @return boolean
+	 */
+	public function recordMetric($stackPtr, $metric, $value)
+	{
+		if (isset($this->metrics[$metric]) === false) {
+			$this->metrics[$metric] = ['values' => [$value => 1]];
+			$this->metricTokens[$metric][$stackPtr] = true;
+		} else if (isset($this->metricTokens[$metric][$stackPtr]) === false) {
+			$this->metricTokens[$metric][$stackPtr] = true;
+			if (isset($this->metrics[$metric]['values'][$value]) === false) {
+				$this->metrics[$metric]['values'][$value] = 1;
+			} else {
+				$this->metrics[$metric]['values'][$value]++;
+			}
+		}
+
+		return true;
+
+	}//end recordMetric()
+
+
+	/**
+	 * Returns the number of errors raised.
+	 *
+	 * @return int
+	 */
+	public function getErrorCount()
+	{
+		return $this->errorCount;
+
+	}//end getErrorCount()
+
+
+	/**
+	 * Returns the number of warnings raised.
+	 *
+	 * @return int
+	 */
+	public function getWarningCount()
+	{
+		return $this->warningCount;
+
+	}//end getWarningCount()
+
+
+	/**
+	 * Returns the number of fixable errors/warnings raised.
+	 *
+	 * @return int
+	 */
+	public function getFixableCount()
+	{
+		return $this->fixableCount;
+
+	}//end getFixableCount()
+
+
+	/**
+	 * Returns the number of fixed errors/warnings.
+	 *
+	 * @return int
+	 */
+	public function getFixedCount()
+	{
+		return $this->fixedCount;
+
+	}//end getFixedCount()
+
+
+	/**
+	 * Returns the list of ignored lines.
+	 *
+	 * @return array
+	 */
+	public function getIgnoredLines()
+	{
+		return $this->tokenizer->ignoredLines;
+
+	}//end getIgnoredLines()
+
+
+	/**
+	 * Returns the errors raised from processing this file.
+	 *
+	 * @return array
+	 */
+	public function getErrors()
+	{
+		return $this->errors;
+
+	}//end getErrors()
+
+
+	/**
+	 * Returns the warnings raised from processing this file.
+	 *
+	 * @return array
+	 */
+	public function getWarnings()
+	{
+		return $this->warnings;
+
+	}//end getWarnings()
+
+
+	/**
+	 * Returns the metrics found while processing this file.
+	 *
+	 * @return array
+	 */
+	public function getMetrics()
+	{
+		return $this->metrics;
+
+	}//end getMetrics()
+
+
+	/**
+	 * Returns the absolute filename of this file.
+	 *
+	 * @return string
+	 */
+	public function getFilename()
+	{
+		return $this->path;
+
+	}//end getFilename()
+
+
+	/**
+	 * Returns the declaration names for classes, interfaces, traits, and functions.
+	 *
+	 * @param int $stackPtr The position of the declaration token which
+	 *                      declared the class, interface, trait, or function.
+	 *
+	 * @return string|null The name of the class, interface, trait, or function;
+	 *                     or NULL if the function or class is anonymous.
+	 * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified token is not of type
+	 *                                                      T_FUNCTION, T_CLASS, T_ANON_CLASS,
+	 *                                                      T_CLOSURE, T_TRAIT, or T_INTERFACE.
+	 */
+	public function getDeclarationName($stackPtr)
+	{
+		$tokenCode = $this->tokens[$stackPtr]['code'];
+
+		if ($tokenCode === T_ANON_CLASS || $tokenCode === T_CLOSURE) {
+			return null;
+		}
+
+		if ($tokenCode !== T_FUNCTION
+			&& $tokenCode !== T_CLASS
+			&& $tokenCode !== T_INTERFACE
+			&& $tokenCode !== T_TRAIT
+		) {
+			throw new RuntimeException('Token type "'.$this->tokens[$stackPtr]['type'].'" is not T_FUNCTION, T_CLASS, T_INTERFACE or T_TRAIT');
+		}
+
+		if ($tokenCode === T_FUNCTION
+			&& strtolower($this->tokens[$stackPtr]['content']) !== 'function'
+		) {
+			// This is a function declared without the "function" keyword.
+			// So this token is the function name.
+			return $this->tokens[$stackPtr]['content'];
+		}
+
+		$content = null;
+		for ($i = $stackPtr; $i < $this->numTokens; $i++) {
+			if ($this->tokens[$i]['code'] === T_STRING) {
+				$content = $this->tokens[$i]['content'];
+				break;
+			}
+		}
+
+		return $content;
+
+	}//end getDeclarationName()
+
+
+	/**
+	 * Returns the method parameters for the specified function token.
+	 *
+	 * Each parameter is in the following format:
+	 *
+	 * <code>
+	 *   0 => array(
+	 *         'name'              => '$var',  // The variable name.
+	 *         'token'             => integer, // The stack pointer to the variable name.
+	 *         'content'           => string,  // The full content of the variable definition.
+	 *         'pass_by_reference' => boolean, // Is the variable passed by reference?
+	 *         'variable_length'   => boolean, // Is the param of variable length through use of `...` ?
+	 *         'type_hint'         => string,  // The type hint for the variable.
+	 *         'type_hint_token'   => integer, // The stack pointer to the type hint
+	 *                                         // or false if there is no type hint.
+	 *         'nullable_type'     => boolean, // Is the variable using a nullable type?
+	 *        )
+	 * </code>
+	 *
+	 * Parameters with default values have an additional array index of
+	 * 'default' with the value of the default as a string.
+	 *
+	 * @param int $stackPtr The position in the stack of the function token
+	 *                      to acquire the parameters for.
+	 *
+	 * @return array
+	 * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified $stackPtr is not of
+	 *                                                        type T_FUNCTION or T_CLOSURE.
+	 */
+	public function getMethodParameters($stackPtr)
+	{
+		if ($this->tokens[$stackPtr]['code'] !== T_FUNCTION
+			&& $this->tokens[$stackPtr]['code'] !== T_CLOSURE
+		) {
+			throw new TokenizerException('$stackPtr must be of type T_FUNCTION or T_CLOSURE');
+		}
+
+		$opener = $this->tokens[$stackPtr]['parenthesis_opener'];
+		$closer = $this->tokens[$stackPtr]['parenthesis_closer'];
+
+		$vars            = [];
+		$currVar         = null;
+		$paramStart      = ($opener + 1);
+		$defaultStart    = null;
+		$paramCount      = 0;
+		$passByReference = false;
+		$variableLength  = false;
+		$typeHint        = '';
+		$typeHintToken   = false;
+		$nullableType    = false;
+
+		for ($i = $paramStart; $i <= $closer; $i++) {
+			// Check to see if this token has a parenthesis or bracket opener. If it does
+			// it's likely to be an array which might have arguments in it. This
+			// could cause problems in our parsing below, so lets just skip to the
+			// end of it.
+			if (isset($this->tokens[$i]['parenthesis_opener']) === true) {
+				// Don't do this if it's the close parenthesis for the method.
+				if ($i !== $this->tokens[$i]['parenthesis_closer']) {
+					$i = ($this->tokens[$i]['parenthesis_closer'] + 1);
+				}
+			}
+
+			if (isset($this->tokens[$i]['bracket_opener']) === true) {
+				// Don't do this if it's the close parenthesis for the method.
+				if ($i !== $this->tokens[$i]['bracket_closer']) {
+					$i = ($this->tokens[$i]['bracket_closer'] + 1);
+				}
+			}
+
+			switch ($this->tokens[$i]['code']) {
+			case T_BITWISE_AND:
+				if ($defaultStart === null) {
+					$passByReference = true;
+				}
+				break;
+			case T_VARIABLE:
+				$currVar = $i;
+				break;
+			case T_ELLIPSIS:
+				$variableLength = true;
+				break;
+			case T_CALLABLE:
+				if ($typeHintToken === false) {
+					$typeHintToken = $i;
+				}
+
+				$typeHint .= $this->tokens[$i]['content'];
+				break;
+			case T_SELF:
+			case T_PARENT:
+			case T_STATIC:
+				// Self and parent are valid, static invalid, but was probably intended as type hint.
+				if (isset($defaultStart) === false) {
+					if ($typeHintToken === false) {
+						$typeHintToken = $i;
+					}
+
+					$typeHint .= $this->tokens[$i]['content'];
+				}
+				break;
+			case T_STRING:
+				// This is a string, so it may be a type hint, but it could
+				// also be a constant used as a default value.
+				$prevComma = false;
+				for ($t = $i; $t >= $opener; $t--) {
+					if ($this->tokens[$t]['code'] === T_COMMA) {
+						$prevComma = $t;
+						break;
+					}
+				}
+
+				if ($prevComma !== false) {
+					$nextEquals = false;
+					for ($t = $prevComma; $t < $i; $t++) {
+						if ($this->tokens[$t]['code'] === T_EQUAL) {
+							$nextEquals = $t;
+							break;
+						}
+					}
+
+					if ($nextEquals !== false) {
+						break;
+					}
+				}
+
+				if ($defaultStart === null) {
+					if ($typeHintToken === false) {
+						$typeHintToken = $i;
+					}
+
+					$typeHint .= $this->tokens[$i]['content'];
+				}
+				break;
+			case T_NS_SEPARATOR:
+				// Part of a type hint or default value.
+				if ($defaultStart === null) {
+					if ($typeHintToken === false) {
+						$typeHintToken = $i;
+					}
+
+					$typeHint .= $this->tokens[$i]['content'];
+				}
+				break;
+			case T_NULLABLE:
+				if ($defaultStart === null) {
+					$nullableType = true;
+					$typeHint    .= $this->tokens[$i]['content'];
+				}
+				break;
+			case T_CLOSE_PARENTHESIS:
+			case T_COMMA:
+				// If it's null, then there must be no parameters for this
+				// method.
+				if ($currVar === null) {
+					continue 2;
+				}
+
+				$vars[$paramCount]            = [];
+				$vars[$paramCount]['token']   = $currVar;
+				$vars[$paramCount]['name']    = $this->tokens[$currVar]['content'];
+				$vars[$paramCount]['content'] = trim($this->getTokensAsString($paramStart, ($i - $paramStart)));
+
+				if ($defaultStart !== null) {
+					$vars[$paramCount]['default'] = trim($this->getTokensAsString($defaultStart, ($i - $defaultStart)));
+				}
+
+				$vars[$paramCount]['pass_by_reference'] = $passByReference;
+				$vars[$paramCount]['variable_length']   = $variableLength;
+				$vars[$paramCount]['type_hint']         = $typeHint;
+				$vars[$paramCount]['type_hint_token']   = $typeHintToken;
+				$vars[$paramCount]['nullable_type']     = $nullableType;
+
+				// Reset the vars, as we are about to process the next parameter.
+				$defaultStart    = null;
+				$paramStart      = ($i + 1);
+				$passByReference = false;
+				$variableLength  = false;
+				$typeHint        = '';
+				$typeHintToken   = false;
+				$nullableType    = false;
+
+				$paramCount++;
+				break;
+			case T_EQUAL:
+				$defaultStart = ($i + 1);
+				break;
+			}//end switch
+		}//end for
+
+		return $vars;
+
+	}//end getMethodParameters()
+
+
+	/**
+	 * Returns the visibility and implementation properties of a method.
+	 *
+	 * The format of the array is:
+	 * <code>
+	 *   array(
+	 *    'scope'                => 'public', // public protected or protected
+	 *    'scope_specified'      => true,     // true is scope keyword was found.
+	 *    'return_type'          => '',       // the return type of the method.
+	 *    'return_type_token'    => integer,  // The stack pointer to the start of the return type
+	 *                                        // or false if there is no return type.
+	 *    'nullable_return_type' => false,    // true if the return type is nullable.
+	 *    'is_abstract'          => false,    // true if the abstract keyword was found.
+	 *    'is_final'             => false,    // true if the final keyword was found.
+	 *    'is_static'            => false,    // true if the static keyword was found.
+	 *    'has_body'             => false,    // true if the method has a body
+	 *   );
+	 * </code>
+	 *
+	 * @param int $stackPtr The position in the stack of the function token to
+	 *                      acquire the properties for.
+	 *
+	 * @return array
+	 * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified position is not a
+	 *                                                        T_FUNCTION token.
+	 */
+	public function getMethodProperties($stackPtr)
+	{
+		if ($this->tokens[$stackPtr]['code'] !== T_FUNCTION
+			&& $this->tokens[$stackPtr]['code'] !== T_CLOSURE
+		) {
+			throw new TokenizerException('$stackPtr must be of type T_FUNCTION or T_CLOSURE');
+		}
+
+		if ($this->tokens[$stackPtr]['code'] === T_FUNCTION) {
+			$valid = [
+				T_PUBLIC      => T_PUBLIC,
+				T_PRIVATE     => T_PRIVATE,
+				T_PROTECTED   => T_PROTECTED,
+				T_STATIC      => T_STATIC,
+				T_FINAL       => T_FINAL,
+				T_ABSTRACT    => T_ABSTRACT,
+				T_WHITESPACE  => T_WHITESPACE,
+				T_COMMENT     => T_COMMENT,
+				T_DOC_COMMENT => T_DOC_COMMENT,
+			];
+		} else {
+			$valid = [
+				T_STATIC      => T_STATIC,
+				T_WHITESPACE  => T_WHITESPACE,
+				T_COMMENT     => T_COMMENT,
+				T_DOC_COMMENT => T_DOC_COMMENT,
+			];
+		}
+
+		$scope          = 'public';
+		$scopeSpecified = false;
+		$isAbstract     = false;
+		$isFinal        = false;
+		$isStatic       = false;
+
+		for ($i = ($stackPtr - 1); $i > 0; $i--) {
+			if (isset($valid[$this->tokens[$i]['code']]) === false) {
+				break;
+			}
+
+			switch ($this->tokens[$i]['code']) {
+			case T_PUBLIC:
+				$scope          = 'public';
+				$scopeSpecified = true;
+				break;
+			case T_PRIVATE:
+				$scope          = 'private';
+				$scopeSpecified = true;
+				break;
+			case T_PROTECTED:
+				$scope          = 'protected';
+				$scopeSpecified = true;
+				break;
+			case T_ABSTRACT:
+				$isAbstract = true;
+				break;
+			case T_FINAL:
+				$isFinal = true;
+				break;
+			case T_STATIC:
+				$isStatic = true;
+				break;
+			}//end switch
+		}//end for
+
+		$returnType         = '';
+		$returnTypeToken    = false;
+		$nullableReturnType = false;
+		$hasBody            = true;
+
+		if (isset($this->tokens[$stackPtr]['parenthesis_closer']) === true) {
+			$scopeOpener = null;
+			if (isset($this->tokens[$stackPtr]['scope_opener']) === true) {
+				$scopeOpener = $this->tokens[$stackPtr]['scope_opener'];
+			}
+
+			$valid = [
+				T_STRING       => T_STRING,
+				T_CALLABLE     => T_CALLABLE,
+				T_SELF         => T_SELF,
+				T_PARENT       => T_PARENT,
+				T_NS_SEPARATOR => T_NS_SEPARATOR,
+			];
+
+			for ($i = $this->tokens[$stackPtr]['parenthesis_closer']; $i < $this->numTokens; $i++) {
+				if (($scopeOpener === null && $this->tokens[$i]['code'] === T_SEMICOLON)
+					|| ($scopeOpener !== null && $i === $scopeOpener)
+				) {
+					// End of function definition.
+					break;
+				}
+
+				if ($this->tokens[$i]['code'] === T_NULLABLE) {
+					$nullableReturnType = true;
+				}
+
+				if (isset($valid[$this->tokens[$i]['code']]) === true) {
+					if ($returnTypeToken === false) {
+						$returnTypeToken = $i;
+					}
+
+					$returnType .= $this->tokens[$i]['content'];
+				}
+			}
+
+			$end     = $this->findNext([T_OPEN_CURLY_BRACKET, T_SEMICOLON], $this->tokens[$stackPtr]['parenthesis_closer']);
+			$hasBody = $this->tokens[$end]['code'] === T_OPEN_CURLY_BRACKET;
+		}//end if
+
+		if ($returnType !== '' && $nullableReturnType === true) {
+			$returnType = '?'.$returnType;
+		}
+
+		return [
+			'scope'                => $scope,
+			'scope_specified'      => $scopeSpecified,
+			'return_type'          => $returnType,
+			'return_type_token'    => $returnTypeToken,
+			'nullable_return_type' => $nullableReturnType,
+			'is_abstract'          => $isAbstract,
+			'is_final'             => $isFinal,
+			'is_static'            => $isStatic,
+			'has_body'             => $hasBody,
+		];
+
+	}//end getMethodProperties()
+
+
+	/**
+	 * Returns the visibility and implementation properties of the class member
+	 * variable found at the specified position in the stack.
+	 *
+	 * The format of the array is:
+	 *
+	 * <code>
+	 *   array(
+	 *    'scope'           => 'public', // public protected or protected.
+	 *    'scope_specified' => false,    // true if the scope was explicitly specified.
+	 *    'is_static'       => false,    // true if the static keyword was found.
+	 *   );
+	 * </code>
+	 *
+	 * @param int $stackPtr The position in the stack of the T_VARIABLE token to
+	 *                      acquire the properties for.
+	 *
+	 * @return array
+	 * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified position is not a
+	 *                                                        T_VARIABLE token, or if the position is not
+	 *                                                        a class member variable.
+	 */
+	public function getMemberProperties($stackPtr)
+	{
+		if ($this->tokens[$stackPtr]['code'] !== T_VARIABLE) {
+			throw new TokenizerException('$stackPtr must be of type T_VARIABLE');
+		}
+
+		$conditions = array_keys($this->tokens[$stackPtr]['conditions']);
+		$ptr        = array_pop($conditions);
+		if (isset($this->tokens[$ptr]) === false
+			|| ($this->tokens[$ptr]['code'] !== T_CLASS
+			&& $this->tokens[$ptr]['code'] !== T_ANON_CLASS
+			&& $this->tokens[$ptr]['code'] !== T_TRAIT)
+		) {
+			if (isset($this->tokens[$ptr]) === true
+				&& $this->tokens[$ptr]['code'] === T_INTERFACE
+			) {
+				// T_VARIABLEs in interfaces can actually be method arguments
+				// but they wont be seen as being inside the method because there
+				// are no scope openers and closers for abstract methods. If it is in
+				// parentheses, we can be pretty sure it is a method argument.
+				if (isset($this->tokens[$stackPtr]['nested_parenthesis']) === false
+					|| empty($this->tokens[$stackPtr]['nested_parenthesis']) === true
+				) {
+					$error = 'Possible parse error: interfaces may not include member vars';
+					$this->addWarning($error, $stackPtr, 'Internal.ParseError.InterfaceHasMemberVar');
+					return [];
+				}
+			} else {
+				throw new TokenizerException('$stackPtr is not a class member var');
+			}
+		}
+
+		// Make sure it's not a method parameter.
+		if (empty($this->tokens[$stackPtr]['nested_parenthesis']) === false) {
+			$parenthesis = array_keys($this->tokens[$stackPtr]['nested_parenthesis']);
+			$deepestOpen = array_pop($parenthesis);
+			if ($deepestOpen > $ptr
+				&& isset($this->tokens[$deepestOpen]['parenthesis_owner']) === true
+				&& $this->tokens[$this->tokens[$deepestOpen]['parenthesis_owner']]['code'] === T_FUNCTION
+			) {
+				throw new TokenizerException('$stackPtr is not a class member var');
+			}
+		}
+
+		$valid = [
+			T_PUBLIC    => T_PUBLIC,
+			T_PRIVATE   => T_PRIVATE,
+			T_PROTECTED => T_PROTECTED,
+			T_STATIC    => T_STATIC,
+			T_VAR       => T_VAR,
+		];
+
+		$valid += Util\Tokens::$emptyTokens;
+
+		$scope          = 'public';
+		$scopeSpecified = false;
+		$isStatic       = false;
+
+		$startOfStatement = $this->findPrevious(
+			[
+				T_SEMICOLON,
+				T_OPEN_CURLY_BRACKET,
+				T_CLOSE_CURLY_BRACKET,
+			],
+			($stackPtr - 1)
+		);
+
+		for ($i = ($startOfStatement + 1); $i < $stackPtr; $i++) {
+			if (isset($valid[$this->tokens[$i]['code']]) === false) {
+				break;
+			}
+
+			switch ($this->tokens[$i]['code']) {
+			case T_PUBLIC:
+				$scope          = 'public';
+				$scopeSpecified = true;
+				break;
+			case T_PRIVATE:
+				$scope          = 'private';
+				$scopeSpecified = true;
+				break;
+			case T_PROTECTED:
+				$scope          = 'protected';
+				$scopeSpecified = true;
+				break;
+			case T_STATIC:
+				$isStatic = true;
+				break;
+			}
+		}//end for
+
+		return [
+			'scope'           => $scope,
+			'scope_specified' => $scopeSpecified,
+			'is_static'       => $isStatic,
+		];
+
+	}//end getMemberProperties()
+
+
+	/**
+	 * Returns the visibility and implementation properties of a class.
+	 *
+	 * The format of the array is:
+	 * <code>
+	 *   array(
+	 *    'is_abstract' => false, // true if the abstract keyword was found.
+	 *    'is_final'    => false, // true if the final keyword was found.
+	 *   );
+	 * </code>
+	 *
+	 * @param int $stackPtr The position in the stack of the T_CLASS token to
+	 *                      acquire the properties for.
+	 *
+	 * @return array
+	 * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified position is not a
+	 *                                                        T_CLASS token.
+	 */
+	public function getClassProperties($stackPtr)
+	{
+		if ($this->tokens[$stackPtr]['code'] !== T_CLASS) {
+			throw new TokenizerException('$stackPtr must be of type T_CLASS');
+		}
+
+		$valid = [
+			T_FINAL       => T_FINAL,
+			T_ABSTRACT    => T_ABSTRACT,
+			T_WHITESPACE  => T_WHITESPACE,
+			T_COMMENT     => T_COMMENT,
+			T_DOC_COMMENT => T_DOC_COMMENT,
+		];
+
+		$isAbstract = false;
+		$isFinal    = false;
+
+		for ($i = ($stackPtr - 1); $i > 0; $i--) {
+			if (isset($valid[$this->tokens[$i]['code']]) === false) {
+				break;
+			}
+
+			switch ($this->tokens[$i]['code']) {
+			case T_ABSTRACT:
+				$isAbstract = true;
+				break;
+
+			case T_FINAL:
+				$isFinal = true;
+				break;
+			}
+		}//end for
+
+		return [
+			'is_abstract' => $isAbstract,
+			'is_final'    => $isFinal,
+		];
+
+	}//end getClassProperties()
+
+
+	/**
+	 * Determine if the passed token is a reference operator.
+	 *
+	 * Returns true if the specified token position represents a reference.
+	 * Returns false if the token represents a bitwise operator.
+	 *
+	 * @param int $stackPtr The position of the T_BITWISE_AND token.
+	 *
+	 * @return boolean
+	 */
+	public function isReference($stackPtr)
+	{
+		if ($this->tokens[$stackPtr]['code'] !== T_BITWISE_AND) {
+			return false;
+		}
+
+		$tokenBefore = $this->findPrevious(
+			Util\Tokens::$emptyTokens,
+			($stackPtr - 1),
+			null,
+			true
+		);
+
+		if ($this->tokens[$tokenBefore]['code'] === T_FUNCTION) {
+			// Function returns a reference.
+			return true;
+		}
+
+		if ($this->tokens[$tokenBefore]['code'] === T_DOUBLE_ARROW) {
+			// Inside a foreach loop or array assignment, this is a reference.
+			return true;
+		}
+
+		if ($this->tokens[$tokenBefore]['code'] === T_AS) {
+			// Inside a foreach loop, this is a reference.
+			return true;
+		}
+
+		if (isset(Util\Tokens::$assignmentTokens[$this->tokens[$tokenBefore]['code']]) === true) {
+			// This is directly after an assignment. It's a reference. Even if
+			// it is part of an operation, the other tests will handle it.
+			return true;
+		}
+
+		$tokenAfter = $this->findNext(
+			Util\Tokens::$emptyTokens,
+			($stackPtr + 1),
+			null,
+			true
+		);
+
+		if ($this->tokens[$tokenAfter]['code'] === T_NEW) {
+			return true;
+		}
+
+		if (isset($this->tokens[$stackPtr]['nested_parenthesis']) === true) {
+			$brackets    = $this->tokens[$stackPtr]['nested_parenthesis'];
+			$lastBracket = array_pop($brackets);
+			if (isset($this->tokens[$lastBracket]['parenthesis_owner']) === true) {
+				$owner = $this->tokens[$this->tokens[$lastBracket]['parenthesis_owner']];
+				if ($owner['code'] === T_FUNCTION
+					|| $owner['code'] === T_CLOSURE
+				) {
+					$params = $this->getMethodParameters($this->tokens[$lastBracket]['parenthesis_owner']);
+					foreach ($params as $param) {
+						$varToken = $tokenAfter;
+						if ($param['variable_length'] === true) {
+							$varToken = $this->findNext(
+								(Util\Tokens::$emptyTokens + [T_ELLIPSIS]),
+								($stackPtr + 1),
+								null,
+								true
+							);
+						}
+
+						if ($param['token'] === $varToken
+							&& $param['pass_by_reference'] === true
+						) {
+							// Function parameter declared to be passed by reference.
+							return true;
+						}
+					}
+				}//end if
+			} else {
+				$prev = false;
+				for ($t = ($this->tokens[$lastBracket]['parenthesis_opener'] - 1); $t >= 0; $t--) {
+					if ($this->tokens[$t]['code'] !== T_WHITESPACE) {
+						$prev = $t;
+						break;
+					}
+				}
+
+				if ($prev !== false && $this->tokens[$prev]['code'] === T_USE) {
+					// Closure use by reference.
+					return true;
+				}
+			}//end if
+		}//end if
+
+		// Pass by reference in function calls and assign by reference in arrays.
+		if ($this->tokens[$tokenBefore]['code'] === T_OPEN_PARENTHESIS
+			|| $this->tokens[$tokenBefore]['code'] === T_COMMA
+			|| $this->tokens[$tokenBefore]['code'] === T_OPEN_SHORT_ARRAY
+		) {
+			if ($this->tokens[$tokenAfter]['code'] === T_VARIABLE) {
+				return true;
+			} else {
+				$skip   = Util\Tokens::$emptyTokens;
+				$skip[] = T_NS_SEPARATOR;
+				$skip[] = T_SELF;
+				$skip[] = T_PARENT;
+				$skip[] = T_STATIC;
+				$skip[] = T_STRING;
+				$skip[] = T_NAMESPACE;
+				$skip[] = T_DOUBLE_COLON;
+
+				$nextSignificantAfter = $this->findNext(
+					$skip,
+					($stackPtr + 1),
+					null,
+					true
+				);
+				if ($this->tokens[$nextSignificantAfter]['code'] === T_VARIABLE) {
+					return true;
+				}
+			}//end if
+		}//end if
+
+		return false;
+
+	}//end isReference()
+
+
+	/**
+	 * Returns the content of the tokens from the specified start position in
+	 * the token stack for the specified length.
+	 *
+	 * @param int  $start       The position to start from in the token stack.
+	 * @param int  $length      The length of tokens to traverse from the start pos.
+	 * @param bool $origContent Whether the original content or the tab replaced
+	 *                          content should be used.
+	 *
+	 * @return string The token contents.
+	 */
+	public function getTokensAsString($start, $length, $origContent=false)
+	{
+		if (is_int($start) === false || isset($this->tokens[$start]) === false) {
+			throw new RuntimeException('The $start position for getTokensAsString() must exist in the token stack');
+		}
+
+		if (is_int($length) === false || $length <= 0) {
+			return '';
+		}
+
+		$str = '';
+		$end = ($start + $length);
+		if ($end > $this->numTokens) {
+			$end = $this->numTokens;
+		}
+
+		for ($i = $start; $i < $end; $i++) {
+			// If tabs are being converted to spaces by the tokeniser, the
+			// original content should be used instead of the converted content.
+			if ($origContent === true && isset($this->tokens[$i]['orig_content']) === true) {
+				$str .= $this->tokens[$i]['orig_content'];
+			} else {
+				$str .= $this->tokens[$i]['content'];
+			}
+		}
+
+		return $str;
+
+	}//end getTokensAsString()
+
+
+	/**
+	 * Returns the position of the previous specified token(s).
+	 *
+	 * If a value is specified, the previous token of the specified type(s)
+	 * containing the specified value will be returned.
+	 *
+	 * Returns false if no token can be found.
+	 *
+	 * @param int|string|array $types   The type(s) of tokens to search for.
+	 * @param int              $start   The position to start searching from in the
+	 *                                  token stack.
+	 * @param int              $end     The end position to fail if no token is found.
+	 *                                  if not specified or null, end will default to
+	 *                                  the start of the token stack.
+	 * @param bool             $exclude If true, find the previous token that is NOT of
+	 *                                  the types specified in $types.
+	 * @param string           $value   The value that the token(s) must be equal to.
+	 *                                  If value is omitted, tokens with any value will
+	 *                                  be returned.
+	 * @param bool             $local   If true, tokens outside the current statement
+	 *                                  will not be checked. IE. checking will stop
+	 *                                  at the previous semi-colon found.
+	 *
+	 * @return int|bool
+	 * @see    findNext()
+	 */
+	public function findPrevious(
+		$types,
+		$start,
+		$end=null,
+		$exclude=false,
+		$value=null,
+		$local=false
+	) {
+		$types = (array) $types;
+
+		if ($end === null) {
+			$end = 0;
+		}
+
+		for ($i = $start; $i >= $end; $i--) {
+			$found = (bool) $exclude;
+			foreach ($types as $type) {
+				if ($this->tokens[$i]['code'] === $type) {
+					$found = !$exclude;
+					break;
+				}
+			}
+
+			if ($found === true) {
+				if ($value === null) {
+					return $i;
+				} else if ($this->tokens[$i]['content'] === $value) {
+					return $i;
+				}
+			}
+
+			if ($local === true) {
+				if (isset($this->tokens[$i]['scope_opener']) === true
+					&& $i === $this->tokens[$i]['scope_closer']
+				) {
+					$i = $this->tokens[$i]['scope_opener'];
+				} else if (isset($this->tokens[$i]['bracket_opener']) === true
+					&& $i === $this->tokens[$i]['bracket_closer']
+				) {
+					$i = $this->tokens[$i]['bracket_opener'];
+				} else if (isset($this->tokens[$i]['parenthesis_opener']) === true
+					&& $i === $this->tokens[$i]['parenthesis_closer']
+				) {
+					$i = $this->tokens[$i]['parenthesis_opener'];
+				} else if ($this->tokens[$i]['code'] === T_SEMICOLON) {
+					break;
+				}
+			}
+		}//end for
+
+		return false;
+
+	}//end findPrevious()
+
+
+	/**
+	 * Returns the position of the next specified token(s).
+	 *
+	 * If a value is specified, the next token of the specified type(s)
+	 * containing the specified value will be returned.
+	 *
+	 * Returns false if no token can be found.
+	 *
+	 * @param int|string|array $types   The type(s) of tokens to search for.
+	 * @param int              $start   The position to start searching from in the
+	 *                                  token stack.
+	 * @param int              $end     The end position to fail if no token is found.
+	 *                                  if not specified or null, end will default to
+	 *                                  the end of the token stack.
+	 * @param bool             $exclude If true, find the next token that is NOT of
+	 *                                  a type specified in $types.
+	 * @param string           $value   The value that the token(s) must be equal to.
+	 *                                  If value is omitted, tokens with any value will
+	 *                                  be returned.
+	 * @param bool             $local   If true, tokens outside the current statement
+	 *                                  will not be checked. i.e., checking will stop
+	 *                                  at the next semi-colon found.
+	 *
+	 * @return int|bool
+	 * @see    findPrevious()
+	 */
+	public function findNext(
+		$types,
+		$start,
+		$end=null,
+		$exclude=false,
+		$value=null,
+		$local=false
+	) {
+		$types = (array) $types;
+
+		if ($end === null || $end > $this->numTokens) {
+			$end = $this->numTokens;
+		}
+
+		for ($i = $start; $i < $end; $i++) {
+			$found = (bool) $exclude;
+			foreach ($types as $type) {
+				if ($this->tokens[$i]['code'] === $type) {
+					$found = !$exclude;
+					break;
+				}
+			}
+
+			if ($found === true) {
+				if ($value === null) {
+					return $i;
+				} else if ($this->tokens[$i]['content'] === $value) {
+					return $i;
+				}
+			}
+
+			if ($local === true && $this->tokens[$i]['code'] === T_SEMICOLON) {
+				break;
+			}
+		}//end for
+
+		return false;
+
+	}//end findNext()
+
+
+	/**
+	 * Returns the position of the first non-whitespace token in a statement.
+	 *
+	 * @param int       $start  The position to start searching from in the token stack.
+	 * @param int|array $ignore Token types that should not be considered stop points.
+	 *
+	 * @return int
+	 */
+	public function findStartOfStatement($start, $ignore=null)
+	{
+		$endTokens = Util\Tokens::$blockOpeners;
+
+		$endTokens[T_COLON]            = true;
+		$endTokens[T_COMMA]            = true;
+		$endTokens[T_DOUBLE_ARROW]     = true;
+		$endTokens[T_SEMICOLON]        = true;
+		$endTokens[T_OPEN_TAG]         = true;
+		$endTokens[T_CLOSE_TAG]        = true;
+		$endTokens[T_OPEN_SHORT_ARRAY] = true;
+
+		if ($ignore !== null) {
+			$ignore = (array) $ignore;
+			foreach ($ignore as $code) {
+				unset($endTokens[$code]);
+			}
+		}
+
+		$lastNotEmpty = $start;
+
+		for ($i = $start; $i >= 0; $i--) {
+			if (isset($endTokens[$this->tokens[$i]['code']]) === true) {
+				// Found the end of the previous statement.
+				return $lastNotEmpty;
+			}
+
+			if (isset($this->tokens[$i]['scope_opener']) === true
+				&& $i === $this->tokens[$i]['scope_closer']
+			) {
+				// Found the end of the previous scope block.
+				return $lastNotEmpty;
+			}
+
+			// Skip nested statements.
+			if (isset($this->tokens[$i]['bracket_opener']) === true
+				&& $i === $this->tokens[$i]['bracket_closer']
+			) {
+				$i = $this->tokens[$i]['bracket_opener'];
+			} else if (isset($this->tokens[$i]['parenthesis_opener']) === true
+				&& $i === $this->tokens[$i]['parenthesis_closer']
+			) {
+				$i = $this->tokens[$i]['parenthesis_opener'];
+			}
+
+			if (isset(Util\Tokens::$emptyTokens[$this->tokens[$i]['code']]) === false) {
+				$lastNotEmpty = $i;
+			}
+		}//end for
+
+		return 0;
+
+	}//end findStartOfStatement()
+
+
+	/**
+	 * Returns the position of the last non-whitespace token in a statement.
+	 *
+	 * @param int       $start  The position to start searching from in the token stack.
+	 * @param int|array $ignore Token types that should not be considered stop points.
+	 *
+	 * @return int
+	 */
+	public function findEndOfStatement($start, $ignore=null)
+	{
+		$endTokens = [
+			T_COLON                => true,
+			T_COMMA                => true,
+			T_DOUBLE_ARROW         => true,
+			T_SEMICOLON            => true,
+			T_CLOSE_PARENTHESIS    => true,
+			T_CLOSE_SQUARE_BRACKET => true,
+			T_CLOSE_CURLY_BRACKET  => true,
+			T_CLOSE_SHORT_ARRAY    => true,
+			T_OPEN_TAG             => true,
+			T_CLOSE_TAG            => true,
+		];
+
+		if ($ignore !== null) {
+			$ignore = (array) $ignore;
+			foreach ($ignore as $code) {
+				unset($endTokens[$code]);
+			}
+		}
+
+		$lastNotEmpty = $start;
+
+		for ($i = $start; $i < $this->numTokens; $i++) {
+			if ($i !== $start && isset($endTokens[$this->tokens[$i]['code']]) === true) {
+				// Found the end of the statement.
+				if ($this->tokens[$i]['code'] === T_CLOSE_PARENTHESIS
+					|| $this->tokens[$i]['code'] === T_CLOSE_SQUARE_BRACKET
+					|| $this->tokens[$i]['code'] === T_CLOSE_CURLY_BRACKET
+					|| $this->tokens[$i]['code'] === T_CLOSE_SHORT_ARRAY
+					|| $this->tokens[$i]['code'] === T_OPEN_TAG
+					|| $this->tokens[$i]['code'] === T_CLOSE_TAG
+				) {
+					return $lastNotEmpty;
+				}
+
+				return $i;
+			}
+
+			// Skip nested statements.
+			if (isset($this->tokens[$i]['scope_closer']) === true
+				&& ($i === $this->tokens[$i]['scope_opener']
+				|| $i === $this->tokens[$i]['scope_condition'])
+			) {
+				if ($i === $start && isset(Util\Tokens::$scopeOpeners[$this->tokens[$i]['code']]) === true) {
+					return $this->tokens[$i]['scope_closer'];
+				}
+
+				$i = $this->tokens[$i]['scope_closer'];
+			} else if (isset($this->tokens[$i]['bracket_closer']) === true
+				&& $i === $this->tokens[$i]['bracket_opener']
+			) {
+				$i = $this->tokens[$i]['bracket_closer'];
+			} else if (isset($this->tokens[$i]['parenthesis_closer']) === true
+				&& $i === $this->tokens[$i]['parenthesis_opener']
+			) {
+				$i = $this->tokens[$i]['parenthesis_closer'];
+			}
+
+			if (isset(Util\Tokens::$emptyTokens[$this->tokens[$i]['code']]) === false) {
+				$lastNotEmpty = $i;
+			}
+		}//end for
+
+		return ($this->numTokens - 1);
+
+	}//end findEndOfStatement()
+
+
+	/**
+	 * Returns the position of the first token on a line, matching given type.
+	 *
+	 * Returns false if no token can be found.
+	 *
+	 * @param int|string|array $types   The type(s) of tokens to search for.
+	 * @param int              $start   The position to start searching from in the
+	 *                                  token stack. The first token matching on
+	 *                                  this line before this token will be returned.
+	 * @param bool             $exclude If true, find the token that is NOT of
+	 *                                  the types specified in $types.
+	 * @param string           $value   The value that the token must be equal to.
+	 *                                  If value is omitted, tokens with any value will
+	 *                                  be returned.
+	 *
+	 * @return int | bool
+	 */
+	public function findFirstOnLine($types, $start, $exclude=false, $value=null)
+	{
+		if (is_array($types) === false) {
+			$types = [$types];
+		}
+
+		$foundToken = false;
+
+		for ($i = $start; $i >= 0; $i--) {
+			if ($this->tokens[$i]['line'] < $this->tokens[$start]['line']) {
+				break;
+			}
+
+			$found = $exclude;
+			foreach ($types as $type) {
+				if ($exclude === false) {
+					if ($this->tokens[$i]['code'] === $type) {
+						$found = true;
+						break;
+					}
+				} else {
+					if ($this->tokens[$i]['code'] === $type) {
+						$found = false;
+						break;
+					}
+				}
+			}
+
+			if ($found === true) {
+				if ($value === null) {
+					$foundToken = $i;
+				} else if ($this->tokens[$i]['content'] === $value) {
+					$foundToken = $i;
+				}
+			}
+		}//end for
+
+		return $foundToken;
+
+	}//end findFirstOnLine()
+
+
+	/**
+	 * Determine if the passed token has a condition of one of the passed types.
+	 *
+	 * @param int              $stackPtr The position of the token we are checking.
+	 * @param int|string|array $types    The type(s) of tokens to search for.
+	 *
+	 * @return boolean
+	 */
+	public function hasCondition($stackPtr, $types)
+	{
+		// Check for the existence of the token.
+		if (isset($this->tokens[$stackPtr]) === false) {
+			return false;
+		}
+
+		// Make sure the token has conditions.
+		if (isset($this->tokens[$stackPtr]['conditions']) === false) {
+			return false;
+		}
+
+		$types      = (array) $types;
+		$conditions = $this->tokens[$stackPtr]['conditions'];
+
+		foreach ($types as $type) {
+			if (in_array($type, $conditions, true) === true) {
+				// We found a token with the required type.
+				return true;
+			}
+		}
+
+		return false;
+
+	}//end hasCondition()
+
+
+	/**
+	 * Return the position of the condition for the passed token.
+	 *
+	 * Returns FALSE if the token does not have the condition.
+	 *
+	 * @param int        $stackPtr The position of the token we are checking.
+	 * @param int|string $type     The type of token to search for.
+	 *
+	 * @return int
+	 */
+	public function getCondition($stackPtr, $type)
+	{
+		// Check for the existence of the token.
+		if (isset($this->tokens[$stackPtr]) === false) {
+			return false;
+		}
+
+		// Make sure the token has conditions.
+		if (isset($this->tokens[$stackPtr]['conditions']) === false) {
+			return false;
+		}
+
+		$conditions = $this->tokens[$stackPtr]['conditions'];
+		foreach ($conditions as $token => $condition) {
+			if ($condition === $type) {
+				return $token;
+			}
+		}
+
+		return false;
+
+	}//end getCondition()
+
+
+	/**
+	 * Returns the name of the class that the specified class extends.
+	 * (works for classes, anonymous classes and interfaces)
+	 *
+	 * Returns FALSE on error or if there is no extended class name.
+	 *
+	 * @param int $stackPtr The stack position of the class.
+	 *
+	 * @return string|false
+	 */
+	public function findExtendedClassName($stackPtr)
+	{
+		// Check for the existence of the token.
+		if (isset($this->tokens[$stackPtr]) === false) {
+			return false;
+		}
+
+		if ($this->tokens[$stackPtr]['code'] !== T_CLASS
+			&& $this->tokens[$stackPtr]['code'] !== T_ANON_CLASS
+			&& $this->tokens[$stackPtr]['code'] !== T_INTERFACE
+		) {
+			return false;
+		}
+
+		if (isset($this->tokens[$stackPtr]['scope_opener']) === false) {
+			return false;
+		}
+
+		$classOpenerIndex = $this->tokens[$stackPtr]['scope_opener'];
+		$extendsIndex     = $this->findNext(T_EXTENDS, $stackPtr, $classOpenerIndex);
+		if (false === $extendsIndex) {
+			return false;
+		}
+
+		$find = [
+			T_NS_SEPARATOR,
+			T_STRING,
+			T_WHITESPACE,
+		];
+
+		$end  = $this->findNext($find, ($extendsIndex + 1), ($classOpenerIndex + 1), true);
+		$name = $this->getTokensAsString(($extendsIndex + 1), ($end - $extendsIndex - 1));
+		$name = trim($name);
+
+		if ($name === '') {
+			return false;
+		}
+
+		return $name;
+
+	}//end findExtendedClassName()
+
+
+	/**
+	 * Returns the names of the interfaces that the specified class implements.
+	 *
+	 * Returns FALSE on error or if there are no implemented interface names.
+	 *
+	 * @param int $stackPtr The stack position of the class.
+	 *
+	 * @return array|false
+	 */
+	public function findImplementedInterfaceNames($stackPtr)
+	{
+		// Check for the existence of the token.
+		if (isset($this->tokens[$stackPtr]) === false) {
+			return false;
+		}
+
+		if ($this->tokens[$stackPtr]['code'] !== T_CLASS
+			&& $this->tokens[$stackPtr]['code'] !== T_ANON_CLASS
+		) {
+			return false;
+		}
+
+		if (isset($this->tokens[$stackPtr]['scope_closer']) === false) {
+			return false;
+		}
+
+		$classOpenerIndex = $this->tokens[$stackPtr]['scope_opener'];
+		$implementsIndex  = $this->findNext(T_IMPLEMENTS, $stackPtr, $classOpenerIndex);
+		if ($implementsIndex === false) {
+			return false;
+		}
+
+		$find = [
+			T_NS_SEPARATOR,
+			T_STRING,
+			T_WHITESPACE,
+			T_COMMA,
+		];
+
+		$end  = $this->findNext($find, ($implementsIndex + 1), ($classOpenerIndex + 1), true);
+		$name = $this->getTokensAsString(($implementsIndex + 1), ($end - $implementsIndex - 1));
+		$name = trim($name);
+
+		if ($name === '') {
+			return false;
+		} else {
+			$names = explode(',', $name);
+			$names = array_map('trim', $names);
+			return $names;
+		}
+
+	}//end findImplementedInterfaceNames()
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Files/FileList.php

Indentation +222 added lines, -222 removed lines

@@ -20,228 +20,228 @@
 class FileList implements \Iterator, \Countable
 {
 
-    /**
-     * A list of file paths that are included in the list.
-     *
-     * @var array
-     */
-    private $files = [];
-
-    /**
-     * The number of files in the list.
-     *
-     * @var integer
-     */
-    private $numFiles = 0;
-
-    /**
-     * The config data for the run.
-     *
-     * @var \PHP_CodeSniffer\Config
-     */
-    public $config = null;
-
-    /**
-     * The ruleset used for the run.
-     *
-     * @var \PHP_CodeSniffer\Ruleset
-     */
-    public $ruleset = null;
-
-    /**
-     * An array of patterns to use for skipping files.
-     *
-     * @var array
-     */
-    protected $ignorePatterns = [];
-
-
-    /**
-     * Constructs a file list and loads in an array of file paths to process.
-     *
-     * @param \PHP_CodeSniffer\Config  $config  The config data for the run.
-     * @param \PHP_CodeSniffer\Ruleset $ruleset The ruleset used for the run.
-     *
-     * @return void
-     */
-    public function __construct(Config $config, Ruleset $ruleset)
-    {
-        $this->ruleset = $ruleset;
-        $this->config  = $config;
-
-        $paths = $config->files;
-        foreach ($paths as $path) {
-            $isPharFile = Util\Common::isPharFile($path);
-            if (is_dir($path) === true || $isPharFile === true) {
-                if ($isPharFile === true) {
-                    $path = 'phar://'.$path;
-                }
-
-                $filterClass = $this->getFilterClass();
-
-                $di       = new \RecursiveDirectoryIterator($path, (\RecursiveDirectoryIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS));
-                $filter   = new $filterClass($di, $path, $config, $ruleset);
-                $iterator = new \RecursiveIteratorIterator($filter);
-
-                foreach ($iterator as $file) {
-                    $this->files[$file->getPathname()] = null;
-                    $this->numFiles++;
-                }
-            } else {
-                $this->addFile($path);
-            }//end if
-        }//end foreach
-
-        reset($this->files);
-
-    }//end __construct()
-
-
-    /**
-     * Add a file to the list.
-     *
-     * If a file object has already been created, it can be passed here.
-     * If it is left NULL, it will be created when accessed.
-     *
-     * @param string                      $path The path to the file being added.
-     * @param \PHP_CodeSniffer\Files\File $file The file being added.
-     *
-     * @return void
-     */
-    public function addFile($path, $file=null)
-    {
-        // No filtering is done for STDIN when the filename
-        // has not been specified.
-        if ($path === 'STDIN') {
-            $this->files[$path] = $file;
-            $this->numFiles++;
-            return;
-        }
-
-        $filterClass = $this->getFilterClass();
-
-        $di       = new \RecursiveArrayIterator([$path]);
-        $filter   = new $filterClass($di, $path, $this->config, $this->ruleset);
-        $iterator = new \RecursiveIteratorIterator($filter);
-
-        foreach ($iterator as $path) {
-            $this->files[$path] = $file;
-            $this->numFiles++;
-        }
-
-    }//end addFile()
-
-
-    /**
-     * Get the class name of the filter being used for the run.
-     *
-     * @return string
-     */
-    private function getFilterClass()
-    {
-        $filterType = $this->config->filter;
-
-        if ($filterType === null) {
-            $filterClass = '\PHP_CodeSniffer\Filters\Filter';
-        } else {
-            if (strpos($filterType, '.') !== false) {
-                // This is a path to a custom filter class.
-                $filename = realpath($filterType);
-                if ($filename === false) {
-                    $error = "ERROR: Custom filter \"$filterType\" not found".PHP_EOL;
-                    throw new DeepExitException($error, 3);
-                }
-
-                $filterClass = Autoload::loadFile($filename);
-            } else {
-                $filterClass = '\PHP_CodeSniffer\Filters\\'.$filterType;
-            }
-        }
-
-        return $filterClass;
-
-    }//end getFilterClass()
-
-
-    /**
-     * Rewind the iterator to the first file.
-     *
-     * @return void
-     */
-    public function rewind()
-    {
-        reset($this->files);
-
-    }//end rewind()
-
-
-    /**
-     * Get the file that is currently being processed.
-     *
-     * @return \PHP_CodeSniffer\Files\File
-     */
-    public function current()
-    {
-        $path = key($this->files);
-        if ($this->files[$path] === null) {
-            $this->files[$path] = new LocalFile($path, $this->ruleset, $this->config);
-        }
-
-        return $this->files[$path];
-
-    }//end current()
-
-
-    /**
-     * Return the file path of the current file being processed.
-     *
-     * @return void
-     */
-    public function key()
-    {
-        return key($this->files);
-
-    }//end key()
-
-
-    /**
-     * Move forward to the next file.
-     *
-     * @return void
-     */
-    public function next()
-    {
-        next($this->files);
-
-    }//end next()
-
-
-    /**
-     * Checks if current position is valid.
-     *
-     * @return boolean
-     */
-    public function valid()
-    {
-        if (current($this->files) === false) {
-            return false;
-        }
-
-        return true;
-
-    }//end valid()
-
-
-    /**
-     * Return the number of files in the list.
-     *
-     * @return integer
-     */
-    public function count()
-    {
-        return $this->numFiles;
-
-    }//end count()
+	/**
+	 * A list of file paths that are included in the list.
+	 *
+	 * @var array
+	 */
+	private $files = [];
+
+	/**
+	 * The number of files in the list.
+	 *
+	 * @var integer
+	 */
+	private $numFiles = 0;
+
+	/**
+	 * The config data for the run.
+	 *
+	 * @var \PHP_CodeSniffer\Config
+	 */
+	public $config = null;
+
+	/**
+	 * The ruleset used for the run.
+	 *
+	 * @var \PHP_CodeSniffer\Ruleset
+	 */
+	public $ruleset = null;
+
+	/**
+	 * An array of patterns to use for skipping files.
+	 *
+	 * @var array
+	 */
+	protected $ignorePatterns = [];
+
+
+	/**
+	 * Constructs a file list and loads in an array of file paths to process.
+	 *
+	 * @param \PHP_CodeSniffer\Config  $config  The config data for the run.
+	 * @param \PHP_CodeSniffer\Ruleset $ruleset The ruleset used for the run.
+	 *
+	 * @return void
+	 */
+	public function __construct(Config $config, Ruleset $ruleset)
+	{
+		$this->ruleset = $ruleset;
+		$this->config  = $config;
+
+		$paths = $config->files;
+		foreach ($paths as $path) {
+			$isPharFile = Util\Common::isPharFile($path);
+			if (is_dir($path) === true || $isPharFile === true) {
+				if ($isPharFile === true) {
+					$path = 'phar://'.$path;
+				}
+
+				$filterClass = $this->getFilterClass();
+
+				$di       = new \RecursiveDirectoryIterator($path, (\RecursiveDirectoryIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS));
+				$filter   = new $filterClass($di, $path, $config, $ruleset);
+				$iterator = new \RecursiveIteratorIterator($filter);
+
+				foreach ($iterator as $file) {
+					$this->files[$file->getPathname()] = null;
+					$this->numFiles++;
+				}
+			} else {
+				$this->addFile($path);
+			}//end if
+		}//end foreach
+
+		reset($this->files);
+
+	}//end __construct()
+
+
+	/**
+	 * Add a file to the list.
+	 *
+	 * If a file object has already been created, it can be passed here.
+	 * If it is left NULL, it will be created when accessed.
+	 *
+	 * @param string                      $path The path to the file being added.
+	 * @param \PHP_CodeSniffer\Files\File $file The file being added.
+	 *
+	 * @return void
+	 */
+	public function addFile($path, $file=null)
+	{
+		// No filtering is done for STDIN when the filename
+		// has not been specified.
+		if ($path === 'STDIN') {
+			$this->files[$path] = $file;
+			$this->numFiles++;
+			return;
+		}
+
+		$filterClass = $this->getFilterClass();
+
+		$di       = new \RecursiveArrayIterator([$path]);
+		$filter   = new $filterClass($di, $path, $this->config, $this->ruleset);
+		$iterator = new \RecursiveIteratorIterator($filter);
+
+		foreach ($iterator as $path) {
+			$this->files[$path] = $file;
+			$this->numFiles++;
+		}
+
+	}//end addFile()
+
+
+	/**
+	 * Get the class name of the filter being used for the run.
+	 *
+	 * @return string
+	 */
+	private function getFilterClass()
+	{
+		$filterType = $this->config->filter;
+
+		if ($filterType === null) {
+			$filterClass = '\PHP_CodeSniffer\Filters\Filter';
+		} else {
+			if (strpos($filterType, '.') !== false) {
+				// This is a path to a custom filter class.
+				$filename = realpath($filterType);
+				if ($filename === false) {
+					$error = "ERROR: Custom filter \"$filterType\" not found".PHP_EOL;
+					throw new DeepExitException($error, 3);
+				}
+
+				$filterClass = Autoload::loadFile($filename);
+			} else {
+				$filterClass = '\PHP_CodeSniffer\Filters\\'.$filterType;
+			}
+		}
+
+		return $filterClass;
+
+	}//end getFilterClass()
+
+
+	/**
+	 * Rewind the iterator to the first file.
+	 *
+	 * @return void
+	 */
+	public function rewind()
+	{
+		reset($this->files);
+
+	}//end rewind()
+
+
+	/**
+	 * Get the file that is currently being processed.
+	 *
+	 * @return \PHP_CodeSniffer\Files\File
+	 */
+	public function current()
+	{
+		$path = key($this->files);
+		if ($this->files[$path] === null) {
+			$this->files[$path] = new LocalFile($path, $this->ruleset, $this->config);
+		}
+
+		return $this->files[$path];
+
+	}//end current()
+
+
+	/**
+	 * Return the file path of the current file being processed.
+	 *
+	 * @return void
+	 */
+	public function key()
+	{
+		return key($this->files);
+
+	}//end key()
+
+
+	/**
+	 * Move forward to the next file.
+	 *
+	 * @return void
+	 */
+	public function next()
+	{
+		next($this->files);
+
+	}//end next()
+
+
+	/**
+	 * Checks if current position is valid.
+	 *
+	 * @return boolean
+	 */
+	public function valid()
+	{
+		if (current($this->files) === false) {
+			return false;
+		}
+
+		return true;
+
+	}//end valid()
+
+
+	/**
+	 * Return the number of files in the list.
+	 *
+	 * @return integer
+	 */
+	public function count()
+	{
+		return $this->numFiles;
+
+	}//end count()
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Files/LocalFile.php

Indentation +191 added lines, -191 removed lines

@@ -17,197 +17,197 @@
 {
 
 
-    /**
-     * Creates a LocalFile object and sets the content.
-     *
-     * @param string                   $path    The absolute path to the file.
-     * @param \PHP_CodeSniffer\Ruleset $ruleset The ruleset used for the run.
-     * @param \PHP_CodeSniffer\Config  $config  The config data for the run.
-     *
-     * @return void
-     */
-    public function __construct($path, Ruleset $ruleset, Config $config)
-    {
-        $this->path = trim($path);
-        if (is_readable($this->path) === false) {
-            parent::__construct($this->path, $ruleset, $config);
-            $error = 'Error opening file; file no longer exists or you do not have access to read the file';
-            $this->addMessage(true, $error, 1, 1, 'Internal.LocalFile', [], 5, false);
-            $this->ignored = true;
-            return;
-        }
-
-        // Before we go and spend time tokenizing this file, just check
-        // to see if there is a tag up top to indicate that the whole
-        // file should be ignored. It must be on one of the first two lines.
-        if ($config->annotations === true) {
-            $handle = fopen($this->path, 'r');
-            if ($handle !== false) {
-                $firstContent  = fgets($handle);
-                $firstContent .= fgets($handle);
-                fclose($handle);
-
-                if (strpos($firstContent, '@codingStandardsIgnoreFile') !== false
-                    || stripos($firstContent, 'phpcs:ignorefile') !== false
-                ) {
-                    // We are ignoring the whole file.
-                    $this->ignored = true;
-                    return;
-                }
-            }
-        }
-
-        $this->reloadContent();
-
-        parent::__construct($this->path, $ruleset, $config);
-
-    }//end __construct()
-
-
-    /**
-     * Loads the latest version of the file's content from the file system.
-     *
-     * @return void
-     */
-    public function reloadContent()
-    {
-        $this->setContent(file_get_contents($this->path));
-
-    }//end reloadContent()
-
-
-    /**
-     * Processes the file.
-     *
-     * @return void
-     */
-    public function process()
-    {
-        if ($this->ignored === true) {
-            return;
-        }
-
-        if ($this->configCache['cache'] === false) {
-            parent::process();
-            return;
-        }
-
-        $hash  = md5_file($this->path);
-        $cache = Cache::get($this->path);
-        if ($cache !== false && $cache['hash'] === $hash) {
-            // We can't filter metrics, so just load all of them.
-            $this->metrics = $cache['metrics'];
-
-            if ($this->configCache['recordErrors'] === true) {
-                // Replay the cached errors and warnings to filter out the ones
-                // we don't need for this specific run.
-                $this->configCache['cache'] = false;
-                $this->replayErrors($cache['errors'], $cache['warnings']);
-                $this->configCache['cache'] = true;
-            } else {
-                $this->errorCount   = $cache['errorCount'];
-                $this->warningCount = $cache['warningCount'];
-                $this->fixableCount = $cache['fixableCount'];
-            }
-
-            if (PHP_CODESNIFFER_VERBOSITY > 0
-                || (PHP_CODESNIFFER_CBF === true && empty($this->config->files) === false)
-            ) {
-                echo "[loaded from cache]... ";
-            }
-
-            $this->numTokens = $cache['numTokens'];
-            $this->fromCache = true;
-            return;
-        }//end if
-
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            echo PHP_EOL;
-        }
-
-        parent::process();
-
-        $cache = [
-            'hash'         => $hash,
-            'errors'       => $this->errors,
-            'warnings'     => $this->warnings,
-            'metrics'      => $this->metrics,
-            'errorCount'   => $this->errorCount,
-            'warningCount' => $this->warningCount,
-            'fixableCount' => $this->fixableCount,
-            'numTokens'    => $this->numTokens,
-        ];
-
-        Cache::set($this->path, $cache);
-
-        // During caching, we don't filter out errors in any way, so
-        // we need to do that manually now by replaying them.
-        if ($this->configCache['recordErrors'] === true) {
-            $this->configCache['cache'] = false;
-            $this->replayErrors($this->errors, $this->warnings);
-            $this->configCache['cache'] = true;
-        }
-
-    }//end process()
-
-
-    /**
-     * Clears and replays error and warnings for the file.
-     *
-     * Replaying errors and warnings allows for filtering rules to be changed
-     * and then errors and warnings to be reapplied with the new rules. This is
-     * particularly useful while caching.
-     *
-     * @param array $errors   The list of errors to replay.
-     * @param array $warnings The list of warnings to replay.
-     *
-     * @return void
-     */
-    private function replayErrors($errors, $warnings)
-    {
-        $this->errors       = [];
-        $this->warnings     = [];
-        $this->errorCount   = 0;
-        $this->warningCount = 0;
-        $this->fixableCount = 0;
-
-        foreach ($errors as $line => $lineErrors) {
-            foreach ($lineErrors as $column => $colErrors) {
-                foreach ($colErrors as $error) {
-                    $this->activeListener = $error['listener'];
-                    $this->addMessage(
-                        true,
-                        $error['message'],
-                        $line,
-                        $column,
-                        $error['source'],
-                        [],
-                        $error['severity'],
-                        $error['fixable']
-                    );
-                }
-            }
-        }
-
-        foreach ($warnings as $line => $lineErrors) {
-            foreach ($lineErrors as $column => $colErrors) {
-                foreach ($colErrors as $error) {
-                    $this->activeListener = $error['listener'];
-                    $this->addMessage(
-                        false,
-                        $error['message'],
-                        $line,
-                        $column,
-                        $error['source'],
-                        [],
-                        $error['severity'],
-                        $error['fixable']
-                    );
-                }
-            }
-        }
-
-    }//end replayErrors()
+	/**
+	 * Creates a LocalFile object and sets the content.
+	 *
+	 * @param string                   $path    The absolute path to the file.
+	 * @param \PHP_CodeSniffer\Ruleset $ruleset The ruleset used for the run.
+	 * @param \PHP_CodeSniffer\Config  $config  The config data for the run.
+	 *
+	 * @return void
+	 */
+	public function __construct($path, Ruleset $ruleset, Config $config)
+	{
+		$this->path = trim($path);
+		if (is_readable($this->path) === false) {
+			parent::__construct($this->path, $ruleset, $config);
+			$error = 'Error opening file; file no longer exists or you do not have access to read the file';
+			$this->addMessage(true, $error, 1, 1, 'Internal.LocalFile', [], 5, false);
+			$this->ignored = true;
+			return;
+		}
+
+		// Before we go and spend time tokenizing this file, just check
+		// to see if there is a tag up top to indicate that the whole
+		// file should be ignored. It must be on one of the first two lines.
+		if ($config->annotations === true) {
+			$handle = fopen($this->path, 'r');
+			if ($handle !== false) {
+				$firstContent  = fgets($handle);
+				$firstContent .= fgets($handle);
+				fclose($handle);
+
+				if (strpos($firstContent, '@codingStandardsIgnoreFile') !== false
+					|| stripos($firstContent, 'phpcs:ignorefile') !== false
+				) {
+					// We are ignoring the whole file.
+					$this->ignored = true;
+					return;
+				}
+			}
+		}
+
+		$this->reloadContent();
+
+		parent::__construct($this->path, $ruleset, $config);
+
+	}//end __construct()
+
+
+	/**
+	 * Loads the latest version of the file's content from the file system.
+	 *
+	 * @return void
+	 */
+	public function reloadContent()
+	{
+		$this->setContent(file_get_contents($this->path));
+
+	}//end reloadContent()
+
+
+	/**
+	 * Processes the file.
+	 *
+	 * @return void
+	 */
+	public function process()
+	{
+		if ($this->ignored === true) {
+			return;
+		}
+
+		if ($this->configCache['cache'] === false) {
+			parent::process();
+			return;
+		}
+
+		$hash  = md5_file($this->path);
+		$cache = Cache::get($this->path);
+		if ($cache !== false && $cache['hash'] === $hash) {
+			// We can't filter metrics, so just load all of them.
+			$this->metrics = $cache['metrics'];
+
+			if ($this->configCache['recordErrors'] === true) {
+				// Replay the cached errors and warnings to filter out the ones
+				// we don't need for this specific run.
+				$this->configCache['cache'] = false;
+				$this->replayErrors($cache['errors'], $cache['warnings']);
+				$this->configCache['cache'] = true;
+			} else {
+				$this->errorCount   = $cache['errorCount'];
+				$this->warningCount = $cache['warningCount'];
+				$this->fixableCount = $cache['fixableCount'];
+			}
+
+			if (PHP_CODESNIFFER_VERBOSITY > 0
+				|| (PHP_CODESNIFFER_CBF === true && empty($this->config->files) === false)
+			) {
+				echo "[loaded from cache]... ";
+			}
+
+			$this->numTokens = $cache['numTokens'];
+			$this->fromCache = true;
+			return;
+		}//end if
+
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			echo PHP_EOL;
+		}
+
+		parent::process();
+
+		$cache = [
+			'hash'         => $hash,
+			'errors'       => $this->errors,
+			'warnings'     => $this->warnings,
+			'metrics'      => $this->metrics,
+			'errorCount'   => $this->errorCount,
+			'warningCount' => $this->warningCount,
+			'fixableCount' => $this->fixableCount,
+			'numTokens'    => $this->numTokens,
+		];
+
+		Cache::set($this->path, $cache);
+
+		// During caching, we don't filter out errors in any way, so
+		// we need to do that manually now by replaying them.
+		if ($this->configCache['recordErrors'] === true) {
+			$this->configCache['cache'] = false;
+			$this->replayErrors($this->errors, $this->warnings);
+			$this->configCache['cache'] = true;
+		}
+
+	}//end process()
+
+
+	/**
+	 * Clears and replays error and warnings for the file.
+	 *
+	 * Replaying errors and warnings allows for filtering rules to be changed
+	 * and then errors and warnings to be reapplied with the new rules. This is
+	 * particularly useful while caching.
+	 *
+	 * @param array $errors   The list of errors to replay.
+	 * @param array $warnings The list of warnings to replay.
+	 *
+	 * @return void
+	 */
+	private function replayErrors($errors, $warnings)
+	{
+		$this->errors       = [];
+		$this->warnings     = [];
+		$this->errorCount   = 0;
+		$this->warningCount = 0;
+		$this->fixableCount = 0;
+
+		foreach ($errors as $line => $lineErrors) {
+			foreach ($lineErrors as $column => $colErrors) {
+				foreach ($colErrors as $error) {
+					$this->activeListener = $error['listener'];
+					$this->addMessage(
+						true,
+						$error['message'],
+						$line,
+						$column,
+						$error['source'],
+						[],
+						$error['severity'],
+						$error['fixable']
+					);
+				}
+			}
+		}
+
+		foreach ($warnings as $line => $lineErrors) {
+			foreach ($lineErrors as $column => $colErrors) {
+				foreach ($colErrors as $error) {
+					$this->activeListener = $error['listener'];
+					$this->addMessage(
+						false,
+						$error['message'],
+						$line,
+						$column,
+						$error['source'],
+						[],
+						$error['severity'],
+						$error['fixable']
+					);
+				}
+			}
+		}
+
+	}//end replayErrors()
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Files/DummyFile.php

Indentation +48 added lines, -48 removed lines

@@ -21,62 +21,62 @@
 {
 
 
-    /**
-     * Creates a DummyFile object and sets the content.
-     *
-     * @param string                   $content The content of the file.
-     * @param \PHP_CodeSniffer\Ruleset $ruleset The ruleset used for the run.
-     * @param \PHP_CodeSniffer\Config  $config  The config data for the run.
-     *
-     * @return void
-     */
-    public function __construct($content, Ruleset $ruleset, Config $config)
-    {
-        $this->setContent($content);
+	/**
+	 * Creates a DummyFile object and sets the content.
+	 *
+	 * @param string                   $content The content of the file.
+	 * @param \PHP_CodeSniffer\Ruleset $ruleset The ruleset used for the run.
+	 * @param \PHP_CodeSniffer\Config  $config  The config data for the run.
+	 *
+	 * @return void
+	 */
+	public function __construct($content, Ruleset $ruleset, Config $config)
+	{
+		$this->setContent($content);
 
-        // See if a filename was defined in the content.
-        // This is done by including: phpcs_input_file: [file path]
-        // as the first line of content.
-        $path = 'STDIN';
-        if ($content !== null) {
-            if (substr($content, 0, 17) === 'phpcs_input_file:') {
-                $eolPos   = strpos($content, $this->eolChar);
-                $filename = trim(substr($content, 17, ($eolPos - 17)));
-                $content  = substr($content, ($eolPos + strlen($this->eolChar)));
-                $path     = $filename;
+		// See if a filename was defined in the content.
+		// This is done by including: phpcs_input_file: [file path]
+		// as the first line of content.
+		$path = 'STDIN';
+		if ($content !== null) {
+			if (substr($content, 0, 17) === 'phpcs_input_file:') {
+				$eolPos   = strpos($content, $this->eolChar);
+				$filename = trim(substr($content, 17, ($eolPos - 17)));
+				$content  = substr($content, ($eolPos + strlen($this->eolChar)));
+				$path     = $filename;
 
-                $this->setContent($content);
-            }
-        }
+				$this->setContent($content);
+			}
+		}
 
-        // The CLI arg overrides anything passed in the content.
-        if ($config->stdinPath !== null) {
-            $path = $config->stdinPath;
-        }
+		// The CLI arg overrides anything passed in the content.
+		if ($config->stdinPath !== null) {
+			$path = $config->stdinPath;
+		}
 
-        parent::__construct($path, $ruleset, $config);
+		parent::__construct($path, $ruleset, $config);
 
-    }//end __construct()
+	}//end __construct()
 
 
-    /**
-     * Set the error, warning, and fixable counts for the file.
-     *
-     * @param int $errorCount   The number of errors found.
-     * @param int $warningCount The number of warnings found.
-     * @param int $fixableCount The number of fixable errors found.
-     * @param int $fixedCount   The number of errors that were fixed.
-     *
-     * @return void
-     */
-    public function setErrorCounts($errorCount, $warningCount, $fixableCount, $fixedCount)
-    {
-        $this->errorCount   = $errorCount;
-        $this->warningCount = $warningCount;
-        $this->fixableCount = $fixableCount;
-        $this->fixedCount   = $fixedCount;
+	/**
+	 * Set the error, warning, and fixable counts for the file.
+	 *
+	 * @param int $errorCount   The number of errors found.
+	 * @param int $warningCount The number of warnings found.
+	 * @param int $fixableCount The number of fixable errors found.
+	 * @param int $fixedCount   The number of errors that were fixed.
+	 *
+	 * @return void
+	 */
+	public function setErrorCounts($errorCount, $warningCount, $fixableCount, $fixedCount)
+	{
+		$this->errorCount   = $errorCount;
+		$this->warningCount = $warningCount;
+		$this->fixableCount = $fixableCount;
+		$this->fixedCount   = $fixedCount;
 
-    }//end setErrorCounts()
+	}//end setErrorCounts()
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Ruleset.php

Indentation +1348 added lines, -1348 removed lines

@@ -17,1354 +17,1354 @@
 class Ruleset
 {
 
-    /**
-     * The name of the coding standard being used.
-     *
-     * If a top-level standard includes other standards, or sniffs
-     * from other standards, only the name of the top-level standard
-     * will be stored in here.
-     *
-     * If multiple top-level standards are being loaded into
-     * a single ruleset object, this will store a comma separated list
-     * of the top-level standard names.
-     *
-     * @var string
-     */
-    public $name = '';
-
-    /**
-     * A list of file paths for the ruleset files being used.
-     *
-     * @var string[]
-     */
-    public $paths = [];
-
-    /**
-     * A list of regular expressions used to ignore specific sniffs for files and folders.
-     *
-     * Is also used to set global exclude patterns.
-     * The key is the regular expression and the value is the type
-     * of ignore pattern (absolute or relative).
-     *
-     * @var array<string, string>
-     */
-    public $ignorePatterns = [];
-
-    /**
-     * A list of regular expressions used to include specific sniffs for files and folders.
-     *
-     * The key is the sniff code and the value is an array with
-     * the key being a regular expression and the value is the type
-     * of ignore pattern (absolute or relative).
-     *
-     * @var array<string, array<string, string>>
-     */
-    public $includePatterns = [];
-
-    /**
-     * An array of sniff objects that are being used to check files.
-     *
-     * The key is the fully qualified name of the sniff class
-     * and the value is the sniff object.
-     *
-     * @var array<string, \PHP_CodeSniffer\Sniffs\Sniff>
-     */
-    public $sniffs = [];
-
-    /**
-     * A mapping of sniff codes to fully qualified class names.
-     *
-     * The key is the sniff code and the value
-     * is the fully qualified name of the sniff class.
-     *
-     * @var array<string, string>
-     */
-    public $sniffCodes = [];
-
-    /**
-     * An array of token types and the sniffs that are listening for them.
-     *
-     * The key is the token name being listened for and the value
-     * is the sniff object.
-     *
-     * @var array<int, \PHP_CodeSniffer\Sniffs\Sniff>
-     */
-    public $tokenListeners = [];
-
-    /**
-     * An array of rules from the ruleset.xml file.
-     *
-     * It may be empty, indicating that the ruleset does not override
-     * any of the default sniff settings.
-     *
-     * @var array<string, mixed>
-     */
-    public $ruleset = [];
-
-    /**
-     * The directories that the processed rulesets are in.
-     *
-     * @var string[]
-     */
-    protected $rulesetDirs = [];
-
-    /**
-     * The config data for the run.
-     *
-     * @var \PHP_CodeSniffer\Config
-     */
-    private $config = null;
-
-
-    /**
-     * Initialise the ruleset that the run will use.
-     *
-     * @param \PHP_CodeSniffer\Config $config The config data for the run.
-     *
-     * @return void
-     */
-    public function __construct(Config $config)
-    {
-        // Ignore sniff restrictions if caching is on.
-        $restrictions = [];
-        $exclusions   = [];
-        if ($config->cache === false) {
-            $restrictions = $config->sniffs;
-            $exclusions   = $config->exclude;
-        }
-
-        $this->config = $config;
-        $sniffs       = [];
-
-        $standardPaths = [];
-        foreach ($config->standards as $standard) {
-            $installed = Util\Standards::getInstalledStandardPath($standard);
-            if ($installed === null) {
-                $standard = Util\Common::realpath($standard);
-                if (is_dir($standard) === true
-                    && is_file(Util\Common::realpath($standard.DIRECTORY_SEPARATOR.'ruleset.xml')) === true
-                ) {
-                    $standard = Util\Common::realpath($standard.DIRECTORY_SEPARATOR.'ruleset.xml');
-                }
-            } else {
-                $standard = $installed;
-            }
-
-            $standardPaths[] = $standard;
-        }
-
-        foreach ($standardPaths as $standard) {
-            $ruleset = @simplexml_load_string(file_get_contents($standard));
-            if ($ruleset !== false) {
-                $standardName = (string) $ruleset['name'];
-                if ($this->name !== '') {
-                    $this->name .= ', ';
-                }
-
-                $this->name .= $standardName;
-
-                // Allow autoloading of custom files inside this standard.
-                if (isset($ruleset['namespace']) === true) {
-                    $namespace = (string) $ruleset['namespace'];
-                } else {
-                    $namespace = basename(dirname($standard));
-                }
-
-                Autoload::addSearchPath(dirname($standard), $namespace);
-            }
-
-            if (defined('PHP_CODESNIFFER_IN_TESTS') === true && empty($restrictions) === false) {
-                // In unit tests, only register the sniffs that the test wants and not the entire standard.
-                try {
-                    foreach ($restrictions as $restriction) {
-                        $sniffs = array_merge($sniffs, $this->expandRulesetReference($restriction, dirname($standard)));
-                    }
-                } catch (RuntimeException $e) {
-                    // Sniff reference could not be expanded, which probably means this
-                    // is an installed standard. Let the unit test system take care of
-                    // setting the correct sniff for testing.
-                    return;
-                }
-
-                break;
-            }
-
-            if (PHP_CODESNIFFER_VERBOSITY === 1) {
-                echo "Registering sniffs in the $standardName standard... ";
-                if (count($config->standards) > 1 || PHP_CODESNIFFER_VERBOSITY > 2) {
-                    echo PHP_EOL;
-                }
-            }
-
-            $sniffs = array_merge($sniffs, $this->processRuleset($standard));
-        }//end foreach
-
-        $sniffRestrictions = [];
-        foreach ($restrictions as $sniffCode) {
-            $parts     = explode('.', strtolower($sniffCode));
-            $sniffName = $parts[0].'\sniffs\\'.$parts[1].'\\'.$parts[2].'sniff';
-            $sniffRestrictions[$sniffName] = true;
-        }
-
-        $sniffExclusions = [];
-        foreach ($exclusions as $sniffCode) {
-            $parts     = explode('.', strtolower($sniffCode));
-            $sniffName = $parts[0].'\sniffs\\'.$parts[1].'\\'.$parts[2].'sniff';
-            $sniffExclusions[$sniffName] = true;
-        }
-
-        $this->registerSniffs($sniffs, $sniffRestrictions, $sniffExclusions);
-        $this->populateTokenListeners();
-
-        $numSniffs = count($this->sniffs);
-        if (PHP_CODESNIFFER_VERBOSITY === 1) {
-            echo "DONE ($numSniffs sniffs registered)".PHP_EOL;
-        }
-
-        if ($numSniffs === 0) {
-            throw new RuntimeException('No sniffs were registered');
-        }
-
-    }//end __construct()
-
-
-    /**
-     * Prints a report showing the sniffs contained in a standard.
-     *
-     * @return void
-     */
-    public function explain()
-    {
-        $sniffs = array_keys($this->sniffCodes);
-        sort($sniffs);
-
-        ob_start();
-
-        $lastStandard = null;
-        $lastCount    = '';
-        $sniffCount   = count($sniffs);
-
-        // Add a dummy entry to the end so we loop
-        // one last time and clear the output buffer.
-        $sniffs[] = '';
-
-        echo PHP_EOL."The $this->name standard contains $sniffCount sniffs".PHP_EOL;
-
-        ob_start();
-
-        foreach ($sniffs as $i => $sniff) {
-            if ($i === $sniffCount) {
-                $currentStandard = null;
-            } else {
-                $currentStandard = substr($sniff, 0, strpos($sniff, '.'));
-                if ($lastStandard === null) {
-                    $lastStandard = $currentStandard;
-                }
-            }
-
-            if ($currentStandard !== $lastStandard) {
-                $sniffList = ob_get_contents();
-                ob_end_clean();
-
-                echo PHP_EOL.$lastStandard.' ('.$lastCount.' sniff';
-                if ($lastCount > 1) {
-                    echo 's';
-                }
-
-                echo ')'.PHP_EOL;
-                echo str_repeat('-', (strlen($lastStandard.$lastCount) + 10));
-                echo PHP_EOL;
-                echo $sniffList;
-
-                $lastStandard = $currentStandard;
-                $lastCount    = 0;
-
-                if ($currentStandard === null) {
-                    break;
-                }
-
-                ob_start();
-            }//end if
-
-            echo '  '.$sniff.PHP_EOL;
-            $lastCount++;
-        }//end foreach
-
-    }//end explain()
-
-
-    /**
-     * Processes a single ruleset and returns a list of the sniffs it represents.
-     *
-     * Rules founds within the ruleset are processed immediately, but sniff classes
-     * are not registered by this method.
-     *
-     * @param string $rulesetPath The path to a ruleset XML file.
-     * @param int    $depth       How many nested processing steps we are in. This
-     *                            is only used for debug output.
-     *
-     * @return string[]
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the ruleset path is invalid.
-     */
-    public function processRuleset($rulesetPath, $depth=0)
-    {
-        $rulesetPath = Util\Common::realpath($rulesetPath);
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            echo str_repeat("\t", $depth);
-            echo 'Processing ruleset '.Util\Common::stripBasepath($rulesetPath, $this->config->basepath).PHP_EOL;
-        }
-
-        libxml_use_internal_errors(true);
-        $ruleset = simplexml_load_string(file_get_contents($rulesetPath));
-        if ($ruleset === false) {
-            $errorMsg = "Ruleset $rulesetPath is not valid".PHP_EOL;
-            $errors   = libxml_get_errors();
-            foreach ($errors as $error) {
-                $errorMsg .= '- On line '.$error->line.', column '.$error->column.': '.$error->message;
-            }
-
-            libxml_clear_errors();
-            throw new RuntimeException($errorMsg);
-        }
-
-        libxml_use_internal_errors(false);
-
-        $ownSniffs      = [];
-        $includedSniffs = [];
-        $excludedSniffs = [];
-
-        $this->paths[]       = $rulesetPath;
-        $rulesetDir          = dirname($rulesetPath);
-        $this->rulesetDirs[] = $rulesetDir;
-
-        $sniffDir = $rulesetDir.DIRECTORY_SEPARATOR.'Sniffs';
-        if (is_dir($sniffDir) === true) {
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo str_repeat("\t", $depth);
-                echo "\tAdding sniff files from ".Util\Common::stripBasepath($sniffDir, $this->config->basepath).' directory'.PHP_EOL;
-            }
-
-            $ownSniffs = $this->expandSniffDirectory($sniffDir, $depth);
-        }
-
-        // Included custom autoloaders.
-        foreach ($ruleset->{'autoload'} as $autoload) {
-            if ($this->shouldProcessElement($autoload) === false) {
-                continue;
-            }
-
-            $autoloadPath = (string) $autoload;
-            if (is_file($autoloadPath) === false) {
-                $autoloadPath = Util\Common::realPath(dirname($rulesetPath).DIRECTORY_SEPARATOR.$autoloadPath);
-            }
-
-            if ($autoloadPath === false) {
-                throw new RuntimeException('The specified autoload file "'.$autoload.'" does not exist');
-            }
-
-            include_once $autoloadPath;
-
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo str_repeat("\t", $depth);
-                echo "\t=> included autoloader $autoloadPath".PHP_EOL;
-            }
-        }//end foreach
-
-        // Process custom sniff config settings.
-        foreach ($ruleset->{'config'} as $config) {
-            if ($this->shouldProcessElement($config) === false) {
-                continue;
-            }
-
-            Config::setConfigData((string) $config['name'], (string) $config['value'], true);
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo str_repeat("\t", $depth);
-                echo "\t=> set config value ".(string) $config['name'].': '.(string) $config['value'].PHP_EOL;
-            }
-        }
-
-        foreach ($ruleset->rule as $rule) {
-            if (isset($rule['ref']) === false
-                || $this->shouldProcessElement($rule) === false
-            ) {
-                continue;
-            }
-
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo str_repeat("\t", $depth);
-                echo "\tProcessing rule \"".$rule['ref'].'"'.PHP_EOL;
-            }
-
-            $expandedSniffs = $this->expandRulesetReference((string) $rule['ref'], $rulesetDir, $depth);
-            $newSniffs      = array_diff($expandedSniffs, $includedSniffs);
-            $includedSniffs = array_merge($includedSniffs, $expandedSniffs);
-
-            $parts = explode('.', $rule['ref']);
-            if (count($parts) === 4
-                && $parts[0] !== ''
-                && $parts[1] !== ''
-                && $parts[2] !== ''
-            ) {
-                $sniffCode = $parts[0].'.'.$parts[1].'.'.$parts[2];
-                if (isset($this->ruleset[$sniffCode]['severity']) === true
-                    && $this->ruleset[$sniffCode]['severity'] === 0
-                ) {
-                    // This sniff code has already been turned off, but now
-                    // it is being explicitly included again, so turn it back on.
-                    $this->ruleset[(string) $rule['ref']]['severity'] = 5;
-                    if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                        echo str_repeat("\t", $depth);
-                        echo "\t\t* disabling sniff exclusion for specific message code *".PHP_EOL;
-                        echo str_repeat("\t", $depth);
-                        echo "\t\t=> severity set to 5".PHP_EOL;
-                    }
-                } else if (empty($newSniffs) === false) {
-                    $newSniff = $newSniffs[0];
-                    if (in_array($newSniff, $ownSniffs, true) === false) {
-                        // Including a sniff that hasn't been included higher up, but
-                        // only including a single message from it. So turn off all messages in
-                        // the sniff, except this one.
-                        $this->ruleset[$sniffCode]['severity']            = 0;
-                        $this->ruleset[(string) $rule['ref']]['severity'] = 5;
-                        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                            echo str_repeat("\t", $depth);
-                            echo "\t\tExcluding sniff \"".$sniffCode.'" except for "'.$parts[3].'"'.PHP_EOL;
-                        }
-                    }
-                }//end if
-            }//end if
-
-            if (isset($rule->exclude) === true) {
-                foreach ($rule->exclude as $exclude) {
-                    if (isset($exclude['name']) === false) {
-                        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                            echo str_repeat("\t", $depth);
-                            echo "\t\t* ignoring empty exclude rule *".PHP_EOL;
-                            echo "\t\t\t=> ".$exclude->asXML().PHP_EOL;
-                        }
-
-                        continue;
-                    }
-
-                    if ($this->shouldProcessElement($exclude) === false) {
-                        continue;
-                    }
-
-                    if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                        echo str_repeat("\t", $depth);
-                        echo "\t\tExcluding rule \"".$exclude['name'].'"'.PHP_EOL;
-                    }
-
-                    // Check if a single code is being excluded, which is a shortcut
-                    // for setting the severity of the message to 0.
-                    $parts = explode('.', $exclude['name']);
-                    if (count($parts) === 4) {
-                        $this->ruleset[(string) $exclude['name']]['severity'] = 0;
-                        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                            echo str_repeat("\t", $depth);
-                            echo "\t\t=> severity set to 0".PHP_EOL;
-                        }
-                    } else {
-                        $excludedSniffs = array_merge(
-                            $excludedSniffs,
-                            $this->expandRulesetReference((string) $exclude['name'], $rulesetDir, ($depth + 1))
-                        );
-                    }
-                }//end foreach
-            }//end if
-
-            $this->processRule($rule, $newSniffs, $depth);
-        }//end foreach
-
-        // Process custom command line arguments.
-        $cliArgs = [];
-        foreach ($ruleset->{'arg'} as $arg) {
-            if ($this->shouldProcessElement($arg) === false) {
-                continue;
-            }
-
-            if (isset($arg['name']) === true) {
-                $argString = '--'.(string) $arg['name'];
-                if (isset($arg['value']) === true) {
-                    $argString .= '='.(string) $arg['value'];
-                }
-            } else {
-                $argString = '-'.(string) $arg['value'];
-            }
-
-            $cliArgs[] = $argString;
-
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo str_repeat("\t", $depth);
-                echo "\t=> set command line value $argString".PHP_EOL;
-            }
-        }//end foreach
-
-        // Set custom php ini values as CLI args.
-        foreach ($ruleset->{'ini'} as $arg) {
-            if ($this->shouldProcessElement($arg) === false) {
-                continue;
-            }
-
-            if (isset($arg['name']) === false) {
-                continue;
-            }
-
-            $name      = (string) $arg['name'];
-            $argString = $name;
-            if (isset($arg['value']) === true) {
-                $value      = (string) $arg['value'];
-                $argString .= "=$value";
-            } else {
-                $value = 'true';
-            }
-
-            $cliArgs[] = '-d';
-            $cliArgs[] = $argString;
-
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo str_repeat("\t", $depth);
-                echo "\t=> set PHP ini value $name to $value".PHP_EOL;
-            }
-        }//end foreach
-
-        if (empty($this->config->files) === true) {
-            // Process hard-coded file paths.
-            foreach ($ruleset->{'file'} as $file) {
-                $file      = (string) $file;
-                $cliArgs[] = $file;
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", $depth);
-                    echo "\t=> added \"$file\" to the file list".PHP_EOL;
-                }
-            }
-        }
-
-        if (empty($cliArgs) === false) {
-            // Change the directory so all relative paths are worked
-            // out based on the location of the ruleset instead of
-            // the location of the user.
-            $inPhar = Util\Common::isPharFile($rulesetDir);
-            if ($inPhar === false) {
-                $currentDir = getcwd();
-                chdir($rulesetDir);
-            }
-
-            $this->config->setCommandLineValues($cliArgs);
-
-            if ($inPhar === false) {
-                chdir($currentDir);
-            }
-        }
-
-        // Process custom ignore pattern rules.
-        foreach ($ruleset->{'exclude-pattern'} as $pattern) {
-            if ($this->shouldProcessElement($pattern) === false) {
-                continue;
-            }
-
-            if (isset($pattern['type']) === false) {
-                $pattern['type'] = 'absolute';
-            }
-
-            $this->ignorePatterns[(string) $pattern] = (string) $pattern['type'];
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo str_repeat("\t", $depth);
-                echo "\t=> added global ".(string) $pattern['type'].' ignore pattern: '.(string) $pattern.PHP_EOL;
-            }
-        }
-
-        $includedSniffs = array_unique(array_merge($ownSniffs, $includedSniffs));
-        $excludedSniffs = array_unique($excludedSniffs);
-
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            $included = count($includedSniffs);
-            $excluded = count($excludedSniffs);
-            echo str_repeat("\t", $depth);
-            echo "=> Ruleset processing complete; included $included sniffs and excluded $excluded".PHP_EOL;
-        }
-
-        // Merge our own sniff list with our externally included
-        // sniff list, but filter out any excluded sniffs.
-        $files = [];
-        foreach ($includedSniffs as $sniff) {
-            if (in_array($sniff, $excludedSniffs, true) === true) {
-                continue;
-            } else {
-                $files[] = Util\Common::realpath($sniff);
-            }
-        }
-
-        return $files;
-
-    }//end processRuleset()
-
-
-    /**
-     * Expands a directory into a list of sniff files within.
-     *
-     * @param string $directory The path to a directory.
-     * @param int    $depth     How many nested processing steps we are in. This
-     *                          is only used for debug output.
-     *
-     * @return array
-     */
-    private function expandSniffDirectory($directory, $depth=0)
-    {
-        $sniffs = [];
-
-        $rdi = new \RecursiveDirectoryIterator($directory, \RecursiveDirectoryIterator::FOLLOW_SYMLINKS);
-        $di  = new \RecursiveIteratorIterator($rdi, 0, \RecursiveIteratorIterator::CATCH_GET_CHILD);
-
-        $dirLen = strlen($directory);
-
-        foreach ($di as $file) {
-            $filename = $file->getFilename();
-
-            // Skip hidden files.
-            if (substr($filename, 0, 1) === '.') {
-                continue;
-            }
-
-            // We are only interested in PHP and sniff files.
-            $fileParts = explode('.', $filename);
-            if (array_pop($fileParts) !== 'php') {
-                continue;
-            }
-
-            $basename = basename($filename, '.php');
-            if (substr($basename, -5) !== 'Sniff') {
-                continue;
-            }
-
-            $path = $file->getPathname();
-
-            // Skip files in hidden directories within the Sniffs directory of this
-            // standard. We use the offset with strpos() to allow hidden directories
-            // before, valid example:
-            // /home/foo/.composer/vendor/squiz/custom_tool/MyStandard/Sniffs/...
-            if (strpos($path, DIRECTORY_SEPARATOR.'.', $dirLen) !== false) {
-                continue;
-            }
-
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo str_repeat("\t", $depth);
-                echo "\t\t=> ".Util\Common::stripBasepath($path, $this->config->basepath).PHP_EOL;
-            }
-
-            $sniffs[] = $path;
-        }//end foreach
-
-        return $sniffs;
-
-    }//end expandSniffDirectory()
-
-
-    /**
-     * Expands a ruleset reference into a list of sniff files.
-     *
-     * @param string $ref        The reference from the ruleset XML file.
-     * @param string $rulesetDir The directory of the ruleset XML file, used to
-     *                           evaluate relative paths.
-     * @param int    $depth      How many nested processing steps we are in. This
-     *                           is only used for debug output.
-     *
-     * @return array
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the reference is invalid.
-     */
-    private function expandRulesetReference($ref, $rulesetDir, $depth=0)
-    {
-        // Ignore internal sniffs codes as they are used to only
-        // hide and change internal messages.
-        if (substr($ref, 0, 9) === 'Internal.') {
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo str_repeat("\t", $depth);
-                echo "\t\t* ignoring internal sniff code *".PHP_EOL;
-            }
-
-            return [];
-        }
-
-        // As sniffs can't begin with a full stop, assume references in
-        // this format are relative paths and attempt to convert them
-        // to absolute paths. If this fails, let the reference run through
-        // the normal checks and have it fail as normal.
-        if (substr($ref, 0, 1) === '.') {
-            $realpath = Util\Common::realpath($rulesetDir.'/'.$ref);
-            if ($realpath !== false) {
-                $ref = $realpath;
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", $depth);
-                    echo "\t\t=> ".Util\Common::stripBasepath($ref, $this->config->basepath).PHP_EOL;
-                }
-            }
-        }
-
-        // As sniffs can't begin with a tilde, assume references in
-        // this format are relative to the user's home directory.
-        if (substr($ref, 0, 2) === '~/') {
-            $realpath = Util\Common::realpath($ref);
-            if ($realpath !== false) {
-                $ref = $realpath;
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", $depth);
-                    echo "\t\t=> ".Util\Common::stripBasepath($ref, $this->config->basepath).PHP_EOL;
-                }
-            }
-        }
-
-        if (is_file($ref) === true) {
-            if (substr($ref, -9) === 'Sniff.php') {
-                // A single external sniff.
-                $this->rulesetDirs[] = dirname(dirname(dirname($ref)));
-                return [$ref];
-            }
-        } else {
-            // See if this is a whole standard being referenced.
-            $path = Util\Standards::getInstalledStandardPath($ref);
-            if (Util\Common::isPharFile($path) === true && strpos($path, 'ruleset.xml') === false) {
-                // If the ruleset exists inside the phar file, use it.
-                if (file_exists($path.DIRECTORY_SEPARATOR.'ruleset.xml') === true) {
-                    $path .= DIRECTORY_SEPARATOR.'ruleset.xml';
-                } else {
-                    $path = null;
-                }
-            }
-
-            if ($path !== null) {
-                $ref = $path;
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", $depth);
-                    echo "\t\t=> ".Util\Common::stripBasepath($ref, $this->config->basepath).PHP_EOL;
-                }
-            } else if (is_dir($ref) === false) {
-                // Work out the sniff path.
-                $sepPos = strpos($ref, DIRECTORY_SEPARATOR);
-                if ($sepPos !== false) {
-                    $stdName = substr($ref, 0, $sepPos);
-                    $path    = substr($ref, $sepPos);
-                } else {
-                    $parts   = explode('.', $ref);
-                    $stdName = $parts[0];
-                    if (count($parts) === 1) {
-                        // A whole standard?
-                        $path = '';
-                    } else if (count($parts) === 2) {
-                        // A directory of sniffs?
-                        $path = DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR.$parts[1];
-                    } else {
-                        // A single sniff?
-                        $path = DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR.$parts[1].DIRECTORY_SEPARATOR.$parts[2].'Sniff.php';
-                    }
-                }
-
-                $newRef  = false;
-                $stdPath = Util\Standards::getInstalledStandardPath($stdName);
-                if ($stdPath !== null && $path !== '') {
-                    if (Util\Common::isPharFile($stdPath) === true
-                        && strpos($stdPath, 'ruleset.xml') === false
-                    ) {
-                        // Phar files can only return the directory,
-                        // since ruleset can be omitted if building one standard.
-                        $newRef = Util\Common::realpath($stdPath.$path);
-                    } else {
-                        $newRef = Util\Common::realpath(dirname($stdPath).$path);
-                    }
-                }
-
-                if ($newRef === false) {
-                    // The sniff is not locally installed, so check if it is being
-                    // referenced as a remote sniff outside the install. We do this
-                    // by looking through all directories where we have found ruleset
-                    // files before, looking for ones for this particular standard,
-                    // and seeing if it is in there.
-                    foreach ($this->rulesetDirs as $dir) {
-                        if (strtolower(basename($dir)) !== strtolower($stdName)) {
-                            continue;
-                        }
-
-                        $newRef = Util\Common::realpath($dir.$path);
-
-                        if ($newRef !== false) {
-                            $ref = $newRef;
-                        }
-                    }
-                } else {
-                    $ref = $newRef;
-                }
-
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", $depth);
-                    echo "\t\t=> ".Util\Common::stripBasepath($ref, $this->config->basepath).PHP_EOL;
-                }
-            }//end if
-        }//end if
-
-        if (is_dir($ref) === true) {
-            if (is_file($ref.DIRECTORY_SEPARATOR.'ruleset.xml') === true) {
-                // We are referencing an external coding standard.
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", $depth);
-                    echo "\t\t* rule is referencing a standard using directory name; processing *".PHP_EOL;
-                }
-
-                return $this->processRuleset($ref.DIRECTORY_SEPARATOR.'ruleset.xml', ($depth + 2));
-            } else {
-                // We are referencing a whole directory of sniffs.
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", $depth);
-                    echo "\t\t* rule is referencing a directory of sniffs *".PHP_EOL;
-                    echo str_repeat("\t", $depth);
-                    echo "\t\tAdding sniff files from directory".PHP_EOL;
-                }
-
-                return $this->expandSniffDirectory($ref, ($depth + 1));
-            }
-        } else {
-            if (is_file($ref) === false) {
-                $error = "Referenced sniff \"$ref\" does not exist";
-                throw new RuntimeException($error);
-            }
-
-            if (substr($ref, -9) === 'Sniff.php') {
-                // A single sniff.
-                return [$ref];
-            } else {
-                // Assume an external ruleset.xml file.
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", $depth);
-                    echo "\t\t* rule is referencing a standard using ruleset path; processing *".PHP_EOL;
-                }
-
-                return $this->processRuleset($ref, ($depth + 2));
-            }
-        }//end if
-
-    }//end expandRulesetReference()
-
-
-    /**
-     * Processes a rule from a ruleset XML file, overriding built-in defaults.
-     *
-     * @param \SimpleXMLElement $rule      The rule object from a ruleset XML file.
-     * @param string[]          $newSniffs An array of sniffs that got included by this rule.
-     * @param int               $depth     How many nested processing steps we are in.
-     *                                     This is only used for debug output.
-     *
-     * @return void
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If rule settings are invalid.
-     */
-    private function processRule($rule, $newSniffs, $depth=0)
-    {
-        $ref  = (string) $rule['ref'];
-        $todo = [$ref];
-
-        $parts = explode('.', $ref);
-        if (count($parts) <= 2) {
-            // We are processing a standard or a category of sniffs.
-            foreach ($newSniffs as $sniffFile) {
-                $parts         = explode(DIRECTORY_SEPARATOR, $sniffFile);
-                $sniffName     = array_pop($parts);
-                $sniffCategory = array_pop($parts);
-                array_pop($parts);
-                $sniffStandard = array_pop($parts);
-                $todo[]        = $sniffStandard.'.'.$sniffCategory.'.'.substr($sniffName, 0, -9);
-            }
-        }
-
-        foreach ($todo as $code) {
-            // Custom severity.
-            if (isset($rule->severity) === true
-                && $this->shouldProcessElement($rule->severity) === true
-            ) {
-                if (isset($this->ruleset[$code]) === false) {
-                    $this->ruleset[$code] = [];
-                }
-
-                $this->ruleset[$code]['severity'] = (int) $rule->severity;
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", $depth);
-                    echo "\t\t=> severity set to ".(int) $rule->severity;
-                    if ($code !== $ref) {
-                        echo " for $code";
-                    }
-
-                    echo PHP_EOL;
-                }
-            }
-
-            // Custom message type.
-            if (isset($rule->type) === true
-                && $this->shouldProcessElement($rule->type) === true
-            ) {
-                if (isset($this->ruleset[$code]) === false) {
-                    $this->ruleset[$code] = [];
-                }
-
-                $type = strtolower((string) $rule->type);
-                if ($type !== 'error' && $type !== 'warning') {
-                    throw new RuntimeException("Message type \"$type\" is invalid; must be \"error\" or \"warning\"");
-                }
-
-                $this->ruleset[$code]['type'] = $type;
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", $depth);
-                    echo "\t\t=> message type set to ".(string) $rule->type;
-                    if ($code !== $ref) {
-                        echo " for $code";
-                    }
-
-                    echo PHP_EOL;
-                }
-            }//end if
-
-            // Custom message.
-            if (isset($rule->message) === true
-                && $this->shouldProcessElement($rule->message) === true
-            ) {
-                if (isset($this->ruleset[$code]) === false) {
-                    $this->ruleset[$code] = [];
-                }
-
-                $this->ruleset[$code]['message'] = (string) $rule->message;
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", $depth);
-                    echo "\t\t=> message set to ".(string) $rule->message;
-                    if ($code !== $ref) {
-                        echo " for $code";
-                    }
-
-                    echo PHP_EOL;
-                }
-            }
-
-            // Custom properties.
-            if (isset($rule->properties) === true
-                && $this->shouldProcessElement($rule->properties) === true
-            ) {
-                foreach ($rule->properties->property as $prop) {
-                    if ($this->shouldProcessElement($prop) === false) {
-                        continue;
-                    }
-
-                    if (isset($this->ruleset[$code]) === false) {
-                        $this->ruleset[$code] = [
-                            'properties' => [],
-                        ];
-                    } else if (isset($this->ruleset[$code]['properties']) === false) {
-                        $this->ruleset[$code]['properties'] = [];
-                    }
-
-                    $name = (string) $prop['name'];
-                    if (isset($prop['type']) === true
-                        && (string) $prop['type'] === 'array'
-                    ) {
-                        $values = [];
-                        if (isset($prop['extend']) === true
-                            && (string) $prop['extend'] === 'true'
-                            && isset($this->ruleset[$code]['properties'][$name]) === true
-                        ) {
-                            $values = $this->ruleset[$code]['properties'][$name];
-                        }
-
-                        if (isset($prop->element) === true) {
-                            $printValue = '';
-                            foreach ($prop->element as $element) {
-                                if ($this->shouldProcessElement($element) === false) {
-                                    continue;
-                                }
-
-                                $value = (string) $element['value'];
-                                if (isset($element['key']) === true) {
-                                    $key          = (string) $element['key'];
-                                    $values[$key] = $value;
-                                    $printValue  .= $key.'=>'.$value.',';
-                                } else {
-                                    $values[]    = $value;
-                                    $printValue .= $value.',';
-                                }
-                            }
-
-                            $printValue = rtrim($printValue, ',');
-                        } else {
-                            $value      = (string) $prop['value'];
-                            $printValue = $value;
-                            foreach (explode(',', $value) as $val) {
-                                list($k, $v) = explode('=>', $val.'=>');
-                                if ($v !== '') {
-                                    $values[trim($k)] = trim($v);
-                                } else {
-                                    $values[] = trim($k);
-                                }
-                            }
-                        }//end if
-
-                        $this->ruleset[$code]['properties'][$name] = $values;
-                        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                            echo str_repeat("\t", $depth);
-                            echo "\t\t=> array property \"$name\" set to \"$printValue\"";
-                            if ($code !== $ref) {
-                                echo " for $code";
-                            }
-
-                            echo PHP_EOL;
-                        }
-                    } else {
-                        $this->ruleset[$code]['properties'][$name] = (string) $prop['value'];
-                        if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                            echo str_repeat("\t", $depth);
-                            echo "\t\t=> property \"$name\" set to \"".(string) $prop['value'].'"';
-                            if ($code !== $ref) {
-                                echo " for $code";
-                            }
-
-                            echo PHP_EOL;
-                        }
-                    }//end if
-                }//end foreach
-            }//end if
-
-            // Ignore patterns.
-            foreach ($rule->{'exclude-pattern'} as $pattern) {
-                if ($this->shouldProcessElement($pattern) === false) {
-                    continue;
-                }
-
-                if (isset($this->ignorePatterns[$code]) === false) {
-                    $this->ignorePatterns[$code] = [];
-                }
-
-                if (isset($pattern['type']) === false) {
-                    $pattern['type'] = 'absolute';
-                }
-
-                $this->ignorePatterns[$code][(string) $pattern] = (string) $pattern['type'];
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", $depth);
-                    echo "\t\t=> added rule-specific ".(string) $pattern['type'].' ignore pattern';
-                    if ($code !== $ref) {
-                        echo " for $code";
-                    }
-
-                    echo ': '.(string) $pattern.PHP_EOL;
-                }
-            }//end foreach
-
-            // Include patterns.
-            foreach ($rule->{'include-pattern'} as $pattern) {
-                if ($this->shouldProcessElement($pattern) === false) {
-                    continue;
-                }
-
-                if (isset($this->includePatterns[$code]) === false) {
-                    $this->includePatterns[$code] = [];
-                }
-
-                if (isset($pattern['type']) === false) {
-                    $pattern['type'] = 'absolute';
-                }
-
-                $this->includePatterns[$code][(string) $pattern] = (string) $pattern['type'];
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", $depth);
-                    echo "\t\t=> added rule-specific ".(string) $pattern['type'].' include pattern';
-                    if ($code !== $ref) {
-                        echo " for $code";
-                    }
-
-                    echo ': '.(string) $pattern.PHP_EOL;
-                }
-            }//end foreach
-        }//end foreach
-
-    }//end processRule()
-
-
-    /**
-     * Determine if an element should be processed or ignored.
-     *
-     * @param \SimpleXMLElement $element An object from a ruleset XML file.
-     *
-     * @return bool
-     */
-    private function shouldProcessElement($element)
-    {
-        if (isset($element['phpcbf-only']) === false
-            && isset($element['phpcs-only']) === false
-        ) {
-            // No exceptions are being made.
-            return true;
-        }
-
-        if (PHP_CODESNIFFER_CBF === true
-            && isset($element['phpcbf-only']) === true
-            && (string) $element['phpcbf-only'] === 'true'
-        ) {
-            return true;
-        }
-
-        if (PHP_CODESNIFFER_CBF === false
-            && isset($element['phpcs-only']) === true
-            && (string) $element['phpcs-only'] === 'true'
-        ) {
-            return true;
-        }
-
-        return false;
-
-    }//end shouldProcessElement()
-
-
-    /**
-     * Loads and stores sniffs objects used for sniffing files.
-     *
-     * @param array $files        Paths to the sniff files to register.
-     * @param array $restrictions The sniff class names to restrict the allowed
-     *                            listeners to.
-     * @param array $exclusions   The sniff class names to exclude from the
-     *                            listeners list.
-     *
-     * @return void
-     */
-    public function registerSniffs($files, $restrictions, $exclusions)
-    {
-        $listeners = [];
-
-        foreach ($files as $file) {
-            // Work out where the position of /StandardName/Sniffs/... is
-            // so we can determine what the class will be called.
-            $sniffPos = strrpos($file, DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR);
-            if ($sniffPos === false) {
-                continue;
-            }
-
-            $slashPos = strrpos(substr($file, 0, $sniffPos), DIRECTORY_SEPARATOR);
-            if ($slashPos === false) {
-                continue;
-            }
-
-            $className   = Autoload::loadFile($file);
-            $compareName = Util\Common::cleanSniffClass($className);
-
-            // If they have specified a list of sniffs to restrict to, check
-            // to see if this sniff is allowed.
-            if (empty($restrictions) === false
-                && isset($restrictions[$compareName]) === false
-            ) {
-                continue;
-            }
-
-            // If they have specified a list of sniffs to exclude, check
-            // to see if this sniff is allowed.
-            if (empty($exclusions) === false
-                && isset($exclusions[$compareName]) === true
-            ) {
-                continue;
-            }
-
-            // Skip abstract classes.
-            $reflection = new \ReflectionClass($className);
-            if ($reflection->isAbstract() === true) {
-                continue;
-            }
-
-            $listeners[$className] = $className;
-
-            if (PHP_CODESNIFFER_VERBOSITY > 2) {
-                echo "Registered $className".PHP_EOL;
-            }
-        }//end foreach
-
-        $this->sniffs = $listeners;
-
-    }//end registerSniffs()
-
-
-    /**
-     * Populates the array of PHP_CodeSniffer_Sniff's for this file.
-     *
-     * @return void
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If sniff registration fails.
-     */
-    public function populateTokenListeners()
-    {
-        // Construct a list of listeners indexed by token being listened for.
-        $this->tokenListeners = [];
-
-        foreach ($this->sniffs as $sniffClass => $sniffObject) {
-            $this->sniffs[$sniffClass] = null;
-            $this->sniffs[$sniffClass] = new $sniffClass();
-
-            $sniffCode = Util\Common::getSniffCode($sniffClass);
-            $this->sniffCodes[$sniffCode] = $sniffClass;
-
-            // Set custom properties.
-            if (isset($this->ruleset[$sniffCode]['properties']) === true) {
-                foreach ($this->ruleset[$sniffCode]['properties'] as $name => $value) {
-                    $this->setSniffProperty($sniffClass, $name, $value);
-                }
-            }
-
-            $tokenizers = [];
-            $vars       = get_class_vars($sniffClass);
-            if (isset($vars['supportedTokenizers']) === true) {
-                foreach ($vars['supportedTokenizers'] as $tokenizer) {
-                    $tokenizers[$tokenizer] = $tokenizer;
-                }
-            } else {
-                $tokenizers = ['PHP' => 'PHP'];
-            }
-
-            $tokens = $this->sniffs[$sniffClass]->register();
-            if (is_array($tokens) === false) {
-                $msg = "Sniff $sniffClass register() method must return an array";
-                throw new RuntimeException($msg);
-            }
-
-            $ignorePatterns = [];
-            $patterns       = $this->getIgnorePatterns($sniffCode);
-            foreach ($patterns as $pattern => $type) {
-                $replacements = [
-                    '\\,' => ',',
-                    '*'   => '.*',
-                ];
-
-                $ignorePatterns[] = strtr($pattern, $replacements);
-            }
-
-            $includePatterns = [];
-            $patterns        = $this->getIncludePatterns($sniffCode);
-            foreach ($patterns as $pattern => $type) {
-                $replacements = [
-                    '\\,' => ',',
-                    '*'   => '.*',
-                ];
-
-                $includePatterns[] = strtr($pattern, $replacements);
-            }
-
-            foreach ($tokens as $token) {
-                if (isset($this->tokenListeners[$token]) === false) {
-                    $this->tokenListeners[$token] = [];
-                }
-
-                if (isset($this->tokenListeners[$token][$sniffClass]) === false) {
-                    $this->tokenListeners[$token][$sniffClass] = [
-                        'class'      => $sniffClass,
-                        'source'     => $sniffCode,
-                        'tokenizers' => $tokenizers,
-                        'ignore'     => $ignorePatterns,
-                        'include'    => $includePatterns,
-                    ];
-                }
-            }
-        }//end foreach
-
-    }//end populateTokenListeners()
-
-
-    /**
-     * Set a single property for a sniff.
-     *
-     * @param string $sniffClass The class name of the sniff.
-     * @param string $name       The name of the property to change.
-     * @param string $value      The new value of the property.
-     *
-     * @return void
-     */
-    public function setSniffProperty($sniffClass, $name, $value)
-    {
-        // Setting a property for a sniff we are not using.
-        if (isset($this->sniffs[$sniffClass]) === false) {
-            return;
-        }
-
-        $name = trim($name);
-        if (is_string($value) === true) {
-            $value = trim($value);
-        }
-
-        if ($value === '') {
-            $value = null;
-        }
-
-        // Special case for booleans.
-        if ($value === 'true') {
-            $value = true;
-        } else if ($value === 'false') {
-            $value = false;
-        } else if (substr($name, -2) === '[]') {
-            $name   = substr($name, 0, -2);
-            $values = [];
-            if ($value !== null) {
-                foreach (explode(',', $value) as $val) {
-                    list($k, $v) = explode('=>', $val.'=>');
-                    if ($v !== '') {
-                        $values[trim($k)] = trim($v);
-                    } else {
-                        $values[] = trim($k);
-                    }
-                }
-            }
-
-            $value = $values;
-        }
-
-        $this->sniffs[$sniffClass]->$name = $value;
-
-    }//end setSniffProperty()
-
-
-    /**
-     * Gets the array of ignore patterns.
-     *
-     * Optionally takes a listener to get ignore patterns specified
-     * for that sniff only.
-     *
-     * @param string $listener The listener to get patterns for. If NULL, all
-     *                         patterns are returned.
-     *
-     * @return array
-     */
-    public function getIgnorePatterns($listener=null)
-    {
-        if ($listener === null) {
-            return $this->ignorePatterns;
-        }
-
-        if (isset($this->ignorePatterns[$listener]) === true) {
-            return $this->ignorePatterns[$listener];
-        }
-
-        return [];
-
-    }//end getIgnorePatterns()
-
-
-    /**
-     * Gets the array of include patterns.
-     *
-     * Optionally takes a listener to get include patterns specified
-     * for that sniff only.
-     *
-     * @param string $listener The listener to get patterns for. If NULL, all
-     *                         patterns are returned.
-     *
-     * @return array
-     */
-    public function getIncludePatterns($listener=null)
-    {
-        if ($listener === null) {
-            return $this->includePatterns;
-        }
-
-        if (isset($this->includePatterns[$listener]) === true) {
-            return $this->includePatterns[$listener];
-        }
-
-        return [];
-
-    }//end getIncludePatterns()
+	/**
+	 * The name of the coding standard being used.
+	 *
+	 * If a top-level standard includes other standards, or sniffs
+	 * from other standards, only the name of the top-level standard
+	 * will be stored in here.
+	 *
+	 * If multiple top-level standards are being loaded into
+	 * a single ruleset object, this will store a comma separated list
+	 * of the top-level standard names.
+	 *
+	 * @var string
+	 */
+	public $name = '';
+
+	/**
+	 * A list of file paths for the ruleset files being used.
+	 *
+	 * @var string[]
+	 */
+	public $paths = [];
+
+	/**
+	 * A list of regular expressions used to ignore specific sniffs for files and folders.
+	 *
+	 * Is also used to set global exclude patterns.
+	 * The key is the regular expression and the value is the type
+	 * of ignore pattern (absolute or relative).
+	 *
+	 * @var array<string, string>
+	 */
+	public $ignorePatterns = [];
+
+	/**
+	 * A list of regular expressions used to include specific sniffs for files and folders.
+	 *
+	 * The key is the sniff code and the value is an array with
+	 * the key being a regular expression and the value is the type
+	 * of ignore pattern (absolute or relative).
+	 *
+	 * @var array<string, array<string, string>>
+	 */
+	public $includePatterns = [];
+
+	/**
+	 * An array of sniff objects that are being used to check files.
+	 *
+	 * The key is the fully qualified name of the sniff class
+	 * and the value is the sniff object.
+	 *
+	 * @var array<string, \PHP_CodeSniffer\Sniffs\Sniff>
+	 */
+	public $sniffs = [];
+
+	/**
+	 * A mapping of sniff codes to fully qualified class names.
+	 *
+	 * The key is the sniff code and the value
+	 * is the fully qualified name of the sniff class.
+	 *
+	 * @var array<string, string>
+	 */
+	public $sniffCodes = [];
+
+	/**
+	 * An array of token types and the sniffs that are listening for them.
+	 *
+	 * The key is the token name being listened for and the value
+	 * is the sniff object.
+	 *
+	 * @var array<int, \PHP_CodeSniffer\Sniffs\Sniff>
+	 */
+	public $tokenListeners = [];
+
+	/**
+	 * An array of rules from the ruleset.xml file.
+	 *
+	 * It may be empty, indicating that the ruleset does not override
+	 * any of the default sniff settings.
+	 *
+	 * @var array<string, mixed>
+	 */
+	public $ruleset = [];
+
+	/**
+	 * The directories that the processed rulesets are in.
+	 *
+	 * @var string[]
+	 */
+	protected $rulesetDirs = [];
+
+	/**
+	 * The config data for the run.
+	 *
+	 * @var \PHP_CodeSniffer\Config
+	 */
+	private $config = null;
+
+
+	/**
+	 * Initialise the ruleset that the run will use.
+	 *
+	 * @param \PHP_CodeSniffer\Config $config The config data for the run.
+	 *
+	 * @return void
+	 */
+	public function __construct(Config $config)
+	{
+		// Ignore sniff restrictions if caching is on.
+		$restrictions = [];
+		$exclusions   = [];
+		if ($config->cache === false) {
+			$restrictions = $config->sniffs;
+			$exclusions   = $config->exclude;
+		}
+
+		$this->config = $config;
+		$sniffs       = [];
+
+		$standardPaths = [];
+		foreach ($config->standards as $standard) {
+			$installed = Util\Standards::getInstalledStandardPath($standard);
+			if ($installed === null) {
+				$standard = Util\Common::realpath($standard);
+				if (is_dir($standard) === true
+					&& is_file(Util\Common::realpath($standard.DIRECTORY_SEPARATOR.'ruleset.xml')) === true
+				) {
+					$standard = Util\Common::realpath($standard.DIRECTORY_SEPARATOR.'ruleset.xml');
+				}
+			} else {
+				$standard = $installed;
+			}
+
+			$standardPaths[] = $standard;
+		}
+
+		foreach ($standardPaths as $standard) {
+			$ruleset = @simplexml_load_string(file_get_contents($standard));
+			if ($ruleset !== false) {
+				$standardName = (string) $ruleset['name'];
+				if ($this->name !== '') {
+					$this->name .= ', ';
+				}
+
+				$this->name .= $standardName;
+
+				// Allow autoloading of custom files inside this standard.
+				if (isset($ruleset['namespace']) === true) {
+					$namespace = (string) $ruleset['namespace'];
+				} else {
+					$namespace = basename(dirname($standard));
+				}
+
+				Autoload::addSearchPath(dirname($standard), $namespace);
+			}
+
+			if (defined('PHP_CODESNIFFER_IN_TESTS') === true && empty($restrictions) === false) {
+				// In unit tests, only register the sniffs that the test wants and not the entire standard.
+				try {
+					foreach ($restrictions as $restriction) {
+						$sniffs = array_merge($sniffs, $this->expandRulesetReference($restriction, dirname($standard)));
+					}
+				} catch (RuntimeException $e) {
+					// Sniff reference could not be expanded, which probably means this
+					// is an installed standard. Let the unit test system take care of
+					// setting the correct sniff for testing.
+					return;
+				}
+
+				break;
+			}
+
+			if (PHP_CODESNIFFER_VERBOSITY === 1) {
+				echo "Registering sniffs in the $standardName standard... ";
+				if (count($config->standards) > 1 || PHP_CODESNIFFER_VERBOSITY > 2) {
+					echo PHP_EOL;
+				}
+			}
+
+			$sniffs = array_merge($sniffs, $this->processRuleset($standard));
+		}//end foreach
+
+		$sniffRestrictions = [];
+		foreach ($restrictions as $sniffCode) {
+			$parts     = explode('.', strtolower($sniffCode));
+			$sniffName = $parts[0].'\sniffs\\'.$parts[1].'\\'.$parts[2].'sniff';
+			$sniffRestrictions[$sniffName] = true;
+		}
+
+		$sniffExclusions = [];
+		foreach ($exclusions as $sniffCode) {
+			$parts     = explode('.', strtolower($sniffCode));
+			$sniffName = $parts[0].'\sniffs\\'.$parts[1].'\\'.$parts[2].'sniff';
+			$sniffExclusions[$sniffName] = true;
+		}
+
+		$this->registerSniffs($sniffs, $sniffRestrictions, $sniffExclusions);
+		$this->populateTokenListeners();
+
+		$numSniffs = count($this->sniffs);
+		if (PHP_CODESNIFFER_VERBOSITY === 1) {
+			echo "DONE ($numSniffs sniffs registered)".PHP_EOL;
+		}
+
+		if ($numSniffs === 0) {
+			throw new RuntimeException('No sniffs were registered');
+		}
+
+	}//end __construct()
+
+
+	/**
+	 * Prints a report showing the sniffs contained in a standard.
+	 *
+	 * @return void
+	 */
+	public function explain()
+	{
+		$sniffs = array_keys($this->sniffCodes);
+		sort($sniffs);
+
+		ob_start();
+
+		$lastStandard = null;
+		$lastCount    = '';
+		$sniffCount   = count($sniffs);
+
+		// Add a dummy entry to the end so we loop
+		// one last time and clear the output buffer.
+		$sniffs[] = '';
+
+		echo PHP_EOL."The $this->name standard contains $sniffCount sniffs".PHP_EOL;
+
+		ob_start();
+
+		foreach ($sniffs as $i => $sniff) {
+			if ($i === $sniffCount) {
+				$currentStandard = null;
+			} else {
+				$currentStandard = substr($sniff, 0, strpos($sniff, '.'));
+				if ($lastStandard === null) {
+					$lastStandard = $currentStandard;
+				}
+			}
+
+			if ($currentStandard !== $lastStandard) {
+				$sniffList = ob_get_contents();
+				ob_end_clean();
+
+				echo PHP_EOL.$lastStandard.' ('.$lastCount.' sniff';
+				if ($lastCount > 1) {
+					echo 's';
+				}
+
+				echo ')'.PHP_EOL;
+				echo str_repeat('-', (strlen($lastStandard.$lastCount) + 10));
+				echo PHP_EOL;
+				echo $sniffList;
+
+				$lastStandard = $currentStandard;
+				$lastCount    = 0;
+
+				if ($currentStandard === null) {
+					break;
+				}
+
+				ob_start();
+			}//end if
+
+			echo '  '.$sniff.PHP_EOL;
+			$lastCount++;
+		}//end foreach
+
+	}//end explain()
+
+
+	/**
+	 * Processes a single ruleset and returns a list of the sniffs it represents.
+	 *
+	 * Rules founds within the ruleset are processed immediately, but sniff classes
+	 * are not registered by this method.
+	 *
+	 * @param string $rulesetPath The path to a ruleset XML file.
+	 * @param int    $depth       How many nested processing steps we are in. This
+	 *                            is only used for debug output.
+	 *
+	 * @return string[]
+	 * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the ruleset path is invalid.
+	 */
+	public function processRuleset($rulesetPath, $depth=0)
+	{
+		$rulesetPath = Util\Common::realpath($rulesetPath);
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			echo str_repeat("\t", $depth);
+			echo 'Processing ruleset '.Util\Common::stripBasepath($rulesetPath, $this->config->basepath).PHP_EOL;
+		}
+
+		libxml_use_internal_errors(true);
+		$ruleset = simplexml_load_string(file_get_contents($rulesetPath));
+		if ($ruleset === false) {
+			$errorMsg = "Ruleset $rulesetPath is not valid".PHP_EOL;
+			$errors   = libxml_get_errors();
+			foreach ($errors as $error) {
+				$errorMsg .= '- On line '.$error->line.', column '.$error->column.': '.$error->message;
+			}
+
+			libxml_clear_errors();
+			throw new RuntimeException($errorMsg);
+		}
+
+		libxml_use_internal_errors(false);
+
+		$ownSniffs      = [];
+		$includedSniffs = [];
+		$excludedSniffs = [];
+
+		$this->paths[]       = $rulesetPath;
+		$rulesetDir          = dirname($rulesetPath);
+		$this->rulesetDirs[] = $rulesetDir;
+
+		$sniffDir = $rulesetDir.DIRECTORY_SEPARATOR.'Sniffs';
+		if (is_dir($sniffDir) === true) {
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				echo str_repeat("\t", $depth);
+				echo "\tAdding sniff files from ".Util\Common::stripBasepath($sniffDir, $this->config->basepath).' directory'.PHP_EOL;
+			}
+
+			$ownSniffs = $this->expandSniffDirectory($sniffDir, $depth);
+		}
+
+		// Included custom autoloaders.
+		foreach ($ruleset->{'autoload'} as $autoload) {
+			if ($this->shouldProcessElement($autoload) === false) {
+				continue;
+			}
+
+			$autoloadPath = (string) $autoload;
+			if (is_file($autoloadPath) === false) {
+				$autoloadPath = Util\Common::realPath(dirname($rulesetPath).DIRECTORY_SEPARATOR.$autoloadPath);
+			}
+
+			if ($autoloadPath === false) {
+				throw new RuntimeException('The specified autoload file "'.$autoload.'" does not exist');
+			}
+
+			include_once $autoloadPath;
+
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				echo str_repeat("\t", $depth);
+				echo "\t=> included autoloader $autoloadPath".PHP_EOL;
+			}
+		}//end foreach
+
+		// Process custom sniff config settings.
+		foreach ($ruleset->{'config'} as $config) {
+			if ($this->shouldProcessElement($config) === false) {
+				continue;
+			}
+
+			Config::setConfigData((string) $config['name'], (string) $config['value'], true);
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				echo str_repeat("\t", $depth);
+				echo "\t=> set config value ".(string) $config['name'].': '.(string) $config['value'].PHP_EOL;
+			}
+		}
+
+		foreach ($ruleset->rule as $rule) {
+			if (isset($rule['ref']) === false
+				|| $this->shouldProcessElement($rule) === false
+			) {
+				continue;
+			}
+
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				echo str_repeat("\t", $depth);
+				echo "\tProcessing rule \"".$rule['ref'].'"'.PHP_EOL;
+			}
+
+			$expandedSniffs = $this->expandRulesetReference((string) $rule['ref'], $rulesetDir, $depth);
+			$newSniffs      = array_diff($expandedSniffs, $includedSniffs);
+			$includedSniffs = array_merge($includedSniffs, $expandedSniffs);
+
+			$parts = explode('.', $rule['ref']);
+			if (count($parts) === 4
+				&& $parts[0] !== ''
+				&& $parts[1] !== ''
+				&& $parts[2] !== ''
+			) {
+				$sniffCode = $parts[0].'.'.$parts[1].'.'.$parts[2];
+				if (isset($this->ruleset[$sniffCode]['severity']) === true
+					&& $this->ruleset[$sniffCode]['severity'] === 0
+				) {
+					// This sniff code has already been turned off, but now
+					// it is being explicitly included again, so turn it back on.
+					$this->ruleset[(string) $rule['ref']]['severity'] = 5;
+					if (PHP_CODESNIFFER_VERBOSITY > 1) {
+						echo str_repeat("\t", $depth);
+						echo "\t\t* disabling sniff exclusion for specific message code *".PHP_EOL;
+						echo str_repeat("\t", $depth);
+						echo "\t\t=> severity set to 5".PHP_EOL;
+					}
+				} else if (empty($newSniffs) === false) {
+					$newSniff = $newSniffs[0];
+					if (in_array($newSniff, $ownSniffs, true) === false) {
+						// Including a sniff that hasn't been included higher up, but
+						// only including a single message from it. So turn off all messages in
+						// the sniff, except this one.
+						$this->ruleset[$sniffCode]['severity']            = 0;
+						$this->ruleset[(string) $rule['ref']]['severity'] = 5;
+						if (PHP_CODESNIFFER_VERBOSITY > 1) {
+							echo str_repeat("\t", $depth);
+							echo "\t\tExcluding sniff \"".$sniffCode.'" except for "'.$parts[3].'"'.PHP_EOL;
+						}
+					}
+				}//end if
+			}//end if
+
+			if (isset($rule->exclude) === true) {
+				foreach ($rule->exclude as $exclude) {
+					if (isset($exclude['name']) === false) {
+						if (PHP_CODESNIFFER_VERBOSITY > 1) {
+							echo str_repeat("\t", $depth);
+							echo "\t\t* ignoring empty exclude rule *".PHP_EOL;
+							echo "\t\t\t=> ".$exclude->asXML().PHP_EOL;
+						}
+
+						continue;
+					}
+
+					if ($this->shouldProcessElement($exclude) === false) {
+						continue;
+					}
+
+					if (PHP_CODESNIFFER_VERBOSITY > 1) {
+						echo str_repeat("\t", $depth);
+						echo "\t\tExcluding rule \"".$exclude['name'].'"'.PHP_EOL;
+					}
+
+					// Check if a single code is being excluded, which is a shortcut
+					// for setting the severity of the message to 0.
+					$parts = explode('.', $exclude['name']);
+					if (count($parts) === 4) {
+						$this->ruleset[(string) $exclude['name']]['severity'] = 0;
+						if (PHP_CODESNIFFER_VERBOSITY > 1) {
+							echo str_repeat("\t", $depth);
+							echo "\t\t=> severity set to 0".PHP_EOL;
+						}
+					} else {
+						$excludedSniffs = array_merge(
+							$excludedSniffs,
+							$this->expandRulesetReference((string) $exclude['name'], $rulesetDir, ($depth + 1))
+						);
+					}
+				}//end foreach
+			}//end if
+
+			$this->processRule($rule, $newSniffs, $depth);
+		}//end foreach
+
+		// Process custom command line arguments.
+		$cliArgs = [];
+		foreach ($ruleset->{'arg'} as $arg) {
+			if ($this->shouldProcessElement($arg) === false) {
+				continue;
+			}
+
+			if (isset($arg['name']) === true) {
+				$argString = '--'.(string) $arg['name'];
+				if (isset($arg['value']) === true) {
+					$argString .= '='.(string) $arg['value'];
+				}
+			} else {
+				$argString = '-'.(string) $arg['value'];
+			}
+
+			$cliArgs[] = $argString;
+
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				echo str_repeat("\t", $depth);
+				echo "\t=> set command line value $argString".PHP_EOL;
+			}
+		}//end foreach
+
+		// Set custom php ini values as CLI args.
+		foreach ($ruleset->{'ini'} as $arg) {
+			if ($this->shouldProcessElement($arg) === false) {
+				continue;
+			}
+
+			if (isset($arg['name']) === false) {
+				continue;
+			}
+
+			$name      = (string) $arg['name'];
+			$argString = $name;
+			if (isset($arg['value']) === true) {
+				$value      = (string) $arg['value'];
+				$argString .= "=$value";
+			} else {
+				$value = 'true';
+			}
+
+			$cliArgs[] = '-d';
+			$cliArgs[] = $argString;
+
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				echo str_repeat("\t", $depth);
+				echo "\t=> set PHP ini value $name to $value".PHP_EOL;
+			}
+		}//end foreach
+
+		if (empty($this->config->files) === true) {
+			// Process hard-coded file paths.
+			foreach ($ruleset->{'file'} as $file) {
+				$file      = (string) $file;
+				$cliArgs[] = $file;
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo str_repeat("\t", $depth);
+					echo "\t=> added \"$file\" to the file list".PHP_EOL;
+				}
+			}
+		}
+
+		if (empty($cliArgs) === false) {
+			// Change the directory so all relative paths are worked
+			// out based on the location of the ruleset instead of
+			// the location of the user.
+			$inPhar = Util\Common::isPharFile($rulesetDir);
+			if ($inPhar === false) {
+				$currentDir = getcwd();
+				chdir($rulesetDir);
+			}
+
+			$this->config->setCommandLineValues($cliArgs);
+
+			if ($inPhar === false) {
+				chdir($currentDir);
+			}
+		}
+
+		// Process custom ignore pattern rules.
+		foreach ($ruleset->{'exclude-pattern'} as $pattern) {
+			if ($this->shouldProcessElement($pattern) === false) {
+				continue;
+			}
+
+			if (isset($pattern['type']) === false) {
+				$pattern['type'] = 'absolute';
+			}
+
+			$this->ignorePatterns[(string) $pattern] = (string) $pattern['type'];
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				echo str_repeat("\t", $depth);
+				echo "\t=> added global ".(string) $pattern['type'].' ignore pattern: '.(string) $pattern.PHP_EOL;
+			}
+		}
+
+		$includedSniffs = array_unique(array_merge($ownSniffs, $includedSniffs));
+		$excludedSniffs = array_unique($excludedSniffs);
+
+		if (PHP_CODESNIFFER_VERBOSITY > 1) {
+			$included = count($includedSniffs);
+			$excluded = count($excludedSniffs);
+			echo str_repeat("\t", $depth);
+			echo "=> Ruleset processing complete; included $included sniffs and excluded $excluded".PHP_EOL;
+		}
+
+		// Merge our own sniff list with our externally included
+		// sniff list, but filter out any excluded sniffs.
+		$files = [];
+		foreach ($includedSniffs as $sniff) {
+			if (in_array($sniff, $excludedSniffs, true) === true) {
+				continue;
+			} else {
+				$files[] = Util\Common::realpath($sniff);
+			}
+		}
+
+		return $files;
+
+	}//end processRuleset()
+
+
+	/**
+	 * Expands a directory into a list of sniff files within.
+	 *
+	 * @param string $directory The path to a directory.
+	 * @param int    $depth     How many nested processing steps we are in. This
+	 *                          is only used for debug output.
+	 *
+	 * @return array
+	 */
+	private function expandSniffDirectory($directory, $depth=0)
+	{
+		$sniffs = [];
+
+		$rdi = new \RecursiveDirectoryIterator($directory, \RecursiveDirectoryIterator::FOLLOW_SYMLINKS);
+		$di  = new \RecursiveIteratorIterator($rdi, 0, \RecursiveIteratorIterator::CATCH_GET_CHILD);
+
+		$dirLen = strlen($directory);
+
+		foreach ($di as $file) {
+			$filename = $file->getFilename();
+
+			// Skip hidden files.
+			if (substr($filename, 0, 1) === '.') {
+				continue;
+			}
+
+			// We are only interested in PHP and sniff files.
+			$fileParts = explode('.', $filename);
+			if (array_pop($fileParts) !== 'php') {
+				continue;
+			}
+
+			$basename = basename($filename, '.php');
+			if (substr($basename, -5) !== 'Sniff') {
+				continue;
+			}
+
+			$path = $file->getPathname();
+
+			// Skip files in hidden directories within the Sniffs directory of this
+			// standard. We use the offset with strpos() to allow hidden directories
+			// before, valid example:
+			// /home/foo/.composer/vendor/squiz/custom_tool/MyStandard/Sniffs/...
+			if (strpos($path, DIRECTORY_SEPARATOR.'.', $dirLen) !== false) {
+				continue;
+			}
+
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				echo str_repeat("\t", $depth);
+				echo "\t\t=> ".Util\Common::stripBasepath($path, $this->config->basepath).PHP_EOL;
+			}
+
+			$sniffs[] = $path;
+		}//end foreach
+
+		return $sniffs;
+
+	}//end expandSniffDirectory()
+
+
+	/**
+	 * Expands a ruleset reference into a list of sniff files.
+	 *
+	 * @param string $ref        The reference from the ruleset XML file.
+	 * @param string $rulesetDir The directory of the ruleset XML file, used to
+	 *                           evaluate relative paths.
+	 * @param int    $depth      How many nested processing steps we are in. This
+	 *                           is only used for debug output.
+	 *
+	 * @return array
+	 * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the reference is invalid.
+	 */
+	private function expandRulesetReference($ref, $rulesetDir, $depth=0)
+	{
+		// Ignore internal sniffs codes as they are used to only
+		// hide and change internal messages.
+		if (substr($ref, 0, 9) === 'Internal.') {
+			if (PHP_CODESNIFFER_VERBOSITY > 1) {
+				echo str_repeat("\t", $depth);
+				echo "\t\t* ignoring internal sniff code *".PHP_EOL;
+			}
+
+			return [];
+		}
+
+		// As sniffs can't begin with a full stop, assume references in
+		// this format are relative paths and attempt to convert them
+		// to absolute paths. If this fails, let the reference run through
+		// the normal checks and have it fail as normal.
+		if (substr($ref, 0, 1) === '.') {
+			$realpath = Util\Common::realpath($rulesetDir.'/'.$ref);
+			if ($realpath !== false) {
+				$ref = $realpath;
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo str_repeat("\t", $depth);
+					echo "\t\t=> ".Util\Common::stripBasepath($ref, $this->config->basepath).PHP_EOL;
+				}
+			}
+		}
+
+		// As sniffs can't begin with a tilde, assume references in
+		// this format are relative to the user's home directory.
+		if (substr($ref, 0, 2) === '~/') {
+			$realpath = Util\Common::realpath($ref);
+			if ($realpath !== false) {
+				$ref = $realpath;
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo str_repeat("\t", $depth);
+					echo "\t\t=> ".Util\Common::stripBasepath($ref, $this->config->basepath).PHP_EOL;
+				}
+			}
+		}
+
+		if (is_file($ref) === true) {
+			if (substr($ref, -9) === 'Sniff.php') {
+				// A single external sniff.
+				$this->rulesetDirs[] = dirname(dirname(dirname($ref)));
+				return [$ref];
+			}
+		} else {
+			// See if this is a whole standard being referenced.
+			$path = Util\Standards::getInstalledStandardPath($ref);
+			if (Util\Common::isPharFile($path) === true && strpos($path, 'ruleset.xml') === false) {
+				// If the ruleset exists inside the phar file, use it.
+				if (file_exists($path.DIRECTORY_SEPARATOR.'ruleset.xml') === true) {
+					$path .= DIRECTORY_SEPARATOR.'ruleset.xml';
+				} else {
+					$path = null;
+				}
+			}
+
+			if ($path !== null) {
+				$ref = $path;
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo str_repeat("\t", $depth);
+					echo "\t\t=> ".Util\Common::stripBasepath($ref, $this->config->basepath).PHP_EOL;
+				}
+			} else if (is_dir($ref) === false) {
+				// Work out the sniff path.
+				$sepPos = strpos($ref, DIRECTORY_SEPARATOR);
+				if ($sepPos !== false) {
+					$stdName = substr($ref, 0, $sepPos);
+					$path    = substr($ref, $sepPos);
+				} else {
+					$parts   = explode('.', $ref);
+					$stdName = $parts[0];
+					if (count($parts) === 1) {
+						// A whole standard?
+						$path = '';
+					} else if (count($parts) === 2) {
+						// A directory of sniffs?
+						$path = DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR.$parts[1];
+					} else {
+						// A single sniff?
+						$path = DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR.$parts[1].DIRECTORY_SEPARATOR.$parts[2].'Sniff.php';
+					}
+				}
+
+				$newRef  = false;
+				$stdPath = Util\Standards::getInstalledStandardPath($stdName);
+				if ($stdPath !== null && $path !== '') {
+					if (Util\Common::isPharFile($stdPath) === true
+						&& strpos($stdPath, 'ruleset.xml') === false
+					) {
+						// Phar files can only return the directory,
+						// since ruleset can be omitted if building one standard.
+						$newRef = Util\Common::realpath($stdPath.$path);
+					} else {
+						$newRef = Util\Common::realpath(dirname($stdPath).$path);
+					}
+				}
+
+				if ($newRef === false) {
+					// The sniff is not locally installed, so check if it is being
+					// referenced as a remote sniff outside the install. We do this
+					// by looking through all directories where we have found ruleset
+					// files before, looking for ones for this particular standard,
+					// and seeing if it is in there.
+					foreach ($this->rulesetDirs as $dir) {
+						if (strtolower(basename($dir)) !== strtolower($stdName)) {
+							continue;
+						}
+
+						$newRef = Util\Common::realpath($dir.$path);
+
+						if ($newRef !== false) {
+							$ref = $newRef;
+						}
+					}
+				} else {
+					$ref = $newRef;
+				}
+
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo str_repeat("\t", $depth);
+					echo "\t\t=> ".Util\Common::stripBasepath($ref, $this->config->basepath).PHP_EOL;
+				}
+			}//end if
+		}//end if
+
+		if (is_dir($ref) === true) {
+			if (is_file($ref.DIRECTORY_SEPARATOR.'ruleset.xml') === true) {
+				// We are referencing an external coding standard.
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo str_repeat("\t", $depth);
+					echo "\t\t* rule is referencing a standard using directory name; processing *".PHP_EOL;
+				}
+
+				return $this->processRuleset($ref.DIRECTORY_SEPARATOR.'ruleset.xml', ($depth + 2));
+			} else {
+				// We are referencing a whole directory of sniffs.
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo str_repeat("\t", $depth);
+					echo "\t\t* rule is referencing a directory of sniffs *".PHP_EOL;
+					echo str_repeat("\t", $depth);
+					echo "\t\tAdding sniff files from directory".PHP_EOL;
+				}
+
+				return $this->expandSniffDirectory($ref, ($depth + 1));
+			}
+		} else {
+			if (is_file($ref) === false) {
+				$error = "Referenced sniff \"$ref\" does not exist";
+				throw new RuntimeException($error);
+			}
+
+			if (substr($ref, -9) === 'Sniff.php') {
+				// A single sniff.
+				return [$ref];
+			} else {
+				// Assume an external ruleset.xml file.
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo str_repeat("\t", $depth);
+					echo "\t\t* rule is referencing a standard using ruleset path; processing *".PHP_EOL;
+				}
+
+				return $this->processRuleset($ref, ($depth + 2));
+			}
+		}//end if
+
+	}//end expandRulesetReference()
+
+
+	/**
+	 * Processes a rule from a ruleset XML file, overriding built-in defaults.
+	 *
+	 * @param \SimpleXMLElement $rule      The rule object from a ruleset XML file.
+	 * @param string[]          $newSniffs An array of sniffs that got included by this rule.
+	 * @param int               $depth     How many nested processing steps we are in.
+	 *                                     This is only used for debug output.
+	 *
+	 * @return void
+	 * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If rule settings are invalid.
+	 */
+	private function processRule($rule, $newSniffs, $depth=0)
+	{
+		$ref  = (string) $rule['ref'];
+		$todo = [$ref];
+
+		$parts = explode('.', $ref);
+		if (count($parts) <= 2) {
+			// We are processing a standard or a category of sniffs.
+			foreach ($newSniffs as $sniffFile) {
+				$parts         = explode(DIRECTORY_SEPARATOR, $sniffFile);
+				$sniffName     = array_pop($parts);
+				$sniffCategory = array_pop($parts);
+				array_pop($parts);
+				$sniffStandard = array_pop($parts);
+				$todo[]        = $sniffStandard.'.'.$sniffCategory.'.'.substr($sniffName, 0, -9);
+			}
+		}
+
+		foreach ($todo as $code) {
+			// Custom severity.
+			if (isset($rule->severity) === true
+				&& $this->shouldProcessElement($rule->severity) === true
+			) {
+				if (isset($this->ruleset[$code]) === false) {
+					$this->ruleset[$code] = [];
+				}
+
+				$this->ruleset[$code]['severity'] = (int) $rule->severity;
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo str_repeat("\t", $depth);
+					echo "\t\t=> severity set to ".(int) $rule->severity;
+					if ($code !== $ref) {
+						echo " for $code";
+					}
+
+					echo PHP_EOL;
+				}
+			}
+
+			// Custom message type.
+			if (isset($rule->type) === true
+				&& $this->shouldProcessElement($rule->type) === true
+			) {
+				if (isset($this->ruleset[$code]) === false) {
+					$this->ruleset[$code] = [];
+				}
+
+				$type = strtolower((string) $rule->type);
+				if ($type !== 'error' && $type !== 'warning') {
+					throw new RuntimeException("Message type \"$type\" is invalid; must be \"error\" or \"warning\"");
+				}
+
+				$this->ruleset[$code]['type'] = $type;
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo str_repeat("\t", $depth);
+					echo "\t\t=> message type set to ".(string) $rule->type;
+					if ($code !== $ref) {
+						echo " for $code";
+					}
+
+					echo PHP_EOL;
+				}
+			}//end if
+
+			// Custom message.
+			if (isset($rule->message) === true
+				&& $this->shouldProcessElement($rule->message) === true
+			) {
+				if (isset($this->ruleset[$code]) === false) {
+					$this->ruleset[$code] = [];
+				}
+
+				$this->ruleset[$code]['message'] = (string) $rule->message;
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo str_repeat("\t", $depth);
+					echo "\t\t=> message set to ".(string) $rule->message;
+					if ($code !== $ref) {
+						echo " for $code";
+					}
+
+					echo PHP_EOL;
+				}
+			}
+
+			// Custom properties.
+			if (isset($rule->properties) === true
+				&& $this->shouldProcessElement($rule->properties) === true
+			) {
+				foreach ($rule->properties->property as $prop) {
+					if ($this->shouldProcessElement($prop) === false) {
+						continue;
+					}
+
+					if (isset($this->ruleset[$code]) === false) {
+						$this->ruleset[$code] = [
+							'properties' => [],
+						];
+					} else if (isset($this->ruleset[$code]['properties']) === false) {
+						$this->ruleset[$code]['properties'] = [];
+					}
+
+					$name = (string) $prop['name'];
+					if (isset($prop['type']) === true
+						&& (string) $prop['type'] === 'array'
+					) {
+						$values = [];
+						if (isset($prop['extend']) === true
+							&& (string) $prop['extend'] === 'true'
+							&& isset($this->ruleset[$code]['properties'][$name]) === true
+						) {
+							$values = $this->ruleset[$code]['properties'][$name];
+						}
+
+						if (isset($prop->element) === true) {
+							$printValue = '';
+							foreach ($prop->element as $element) {
+								if ($this->shouldProcessElement($element) === false) {
+									continue;
+								}
+
+								$value = (string) $element['value'];
+								if (isset($element['key']) === true) {
+									$key          = (string) $element['key'];
+									$values[$key] = $value;
+									$printValue  .= $key.'=>'.$value.',';
+								} else {
+									$values[]    = $value;
+									$printValue .= $value.',';
+								}
+							}
+
+							$printValue = rtrim($printValue, ',');
+						} else {
+							$value      = (string) $prop['value'];
+							$printValue = $value;
+							foreach (explode(',', $value) as $val) {
+								list($k, $v) = explode('=>', $val.'=>');
+								if ($v !== '') {
+									$values[trim($k)] = trim($v);
+								} else {
+									$values[] = trim($k);
+								}
+							}
+						}//end if
+
+						$this->ruleset[$code]['properties'][$name] = $values;
+						if (PHP_CODESNIFFER_VERBOSITY > 1) {
+							echo str_repeat("\t", $depth);
+							echo "\t\t=> array property \"$name\" set to \"$printValue\"";
+							if ($code !== $ref) {
+								echo " for $code";
+							}
+
+							echo PHP_EOL;
+						}
+					} else {
+						$this->ruleset[$code]['properties'][$name] = (string) $prop['value'];
+						if (PHP_CODESNIFFER_VERBOSITY > 1) {
+							echo str_repeat("\t", $depth);
+							echo "\t\t=> property \"$name\" set to \"".(string) $prop['value'].'"';
+							if ($code !== $ref) {
+								echo " for $code";
+							}
+
+							echo PHP_EOL;
+						}
+					}//end if
+				}//end foreach
+			}//end if
+
+			// Ignore patterns.
+			foreach ($rule->{'exclude-pattern'} as $pattern) {
+				if ($this->shouldProcessElement($pattern) === false) {
+					continue;
+				}
+
+				if (isset($this->ignorePatterns[$code]) === false) {
+					$this->ignorePatterns[$code] = [];
+				}
+
+				if (isset($pattern['type']) === false) {
+					$pattern['type'] = 'absolute';
+				}
+
+				$this->ignorePatterns[$code][(string) $pattern] = (string) $pattern['type'];
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo str_repeat("\t", $depth);
+					echo "\t\t=> added rule-specific ".(string) $pattern['type'].' ignore pattern';
+					if ($code !== $ref) {
+						echo " for $code";
+					}
+
+					echo ': '.(string) $pattern.PHP_EOL;
+				}
+			}//end foreach
+
+			// Include patterns.
+			foreach ($rule->{'include-pattern'} as $pattern) {
+				if ($this->shouldProcessElement($pattern) === false) {
+					continue;
+				}
+
+				if (isset($this->includePatterns[$code]) === false) {
+					$this->includePatterns[$code] = [];
+				}
+
+				if (isset($pattern['type']) === false) {
+					$pattern['type'] = 'absolute';
+				}
+
+				$this->includePatterns[$code][(string) $pattern] = (string) $pattern['type'];
+				if (PHP_CODESNIFFER_VERBOSITY > 1) {
+					echo str_repeat("\t", $depth);
+					echo "\t\t=> added rule-specific ".(string) $pattern['type'].' include pattern';
+					if ($code !== $ref) {
+						echo " for $code";
+					}
+
+					echo ': '.(string) $pattern.PHP_EOL;
+				}
+			}//end foreach
+		}//end foreach
+
+	}//end processRule()
+
+
+	/**
+	 * Determine if an element should be processed or ignored.
+	 *
+	 * @param \SimpleXMLElement $element An object from a ruleset XML file.
+	 *
+	 * @return bool
+	 */
+	private function shouldProcessElement($element)
+	{
+		if (isset($element['phpcbf-only']) === false
+			&& isset($element['phpcs-only']) === false
+		) {
+			// No exceptions are being made.
+			return true;
+		}
+
+		if (PHP_CODESNIFFER_CBF === true
+			&& isset($element['phpcbf-only']) === true
+			&& (string) $element['phpcbf-only'] === 'true'
+		) {
+			return true;
+		}
+
+		if (PHP_CODESNIFFER_CBF === false
+			&& isset($element['phpcs-only']) === true
+			&& (string) $element['phpcs-only'] === 'true'
+		) {
+			return true;
+		}
+
+		return false;
+
+	}//end shouldProcessElement()
+
+
+	/**
+	 * Loads and stores sniffs objects used for sniffing files.
+	 *
+	 * @param array $files        Paths to the sniff files to register.
+	 * @param array $restrictions The sniff class names to restrict the allowed
+	 *                            listeners to.
+	 * @param array $exclusions   The sniff class names to exclude from the
+	 *                            listeners list.
+	 *
+	 * @return void
+	 */
+	public function registerSniffs($files, $restrictions, $exclusions)
+	{
+		$listeners = [];
+
+		foreach ($files as $file) {
+			// Work out where the position of /StandardName/Sniffs/... is
+			// so we can determine what the class will be called.
+			$sniffPos = strrpos($file, DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR);
+			if ($sniffPos === false) {
+				continue;
+			}
+
+			$slashPos = strrpos(substr($file, 0, $sniffPos), DIRECTORY_SEPARATOR);
+			if ($slashPos === false) {
+				continue;
+			}
+
+			$className   = Autoload::loadFile($file);
+			$compareName = Util\Common::cleanSniffClass($className);
+
+			// If they have specified a list of sniffs to restrict to, check
+			// to see if this sniff is allowed.
+			if (empty($restrictions) === false
+				&& isset($restrictions[$compareName]) === false
+			) {
+				continue;
+			}
+
+			// If they have specified a list of sniffs to exclude, check
+			// to see if this sniff is allowed.
+			if (empty($exclusions) === false
+				&& isset($exclusions[$compareName]) === true
+			) {
+				continue;
+			}
+
+			// Skip abstract classes.
+			$reflection = new \ReflectionClass($className);
+			if ($reflection->isAbstract() === true) {
+				continue;
+			}
+
+			$listeners[$className] = $className;
+
+			if (PHP_CODESNIFFER_VERBOSITY > 2) {
+				echo "Registered $className".PHP_EOL;
+			}
+		}//end foreach
+
+		$this->sniffs = $listeners;
+
+	}//end registerSniffs()
+
+
+	/**
+	 * Populates the array of PHP_CodeSniffer_Sniff's for this file.
+	 *
+	 * @return void
+	 * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If sniff registration fails.
+	 */
+	public function populateTokenListeners()
+	{
+		// Construct a list of listeners indexed by token being listened for.
+		$this->tokenListeners = [];
+
+		foreach ($this->sniffs as $sniffClass => $sniffObject) {
+			$this->sniffs[$sniffClass] = null;
+			$this->sniffs[$sniffClass] = new $sniffClass();
+
+			$sniffCode = Util\Common::getSniffCode($sniffClass);
+			$this->sniffCodes[$sniffCode] = $sniffClass;
+
+			// Set custom properties.
+			if (isset($this->ruleset[$sniffCode]['properties']) === true) {
+				foreach ($this->ruleset[$sniffCode]['properties'] as $name => $value) {
+					$this->setSniffProperty($sniffClass, $name, $value);
+				}
+			}
+
+			$tokenizers = [];
+			$vars       = get_class_vars($sniffClass);
+			if (isset($vars['supportedTokenizers']) === true) {
+				foreach ($vars['supportedTokenizers'] as $tokenizer) {
+					$tokenizers[$tokenizer] = $tokenizer;
+				}
+			} else {
+				$tokenizers = ['PHP' => 'PHP'];
+			}
+
+			$tokens = $this->sniffs[$sniffClass]->register();
+			if (is_array($tokens) === false) {
+				$msg = "Sniff $sniffClass register() method must return an array";
+				throw new RuntimeException($msg);
+			}
+
+			$ignorePatterns = [];
+			$patterns       = $this->getIgnorePatterns($sniffCode);
+			foreach ($patterns as $pattern => $type) {
+				$replacements = [
+					'\\,' => ',',
+					'*'   => '.*',
+				];
+
+				$ignorePatterns[] = strtr($pattern, $replacements);
+			}
+
+			$includePatterns = [];
+			$patterns        = $this->getIncludePatterns($sniffCode);
+			foreach ($patterns as $pattern => $type) {
+				$replacements = [
+					'\\,' => ',',
+					'*'   => '.*',
+				];
+
+				$includePatterns[] = strtr($pattern, $replacements);
+			}
+
+			foreach ($tokens as $token) {
+				if (isset($this->tokenListeners[$token]) === false) {
+					$this->tokenListeners[$token] = [];
+				}
+
+				if (isset($this->tokenListeners[$token][$sniffClass]) === false) {
+					$this->tokenListeners[$token][$sniffClass] = [
+						'class'      => $sniffClass,
+						'source'     => $sniffCode,
+						'tokenizers' => $tokenizers,
+						'ignore'     => $ignorePatterns,
+						'include'    => $includePatterns,
+					];
+				}
+			}
+		}//end foreach
+
+	}//end populateTokenListeners()
+
+
+	/**
+	 * Set a single property for a sniff.
+	 *
+	 * @param string $sniffClass The class name of the sniff.
+	 * @param string $name       The name of the property to change.
+	 * @param string $value      The new value of the property.
+	 *
+	 * @return void
+	 */
+	public function setSniffProperty($sniffClass, $name, $value)
+	{
+		// Setting a property for a sniff we are not using.
+		if (isset($this->sniffs[$sniffClass]) === false) {
+			return;
+		}
+
+		$name = trim($name);
+		if (is_string($value) === true) {
+			$value = trim($value);
+		}
+
+		if ($value === '') {
+			$value = null;
+		}
+
+		// Special case for booleans.
+		if ($value === 'true') {
+			$value = true;
+		} else if ($value === 'false') {
+			$value = false;
+		} else if (substr($name, -2) === '[]') {
+			$name   = substr($name, 0, -2);
+			$values = [];
+			if ($value !== null) {
+				foreach (explode(',', $value) as $val) {
+					list($k, $v) = explode('=>', $val.'=>');
+					if ($v !== '') {
+						$values[trim($k)] = trim($v);
+					} else {
+						$values[] = trim($k);
+					}
+				}
+			}
+
+			$value = $values;
+		}
+
+		$this->sniffs[$sniffClass]->$name = $value;
+
+	}//end setSniffProperty()
+
+
+	/**
+	 * Gets the array of ignore patterns.
+	 *
+	 * Optionally takes a listener to get ignore patterns specified
+	 * for that sniff only.
+	 *
+	 * @param string $listener The listener to get patterns for. If NULL, all
+	 *                         patterns are returned.
+	 *
+	 * @return array
+	 */
+	public function getIgnorePatterns($listener=null)
+	{
+		if ($listener === null) {
+			return $this->ignorePatterns;
+		}
+
+		if (isset($this->ignorePatterns[$listener]) === true) {
+			return $this->ignorePatterns[$listener];
+		}
+
+		return [];
+
+	}//end getIgnorePatterns()
+
+
+	/**
+	 * Gets the array of include patterns.
+	 *
+	 * Optionally takes a listener to get include patterns specified
+	 * for that sniff only.
+	 *
+	 * @param string $listener The listener to get patterns for. If NULL, all
+	 *                         patterns are returned.
+	 *
+	 * @return array
+	 */
+	public function getIncludePatterns($listener=null)
+	{
+		if ($listener === null) {
+			return $this->includePatterns;
+		}
+
+		if (isset($this->includePatterns[$listener]) === true) {
+			return $this->includePatterns[$listener];
+		}
+
+		return [];
+
+	}//end getIncludePatterns()
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Config.php

Indentation +1691 added lines, -1691 removed lines

@@ -18,1697 +18,1697 @@
 class Config
 {
 
-    /**
-     * The current version.
-     *
-     * @var string
-     */
-    const VERSION = '3.4.2';
-
-    /**
-     * Package stability; either stable, beta or alpha.
-     *
-     * @var string
-     */
-    const STABILITY = 'stable';
-
-    /**
-     * An array of settings that PHPCS and PHPCBF accept.
-     *
-     * This array is not meant to be accessed directly. Instead, use the settings
-     * as if they are class member vars so the __get() and __set() magic methods
-     * can be used to validate the values. For example, to set the verbosity level to
-     * level 2, use $this->verbosity = 2; instead of accessing this property directly.
-     *
-     * The list of settings are:
-     *
-     * string[] files           The files and directories to check.
-     * string[] standards       The standards being used for checking.
-     * int      verbosity       How verbose the output should be.
-     *                          0: no unnecessary output
-     *                          1: basic output for files being checked
-     *                          2: ruleset and file parsing output
-     *                          3: sniff execution output
-     * bool     interactive     Enable interactive checking mode.
-     * bool     parallel        Check files in parallel.
-     * bool     cache           Enable the use of the file cache.
-     * bool     cacheFile       A file where the cache data should be written
-     * bool     colors          Display colours in output.
-     * bool     explain         Explain the coding standards.
-     * bool     local           Process local files in directories only (no recursion).
-     * bool     showSources     Show sniff source codes in report output.
-     * bool     showProgress    Show basic progress information while running.
-     * bool     quiet           Quiet mode; disables progress and verbose output.
-     * bool     annotations     Process phpcs: annotations.
-     * int      tabWidth        How many spaces each tab is worth.
-     * string   encoding        The encoding of the files being checked.
-     * string[] sniffs          The sniffs that should be used for checking.
-     *                          If empty, all sniffs in the supplied standards will be used.
-     * string[] exclude         The sniffs that should be excluded from checking.
-     *                          If empty, all sniffs in the supplied standards will be used.
-     * string[] ignored         Regular expressions used to ignore files and folders during checking.
-     * string   reportFile      A file where the report output should be written.
-     * string   generator       The documentation generator to use.
-     * string   filter          The filter to use for the run.
-     * string[] bootstrap       One of more files to include before the run begins.
-     * int      reportWidth     The maximum number of columns that reports should use for output.
-     *                          Set to "auto" for have this value changed to the width of the terminal.
-     * int      errorSeverity   The minimum severity an error must have to be displayed.
-     * int      warningSeverity The minimum severity a warning must have to be displayed.
-     * bool     recordErrors    Record the content of error messages as well as error counts.
-     * string   suffix          A suffix to add to fixed files.
-     * string   basepath        A file system location to strip from the paths of files shown in reports.
-     * bool     stdin           Read content from STDIN instead of supplied files.
-     * string   stdinContent    Content passed directly to PHPCS on STDIN.
-     * string   stdinPath       The path to use for content passed on STDIN.
-     *
-     * array<string, string>      extensions File extensions that should be checked, and what tokenizer to use.
-     *                                       E.g., array('inc' => 'PHP');
-     * array<string, string|null> reports    The reports to use for printing output after the run.
-     *                                       The format of the array is:
-     *                                           array(
-     *                                            'reportName1' => 'outputFile',
-     *                                            'reportName2' => null,
-     *                                           );
-     *                                       If the array value is NULL, the report will be written to the screen.
-     *
-     * string[] unknown Any arguments gathered on the command line that are unknown to us.
-     *                  E.g., using `phpcs -c` will give array('c');
-     *
-     * @var array<string, mixed>
-     */
-    private $settings = [
-        'files'           => null,
-        'standards'       => null,
-        'verbosity'       => null,
-        'interactive'     => null,
-        'parallel'        => null,
-        'cache'           => null,
-        'cacheFile'       => null,
-        'colors'          => null,
-        'explain'         => null,
-        'local'           => null,
-        'showSources'     => null,
-        'showProgress'    => null,
-        'quiet'           => null,
-        'annotations'     => null,
-        'tabWidth'        => null,
-        'encoding'        => null,
-        'extensions'      => null,
-        'sniffs'          => null,
-        'exclude'         => null,
-        'ignored'         => null,
-        'reportFile'      => null,
-        'generator'       => null,
-        'filter'          => null,
-        'bootstrap'       => null,
-        'reports'         => null,
-        'basepath'        => null,
-        'reportWidth'     => null,
-        'errorSeverity'   => null,
-        'warningSeverity' => null,
-        'recordErrors'    => null,
-        'suffix'          => null,
-        'stdin'           => null,
-        'stdinContent'    => null,
-        'stdinPath'       => null,
-        'unknown'         => null,
-    ];
-
-    /**
-     * Whether or not to kill the process when an unknown command line arg is found.
-     *
-     * If FALSE, arguments that are not command line options or file/directory paths
-     * will be ignored and execution will continue. These values will be stored in
-     * $this->unknown.
-     *
-     * @var boolean
-     */
-    public $dieOnUnknownArg;
-
-    /**
-     * The current command line arguments we are processing.
-     *
-     * @var string[]
-     */
-    private $cliArgs = [];
-
-    /**
-     * Command line values that the user has supplied directly.
-     *
-     * @var array<string, TRUE>
-     */
-    private static $overriddenDefaults = [];
-
-    /**
-     * Config file data that has been loaded for the run.
-     *
-     * @var array<string, string>
-     */
-    private static $configData = null;
-
-    /**
-     * The full path to the config data file that has been loaded.
-     *
-     * @var string
-     */
-    private static $configDataFile = null;
-
-    /**
-     * Automatically discovered executable utility paths.
-     *
-     * @var array<string, string>
-     */
-    private static $executablePaths = [];
-
-
-    /**
-     * Get the value of an inaccessible property.
-     *
-     * @param string $name The name of the property.
-     *
-     * @return mixed
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the setting name is invalid.
-     */
-    public function __get($name)
-    {
-        if (array_key_exists($name, $this->settings) === false) {
-            throw new RuntimeException("ERROR: unable to get value of property \"$name\"");
-        }
-
-        return $this->settings[$name];
-
-    }//end __get()
-
-
-    /**
-     * Set the value of an inaccessible property.
-     *
-     * @param string $name  The name of the property.
-     * @param mixed  $value The value of the property.
-     *
-     * @return void
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the setting name is invalid.
-     */
-    public function __set($name, $value)
-    {
-        if (array_key_exists($name, $this->settings) === false) {
-            throw new RuntimeException("Can't __set() $name; setting doesn't exist");
-        }
-
-        switch ($name) {
-        case 'reportWidth' :
-            // Support auto terminal width.
-            if ($value === 'auto' && preg_match('|\d+ (\d+)|', shell_exec('stty size 2>&1'), $matches) === 1) {
-                $value = (int) $matches[1];
-            } else {
-                $value = (int) $value;
-            }
-            break;
-        case 'standards' :
-            $cleaned = [];
-
-            // Check if the standard name is valid, or if the case is invalid.
-            $installedStandards = Util\Standards::getInstalledStandards();
-            foreach ($value as $standard) {
-                foreach ($installedStandards as $validStandard) {
-                    if (strtolower($standard) === strtolower($validStandard)) {
-                        $standard = $validStandard;
-                        break;
-                    }
-                }
-
-                $cleaned[] = $standard;
-            }
-
-            $value = $cleaned;
-            break;
-        default :
-            // No validation required.
-            break;
-        }//end switch
-
-        $this->settings[$name] = $value;
-
-    }//end __set()
-
-
-    /**
-     * Check if the value of an inaccessible property is set.
-     *
-     * @param string $name The name of the property.
-     *
-     * @return bool
-     */
-    public function __isset($name)
-    {
-        return isset($this->settings[$name]);
-
-    }//end __isset()
-
-
-    /**
-     * Unset the value of an inaccessible property.
-     *
-     * @param string $name The name of the property.
-     *
-     * @return void
-     */
-    public function __unset($name)
-    {
-        $this->settings[$name] = null;
-
-    }//end __unset()
-
-
-    /**
-     * Get the array of all config settings.
-     *
-     * @return array<string, mixed>
-     */
-    public function getSettings()
-    {
-        return $this->settings;
-
-    }//end getSettings()
-
-
-    /**
-     * Set the array of all config settings.
-     *
-     * @param array<string, mixed> $settings The array of config settings.
-     *
-     * @return void
-     */
-    public function setSettings($settings)
-    {
-        return $this->settings = $settings;
-
-    }//end setSettings()
-
-
-    /**
-     * Creates a Config object and populates it with command line values.
-     *
-     * @param array $cliArgs         An array of values gathered from CLI args.
-     * @param bool  $dieOnUnknownArg Whether or not to kill the process when an
-     *                               unknown command line arg is found.
-     *
-     * @return void
-     */
-    public function __construct(array $cliArgs=[], $dieOnUnknownArg=true)
-    {
-        if (defined('PHP_CODESNIFFER_IN_TESTS') === true) {
-            // Let everything through during testing so that we can
-            // make use of PHPUnit command line arguments as well.
-            $this->dieOnUnknownArg = false;
-        } else {
-            $this->dieOnUnknownArg = $dieOnUnknownArg;
-        }
-
-        if (empty($cliArgs) === true) {
-            $cliArgs = $_SERVER['argv'];
-            array_shift($cliArgs);
-        }
-
-        $this->restoreDefaults();
-        $this->setCommandLineValues($cliArgs);
-
-        if (isset(self::$overriddenDefaults['standards']) === false) {
-            // They did not supply a standard to use.
-            // Look for a default ruleset in the current directory or higher.
-            $currentDir = getcwd();
-
-            $defaultFiles = [
-                '.phpcs.xml',
-                'phpcs.xml',
-                '.phpcs.xml.dist',
-                'phpcs.xml.dist',
-            ];
-
-            do {
-                foreach ($defaultFiles as $defaultFilename) {
-                    $default = $currentDir.DIRECTORY_SEPARATOR.$defaultFilename;
-                    if (is_file($default) === true) {
-                        $this->standards = [$default];
-                        break(2);
-                    }
-                }
-
-                $lastDir    = $currentDir;
-                $currentDir = dirname($currentDir);
-            } while ($currentDir !== '.' && $currentDir !== $lastDir);
-        }//end if
-
-        if (defined('STDIN') === false
-            || strtoupper(substr(PHP_OS, 0, 3)) === 'WIN'
-        ) {
-            return;
-        }
-
-        $handle = fopen('php://stdin', 'r');
-
-        // Check for content on STDIN.
-        if ($this->stdin === true
-            || (Util\Common::isStdinATTY() === false
-            && feof($handle) === false)
-        ) {
-            $readStreams = [$handle];
-            $writeSteams = null;
-
-            $fileContents = '';
-            while (is_resource($handle) === true && feof($handle) === false) {
-                // Set a timeout of 200ms.
-                if (stream_select($readStreams, $writeSteams, $writeSteams, 0, 200000) === 0) {
-                    break;
-                }
-
-                $fileContents .= fgets($handle);
-            }
-
-            if (trim($fileContents) !== '') {
-                $this->stdin        = true;
-                $this->stdinContent = $fileContents;
-                self::$overriddenDefaults['stdin']        = true;
-                self::$overriddenDefaults['stdinContent'] = true;
-            }
-        }//end if
-
-        fclose($handle);
-
-    }//end __construct()
-
-
-    /**
-     * Set the command line values.
-     *
-     * @param array $args An array of command line arguments to set.
-     *
-     * @return void
-     */
-    public function setCommandLineValues($args)
-    {
-        $this->cliArgs = $args;
-        $numArgs       = count($args);
-
-        for ($i = 0; $i < $numArgs; $i++) {
-            $arg = $this->cliArgs[$i];
-            if ($arg === '') {
-                continue;
-            }
-
-            if ($arg{0} === '-') {
-                if ($arg === '-') {
-                    // Asking to read from STDIN.
-                    $this->stdin = true;
-                    self::$overriddenDefaults['stdin'] = true;
-                    continue;
-                }
-
-                if ($arg === '--') {
-                    // Empty argument, ignore it.
-                    continue;
-                }
-
-                if ($arg{1} === '-') {
-                    $this->processLongArgument(substr($arg, 2), $i);
-                } else {
-                    $switches = str_split($arg);
-                    foreach ($switches as $switch) {
-                        if ($switch === '-') {
-                            continue;
-                        }
-
-                        $this->processShortArgument($switch, $i);
-                    }
-                }
-            } else {
-                $this->processUnknownArgument($arg, $i);
-            }//end if
-        }//end for
-
-    }//end setCommandLineValues()
-
-
-    /**
-     * Restore default values for all possible command line arguments.
-     *
-     * @return array
-     */
-    public function restoreDefaults()
-    {
-        $this->files           = [];
-        $this->standards       = ['PEAR'];
-        $this->verbosity       = 0;
-        $this->interactive     = false;
-        $this->cache           = false;
-        $this->cacheFile       = null;
-        $this->colors          = false;
-        $this->explain         = false;
-        $this->local           = false;
-        $this->showSources     = false;
-        $this->showProgress    = false;
-        $this->quiet           = false;
-        $this->annotations     = true;
-        $this->parallel        = 1;
-        $this->tabWidth        = 0;
-        $this->encoding        = 'utf-8';
-        $this->extensions      = [
-            'php' => 'PHP',
-            'inc' => 'PHP',
-            'js'  => 'JS',
-            'css' => 'CSS',
-        ];
-        $this->sniffs          = [];
-        $this->exclude         = [];
-        $this->ignored         = [];
-        $this->reportFile      = null;
-        $this->generator       = null;
-        $this->filter          = null;
-        $this->bootstrap       = [];
-        $this->basepath        = null;
-        $this->reports         = ['full' => null];
-        $this->reportWidth     = 'auto';
-        $this->errorSeverity   = 5;
-        $this->warningSeverity = 5;
-        $this->recordErrors    = true;
-        $this->suffix          = '';
-        $this->stdin           = false;
-        $this->stdinContent    = null;
-        $this->stdinPath       = null;
-        $this->unknown         = [];
-
-        $standard = self::getConfigData('default_standard');
-        if ($standard !== null) {
-            $this->standards = explode(',', $standard);
-        }
-
-        $reportFormat = self::getConfigData('report_format');
-        if ($reportFormat !== null) {
-            $this->reports = [$reportFormat => null];
-        }
-
-        $tabWidth = self::getConfigData('tab_width');
-        if ($tabWidth !== null) {
-            $this->tabWidth = (int) $tabWidth;
-        }
-
-        $encoding = self::getConfigData('encoding');
-        if ($encoding !== null) {
-            $this->encoding = strtolower($encoding);
-        }
-
-        $severity = self::getConfigData('severity');
-        if ($severity !== null) {
-            $this->errorSeverity   = (int) $severity;
-            $this->warningSeverity = (int) $severity;
-        }
-
-        $severity = self::getConfigData('error_severity');
-        if ($severity !== null) {
-            $this->errorSeverity = (int) $severity;
-        }
-
-        $severity = self::getConfigData('warning_severity');
-        if ($severity !== null) {
-            $this->warningSeverity = (int) $severity;
-        }
-
-        $showWarnings = self::getConfigData('show_warnings');
-        if ($showWarnings !== null) {
-            $showWarnings = (bool) $showWarnings;
-            if ($showWarnings === false) {
-                $this->warningSeverity = 0;
-            }
-        }
-
-        $reportWidth = self::getConfigData('report_width');
-        if ($reportWidth !== null) {
-            $this->reportWidth = $reportWidth;
-        }
-
-        $showProgress = self::getConfigData('show_progress');
-        if ($showProgress !== null) {
-            $this->showProgress = (bool) $showProgress;
-        }
-
-        $quiet = self::getConfigData('quiet');
-        if ($quiet !== null) {
-            $this->quiet = (bool) $quiet;
-        }
-
-        $colors = self::getConfigData('colors');
-        if ($colors !== null) {
-            $this->colors = (bool) $colors;
-        }
-
-        if (defined('PHP_CODESNIFFER_IN_TESTS') === false) {
-            $cache = self::getConfigData('cache');
-            if ($cache !== null) {
-                $this->cache = (bool) $cache;
-            }
-
-            $parallel = self::getConfigData('parallel');
-            if ($parallel !== null) {
-                $this->parallel = max((int) $parallel, 1);
-            }
-        }
-
-    }//end restoreDefaults()
-
-
-    /**
-     * Processes a short (-e) command line argument.
-     *
-     * @param string $arg The command line argument.
-     * @param int    $pos The position of the argument on the command line.
-     *
-     * @return void
-     */
-    public function processShortArgument($arg, $pos)
-    {
-        switch ($arg) {
-        case 'h':
-        case '?':
-            ob_start();
-            $this->printUsage();
-            $output = ob_get_contents();
-            ob_end_clean();
-            throw new DeepExitException($output, 0);
-        case 'i' :
-            ob_start();
-            Util\Standards::printInstalledStandards();
-            $output = ob_get_contents();
-            ob_end_clean();
-            throw new DeepExitException($output, 0);
-        case 'v' :
-            if ($this->quiet === true) {
-                // Ignore when quiet mode is enabled.
-                break;
-            }
-
-            $this->verbosity++;
-            self::$overriddenDefaults['verbosity'] = true;
-            break;
-        case 'l' :
-            $this->local = true;
-            self::$overriddenDefaults['local'] = true;
-            break;
-        case 's' :
-            $this->showSources = true;
-            self::$overriddenDefaults['showSources'] = true;
-            break;
-        case 'a' :
-            $this->interactive = true;
-            self::$overriddenDefaults['interactive'] = true;
-            break;
-        case 'e':
-            $this->explain = true;
-            self::$overriddenDefaults['explain'] = true;
-            break;
-        case 'p' :
-            if ($this->quiet === true) {
-                // Ignore when quiet mode is enabled.
-                break;
-            }
-
-            $this->showProgress = true;
-            self::$overriddenDefaults['showProgress'] = true;
-            break;
-        case 'q' :
-            // Quiet mode disables a few other settings as well.
-            $this->quiet        = true;
-            $this->showProgress = false;
-            $this->verbosity    = 0;
-
-            self::$overriddenDefaults['quiet'] = true;
-            break;
-        case 'm' :
-            $this->recordErrors = false;
-            self::$overriddenDefaults['recordErrors'] = true;
-            break;
-        case 'd' :
-            $ini = explode('=', $this->cliArgs[($pos + 1)]);
-            $this->cliArgs[($pos + 1)] = '';
-            if (isset($ini[1]) === true) {
-                ini_set($ini[0], $ini[1]);
-            } else {
-                ini_set($ini[0], true);
-            }
-            break;
-        case 'n' :
-            if (isset(self::$overriddenDefaults['warningSeverity']) === false) {
-                $this->warningSeverity = 0;
-                self::$overriddenDefaults['warningSeverity'] = true;
-            }
-            break;
-        case 'w' :
-            if (isset(self::$overriddenDefaults['warningSeverity']) === false) {
-                $this->warningSeverity = $this->errorSeverity;
-                self::$overriddenDefaults['warningSeverity'] = true;
-            }
-            break;
-        default:
-            if ($this->dieOnUnknownArg === false) {
-                $unknown       = $this->unknown;
-                $unknown[]     = $arg;
-                $this->unknown = $unknown;
-            } else {
-                $this->processUnknownArgument('-'.$arg, $pos);
-            }
-        }//end switch
-
-    }//end processShortArgument()
-
-
-    /**
-     * Processes a long (--example) command line argument.
-     *
-     * @param string $arg The command line argument.
-     * @param int    $pos The position of the argument on the command line.
-     *
-     * @return void
-     */
-    public function processLongArgument($arg, $pos)
-    {
-        switch ($arg) {
-        case 'help':
-            ob_start();
-            $this->printUsage();
-            $output = ob_get_contents();
-            ob_end_clean();
-            throw new DeepExitException($output, 0);
-        case 'version':
-            $output  = 'PHP_CodeSniffer version '.self::VERSION.' ('.self::STABILITY.') ';
-            $output .= 'by Squiz (http://www.squiz.net)'.PHP_EOL;
-            throw new DeepExitException($output, 0);
-        case 'colors':
-            if (isset(self::$overriddenDefaults['colors']) === true) {
-                break;
-            }
-
-            $this->colors = true;
-            self::$overriddenDefaults['colors'] = true;
-            break;
-        case 'no-colors':
-            if (isset(self::$overriddenDefaults['colors']) === true) {
-                break;
-            }
-
-            $this->colors = false;
-            self::$overriddenDefaults['colors'] = true;
-            break;
-        case 'cache':
-            if (isset(self::$overriddenDefaults['cache']) === true) {
-                break;
-            }
-
-            if (defined('PHP_CODESNIFFER_IN_TESTS') === false) {
-                $this->cache = true;
-                self::$overriddenDefaults['cache'] = true;
-            }
-            break;
-        case 'no-cache':
-            if (isset(self::$overriddenDefaults['cache']) === true) {
-                break;
-            }
-
-            $this->cache = false;
-            self::$overriddenDefaults['cache'] = true;
-            break;
-        case 'ignore-annotations':
-            if (isset(self::$overriddenDefaults['annotations']) === true) {
-                break;
-            }
-
-            $this->annotations = false;
-            self::$overriddenDefaults['annotations'] = true;
-            break;
-        case 'config-set':
-            if (isset($this->cliArgs[($pos + 1)]) === false
-                || isset($this->cliArgs[($pos + 2)]) === false
-            ) {
-                $error  = 'ERROR: Setting a config option requires a name and value'.PHP_EOL.PHP_EOL;
-                $error .= $this->printShortUsage(true);
-                throw new DeepExitException($error, 3);
-            }
-
-            $key     = $this->cliArgs[($pos + 1)];
-            $value   = $this->cliArgs[($pos + 2)];
-            $current = self::getConfigData($key);
-
-            try {
-                $this->setConfigData($key, $value);
-            } catch (\Exception $e) {
-                throw new DeepExitException($e->getMessage().PHP_EOL, 3);
-            }
-
-            $output = 'Using config file: '.self::$configDataFile.PHP_EOL.PHP_EOL;
-
-            if ($current === null) {
-                $output .= "Config value \"$key\" added successfully".PHP_EOL;
-            } else {
-                $output .= "Config value \"$key\" updated successfully; old value was \"$current\"".PHP_EOL;
-            }
-            throw new DeepExitException($output, 0);
-        case 'config-delete':
-            if (isset($this->cliArgs[($pos + 1)]) === false) {
-                $error  = 'ERROR: Deleting a config option requires the name of the option'.PHP_EOL.PHP_EOL;
-                $error .= $this->printShortUsage(true);
-                throw new DeepExitException($error, 3);
-            }
-
-            $output = 'Using config file: '.self::$configDataFile.PHP_EOL.PHP_EOL;
-
-            $key     = $this->cliArgs[($pos + 1)];
-            $current = self::getConfigData($key);
-            if ($current === null) {
-                $output .= "Config value \"$key\" has not been set".PHP_EOL;
-            } else {
-                try {
-                    $this->setConfigData($key, null);
-                } catch (\Exception $e) {
-                    throw new DeepExitException($e->getMessage().PHP_EOL, 3);
-                }
-
-                $output .= "Config value \"$key\" removed successfully; old value was \"$current\"".PHP_EOL;
-            }
-            throw new DeepExitException($output, 0);
-        case 'config-show':
-            ob_start();
-            $data = self::getAllConfigData();
-            echo 'Using config file: '.self::$configDataFile.PHP_EOL.PHP_EOL;
-            $this->printConfigData($data);
-            $output = ob_get_contents();
-            ob_end_clean();
-            throw new DeepExitException($output, 0);
-        case 'runtime-set':
-            if (isset($this->cliArgs[($pos + 1)]) === false
-                || isset($this->cliArgs[($pos + 2)]) === false
-            ) {
-                $error  = 'ERROR: Setting a runtime config option requires a name and value'.PHP_EOL.PHP_EOL;
-                $error .= $this->printShortUsage(true);
-                throw new DeepExitException($error, 3);
-            }
-
-            $key   = $this->cliArgs[($pos + 1)];
-            $value = $this->cliArgs[($pos + 2)];
-            $this->cliArgs[($pos + 1)] = '';
-            $this->cliArgs[($pos + 2)] = '';
-            self::setConfigData($key, $value, true);
-            if (isset(self::$overriddenDefaults['runtime-set']) === false) {
-                self::$overriddenDefaults['runtime-set'] = [];
-            }
-
-            self::$overriddenDefaults['runtime-set'][$key] = true;
-            break;
-        default:
-            if (substr($arg, 0, 7) === 'sniffs=') {
-                if (isset(self::$overriddenDefaults['sniffs']) === true) {
-                    break;
-                }
-
-                $sniffs = explode(',', substr($arg, 7));
-                foreach ($sniffs as $sniff) {
-                    if (substr_count($sniff, '.') !== 2) {
-                        $error  = 'ERROR: The specified sniff code "'.$sniff.'" is invalid'.PHP_EOL.PHP_EOL;
-                        $error .= $this->printShortUsage(true);
-                        throw new DeepExitException($error, 3);
-                    }
-                }
-
-                $this->sniffs = $sniffs;
-                self::$overriddenDefaults['sniffs'] = true;
-            } else if (substr($arg, 0, 8) === 'exclude=') {
-                if (isset(self::$overriddenDefaults['exclude']) === true) {
-                    break;
-                }
-
-                $sniffs = explode(',', substr($arg, 8));
-                foreach ($sniffs as $sniff) {
-                    if (substr_count($sniff, '.') !== 2) {
-                        $error  = 'ERROR: The specified sniff code "'.$sniff.'" is invalid'.PHP_EOL.PHP_EOL;
-                        $error .= $this->printShortUsage(true);
-                        throw new DeepExitException($error, 3);
-                    }
-                }
-
-                $this->exclude = $sniffs;
-                self::$overriddenDefaults['exclude'] = true;
-            } else if (defined('PHP_CODESNIFFER_IN_TESTS') === false
-                && substr($arg, 0, 6) === 'cache='
-            ) {
-                if ((isset(self::$overriddenDefaults['cache']) === true
-                    && $this->cache === false)
-                    || isset(self::$overriddenDefaults['cacheFile']) === true
-                ) {
-                    break;
-                }
-
-                // Turn caching on.
-                $this->cache = true;
-                self::$overriddenDefaults['cache'] = true;
-
-                $this->cacheFile = Util\Common::realpath(substr($arg, 6));
-
-                // It may not exist and return false instead.
-                if ($this->cacheFile === false) {
-                    $this->cacheFile = substr($arg, 6);
-
-                    $dir = dirname($this->cacheFile);
-                    if (is_dir($dir) === false) {
-                        $error  = 'ERROR: The specified cache file path "'.$this->cacheFile.'" points to a non-existent directory'.PHP_EOL.PHP_EOL;
-                        $error .= $this->printShortUsage(true);
-                        throw new DeepExitException($error, 3);
-                    }
-
-                    if ($dir === '.') {
-                        // Passed cache file is a file in the current directory.
-                        $this->cacheFile = getcwd().'/'.basename($this->cacheFile);
-                    } else {
-                        if ($dir{0} === '/') {
-                            // An absolute path.
-                            $dir = Util\Common::realpath($dir);
-                        } else {
-                            $dir = Util\Common::realpath(getcwd().'/'.$dir);
-                        }
-
-                        if ($dir !== false) {
-                            // Cache file path is relative.
-                            $this->cacheFile = $dir.'/'.basename($this->cacheFile);
-                        }
-                    }
-                }//end if
-
-                self::$overriddenDefaults['cacheFile'] = true;
-
-                if (is_dir($this->cacheFile) === true) {
-                    $error  = 'ERROR: The specified cache file path "'.$this->cacheFile.'" is a directory'.PHP_EOL.PHP_EOL;
-                    $error .= $this->printShortUsage(true);
-                    throw new DeepExitException($error, 3);
-                }
-            } else if (substr($arg, 0, 10) === 'bootstrap=') {
-                $files     = explode(',', substr($arg, 10));
-                $bootstrap = [];
-                foreach ($files as $file) {
-                    $path = Util\Common::realpath($file);
-                    if ($path === false) {
-                        $error  = 'ERROR: The specified bootstrap file "'.$file.'" does not exist'.PHP_EOL.PHP_EOL;
-                        $error .= $this->printShortUsage(true);
-                        throw new DeepExitException($error, 3);
-                    }
-
-                    $bootstrap[] = $path;
-                }
-
-                $this->bootstrap = array_merge($this->bootstrap, $bootstrap);
-                self::$overriddenDefaults['bootstrap'] = true;
-            } else if (substr($arg, 0, 10) === 'file-list=') {
-                $fileList = substr($arg, 10);
-                $path     = Util\Common::realpath($fileList);
-                if ($path === false) {
-                    $error  = 'ERROR: The specified file list "'.$fileList.'" does not exist'.PHP_EOL.PHP_EOL;
-                    $error .= $this->printShortUsage(true);
-                    throw new DeepExitException($error, 3);
-                }
-
-                $files = file($path);
-                foreach ($files as $inputFile) {
-                    $inputFile = trim($inputFile);
-
-                    // Skip empty lines.
-                    if ($inputFile === '') {
-                        continue;
-                    }
-
-                    $this->processFilePath($inputFile);
-                }
-            } else if (substr($arg, 0, 11) === 'stdin-path=') {
-                if (isset(self::$overriddenDefaults['stdinPath']) === true) {
-                    break;
-                }
-
-                $this->stdinPath = Util\Common::realpath(substr($arg, 11));
-
-                // It may not exist and return false instead, so use whatever they gave us.
-                if ($this->stdinPath === false) {
-                    $this->stdinPath = trim(substr($arg, 11));
-                }
-
-                self::$overriddenDefaults['stdinPath'] = true;
-            } else if (PHP_CODESNIFFER_CBF === false && substr($arg, 0, 12) === 'report-file=') {
-                if (isset(self::$overriddenDefaults['reportFile']) === true) {
-                    break;
-                }
-
-                $this->reportFile = Util\Common::realpath(substr($arg, 12));
-
-                // It may not exist and return false instead.
-                if ($this->reportFile === false) {
-                    $this->reportFile = substr($arg, 12);
-
-                    $dir = dirname($this->reportFile);
-                    if (is_dir($dir) === false) {
-                        $error  = 'ERROR: The specified report file path "'.$this->reportFile.'" points to a non-existent directory'.PHP_EOL.PHP_EOL;
-                        $error .= $this->printShortUsage(true);
-                        throw new DeepExitException($error, 3);
-                    }
-
-                    if ($dir === '.') {
-                        // Passed report file is a file in the current directory.
-                        $this->reportFile = getcwd().'/'.basename($this->reportFile);
-                    } else {
-                        if ($dir{0} === '/') {
-                            // An absolute path.
-                            $dir = Util\Common::realpath($dir);
-                        } else {
-                            $dir = Util\Common::realpath(getcwd().'/'.$dir);
-                        }
-
-                        if ($dir !== false) {
-                            // Report file path is relative.
-                            $this->reportFile = $dir.'/'.basename($this->reportFile);
-                        }
-                    }
-                }//end if
-
-                self::$overriddenDefaults['reportFile'] = true;
-
-                if (is_dir($this->reportFile) === true) {
-                    $error  = 'ERROR: The specified report file path "'.$this->reportFile.'" is a directory'.PHP_EOL.PHP_EOL;
-                    $error .= $this->printShortUsage(true);
-                    throw new DeepExitException($error, 3);
-                }
-            } else if (substr($arg, 0, 13) === 'report-width=') {
-                if (isset(self::$overriddenDefaults['reportWidth']) === true) {
-                    break;
-                }
-
-                $this->reportWidth = substr($arg, 13);
-                self::$overriddenDefaults['reportWidth'] = true;
-            } else if (substr($arg, 0, 9) === 'basepath=') {
-                if (isset(self::$overriddenDefaults['basepath']) === true) {
-                    break;
-                }
-
-                self::$overriddenDefaults['basepath'] = true;
-
-                if (substr($arg, 9) === '') {
-                    $this->basepath = null;
-                    break;
-                }
-
-                $this->basepath = Util\Common::realpath(substr($arg, 9));
-
-                // It may not exist and return false instead.
-                if ($this->basepath === false) {
-                    $this->basepath = substr($arg, 9);
-                }
-
-                if (is_dir($this->basepath) === false) {
-                    $error  = 'ERROR: The specified basepath "'.$this->basepath.'" points to a non-existent directory'.PHP_EOL.PHP_EOL;
-                    $error .= $this->printShortUsage(true);
-                    throw new DeepExitException($error, 3);
-                }
-            } else if ((substr($arg, 0, 7) === 'report=' || substr($arg, 0, 7) === 'report-')) {
-                $reports = [];
-
-                if ($arg[6] === '-') {
-                    // This is a report with file output.
-                    $split = strpos($arg, '=');
-                    if ($split === false) {
-                        $report = substr($arg, 7);
-                        $output = null;
-                    } else {
-                        $report = substr($arg, 7, ($split - 7));
-                        $output = substr($arg, ($split + 1));
-                        if ($output === false) {
-                            $output = null;
-                        } else {
-                            $dir = dirname($output);
-                            if (is_dir($dir) === false) {
-                                $error  = 'ERROR: The specified '.$report.' report file path "'.$output.'" points to a non-existent directory'.PHP_EOL.PHP_EOL;
-                                $error .= $this->printShortUsage(true);
-                                throw new DeepExitException($error, 3);
-                            }
-
-                            if ($dir === '.') {
-                                // Passed report file is a filename in the current directory.
-                                $output = getcwd().'/'.basename($output);
-                            } else {
-                                if ($dir{0} === '/') {
-                                    // An absolute path.
-                                    $dir = Util\Common::realpath($dir);
-                                } else {
-                                    $dir = Util\Common::realpath(getcwd().'/'.$dir);
-                                }
-
-                                if ($dir !== false) {
-                                    // Report file path is relative.
-                                    $output = $dir.'/'.basename($output);
-                                }
-                            }
-                        }//end if
-                    }//end if
-
-                    $reports[$report] = $output;
-                } else {
-                    // This is a single report.
-                    if (isset(self::$overriddenDefaults['reports']) === true) {
-                        break;
-                    }
-
-                    $reportNames = explode(',', substr($arg, 7));
-                    foreach ($reportNames as $report) {
-                        $reports[$report] = null;
-                    }
-                }//end if
-
-                // Remove the default value so the CLI value overrides it.
-                if (isset(self::$overriddenDefaults['reports']) === false) {
-                    $this->reports = $reports;
-                } else {
-                    $this->reports = array_merge($this->reports, $reports);
-                }
-
-                self::$overriddenDefaults['reports'] = true;
-            } else if (substr($arg, 0, 7) === 'filter=') {
-                if (isset(self::$overriddenDefaults['filter']) === true) {
-                    break;
-                }
-
-                $this->filter = substr($arg, 7);
-                self::$overriddenDefaults['filter'] = true;
-            } else if (substr($arg, 0, 9) === 'standard=') {
-                $standards = trim(substr($arg, 9));
-                if ($standards !== '') {
-                    $this->standards = explode(',', $standards);
-                }
-
-                self::$overriddenDefaults['standards'] = true;
-            } else if (substr($arg, 0, 11) === 'extensions=') {
-                if (isset(self::$overriddenDefaults['extensions']) === true) {
-                    break;
-                }
-
-                $extensions    = explode(',', substr($arg, 11));
-                $newExtensions = [];
-                foreach ($extensions as $ext) {
-                    $slash = strpos($ext, '/');
-                    if ($slash !== false) {
-                        // They specified the tokenizer too.
-                        list($ext, $tokenizer) = explode('/', $ext);
-                        $newExtensions[$ext]   = strtoupper($tokenizer);
-                        continue;
-                    }
-
-                    if (isset($this->extensions[$ext]) === true) {
-                        $newExtensions[$ext] = $this->extensions[$ext];
-                    } else {
-                        $newExtensions[$ext] = 'PHP';
-                    }
-                }
-
-                $this->extensions = $newExtensions;
-                self::$overriddenDefaults['extensions'] = true;
-            } else if (substr($arg, 0, 7) === 'suffix=') {
-                if (isset(self::$overriddenDefaults['suffix']) === true) {
-                    break;
-                }
-
-                $this->suffix = substr($arg, 7);
-                self::$overriddenDefaults['suffix'] = true;
-            } else if (substr($arg, 0, 9) === 'parallel=') {
-                if (isset(self::$overriddenDefaults['parallel']) === true) {
-                    break;
-                }
-
-                $this->parallel = max((int) substr($arg, 9), 1);
-                self::$overriddenDefaults['parallel'] = true;
-            } else if (substr($arg, 0, 9) === 'severity=') {
-                $this->errorSeverity   = (int) substr($arg, 9);
-                $this->warningSeverity = $this->errorSeverity;
-                if (isset(self::$overriddenDefaults['errorSeverity']) === false) {
-                    self::$overriddenDefaults['errorSeverity'] = true;
-                }
-
-                if (isset(self::$overriddenDefaults['warningSeverity']) === false) {
-                    self::$overriddenDefaults['warningSeverity'] = true;
-                }
-            } else if (substr($arg, 0, 15) === 'error-severity=') {
-                if (isset(self::$overriddenDefaults['errorSeverity']) === true) {
-                    break;
-                }
-
-                $this->errorSeverity = (int) substr($arg, 15);
-                self::$overriddenDefaults['errorSeverity'] = true;
-            } else if (substr($arg, 0, 17) === 'warning-severity=') {
-                if (isset(self::$overriddenDefaults['warningSeverity']) === true) {
-                    break;
-                }
-
-                $this->warningSeverity = (int) substr($arg, 17);
-                self::$overriddenDefaults['warningSeverity'] = true;
-            } else if (substr($arg, 0, 7) === 'ignore=') {
-                if (isset(self::$overriddenDefaults['ignored']) === true) {
-                    break;
-                }
-
-                // Split the ignore string on commas, unless the comma is escaped
-                // using 1 or 3 slashes (\, or \\\,).
-                $patterns = preg_split(
-                    '/(?<=(?<!\\\\)\\\\\\\\),|(?<!\\\\),/',
-                    substr($arg, 7)
-                );
-
-                $ignored = [];
-                foreach ($patterns as $pattern) {
-                    $pattern = trim($pattern);
-                    if ($pattern === '') {
-                        continue;
-                    }
-
-                    $ignored[$pattern] = 'absolute';
-                }
-
-                $this->ignored = $ignored;
-                self::$overriddenDefaults['ignored'] = true;
-            } else if (substr($arg, 0, 10) === 'generator='
-                && PHP_CODESNIFFER_CBF === false
-            ) {
-                if (isset(self::$overriddenDefaults['generator']) === true) {
-                    break;
-                }
-
-                $this->generator = substr($arg, 10);
-                self::$overriddenDefaults['generator'] = true;
-            } else if (substr($arg, 0, 9) === 'encoding=') {
-                if (isset(self::$overriddenDefaults['encoding']) === true) {
-                    break;
-                }
-
-                $this->encoding = strtolower(substr($arg, 9));
-                self::$overriddenDefaults['encoding'] = true;
-            } else if (substr($arg, 0, 10) === 'tab-width=') {
-                if (isset(self::$overriddenDefaults['tabWidth']) === true) {
-                    break;
-                }
-
-                $this->tabWidth = (int) substr($arg, 10);
-                self::$overriddenDefaults['tabWidth'] = true;
-            } else {
-                if ($this->dieOnUnknownArg === false) {
-                    $eqPos = strpos($arg, '=');
-                    try {
-                        if ($eqPos === false) {
-                            $this->values[$arg] = $arg;
-                        } else {
-                            $value = substr($arg, ($eqPos + 1));
-                            $arg   = substr($arg, 0, $eqPos);
-                            $this->values[$arg] = $value;
-                        }
-                    } catch (RuntimeException $e) {
-                        // Value is not valid, so just ignore it.
-                    }
-                } else {
-                    $this->processUnknownArgument('--'.$arg, $pos);
-                }
-            }//end if
-            break;
-        }//end switch
-
-    }//end processLongArgument()
-
-
-    /**
-     * Processes an unknown command line argument.
-     *
-     * Assumes all unknown arguments are files and folders to check.
-     *
-     * @param string $arg The command line argument.
-     * @param int    $pos The position of the argument on the command line.
-     *
-     * @return void
-     */
-    public function processUnknownArgument($arg, $pos)
-    {
-        // We don't know about any additional switches; just files.
-        if ($arg{0} === '-') {
-            if ($this->dieOnUnknownArg === false) {
-                return;
-            }
-
-            $error  = "ERROR: option \"$arg\" not known".PHP_EOL.PHP_EOL;
-            $error .= $this->printShortUsage(true);
-            throw new DeepExitException($error, 3);
-        }
-
-        $this->processFilePath($arg);
-
-    }//end processUnknownArgument()
-
-
-    /**
-     * Processes a file path and add it to the file list.
-     *
-     * @param string $path The path to the file to add.
-     *
-     * @return void
-     */
-    public function processFilePath($path)
-    {
-        // If we are processing STDIN, don't record any files to check.
-        if ($this->stdin === true) {
-            return;
-        }
-
-        $file = Util\Common::realpath($path);
-        if (file_exists($file) === false) {
-            if ($this->dieOnUnknownArg === false) {
-                return;
-            }
-
-            $error  = 'ERROR: The file "'.$path.'" does not exist.'.PHP_EOL.PHP_EOL;
-            $error .= $this->printShortUsage(true);
-            throw new DeepExitException($error, 3);
-        } else {
-            // Can't modify the files array directly because it's not a real
-            // class member, so need to use this little get/modify/set trick.
-            $files       = $this->files;
-            $files[]     = $file;
-            $this->files = $files;
-            self::$overriddenDefaults['files'] = true;
-        }
-
-    }//end processFilePath()
-
-
-    /**
-     * Prints out the usage information for this script.
-     *
-     * @return void
-     */
-    public function printUsage()
-    {
-        echo PHP_EOL;
-
-        if (PHP_CODESNIFFER_CBF === true) {
-            $this->printPHPCBFUsage();
-        } else {
-            $this->printPHPCSUsage();
-        }
-
-        echo PHP_EOL;
-
-    }//end printUsage()
-
-
-    /**
-     * Prints out the short usage information for this script.
-     *
-     * @param bool $return If TRUE, the usage string is returned
-     *                     instead of output to screen.
-     *
-     * @return string|void
-     */
-    public function printShortUsage($return=false)
-    {
-        if (PHP_CODESNIFFER_CBF === true) {
-            $usage = 'Run "phpcbf --help" for usage information';
-        } else {
-            $usage = 'Run "phpcs --help" for usage information';
-        }
-
-        $usage .= PHP_EOL.PHP_EOL;
-
-        if ($return === true) {
-            return $usage;
-        }
-
-        echo $usage;
-
-    }//end printShortUsage()
-
-
-    /**
-     * Prints out the usage information for PHPCS.
-     *
-     * @return void
-     */
-    public function printPHPCSUsage()
-    {
-        echo 'Usage: phpcs [-nwlsaepqvi] [-d key[=value]] [--colors] [--no-colors]'.PHP_EOL;
-        echo '  [--cache[=<cacheFile>]] [--no-cache] [--tab-width=<tabWidth>]'.PHP_EOL;
-        echo '  [--report=<report>] [--report-file=<reportFile>] [--report-<report>=<reportFile>]'.PHP_EOL;
-        echo '  [--report-width=<reportWidth>] [--basepath=<basepath>] [--bootstrap=<bootstrap>]'.PHP_EOL;
-        echo '  [--severity=<severity>] [--error-severity=<severity>] [--warning-severity=<severity>]'.PHP_EOL;
-        echo '  [--runtime-set key value] [--config-set key value] [--config-delete key] [--config-show]'.PHP_EOL;
-        echo '  [--standard=<standard>] [--sniffs=<sniffs>] [--exclude=<sniffs>]'.PHP_EOL;
-        echo '  [--encoding=<encoding>] [--parallel=<processes>] [--generator=<generator>]'.PHP_EOL;
-        echo '  [--extensions=<extensions>] [--ignore=<patterns>] [--ignore-annotations]'.PHP_EOL;
-        echo '  [--stdin-path=<stdinPath>] [--file-list=<fileList>] [--filter=<filter>] <file> - ...'.PHP_EOL;
-        echo PHP_EOL;
-        echo ' -     Check STDIN instead of local files and directories'.PHP_EOL;
-        echo ' -n    Do not print warnings (shortcut for --warning-severity=0)'.PHP_EOL;
-        echo ' -w    Print both warnings and errors (this is the default)'.PHP_EOL;
-        echo ' -l    Local directory only, no recursion'.PHP_EOL;
-        echo ' -s    Show sniff codes in all reports'.PHP_EOL;
-        echo ' -a    Run interactively'.PHP_EOL;
-        echo ' -e    Explain a standard by showing the sniffs it includes'.PHP_EOL;
-        echo ' -p    Show progress of the run'.PHP_EOL;
-        echo ' -q    Quiet mode; disables progress and verbose output'.PHP_EOL;
-        echo ' -m    Stop error messages from being recorded'.PHP_EOL;
-        echo '       (saves a lot of memory, but stops many reports from being used)'.PHP_EOL;
-        echo ' -v    Print processed files'.PHP_EOL;
-        echo ' -vv   Print ruleset and token output'.PHP_EOL;
-        echo ' -vvv  Print sniff processing information'.PHP_EOL;
-        echo ' -i    Show a list of installed coding standards'.PHP_EOL;
-        echo ' -d    Set the [key] php.ini value to [value] or [true] if value is omitted'.PHP_EOL;
-        echo PHP_EOL;
-        echo ' --help                Print this help message'.PHP_EOL;
-        echo ' --version             Print version information'.PHP_EOL;
-        echo ' --colors              Use colors in output'.PHP_EOL;
-        echo ' --no-colors           Do not use colors in output (this is the default)'.PHP_EOL;
-        echo ' --cache               Cache results between runs'.PHP_EOL;
-        echo ' --no-cache            Do not cache results between runs (this is the default)'.PHP_EOL;
-        echo ' --ignore-annotations  Ignore all phpcs: annotations in code comments'.PHP_EOL;
-        echo PHP_EOL;
-        echo ' <cacheFile>    Use a specific file for caching (uses a temporary file by default)'.PHP_EOL;
-        echo ' <basepath>     A path to strip from the front of file paths inside reports'.PHP_EOL;
-        echo ' <bootstrap>    A comma separated list of files to run before processing begins'.PHP_EOL;
-        echo ' <encoding>     The encoding of the files being checked (default is utf-8)'.PHP_EOL;
-        echo ' <extensions>   A comma separated list of file extensions to check'.PHP_EOL;
-        echo '                The type of the file can be specified using: ext/type'.PHP_EOL;
-        echo '                e.g., module/php,es/js'.PHP_EOL;
-        echo ' <file>         One or more files and/or directories to check'.PHP_EOL;
-        echo ' <fileList>     A file containing a list of files and/or directories to check (one per line)'.PHP_EOL;
-        echo ' <filter>       Use the "gitmodified" filter, or specify the path to a custom filter class'.PHP_EOL;
-        echo ' <generator>    Uses either the "HTML", "Markdown" or "Text" generator'.PHP_EOL;
-        echo '                (forces documentation generation instead of checking)'.PHP_EOL;
-        echo ' <patterns>     A comma separated list of patterns to ignore files and directories'.PHP_EOL;
-        echo ' <processes>    How many files should be checked simultaneously (default is 1)'.PHP_EOL;
-        echo ' <report>       Print either the "full", "xml", "checkstyle", "csv"'.PHP_EOL;
-        echo '                "json", "junit", "emacs", "source", "summary", "diff"'.PHP_EOL;
-        echo '                "svnblame", "gitblame", "hgblame" or "notifysend" report,'.PHP_EOL;
-        echo '                or specify the path to a custom report class'.PHP_EOL;
-        echo '                (the "full" report is printed by default)'.PHP_EOL;
-        echo ' <reportFile>   Write the report to the specified file path'.PHP_EOL;
-        echo ' <reportWidth>  How many columns wide screen reports should be printed'.PHP_EOL;
-        echo '                or set to "auto" to use current screen width, where supported'.PHP_EOL;
-        echo ' <severity>     The minimum severity required to display an error or warning'.PHP_EOL;
-        echo ' <sniffs>       A comma separated list of sniff codes to include or exclude from checking'.PHP_EOL;
-        echo '                (all sniffs must be part of the specified standard)'.PHP_EOL;
-        echo ' <standard>     The name or path of the coding standard to use'.PHP_EOL;
-        echo ' <stdinPath>    If processing STDIN, the file path that STDIN will be processed as'.PHP_EOL;
-        echo ' <tabWidth>     The number of spaces each tab represents'.PHP_EOL;
-
-    }//end printPHPCSUsage()
-
-
-    /**
-     * Prints out the usage information for PHPCBF.
-     *
-     * @return void
-     */
-    public function printPHPCBFUsage()
-    {
-        echo 'Usage: phpcbf [-nwli] [-d key[=value]] [--ignore-annotations] [--bootstrap=<bootstrap>]'.PHP_EOL;
-        echo '  [--standard=<standard>] [--sniffs=<sniffs>] [--exclude=<sniffs>] [--suffix=<suffix>]'.PHP_EOL;
-        echo '  [--severity=<severity>] [--error-severity=<severity>] [--warning-severity=<severity>]'.PHP_EOL;
-        echo '  [--tab-width=<tabWidth>] [--encoding=<encoding>] [--parallel=<processes>]'.PHP_EOL;
-        echo '  [--basepath=<basepath>] [--extensions=<extensions>] [--ignore=<patterns>]'.PHP_EOL;
-        echo '  [--stdin-path=<stdinPath>] [--file-list=<fileList>] [--filter=<filter>] <file> - ...'.PHP_EOL;
-        echo PHP_EOL;
-        echo ' -     Fix STDIN instead of local files and directories'.PHP_EOL;
-        echo ' -n    Do not fix warnings (shortcut for --warning-severity=0)'.PHP_EOL;
-        echo ' -w    Fix both warnings and errors (on by default)'.PHP_EOL;
-        echo ' -l    Local directory only, no recursion'.PHP_EOL;
-        echo ' -p    Show progress of the run'.PHP_EOL;
-        echo ' -q    Quiet mode; disables progress and verbose output'.PHP_EOL;
-        echo ' -v    Print processed files'.PHP_EOL;
-        echo ' -vv   Print ruleset and token output'.PHP_EOL;
-        echo ' -vvv  Print sniff processing information'.PHP_EOL;
-        echo ' -i    Show a list of installed coding standards'.PHP_EOL;
-        echo ' -d    Set the [key] php.ini value to [value] or [true] if value is omitted'.PHP_EOL;
-        echo PHP_EOL;
-        echo ' --help                Print this help message'.PHP_EOL;
-        echo ' --version             Print version information'.PHP_EOL;
-        echo ' --ignore-annotations  Ignore all phpcs: annotations in code comments'.PHP_EOL;
-        echo PHP_EOL;
-        echo ' <basepath>    A path to strip from the front of file paths inside reports'.PHP_EOL;
-        echo ' <bootstrap>   A comma separated list of files to run before processing begins'.PHP_EOL;
-        echo ' <encoding>    The encoding of the files being fixed (default is utf-8)'.PHP_EOL;
-        echo ' <extensions>  A comma separated list of file extensions to fix'.PHP_EOL;
-        echo '               The type of the file can be specified using: ext/type'.PHP_EOL;
-        echo '               e.g., module/php,es/js'.PHP_EOL;
-        echo ' <file>        One or more files and/or directories to fix'.PHP_EOL;
-        echo ' <fileList>    A file containing a list of files and/or directories to fix (one per line)'.PHP_EOL;
-        echo ' <filter>      Use the "gitmodified" filter, or specify the path to a custom filter class'.PHP_EOL;
-        echo ' <patterns>    A comma separated list of patterns to ignore files and directories'.PHP_EOL;
-        echo ' <processes>   How many files should be fixed simultaneously (default is 1)'.PHP_EOL;
-        echo ' <severity>    The minimum severity required to fix an error or warning'.PHP_EOL;
-        echo ' <sniffs>      A comma separated list of sniff codes to include or exclude from fixing'.PHP_EOL;
-        echo '               (all sniffs must be part of the specified standard)'.PHP_EOL;
-        echo ' <standard>    The name or path of the coding standard to use'.PHP_EOL;
-        echo ' <stdinPath>   If processing STDIN, the file path that STDIN will be processed as'.PHP_EOL;
-        echo ' <suffix>      Write modified files to a filename using this suffix'.PHP_EOL;
-        echo '               ("diff" and "patch" are not used in this mode)'.PHP_EOL;
-        echo ' <tabWidth>    The number of spaces each tab represents'.PHP_EOL;
-
-    }//end printPHPCBFUsage()
-
-
-    /**
-     * Get a single config value.
-     *
-     * @param string $key The name of the config value.
-     *
-     * @return string|null
-     * @see    setConfigData()
-     * @see    getAllConfigData()
-     */
-    public static function getConfigData($key)
-    {
-        $phpCodeSnifferConfig = self::getAllConfigData();
-
-        if ($phpCodeSnifferConfig === null) {
-            return null;
-        }
-
-        if (isset($phpCodeSnifferConfig[$key]) === false) {
-            return null;
-        }
-
-        return $phpCodeSnifferConfig[$key];
-
-    }//end getConfigData()
-
-
-    /**
-     * Get the path to an executable utility.
-     *
-     * @param string $name The name of the executable utility.
-     *
-     * @return string|null
-     * @see    getConfigData()
-     */
-    public static function getExecutablePath($name)
-    {
-        $data = self::getConfigData($name.'_path');
-        if ($data !== null) {
-            return $data;
-        }
-
-        if ($name === "php") {
-            // For php, we know the executable path. There's no need to look it up.
-            return PHP_BINARY;
-        }
-
-        if (array_key_exists($name, self::$executablePaths) === true) {
-            return self::$executablePaths[$name];
-        }
-
-        if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
-            $cmd = 'where '.escapeshellarg($name).' 2> nul';
-        } else {
-            $cmd = 'which '.escapeshellarg($name).' 2> /dev/null';
-        }
-
-        $result = exec($cmd, $output, $retVal);
-        if ($retVal !== 0) {
-            $result = null;
-        }
-
-        self::$executablePaths[$name] = $result;
-        return $result;
-
-    }//end getExecutablePath()
-
-
-    /**
-     * Set a single config value.
-     *
-     * @param string      $key   The name of the config value.
-     * @param string|null $value The value to set. If null, the config
-     *                           entry is deleted, reverting it to the
-     *                           default value.
-     * @param boolean     $temp  Set this config data temporarily for this
-     *                           script run. This will not write the config
-     *                           data to the config file.
-     *
-     * @return bool
-     * @see    getConfigData()
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the config file can not be written.
-     */
-    public static function setConfigData($key, $value, $temp=false)
-    {
-        if (isset(self::$overriddenDefaults['runtime-set']) === true
-            && isset(self::$overriddenDefaults['runtime-set'][$key]) === true
-        ) {
-            return false;
-        }
-
-        if ($temp === false) {
-            $path = '';
-            if (is_callable('\Phar::running') === true) {
-                $path = \Phar::running(false);
-            }
-
-            if ($path !== '') {
-                $configFile = dirname($path).DIRECTORY_SEPARATOR.'CodeSniffer.conf';
-            } else {
-                $configFile = dirname(__DIR__).DIRECTORY_SEPARATOR.'CodeSniffer.conf';
-                if (is_file($configFile) === false
-                    && strpos('@data_dir@', '@data_dir') === false
-                ) {
-                    // If data_dir was replaced, this is a PEAR install and we can
-                    // use the PEAR data dir to store the conf file.
-                    $configFile = '@data_dir@/PHP_CodeSniffer/CodeSniffer.conf';
-                }
-            }
-
-            if (is_file($configFile) === true
-                && is_writable($configFile) === false
-            ) {
-                $error = 'ERROR: Config file '.$configFile.' is not writable'.PHP_EOL.PHP_EOL;
-                throw new DeepExitException($error, 3);
-            }
-        }//end if
-
-        $phpCodeSnifferConfig = self::getAllConfigData();
-
-        if ($value === null) {
-            if (isset($phpCodeSnifferConfig[$key]) === true) {
-                unset($phpCodeSnifferConfig[$key]);
-            }
-        } else {
-            $phpCodeSnifferConfig[$key] = $value;
-        }
-
-        if ($temp === false) {
-            $output  = '<'.'?php'."\n".' $phpCodeSnifferConfig = ';
-            $output .= var_export($phpCodeSnifferConfig, true);
-            $output .= "\n?".'>';
-
-            if (file_put_contents($configFile, $output) === false) {
-                $error = 'ERROR: Config file '.$configFile.' could not be written'.PHP_EOL.PHP_EOL;
-                throw new DeepExitException($error, 3);
-            }
-
-            self::$configDataFile = $configFile;
-        }
-
-        self::$configData = $phpCodeSnifferConfig;
-
-        // If the installed paths are being set, make sure all known
-        // standards paths are added to the autoloader.
-        if ($key === 'installed_paths') {
-            $installedStandards = Util\Standards::getInstalledStandardDetails();
-            foreach ($installedStandards as $name => $details) {
-                Autoload::addSearchPath($details['path'], $details['namespace']);
-            }
-        }
-
-        return true;
-
-    }//end setConfigData()
-
-
-    /**
-     * Get all config data.
-     *
-     * @return array<string, string>
-     * @see    getConfigData()
-     */
-    public static function getAllConfigData()
-    {
-        if (self::$configData !== null) {
-            return self::$configData;
-        }
-
-        $path = '';
-        if (is_callable('\Phar::running') === true) {
-            $path = \Phar::running(false);
-        }
-
-        if ($path !== '') {
-            $configFile = dirname($path).DIRECTORY_SEPARATOR.'CodeSniffer.conf';
-        } else {
-            $configFile = dirname(__DIR__).DIRECTORY_SEPARATOR.'CodeSniffer.conf';
-            if (is_file($configFile) === false
-                && strpos('@data_dir@', '@data_dir') === false
-            ) {
-                $configFile = '@data_dir@/PHP_CodeSniffer/CodeSniffer.conf';
-            }
-        }
-
-        if (is_file($configFile) === false) {
-            self::$configData = [];
-            return [];
-        }
-
-        if (is_readable($configFile) === false) {
-            $error = 'ERROR: Config file '.$configFile.' is not readable'.PHP_EOL.PHP_EOL;
-            throw new DeepExitException($error, 3);
-        }
-
-        include $configFile;
-        self::$configDataFile = $configFile;
-        self::$configData     = $phpCodeSnifferConfig;
-        return self::$configData;
-
-    }//end getAllConfigData()
-
-
-    /**
-     * Prints out the gathered config data.
-     *
-     * @param array $data The config data to print.
-     *
-     * @return void
-     */
-    public function printConfigData($data)
-    {
-        $max  = 0;
-        $keys = array_keys($data);
-        foreach ($keys as $key) {
-            $len = strlen($key);
-            if (strlen($key) > $max) {
-                $max = $len;
-            }
-        }
-
-        if ($max === 0) {
-            return;
-        }
-
-        $max += 2;
-        ksort($data);
-        foreach ($data as $name => $value) {
-            echo str_pad($name.': ', $max).$value.PHP_EOL;
-        }
-
-    }//end printConfigData()
+	/**
+	 * The current version.
+	 *
+	 * @var string
+	 */
+	const VERSION = '3.4.2';
+
+	/**
+	 * Package stability; either stable, beta or alpha.
+	 *
+	 * @var string
+	 */
+	const STABILITY = 'stable';
+
+	/**
+	 * An array of settings that PHPCS and PHPCBF accept.
+	 *
+	 * This array is not meant to be accessed directly. Instead, use the settings
+	 * as if they are class member vars so the __get() and __set() magic methods
+	 * can be used to validate the values. For example, to set the verbosity level to
+	 * level 2, use $this->verbosity = 2; instead of accessing this property directly.
+	 *
+	 * The list of settings are:
+	 *
+	 * string[] files           The files and directories to check.
+	 * string[] standards       The standards being used for checking.
+	 * int      verbosity       How verbose the output should be.
+	 *                          0: no unnecessary output
+	 *                          1: basic output for files being checked
+	 *                          2: ruleset and file parsing output
+	 *                          3: sniff execution output
+	 * bool     interactive     Enable interactive checking mode.
+	 * bool     parallel        Check files in parallel.
+	 * bool     cache           Enable the use of the file cache.
+	 * bool     cacheFile       A file where the cache data should be written
+	 * bool     colors          Display colours in output.
+	 * bool     explain         Explain the coding standards.
+	 * bool     local           Process local files in directories only (no recursion).
+	 * bool     showSources     Show sniff source codes in report output.
+	 * bool     showProgress    Show basic progress information while running.
+	 * bool     quiet           Quiet mode; disables progress and verbose output.
+	 * bool     annotations     Process phpcs: annotations.
+	 * int      tabWidth        How many spaces each tab is worth.
+	 * string   encoding        The encoding of the files being checked.
+	 * string[] sniffs          The sniffs that should be used for checking.
+	 *                          If empty, all sniffs in the supplied standards will be used.
+	 * string[] exclude         The sniffs that should be excluded from checking.
+	 *                          If empty, all sniffs in the supplied standards will be used.
+	 * string[] ignored         Regular expressions used to ignore files and folders during checking.
+	 * string   reportFile      A file where the report output should be written.
+	 * string   generator       The documentation generator to use.
+	 * string   filter          The filter to use for the run.
+	 * string[] bootstrap       One of more files to include before the run begins.
+	 * int      reportWidth     The maximum number of columns that reports should use for output.
+	 *                          Set to "auto" for have this value changed to the width of the terminal.
+	 * int      errorSeverity   The minimum severity an error must have to be displayed.
+	 * int      warningSeverity The minimum severity a warning must have to be displayed.
+	 * bool     recordErrors    Record the content of error messages as well as error counts.
+	 * string   suffix          A suffix to add to fixed files.
+	 * string   basepath        A file system location to strip from the paths of files shown in reports.
+	 * bool     stdin           Read content from STDIN instead of supplied files.
+	 * string   stdinContent    Content passed directly to PHPCS on STDIN.
+	 * string   stdinPath       The path to use for content passed on STDIN.
+	 *
+	 * array<string, string>      extensions File extensions that should be checked, and what tokenizer to use.
+	 *                                       E.g., array('inc' => 'PHP');
+	 * array<string, string|null> reports    The reports to use for printing output after the run.
+	 *                                       The format of the array is:
+	 *                                           array(
+	 *                                            'reportName1' => 'outputFile',
+	 *                                            'reportName2' => null,
+	 *                                           );
+	 *                                       If the array value is NULL, the report will be written to the screen.
+	 *
+	 * string[] unknown Any arguments gathered on the command line that are unknown to us.
+	 *                  E.g., using `phpcs -c` will give array('c');
+	 *
+	 * @var array<string, mixed>
+	 */
+	private $settings = [
+		'files'           => null,
+		'standards'       => null,
+		'verbosity'       => null,
+		'interactive'     => null,
+		'parallel'        => null,
+		'cache'           => null,
+		'cacheFile'       => null,
+		'colors'          => null,
+		'explain'         => null,
+		'local'           => null,
+		'showSources'     => null,
+		'showProgress'    => null,
+		'quiet'           => null,
+		'annotations'     => null,
+		'tabWidth'        => null,
+		'encoding'        => null,
+		'extensions'      => null,
+		'sniffs'          => null,
+		'exclude'         => null,
+		'ignored'         => null,
+		'reportFile'      => null,
+		'generator'       => null,
+		'filter'          => null,
+		'bootstrap'       => null,
+		'reports'         => null,
+		'basepath'        => null,
+		'reportWidth'     => null,
+		'errorSeverity'   => null,
+		'warningSeverity' => null,
+		'recordErrors'    => null,
+		'suffix'          => null,
+		'stdin'           => null,
+		'stdinContent'    => null,
+		'stdinPath'       => null,
+		'unknown'         => null,
+	];
+
+	/**
+	 * Whether or not to kill the process when an unknown command line arg is found.
+	 *
+	 * If FALSE, arguments that are not command line options or file/directory paths
+	 * will be ignored and execution will continue. These values will be stored in
+	 * $this->unknown.
+	 *
+	 * @var boolean
+	 */
+	public $dieOnUnknownArg;
+
+	/**
+	 * The current command line arguments we are processing.
+	 *
+	 * @var string[]
+	 */
+	private $cliArgs = [];
+
+	/**
+	 * Command line values that the user has supplied directly.
+	 *
+	 * @var array<string, TRUE>
+	 */
+	private static $overriddenDefaults = [];
+
+	/**
+	 * Config file data that has been loaded for the run.
+	 *
+	 * @var array<string, string>
+	 */
+	private static $configData = null;
+
+	/**
+	 * The full path to the config data file that has been loaded.
+	 *
+	 * @var string
+	 */
+	private static $configDataFile = null;
+
+	/**
+	 * Automatically discovered executable utility paths.
+	 *
+	 * @var array<string, string>
+	 */
+	private static $executablePaths = [];
+
+
+	/**
+	 * Get the value of an inaccessible property.
+	 *
+	 * @param string $name The name of the property.
+	 *
+	 * @return mixed
+	 * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the setting name is invalid.
+	 */
+	public function __get($name)
+	{
+		if (array_key_exists($name, $this->settings) === false) {
+			throw new RuntimeException("ERROR: unable to get value of property \"$name\"");
+		}
+
+		return $this->settings[$name];
+
+	}//end __get()
+
+
+	/**
+	 * Set the value of an inaccessible property.
+	 *
+	 * @param string $name  The name of the property.
+	 * @param mixed  $value The value of the property.
+	 *
+	 * @return void
+	 * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the setting name is invalid.
+	 */
+	public function __set($name, $value)
+	{
+		if (array_key_exists($name, $this->settings) === false) {
+			throw new RuntimeException("Can't __set() $name; setting doesn't exist");
+		}
+
+		switch ($name) {
+		case 'reportWidth' :
+			// Support auto terminal width.
+			if ($value === 'auto' && preg_match('|\d+ (\d+)|', shell_exec('stty size 2>&1'), $matches) === 1) {
+				$value = (int) $matches[1];
+			} else {
+				$value = (int) $value;
+			}
+			break;
+		case 'standards' :
+			$cleaned = [];
+
+			// Check if the standard name is valid, or if the case is invalid.
+			$installedStandards = Util\Standards::getInstalledStandards();
+			foreach ($value as $standard) {
+				foreach ($installedStandards as $validStandard) {
+					if (strtolower($standard) === strtolower($validStandard)) {
+						$standard = $validStandard;
+						break;
+					}
+				}
+
+				$cleaned[] = $standard;
+			}
+
+			$value = $cleaned;
+			break;
+		default :
+			// No validation required.
+			break;
+		}//end switch
+
+		$this->settings[$name] = $value;
+
+	}//end __set()
+
+
+	/**
+	 * Check if the value of an inaccessible property is set.
+	 *
+	 * @param string $name The name of the property.
+	 *
+	 * @return bool
+	 */
+	public function __isset($name)
+	{
+		return isset($this->settings[$name]);
+
+	}//end __isset()
+
+
+	/**
+	 * Unset the value of an inaccessible property.
+	 *
+	 * @param string $name The name of the property.
+	 *
+	 * @return void
+	 */
+	public function __unset($name)
+	{
+		$this->settings[$name] = null;
+
+	}//end __unset()
+
+
+	/**
+	 * Get the array of all config settings.
+	 *
+	 * @return array<string, mixed>
+	 */
+	public function getSettings()
+	{
+		return $this->settings;
+
+	}//end getSettings()
+
+
+	/**
+	 * Set the array of all config settings.
+	 *
+	 * @param array<string, mixed> $settings The array of config settings.
+	 *
+	 * @return void
+	 */
+	public function setSettings($settings)
+	{
+		return $this->settings = $settings;
+
+	}//end setSettings()
+
+
+	/**
+	 * Creates a Config object and populates it with command line values.
+	 *
+	 * @param array $cliArgs         An array of values gathered from CLI args.
+	 * @param bool  $dieOnUnknownArg Whether or not to kill the process when an
+	 *                               unknown command line arg is found.
+	 *
+	 * @return void
+	 */
+	public function __construct(array $cliArgs=[], $dieOnUnknownArg=true)
+	{
+		if (defined('PHP_CODESNIFFER_IN_TESTS') === true) {
+			// Let everything through during testing so that we can
+			// make use of PHPUnit command line arguments as well.
+			$this->dieOnUnknownArg = false;
+		} else {
+			$this->dieOnUnknownArg = $dieOnUnknownArg;
+		}
+
+		if (empty($cliArgs) === true) {
+			$cliArgs = $_SERVER['argv'];
+			array_shift($cliArgs);
+		}
+
+		$this->restoreDefaults();
+		$this->setCommandLineValues($cliArgs);
+
+		if (isset(self::$overriddenDefaults['standards']) === false) {
+			// They did not supply a standard to use.
+			// Look for a default ruleset in the current directory or higher.
+			$currentDir = getcwd();
+
+			$defaultFiles = [
+				'.phpcs.xml',
+				'phpcs.xml',
+				'.phpcs.xml.dist',
+				'phpcs.xml.dist',
+			];
+
+			do {
+				foreach ($defaultFiles as $defaultFilename) {
+					$default = $currentDir.DIRECTORY_SEPARATOR.$defaultFilename;
+					if (is_file($default) === true) {
+						$this->standards = [$default];
+						break(2);
+					}
+				}
+
+				$lastDir    = $currentDir;
+				$currentDir = dirname($currentDir);
+			} while ($currentDir !== '.' && $currentDir !== $lastDir);
+		}//end if
+
+		if (defined('STDIN') === false
+			|| strtoupper(substr(PHP_OS, 0, 3)) === 'WIN'
+		) {
+			return;
+		}
+
+		$handle = fopen('php://stdin', 'r');
+
+		// Check for content on STDIN.
+		if ($this->stdin === true
+			|| (Util\Common::isStdinATTY() === false
+			&& feof($handle) === false)
+		) {
+			$readStreams = [$handle];
+			$writeSteams = null;
+
+			$fileContents = '';
+			while (is_resource($handle) === true && feof($handle) === false) {
+				// Set a timeout of 200ms.
+				if (stream_select($readStreams, $writeSteams, $writeSteams, 0, 200000) === 0) {
+					break;
+				}
+
+				$fileContents .= fgets($handle);
+			}
+
+			if (trim($fileContents) !== '') {
+				$this->stdin        = true;
+				$this->stdinContent = $fileContents;
+				self::$overriddenDefaults['stdin']        = true;
+				self::$overriddenDefaults['stdinContent'] = true;
+			}
+		}//end if
+
+		fclose($handle);
+
+	}//end __construct()
+
+
+	/**
+	 * Set the command line values.
+	 *
+	 * @param array $args An array of command line arguments to set.
+	 *
+	 * @return void
+	 */
+	public function setCommandLineValues($args)
+	{
+		$this->cliArgs = $args;
+		$numArgs       = count($args);
+
+		for ($i = 0; $i < $numArgs; $i++) {
+			$arg = $this->cliArgs[$i];
+			if ($arg === '') {
+				continue;
+			}
+
+			if ($arg{0} === '-') {
+				if ($arg === '-') {
+					// Asking to read from STDIN.
+					$this->stdin = true;
+					self::$overriddenDefaults['stdin'] = true;
+					continue;
+				}
+
+				if ($arg === '--') {
+					// Empty argument, ignore it.
+					continue;
+				}
+
+				if ($arg{1} === '-') {
+					$this->processLongArgument(substr($arg, 2), $i);
+				} else {
+					$switches = str_split($arg);
+					foreach ($switches as $switch) {
+						if ($switch === '-') {
+							continue;
+						}
+
+						$this->processShortArgument($switch, $i);
+					}
+				}
+			} else {
+				$this->processUnknownArgument($arg, $i);
+			}//end if
+		}//end for
+
+	}//end setCommandLineValues()
+
+
+	/**
+	 * Restore default values for all possible command line arguments.
+	 *
+	 * @return array
+	 */
+	public function restoreDefaults()
+	{
+		$this->files           = [];
+		$this->standards       = ['PEAR'];
+		$this->verbosity       = 0;
+		$this->interactive     = false;
+		$this->cache           = false;
+		$this->cacheFile       = null;
+		$this->colors          = false;
+		$this->explain         = false;
+		$this->local           = false;
+		$this->showSources     = false;
+		$this->showProgress    = false;
+		$this->quiet           = false;
+		$this->annotations     = true;
+		$this->parallel        = 1;
+		$this->tabWidth        = 0;
+		$this->encoding        = 'utf-8';
+		$this->extensions      = [
+			'php' => 'PHP',
+			'inc' => 'PHP',
+			'js'  => 'JS',
+			'css' => 'CSS',
+		];
+		$this->sniffs          = [];
+		$this->exclude         = [];
+		$this->ignored         = [];
+		$this->reportFile      = null;
+		$this->generator       = null;
+		$this->filter          = null;
+		$this->bootstrap       = [];
+		$this->basepath        = null;
+		$this->reports         = ['full' => null];
+		$this->reportWidth     = 'auto';
+		$this->errorSeverity   = 5;
+		$this->warningSeverity = 5;
+		$this->recordErrors    = true;
+		$this->suffix          = '';
+		$this->stdin           = false;
+		$this->stdinContent    = null;
+		$this->stdinPath       = null;
+		$this->unknown         = [];
+
+		$standard = self::getConfigData('default_standard');
+		if ($standard !== null) {
+			$this->standards = explode(',', $standard);
+		}
+
+		$reportFormat = self::getConfigData('report_format');
+		if ($reportFormat !== null) {
+			$this->reports = [$reportFormat => null];
+		}
+
+		$tabWidth = self::getConfigData('tab_width');
+		if ($tabWidth !== null) {
+			$this->tabWidth = (int) $tabWidth;
+		}
+
+		$encoding = self::getConfigData('encoding');
+		if ($encoding !== null) {
+			$this->encoding = strtolower($encoding);
+		}
+
+		$severity = self::getConfigData('severity');
+		if ($severity !== null) {
+			$this->errorSeverity   = (int) $severity;
+			$this->warningSeverity = (int) $severity;
+		}
+
+		$severity = self::getConfigData('error_severity');
+		if ($severity !== null) {
+			$this->errorSeverity = (int) $severity;
+		}
+
+		$severity = self::getConfigData('warning_severity');
+		if ($severity !== null) {
+			$this->warningSeverity = (int) $severity;
+		}
+
+		$showWarnings = self::getConfigData('show_warnings');
+		if ($showWarnings !== null) {
+			$showWarnings = (bool) $showWarnings;
+			if ($showWarnings === false) {
+				$this->warningSeverity = 0;
+			}
+		}
+
+		$reportWidth = self::getConfigData('report_width');
+		if ($reportWidth !== null) {
+			$this->reportWidth = $reportWidth;
+		}
+
+		$showProgress = self::getConfigData('show_progress');
+		if ($showProgress !== null) {
+			$this->showProgress = (bool) $showProgress;
+		}
+
+		$quiet = self::getConfigData('quiet');
+		if ($quiet !== null) {
+			$this->quiet = (bool) $quiet;
+		}
+
+		$colors = self::getConfigData('colors');
+		if ($colors !== null) {
+			$this->colors = (bool) $colors;
+		}
+
+		if (defined('PHP_CODESNIFFER_IN_TESTS') === false) {
+			$cache = self::getConfigData('cache');
+			if ($cache !== null) {
+				$this->cache = (bool) $cache;
+			}
+
+			$parallel = self::getConfigData('parallel');
+			if ($parallel !== null) {
+				$this->parallel = max((int) $parallel, 1);
+			}
+		}
+
+	}//end restoreDefaults()
+
+
+	/**
+	 * Processes a short (-e) command line argument.
+	 *
+	 * @param string $arg The command line argument.
+	 * @param int    $pos The position of the argument on the command line.
+	 *
+	 * @return void
+	 */
+	public function processShortArgument($arg, $pos)
+	{
+		switch ($arg) {
+		case 'h':
+		case '?':
+			ob_start();
+			$this->printUsage();
+			$output = ob_get_contents();
+			ob_end_clean();
+			throw new DeepExitException($output, 0);
+		case 'i' :
+			ob_start();
+			Util\Standards::printInstalledStandards();
+			$output = ob_get_contents();
+			ob_end_clean();
+			throw new DeepExitException($output, 0);
+		case 'v' :
+			if ($this->quiet === true) {
+				// Ignore when quiet mode is enabled.
+				break;
+			}
+
+			$this->verbosity++;
+			self::$overriddenDefaults['verbosity'] = true;
+			break;
+		case 'l' :
+			$this->local = true;
+			self::$overriddenDefaults['local'] = true;
+			break;
+		case 's' :
+			$this->showSources = true;
+			self::$overriddenDefaults['showSources'] = true;
+			break;
+		case 'a' :
+			$this->interactive = true;
+			self::$overriddenDefaults['interactive'] = true;
+			break;
+		case 'e':
+			$this->explain = true;
+			self::$overriddenDefaults['explain'] = true;
+			break;
+		case 'p' :
+			if ($this->quiet === true) {
+				// Ignore when quiet mode is enabled.
+				break;
+			}
+
+			$this->showProgress = true;
+			self::$overriddenDefaults['showProgress'] = true;
+			break;
+		case 'q' :
+			// Quiet mode disables a few other settings as well.
+			$this->quiet        = true;
+			$this->showProgress = false;
+			$this->verbosity    = 0;
+
+			self::$overriddenDefaults['quiet'] = true;
+			break;
+		case 'm' :
+			$this->recordErrors = false;
+			self::$overriddenDefaults['recordErrors'] = true;
+			break;
+		case 'd' :
+			$ini = explode('=', $this->cliArgs[($pos + 1)]);
+			$this->cliArgs[($pos + 1)] = '';
+			if (isset($ini[1]) === true) {
+				ini_set($ini[0], $ini[1]);
+			} else {
+				ini_set($ini[0], true);
+			}
+			break;
+		case 'n' :
+			if (isset(self::$overriddenDefaults['warningSeverity']) === false) {
+				$this->warningSeverity = 0;
+				self::$overriddenDefaults['warningSeverity'] = true;
+			}
+			break;
+		case 'w' :
+			if (isset(self::$overriddenDefaults['warningSeverity']) === false) {
+				$this->warningSeverity = $this->errorSeverity;
+				self::$overriddenDefaults['warningSeverity'] = true;
+			}
+			break;
+		default:
+			if ($this->dieOnUnknownArg === false) {
+				$unknown       = $this->unknown;
+				$unknown[]     = $arg;
+				$this->unknown = $unknown;
+			} else {
+				$this->processUnknownArgument('-'.$arg, $pos);
+			}
+		}//end switch
+
+	}//end processShortArgument()
+
+
+	/**
+	 * Processes a long (--example) command line argument.
+	 *
+	 * @param string $arg The command line argument.
+	 * @param int    $pos The position of the argument on the command line.
+	 *
+	 * @return void
+	 */
+	public function processLongArgument($arg, $pos)
+	{
+		switch ($arg) {
+		case 'help':
+			ob_start();
+			$this->printUsage();
+			$output = ob_get_contents();
+			ob_end_clean();
+			throw new DeepExitException($output, 0);
+		case 'version':
+			$output  = 'PHP_CodeSniffer version '.self::VERSION.' ('.self::STABILITY.') ';
+			$output .= 'by Squiz (http://www.squiz.net)'.PHP_EOL;
+			throw new DeepExitException($output, 0);
+		case 'colors':
+			if (isset(self::$overriddenDefaults['colors']) === true) {
+				break;
+			}
+
+			$this->colors = true;
+			self::$overriddenDefaults['colors'] = true;
+			break;
+		case 'no-colors':
+			if (isset(self::$overriddenDefaults['colors']) === true) {
+				break;
+			}
+
+			$this->colors = false;
+			self::$overriddenDefaults['colors'] = true;
+			break;
+		case 'cache':
+			if (isset(self::$overriddenDefaults['cache']) === true) {
+				break;
+			}
+
+			if (defined('PHP_CODESNIFFER_IN_TESTS') === false) {
+				$this->cache = true;
+				self::$overriddenDefaults['cache'] = true;
+			}
+			break;
+		case 'no-cache':
+			if (isset(self::$overriddenDefaults['cache']) === true) {
+				break;
+			}
+
+			$this->cache = false;
+			self::$overriddenDefaults['cache'] = true;
+			break;
+		case 'ignore-annotations':
+			if (isset(self::$overriddenDefaults['annotations']) === true) {
+				break;
+			}
+
+			$this->annotations = false;
+			self::$overriddenDefaults['annotations'] = true;
+			break;
+		case 'config-set':
+			if (isset($this->cliArgs[($pos + 1)]) === false
+				|| isset($this->cliArgs[($pos + 2)]) === false
+			) {
+				$error  = 'ERROR: Setting a config option requires a name and value'.PHP_EOL.PHP_EOL;
+				$error .= $this->printShortUsage(true);
+				throw new DeepExitException($error, 3);
+			}
+
+			$key     = $this->cliArgs[($pos + 1)];
+			$value   = $this->cliArgs[($pos + 2)];
+			$current = self::getConfigData($key);
+
+			try {
+				$this->setConfigData($key, $value);
+			} catch (\Exception $e) {
+				throw new DeepExitException($e->getMessage().PHP_EOL, 3);
+			}
+
+			$output = 'Using config file: '.self::$configDataFile.PHP_EOL.PHP_EOL;
+
+			if ($current === null) {
+				$output .= "Config value \"$key\" added successfully".PHP_EOL;
+			} else {
+				$output .= "Config value \"$key\" updated successfully; old value was \"$current\"".PHP_EOL;
+			}
+			throw new DeepExitException($output, 0);
+		case 'config-delete':
+			if (isset($this->cliArgs[($pos + 1)]) === false) {
+				$error  = 'ERROR: Deleting a config option requires the name of the option'.PHP_EOL.PHP_EOL;
+				$error .= $this->printShortUsage(true);
+				throw new DeepExitException($error, 3);
+			}
+
+			$output = 'Using config file: '.self::$configDataFile.PHP_EOL.PHP_EOL;
+
+			$key     = $this->cliArgs[($pos + 1)];
+			$current = self::getConfigData($key);
+			if ($current === null) {
+				$output .= "Config value \"$key\" has not been set".PHP_EOL;
+			} else {
+				try {
+					$this->setConfigData($key, null);
+				} catch (\Exception $e) {
+					throw new DeepExitException($e->getMessage().PHP_EOL, 3);
+				}
+
+				$output .= "Config value \"$key\" removed successfully; old value was \"$current\"".PHP_EOL;
+			}
+			throw new DeepExitException($output, 0);
+		case 'config-show':
+			ob_start();
+			$data = self::getAllConfigData();
+			echo 'Using config file: '.self::$configDataFile.PHP_EOL.PHP_EOL;
+			$this->printConfigData($data);
+			$output = ob_get_contents();
+			ob_end_clean();
+			throw new DeepExitException($output, 0);
+		case 'runtime-set':
+			if (isset($this->cliArgs[($pos + 1)]) === false
+				|| isset($this->cliArgs[($pos + 2)]) === false
+			) {
+				$error  = 'ERROR: Setting a runtime config option requires a name and value'.PHP_EOL.PHP_EOL;
+				$error .= $this->printShortUsage(true);
+				throw new DeepExitException($error, 3);
+			}
+
+			$key   = $this->cliArgs[($pos + 1)];
+			$value = $this->cliArgs[($pos + 2)];
+			$this->cliArgs[($pos + 1)] = '';
+			$this->cliArgs[($pos + 2)] = '';
+			self::setConfigData($key, $value, true);
+			if (isset(self::$overriddenDefaults['runtime-set']) === false) {
+				self::$overriddenDefaults['runtime-set'] = [];
+			}
+
+			self::$overriddenDefaults['runtime-set'][$key] = true;
+			break;
+		default:
+			if (substr($arg, 0, 7) === 'sniffs=') {
+				if (isset(self::$overriddenDefaults['sniffs']) === true) {
+					break;
+				}
+
+				$sniffs = explode(',', substr($arg, 7));
+				foreach ($sniffs as $sniff) {
+					if (substr_count($sniff, '.') !== 2) {
+						$error  = 'ERROR: The specified sniff code "'.$sniff.'" is invalid'.PHP_EOL.PHP_EOL;
+						$error .= $this->printShortUsage(true);
+						throw new DeepExitException($error, 3);
+					}
+				}
+
+				$this->sniffs = $sniffs;
+				self::$overriddenDefaults['sniffs'] = true;
+			} else if (substr($arg, 0, 8) === 'exclude=') {
+				if (isset(self::$overriddenDefaults['exclude']) === true) {
+					break;
+				}
+
+				$sniffs = explode(',', substr($arg, 8));
+				foreach ($sniffs as $sniff) {
+					if (substr_count($sniff, '.') !== 2) {
+						$error  = 'ERROR: The specified sniff code "'.$sniff.'" is invalid'.PHP_EOL.PHP_EOL;
+						$error .= $this->printShortUsage(true);
+						throw new DeepExitException($error, 3);
+					}
+				}
+
+				$this->exclude = $sniffs;
+				self::$overriddenDefaults['exclude'] = true;
+			} else if (defined('PHP_CODESNIFFER_IN_TESTS') === false
+				&& substr($arg, 0, 6) === 'cache='
+			) {
+				if ((isset(self::$overriddenDefaults['cache']) === true
+					&& $this->cache === false)
+					|| isset(self::$overriddenDefaults['cacheFile']) === true
+				) {
+					break;
+				}
+
+				// Turn caching on.
+				$this->cache = true;
+				self::$overriddenDefaults['cache'] = true;
+
+				$this->cacheFile = Util\Common::realpath(substr($arg, 6));
+
+				// It may not exist and return false instead.
+				if ($this->cacheFile === false) {
+					$this->cacheFile = substr($arg, 6);
+
+					$dir = dirname($this->cacheFile);
+					if (is_dir($dir) === false) {
+						$error  = 'ERROR: The specified cache file path "'.$this->cacheFile.'" points to a non-existent directory'.PHP_EOL.PHP_EOL;
+						$error .= $this->printShortUsage(true);
+						throw new DeepExitException($error, 3);
+					}
+
+					if ($dir === '.') {
+						// Passed cache file is a file in the current directory.
+						$this->cacheFile = getcwd().'/'.basename($this->cacheFile);
+					} else {
+						if ($dir{0} === '/') {
+							// An absolute path.
+							$dir = Util\Common::realpath($dir);
+						} else {
+							$dir = Util\Common::realpath(getcwd().'/'.$dir);
+						}
+
+						if ($dir !== false) {
+							// Cache file path is relative.
+							$this->cacheFile = $dir.'/'.basename($this->cacheFile);
+						}
+					}
+				}//end if
+
+				self::$overriddenDefaults['cacheFile'] = true;
+
+				if (is_dir($this->cacheFile) === true) {
+					$error  = 'ERROR: The specified cache file path "'.$this->cacheFile.'" is a directory'.PHP_EOL.PHP_EOL;
+					$error .= $this->printShortUsage(true);
+					throw new DeepExitException($error, 3);
+				}
+			} else if (substr($arg, 0, 10) === 'bootstrap=') {
+				$files     = explode(',', substr($arg, 10));
+				$bootstrap = [];
+				foreach ($files as $file) {
+					$path = Util\Common::realpath($file);
+					if ($path === false) {
+						$error  = 'ERROR: The specified bootstrap file "'.$file.'" does not exist'.PHP_EOL.PHP_EOL;
+						$error .= $this->printShortUsage(true);
+						throw new DeepExitException($error, 3);
+					}
+
+					$bootstrap[] = $path;
+				}
+
+				$this->bootstrap = array_merge($this->bootstrap, $bootstrap);
+				self::$overriddenDefaults['bootstrap'] = true;
+			} else if (substr($arg, 0, 10) === 'file-list=') {
+				$fileList = substr($arg, 10);
+				$path     = Util\Common::realpath($fileList);
+				if ($path === false) {
+					$error  = 'ERROR: The specified file list "'.$fileList.'" does not exist'.PHP_EOL.PHP_EOL;
+					$error .= $this->printShortUsage(true);
+					throw new DeepExitException($error, 3);
+				}
+
+				$files = file($path);
+				foreach ($files as $inputFile) {
+					$inputFile = trim($inputFile);
+
+					// Skip empty lines.
+					if ($inputFile === '') {
+						continue;
+					}
+
+					$this->processFilePath($inputFile);
+				}
+			} else if (substr($arg, 0, 11) === 'stdin-path=') {
+				if (isset(self::$overriddenDefaults['stdinPath']) === true) {
+					break;
+				}
+
+				$this->stdinPath = Util\Common::realpath(substr($arg, 11));
+
+				// It may not exist and return false instead, so use whatever they gave us.
+				if ($this->stdinPath === false) {
+					$this->stdinPath = trim(substr($arg, 11));
+				}
+
+				self::$overriddenDefaults['stdinPath'] = true;
+			} else if (PHP_CODESNIFFER_CBF === false && substr($arg, 0, 12) === 'report-file=') {
+				if (isset(self::$overriddenDefaults['reportFile']) === true) {
+					break;
+				}
+
+				$this->reportFile = Util\Common::realpath(substr($arg, 12));
+
+				// It may not exist and return false instead.
+				if ($this->reportFile === false) {
+					$this->reportFile = substr($arg, 12);
+
+					$dir = dirname($this->reportFile);
+					if (is_dir($dir) === false) {
+						$error  = 'ERROR: The specified report file path "'.$this->reportFile.'" points to a non-existent directory'.PHP_EOL.PHP_EOL;
+						$error .= $this->printShortUsage(true);
+						throw new DeepExitException($error, 3);
+					}
+
+					if ($dir === '.') {
+						// Passed report file is a file in the current directory.
+						$this->reportFile = getcwd().'/'.basename($this->reportFile);
+					} else {
+						if ($dir{0} === '/') {
+							// An absolute path.
+							$dir = Util\Common::realpath($dir);
+						} else {
+							$dir = Util\Common::realpath(getcwd().'/'.$dir);
+						}
+
+						if ($dir !== false) {
+							// Report file path is relative.
+							$this->reportFile = $dir.'/'.basename($this->reportFile);
+						}
+					}
+				}//end if
+
+				self::$overriddenDefaults['reportFile'] = true;
+
+				if (is_dir($this->reportFile) === true) {
+					$error  = 'ERROR: The specified report file path "'.$this->reportFile.'" is a directory'.PHP_EOL.PHP_EOL;
+					$error .= $this->printShortUsage(true);
+					throw new DeepExitException($error, 3);
+				}
+			} else if (substr($arg, 0, 13) === 'report-width=') {
+				if (isset(self::$overriddenDefaults['reportWidth']) === true) {
+					break;
+				}
+
+				$this->reportWidth = substr($arg, 13);
+				self::$overriddenDefaults['reportWidth'] = true;
+			} else if (substr($arg, 0, 9) === 'basepath=') {
+				if (isset(self::$overriddenDefaults['basepath']) === true) {
+					break;
+				}
+
+				self::$overriddenDefaults['basepath'] = true;
+
+				if (substr($arg, 9) === '') {
+					$this->basepath = null;
+					break;
+				}
+
+				$this->basepath = Util\Common::realpath(substr($arg, 9));
+
+				// It may not exist and return false instead.
+				if ($this->basepath === false) {
+					$this->basepath = substr($arg, 9);
+				}
+
+				if (is_dir($this->basepath) === false) {
+					$error  = 'ERROR: The specified basepath "'.$this->basepath.'" points to a non-existent directory'.PHP_EOL.PHP_EOL;
+					$error .= $this->printShortUsage(true);
+					throw new DeepExitException($error, 3);
+				}
+			} else if ((substr($arg, 0, 7) === 'report=' || substr($arg, 0, 7) === 'report-')) {
+				$reports = [];
+
+				if ($arg[6] === '-') {
+					// This is a report with file output.
+					$split = strpos($arg, '=');
+					if ($split === false) {
+						$report = substr($arg, 7);
+						$output = null;
+					} else {
+						$report = substr($arg, 7, ($split - 7));
+						$output = substr($arg, ($split + 1));
+						if ($output === false) {
+							$output = null;
+						} else {
+							$dir = dirname($output);
+							if (is_dir($dir) === false) {
+								$error  = 'ERROR: The specified '.$report.' report file path "'.$output.'" points to a non-existent directory'.PHP_EOL.PHP_EOL;
+								$error .= $this->printShortUsage(true);
+								throw new DeepExitException($error, 3);
+							}
+
+							if ($dir === '.') {
+								// Passed report file is a filename in the current directory.
+								$output = getcwd().'/'.basename($output);
+							} else {
+								if ($dir{0} === '/') {
+									// An absolute path.
+									$dir = Util\Common::realpath($dir);
+								} else {
+									$dir = Util\Common::realpath(getcwd().'/'.$dir);
+								}
+
+								if ($dir !== false) {
+									// Report file path is relative.
+									$output = $dir.'/'.basename($output);
+								}
+							}
+						}//end if
+					}//end if
+
+					$reports[$report] = $output;
+				} else {
+					// This is a single report.
+					if (isset(self::$overriddenDefaults['reports']) === true) {
+						break;
+					}
+
+					$reportNames = explode(',', substr($arg, 7));
+					foreach ($reportNames as $report) {
+						$reports[$report] = null;
+					}
+				}//end if
+
+				// Remove the default value so the CLI value overrides it.
+				if (isset(self::$overriddenDefaults['reports']) === false) {
+					$this->reports = $reports;
+				} else {
+					$this->reports = array_merge($this->reports, $reports);
+				}
+
+				self::$overriddenDefaults['reports'] = true;
+			} else if (substr($arg, 0, 7) === 'filter=') {
+				if (isset(self::$overriddenDefaults['filter']) === true) {
+					break;
+				}
+
+				$this->filter = substr($arg, 7);
+				self::$overriddenDefaults['filter'] = true;
+			} else if (substr($arg, 0, 9) === 'standard=') {
+				$standards = trim(substr($arg, 9));
+				if ($standards !== '') {
+					$this->standards = explode(',', $standards);
+				}
+
+				self::$overriddenDefaults['standards'] = true;
+			} else if (substr($arg, 0, 11) === 'extensions=') {
+				if (isset(self::$overriddenDefaults['extensions']) === true) {
+					break;
+				}
+
+				$extensions    = explode(',', substr($arg, 11));
+				$newExtensions = [];
+				foreach ($extensions as $ext) {
+					$slash = strpos($ext, '/');
+					if ($slash !== false) {
+						// They specified the tokenizer too.
+						list($ext, $tokenizer) = explode('/', $ext);
+						$newExtensions[$ext]   = strtoupper($tokenizer);
+						continue;
+					}
+
+					if (isset($this->extensions[$ext]) === true) {
+						$newExtensions[$ext] = $this->extensions[$ext];
+					} else {
+						$newExtensions[$ext] = 'PHP';
+					}
+				}
+
+				$this->extensions = $newExtensions;
+				self::$overriddenDefaults['extensions'] = true;
+			} else if (substr($arg, 0, 7) === 'suffix=') {
+				if (isset(self::$overriddenDefaults['suffix']) === true) {
+					break;
+				}
+
+				$this->suffix = substr($arg, 7);
+				self::$overriddenDefaults['suffix'] = true;
+			} else if (substr($arg, 0, 9) === 'parallel=') {
+				if (isset(self::$overriddenDefaults['parallel']) === true) {
+					break;
+				}
+
+				$this->parallel = max((int) substr($arg, 9), 1);
+				self::$overriddenDefaults['parallel'] = true;
+			} else if (substr($arg, 0, 9) === 'severity=') {
+				$this->errorSeverity   = (int) substr($arg, 9);
+				$this->warningSeverity = $this->errorSeverity;
+				if (isset(self::$overriddenDefaults['errorSeverity']) === false) {
+					self::$overriddenDefaults['errorSeverity'] = true;
+				}
+
+				if (isset(self::$overriddenDefaults['warningSeverity']) === false) {
+					self::$overriddenDefaults['warningSeverity'] = true;
+				}
+			} else if (substr($arg, 0, 15) === 'error-severity=') {
+				if (isset(self::$overriddenDefaults['errorSeverity']) === true) {
+					break;
+				}
+
+				$this->errorSeverity = (int) substr($arg, 15);
+				self::$overriddenDefaults['errorSeverity'] = true;
+			} else if (substr($arg, 0, 17) === 'warning-severity=') {
+				if (isset(self::$overriddenDefaults['warningSeverity']) === true) {
+					break;
+				}
+
+				$this->warningSeverity = (int) substr($arg, 17);
+				self::$overriddenDefaults['warningSeverity'] = true;
+			} else if (substr($arg, 0, 7) === 'ignore=') {
+				if (isset(self::$overriddenDefaults['ignored']) === true) {
+					break;
+				}
+
+				// Split the ignore string on commas, unless the comma is escaped
+				// using 1 or 3 slashes (\, or \\\,).
+				$patterns = preg_split(
+					'/(?<=(?<!\\\\)\\\\\\\\),|(?<!\\\\),/',
+					substr($arg, 7)
+				);
+
+				$ignored = [];
+				foreach ($patterns as $pattern) {
+					$pattern = trim($pattern);
+					if ($pattern === '') {
+						continue;
+					}
+
+					$ignored[$pattern] = 'absolute';
+				}
+
+				$this->ignored = $ignored;
+				self::$overriddenDefaults['ignored'] = true;
+			} else if (substr($arg, 0, 10) === 'generator='
+				&& PHP_CODESNIFFER_CBF === false
+			) {
+				if (isset(self::$overriddenDefaults['generator']) === true) {
+					break;
+				}
+
+				$this->generator = substr($arg, 10);
+				self::$overriddenDefaults['generator'] = true;
+			} else if (substr($arg, 0, 9) === 'encoding=') {
+				if (isset(self::$overriddenDefaults['encoding']) === true) {
+					break;
+				}
+
+				$this->encoding = strtolower(substr($arg, 9));
+				self::$overriddenDefaults['encoding'] = true;
+			} else if (substr($arg, 0, 10) === 'tab-width=') {
+				if (isset(self::$overriddenDefaults['tabWidth']) === true) {
+					break;
+				}
+
+				$this->tabWidth = (int) substr($arg, 10);
+				self::$overriddenDefaults['tabWidth'] = true;
+			} else {
+				if ($this->dieOnUnknownArg === false) {
+					$eqPos = strpos($arg, '=');
+					try {
+						if ($eqPos === false) {
+							$this->values[$arg] = $arg;
+						} else {
+							$value = substr($arg, ($eqPos + 1));
+							$arg   = substr($arg, 0, $eqPos);
+							$this->values[$arg] = $value;
+						}
+					} catch (RuntimeException $e) {
+						// Value is not valid, so just ignore it.
+					}
+				} else {
+					$this->processUnknownArgument('--'.$arg, $pos);
+				}
+			}//end if
+			break;
+		}//end switch
+
+	}//end processLongArgument()
+
+
+	/**
+	 * Processes an unknown command line argument.
+	 *
+	 * Assumes all unknown arguments are files and folders to check.
+	 *
+	 * @param string $arg The command line argument.
+	 * @param int    $pos The position of the argument on the command line.
+	 *
+	 * @return void
+	 */
+	public function processUnknownArgument($arg, $pos)
+	{
+		// We don't know about any additional switches; just files.
+		if ($arg{0} === '-') {
+			if ($this->dieOnUnknownArg === false) {
+				return;
+			}
+
+			$error  = "ERROR: option \"$arg\" not known".PHP_EOL.PHP_EOL;
+			$error .= $this->printShortUsage(true);
+			throw new DeepExitException($error, 3);
+		}
+
+		$this->processFilePath($arg);
+
+	}//end processUnknownArgument()
+
+
+	/**
+	 * Processes a file path and add it to the file list.
+	 *
+	 * @param string $path The path to the file to add.
+	 *
+	 * @return void
+	 */
+	public function processFilePath($path)
+	{
+		// If we are processing STDIN, don't record any files to check.
+		if ($this->stdin === true) {
+			return;
+		}
+
+		$file = Util\Common::realpath($path);
+		if (file_exists($file) === false) {
+			if ($this->dieOnUnknownArg === false) {
+				return;
+			}
+
+			$error  = 'ERROR: The file "'.$path.'" does not exist.'.PHP_EOL.PHP_EOL;
+			$error .= $this->printShortUsage(true);
+			throw new DeepExitException($error, 3);
+		} else {
+			// Can't modify the files array directly because it's not a real
+			// class member, so need to use this little get/modify/set trick.
+			$files       = $this->files;
+			$files[]     = $file;
+			$this->files = $files;
+			self::$overriddenDefaults['files'] = true;
+		}
+
+	}//end processFilePath()
+
+
+	/**
+	 * Prints out the usage information for this script.
+	 *
+	 * @return void
+	 */
+	public function printUsage()
+	{
+		echo PHP_EOL;
+
+		if (PHP_CODESNIFFER_CBF === true) {
+			$this->printPHPCBFUsage();
+		} else {
+			$this->printPHPCSUsage();
+		}
+
+		echo PHP_EOL;
+
+	}//end printUsage()
+
+
+	/**
+	 * Prints out the short usage information for this script.
+	 *
+	 * @param bool $return If TRUE, the usage string is returned
+	 *                     instead of output to screen.
+	 *
+	 * @return string|void
+	 */
+	public function printShortUsage($return=false)
+	{
+		if (PHP_CODESNIFFER_CBF === true) {
+			$usage = 'Run "phpcbf --help" for usage information';
+		} else {
+			$usage = 'Run "phpcs --help" for usage information';
+		}
+
+		$usage .= PHP_EOL.PHP_EOL;
+
+		if ($return === true) {
+			return $usage;
+		}
+
+		echo $usage;
+
+	}//end printShortUsage()
+
+
+	/**
+	 * Prints out the usage information for PHPCS.
+	 *
+	 * @return void
+	 */
+	public function printPHPCSUsage()
+	{
+		echo 'Usage: phpcs [-nwlsaepqvi] [-d key[=value]] [--colors] [--no-colors]'.PHP_EOL;
+		echo '  [--cache[=<cacheFile>]] [--no-cache] [--tab-width=<tabWidth>]'.PHP_EOL;
+		echo '  [--report=<report>] [--report-file=<reportFile>] [--report-<report>=<reportFile>]'.PHP_EOL;
+		echo '  [--report-width=<reportWidth>] [--basepath=<basepath>] [--bootstrap=<bootstrap>]'.PHP_EOL;
+		echo '  [--severity=<severity>] [--error-severity=<severity>] [--warning-severity=<severity>]'.PHP_EOL;
+		echo '  [--runtime-set key value] [--config-set key value] [--config-delete key] [--config-show]'.PHP_EOL;
+		echo '  [--standard=<standard>] [--sniffs=<sniffs>] [--exclude=<sniffs>]'.PHP_EOL;
+		echo '  [--encoding=<encoding>] [--parallel=<processes>] [--generator=<generator>]'.PHP_EOL;
+		echo '  [--extensions=<extensions>] [--ignore=<patterns>] [--ignore-annotations]'.PHP_EOL;
+		echo '  [--stdin-path=<stdinPath>] [--file-list=<fileList>] [--filter=<filter>] <file> - ...'.PHP_EOL;
+		echo PHP_EOL;
+		echo ' -     Check STDIN instead of local files and directories'.PHP_EOL;
+		echo ' -n    Do not print warnings (shortcut for --warning-severity=0)'.PHP_EOL;
+		echo ' -w    Print both warnings and errors (this is the default)'.PHP_EOL;
+		echo ' -l    Local directory only, no recursion'.PHP_EOL;
+		echo ' -s    Show sniff codes in all reports'.PHP_EOL;
+		echo ' -a    Run interactively'.PHP_EOL;
+		echo ' -e    Explain a standard by showing the sniffs it includes'.PHP_EOL;
+		echo ' -p    Show progress of the run'.PHP_EOL;
+		echo ' -q    Quiet mode; disables progress and verbose output'.PHP_EOL;
+		echo ' -m    Stop error messages from being recorded'.PHP_EOL;
+		echo '       (saves a lot of memory, but stops many reports from being used)'.PHP_EOL;
+		echo ' -v    Print processed files'.PHP_EOL;
+		echo ' -vv   Print ruleset and token output'.PHP_EOL;
+		echo ' -vvv  Print sniff processing information'.PHP_EOL;
+		echo ' -i    Show a list of installed coding standards'.PHP_EOL;
+		echo ' -d    Set the [key] php.ini value to [value] or [true] if value is omitted'.PHP_EOL;
+		echo PHP_EOL;
+		echo ' --help                Print this help message'.PHP_EOL;
+		echo ' --version             Print version information'.PHP_EOL;
+		echo ' --colors              Use colors in output'.PHP_EOL;
+		echo ' --no-colors           Do not use colors in output (this is the default)'.PHP_EOL;
+		echo ' --cache               Cache results between runs'.PHP_EOL;
+		echo ' --no-cache            Do not cache results between runs (this is the default)'.PHP_EOL;
+		echo ' --ignore-annotations  Ignore all phpcs: annotations in code comments'.PHP_EOL;
+		echo PHP_EOL;
+		echo ' <cacheFile>    Use a specific file for caching (uses a temporary file by default)'.PHP_EOL;
+		echo ' <basepath>     A path to strip from the front of file paths inside reports'.PHP_EOL;
+		echo ' <bootstrap>    A comma separated list of files to run before processing begins'.PHP_EOL;
+		echo ' <encoding>     The encoding of the files being checked (default is utf-8)'.PHP_EOL;
+		echo ' <extensions>   A comma separated list of file extensions to check'.PHP_EOL;
+		echo '                The type of the file can be specified using: ext/type'.PHP_EOL;
+		echo '                e.g., module/php,es/js'.PHP_EOL;
+		echo ' <file>         One or more files and/or directories to check'.PHP_EOL;
+		echo ' <fileList>     A file containing a list of files and/or directories to check (one per line)'.PHP_EOL;
+		echo ' <filter>       Use the "gitmodified" filter, or specify the path to a custom filter class'.PHP_EOL;
+		echo ' <generator>    Uses either the "HTML", "Markdown" or "Text" generator'.PHP_EOL;
+		echo '                (forces documentation generation instead of checking)'.PHP_EOL;
+		echo ' <patterns>     A comma separated list of patterns to ignore files and directories'.PHP_EOL;
+		echo ' <processes>    How many files should be checked simultaneously (default is 1)'.PHP_EOL;
+		echo ' <report>       Print either the "full", "xml", "checkstyle", "csv"'.PHP_EOL;
+		echo '                "json", "junit", "emacs", "source", "summary", "diff"'.PHP_EOL;
+		echo '                "svnblame", "gitblame", "hgblame" or "notifysend" report,'.PHP_EOL;
+		echo '                or specify the path to a custom report class'.PHP_EOL;
+		echo '                (the "full" report is printed by default)'.PHP_EOL;
+		echo ' <reportFile>   Write the report to the specified file path'.PHP_EOL;
+		echo ' <reportWidth>  How many columns wide screen reports should be printed'.PHP_EOL;
+		echo '                or set to "auto" to use current screen width, where supported'.PHP_EOL;
+		echo ' <severity>     The minimum severity required to display an error or warning'.PHP_EOL;
+		echo ' <sniffs>       A comma separated list of sniff codes to include or exclude from checking'.PHP_EOL;
+		echo '                (all sniffs must be part of the specified standard)'.PHP_EOL;
+		echo ' <standard>     The name or path of the coding standard to use'.PHP_EOL;
+		echo ' <stdinPath>    If processing STDIN, the file path that STDIN will be processed as'.PHP_EOL;
+		echo ' <tabWidth>     The number of spaces each tab represents'.PHP_EOL;
+
+	}//end printPHPCSUsage()
+
+
+	/**
+	 * Prints out the usage information for PHPCBF.
+	 *
+	 * @return void
+	 */
+	public function printPHPCBFUsage()
+	{
+		echo 'Usage: phpcbf [-nwli] [-d key[=value]] [--ignore-annotations] [--bootstrap=<bootstrap>]'.PHP_EOL;
+		echo '  [--standard=<standard>] [--sniffs=<sniffs>] [--exclude=<sniffs>] [--suffix=<suffix>]'.PHP_EOL;
+		echo '  [--severity=<severity>] [--error-severity=<severity>] [--warning-severity=<severity>]'.PHP_EOL;
+		echo '  [--tab-width=<tabWidth>] [--encoding=<encoding>] [--parallel=<processes>]'.PHP_EOL;
+		echo '  [--basepath=<basepath>] [--extensions=<extensions>] [--ignore=<patterns>]'.PHP_EOL;
+		echo '  [--stdin-path=<stdinPath>] [--file-list=<fileList>] [--filter=<filter>] <file> - ...'.PHP_EOL;
+		echo PHP_EOL;
+		echo ' -     Fix STDIN instead of local files and directories'.PHP_EOL;
+		echo ' -n    Do not fix warnings (shortcut for --warning-severity=0)'.PHP_EOL;
+		echo ' -w    Fix both warnings and errors (on by default)'.PHP_EOL;
+		echo ' -l    Local directory only, no recursion'.PHP_EOL;
+		echo ' -p    Show progress of the run'.PHP_EOL;
+		echo ' -q    Quiet mode; disables progress and verbose output'.PHP_EOL;
+		echo ' -v    Print processed files'.PHP_EOL;
+		echo ' -vv   Print ruleset and token output'.PHP_EOL;
+		echo ' -vvv  Print sniff processing information'.PHP_EOL;
+		echo ' -i    Show a list of installed coding standards'.PHP_EOL;
+		echo ' -d    Set the [key] php.ini value to [value] or [true] if value is omitted'.PHP_EOL;
+		echo PHP_EOL;
+		echo ' --help                Print this help message'.PHP_EOL;
+		echo ' --version             Print version information'.PHP_EOL;
+		echo ' --ignore-annotations  Ignore all phpcs: annotations in code comments'.PHP_EOL;
+		echo PHP_EOL;
+		echo ' <basepath>    A path to strip from the front of file paths inside reports'.PHP_EOL;
+		echo ' <bootstrap>   A comma separated list of files to run before processing begins'.PHP_EOL;
+		echo ' <encoding>    The encoding of the files being fixed (default is utf-8)'.PHP_EOL;
+		echo ' <extensions>  A comma separated list of file extensions to fix'.PHP_EOL;
+		echo '               The type of the file can be specified using: ext/type'.PHP_EOL;
+		echo '               e.g., module/php,es/js'.PHP_EOL;
+		echo ' <file>        One or more files and/or directories to fix'.PHP_EOL;
+		echo ' <fileList>    A file containing a list of files and/or directories to fix (one per line)'.PHP_EOL;
+		echo ' <filter>      Use the "gitmodified" filter, or specify the path to a custom filter class'.PHP_EOL;
+		echo ' <patterns>    A comma separated list of patterns to ignore files and directories'.PHP_EOL;
+		echo ' <processes>   How many files should be fixed simultaneously (default is 1)'.PHP_EOL;
+		echo ' <severity>    The minimum severity required to fix an error or warning'.PHP_EOL;
+		echo ' <sniffs>      A comma separated list of sniff codes to include or exclude from fixing'.PHP_EOL;
+		echo '               (all sniffs must be part of the specified standard)'.PHP_EOL;
+		echo ' <standard>    The name or path of the coding standard to use'.PHP_EOL;
+		echo ' <stdinPath>   If processing STDIN, the file path that STDIN will be processed as'.PHP_EOL;
+		echo ' <suffix>      Write modified files to a filename using this suffix'.PHP_EOL;
+		echo '               ("diff" and "patch" are not used in this mode)'.PHP_EOL;
+		echo ' <tabWidth>    The number of spaces each tab represents'.PHP_EOL;
+
+	}//end printPHPCBFUsage()
+
+
+	/**
+	 * Get a single config value.
+	 *
+	 * @param string $key The name of the config value.
+	 *
+	 * @return string|null
+	 * @see    setConfigData()
+	 * @see    getAllConfigData()
+	 */
+	public static function getConfigData($key)
+	{
+		$phpCodeSnifferConfig = self::getAllConfigData();
+
+		if ($phpCodeSnifferConfig === null) {
+			return null;
+		}
+
+		if (isset($phpCodeSnifferConfig[$key]) === false) {
+			return null;
+		}
+
+		return $phpCodeSnifferConfig[$key];
+
+	}//end getConfigData()
+
+
+	/**
+	 * Get the path to an executable utility.
+	 *
+	 * @param string $name The name of the executable utility.
+	 *
+	 * @return string|null
+	 * @see    getConfigData()
+	 */
+	public static function getExecutablePath($name)
+	{
+		$data = self::getConfigData($name.'_path');
+		if ($data !== null) {
+			return $data;
+		}
+
+		if ($name === "php") {
+			// For php, we know the executable path. There's no need to look it up.
+			return PHP_BINARY;
+		}
+
+		if (array_key_exists($name, self::$executablePaths) === true) {
+			return self::$executablePaths[$name];
+		}
+
+		if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
+			$cmd = 'where '.escapeshellarg($name).' 2> nul';
+		} else {
+			$cmd = 'which '.escapeshellarg($name).' 2> /dev/null';
+		}
+
+		$result = exec($cmd, $output, $retVal);
+		if ($retVal !== 0) {
+			$result = null;
+		}
+
+		self::$executablePaths[$name] = $result;
+		return $result;
+
+	}//end getExecutablePath()
+
+
+	/**
+	 * Set a single config value.
+	 *
+	 * @param string      $key   The name of the config value.
+	 * @param string|null $value The value to set. If null, the config
+	 *                           entry is deleted, reverting it to the
+	 *                           default value.
+	 * @param boolean     $temp  Set this config data temporarily for this
+	 *                           script run. This will not write the config
+	 *                           data to the config file.
+	 *
+	 * @return bool
+	 * @see    getConfigData()
+	 * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the config file can not be written.
+	 */
+	public static function setConfigData($key, $value, $temp=false)
+	{
+		if (isset(self::$overriddenDefaults['runtime-set']) === true
+			&& isset(self::$overriddenDefaults['runtime-set'][$key]) === true
+		) {
+			return false;
+		}
+
+		if ($temp === false) {
+			$path = '';
+			if (is_callable('\Phar::running') === true) {
+				$path = \Phar::running(false);
+			}
+
+			if ($path !== '') {
+				$configFile = dirname($path).DIRECTORY_SEPARATOR.'CodeSniffer.conf';
+			} else {
+				$configFile = dirname(__DIR__).DIRECTORY_SEPARATOR.'CodeSniffer.conf';
+				if (is_file($configFile) === false
+					&& strpos('@data_dir@', '@data_dir') === false
+				) {
+					// If data_dir was replaced, this is a PEAR install and we can
+					// use the PEAR data dir to store the conf file.
+					$configFile = '@data_dir@/PHP_CodeSniffer/CodeSniffer.conf';
+				}
+			}
+
+			if (is_file($configFile) === true
+				&& is_writable($configFile) === false
+			) {
+				$error = 'ERROR: Config file '.$configFile.' is not writable'.PHP_EOL.PHP_EOL;
+				throw new DeepExitException($error, 3);
+			}
+		}//end if
+
+		$phpCodeSnifferConfig = self::getAllConfigData();
+
+		if ($value === null) {
+			if (isset($phpCodeSnifferConfig[$key]) === true) {
+				unset($phpCodeSnifferConfig[$key]);
+			}
+		} else {
+			$phpCodeSnifferConfig[$key] = $value;
+		}
+
+		if ($temp === false) {
+			$output  = '<'.'?php'."\n".' $phpCodeSnifferConfig = ';
+			$output .= var_export($phpCodeSnifferConfig, true);
+			$output .= "\n?".'>';
+
+			if (file_put_contents($configFile, $output) === false) {
+				$error = 'ERROR: Config file '.$configFile.' could not be written'.PHP_EOL.PHP_EOL;
+				throw new DeepExitException($error, 3);
+			}
+
+			self::$configDataFile = $configFile;
+		}
+
+		self::$configData = $phpCodeSnifferConfig;
+
+		// If the installed paths are being set, make sure all known
+		// standards paths are added to the autoloader.
+		if ($key === 'installed_paths') {
+			$installedStandards = Util\Standards::getInstalledStandardDetails();
+			foreach ($installedStandards as $name => $details) {
+				Autoload::addSearchPath($details['path'], $details['namespace']);
+			}
+		}
+
+		return true;
+
+	}//end setConfigData()
+
+
+	/**
+	 * Get all config data.
+	 *
+	 * @return array<string, string>
+	 * @see    getConfigData()
+	 */
+	public static function getAllConfigData()
+	{
+		if (self::$configData !== null) {
+			return self::$configData;
+		}
+
+		$path = '';
+		if (is_callable('\Phar::running') === true) {
+			$path = \Phar::running(false);
+		}
+
+		if ($path !== '') {
+			$configFile = dirname($path).DIRECTORY_SEPARATOR.'CodeSniffer.conf';
+		} else {
+			$configFile = dirname(__DIR__).DIRECTORY_SEPARATOR.'CodeSniffer.conf';
+			if (is_file($configFile) === false
+				&& strpos('@data_dir@', '@data_dir') === false
+			) {
+				$configFile = '@data_dir@/PHP_CodeSniffer/CodeSniffer.conf';
+			}
+		}
+
+		if (is_file($configFile) === false) {
+			self::$configData = [];
+			return [];
+		}
+
+		if (is_readable($configFile) === false) {
+			$error = 'ERROR: Config file '.$configFile.' is not readable'.PHP_EOL.PHP_EOL;
+			throw new DeepExitException($error, 3);
+		}
+
+		include $configFile;
+		self::$configDataFile = $configFile;
+		self::$configData     = $phpCodeSnifferConfig;
+		return self::$configData;
+
+	}//end getAllConfigData()
+
+
+	/**
+	 * Prints out the gathered config data.
+	 *
+	 * @param array $data The config data to print.
+	 *
+	 * @return void
+	 */
+	public function printConfigData($data)
+	{
+		$max  = 0;
+		$keys = array_keys($data);
+		foreach ($keys as $key) {
+			$len = strlen($key);
+			if (strlen($key) > $max) {
+				$max = $len;
+			}
+		}
+
+		if ($max === 0) {
+			return;
+		}
+
+		$max += 2;
+		ksort($data);
+		foreach ($data as $name => $value) {
+			echo str_pad($name.': ', $max).$value.PHP_EOL;
+		}
+
+	}//end printConfigData()
 
 
 }//end class

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

Indentation +53 added lines, -53 removed lines

@@ -20,61 +20,61 @@
 {
 
 
-    /**
-     * Registers the tokens that this sniff wants to listen for.
-     *
-     * An example return value for a sniff that wants to listen for whitespace
-     * and any comments would be:
-     *
-     * <code>
-     *    return array(
-     *            T_WHITESPACE,
-     *            T_DOC_COMMENT,
-     *            T_COMMENT,
-     *           );
-     * </code>
-     *
-     * @return mixed[]
-     * @see    Tokens.php
-     */
-    public function register();
+	/**
+	 * Registers the tokens that this sniff wants to listen for.
+	 *
+	 * An example return value for a sniff that wants to listen for whitespace
+	 * and any comments would be:
+	 *
+	 * <code>
+	 *    return array(
+	 *            T_WHITESPACE,
+	 *            T_DOC_COMMENT,
+	 *            T_COMMENT,
+	 *           );
+	 * </code>
+	 *
+	 * @return mixed[]
+	 * @see    Tokens.php
+	 */
+	public function register();
 
 
-    /**
-     * Called when one of the token types that this sniff is listening for
-     * is found.
-     *
-     * The stackPtr variable indicates where in the stack the token was found.
-     * A sniff can acquire information this token, along with all the other
-     * tokens within the stack by first acquiring the token stack:
-     *
-     * <code>
-     *    $tokens = $phpcsFile->getTokens();
-     *    echo 'Encountered a '.$tokens[$stackPtr]['type'].' token';
-     *    echo 'token information: ';
-     *    print_r($tokens[$stackPtr]);
-     * </code>
-     *
-     * If the sniff discovers an anomaly in the code, they can raise an error
-     * by calling addError() on the \PHP_CodeSniffer\Files\File object, specifying an error
-     * message and the position of the offending token:
-     *
-     * <code>
-     *    $phpcsFile->addError('Encountered an error', $stackPtr);
-     * </code>
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where the
-     *                                               token was found.
-     * @param int                         $stackPtr  The position in the PHP_CodeSniffer
-     *                                               file's token stack where the 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.
-     */
-    public function process(File $phpcsFile, $stackPtr);
+	/**
+	 * Called when one of the token types that this sniff is listening for
+	 * is found.
+	 *
+	 * The stackPtr variable indicates where in the stack the token was found.
+	 * A sniff can acquire information this token, along with all the other
+	 * tokens within the stack by first acquiring the token stack:
+	 *
+	 * <code>
+	 *    $tokens = $phpcsFile->getTokens();
+	 *    echo 'Encountered a '.$tokens[$stackPtr]['type'].' token';
+	 *    echo 'token information: ';
+	 *    print_r($tokens[$stackPtr]);
+	 * </code>
+	 *
+	 * If the sniff discovers an anomaly in the code, they can raise an error
+	 * by calling addError() on the \PHP_CodeSniffer\Files\File object, specifying an error
+	 * message and the position of the offending token:
+	 *
+	 * <code>
+	 *    $phpcsFile->addError('Encountered an error', $stackPtr);
+	 * </code>
+	 *
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where the
+	 *                                               token was found.
+	 * @param int                         $stackPtr  The position in the PHP_CodeSniffer
+	 *                                               file's token stack where the 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.
+	 */
+	public function process(File $phpcsFile, $stackPtr);
 
 
 }//end interface

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

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.
-     *
-     * @see    PHP_CodeSniffer.getValidScopeTokeners()
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified tokens array is empty.
-     */
-    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;
-        $skipPtrs   = [];
-        foreach ($tokens[$stackPtr]['conditions'] as $scope => $code) {
-            if (isset($this->scopeTokens[$code]) === true) {
-                $skipPtrs[] = $this->processTokenWithinScope($phpcsFile, $stackPtr, $scope);
-                $foundScope = true;
-            }
-        }
-
-        if ($this->listenOutside === true && $foundScope === false) {
-            $skipPtrs[] = $this->processTokenOutsideScope($phpcsFile, $stackPtr);
-        }
-
-        if (empty($skipPtrs) === false) {
-            return min($skipPtrs);
-        }
-
-        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.
+	 *
+	 * @see    PHP_CodeSniffer.getValidScopeTokeners()
+	 * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified tokens array is empty.
+	 */
+	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;
+		$skipPtrs   = [];
+		foreach ($tokens[$stackPtr]['conditions'] as $scope => $code) {
+			if (isset($this->scopeTokens[$code]) === true) {
+				$skipPtrs[] = $this->processTokenWithinScope($phpcsFile, $stackPtr, $scope);
+				$foundScope = true;
+			}
+		}
+
+		if ($this->listenOutside === true && $foundScope === false) {
+			$skipPtrs[] = $this->processTokenOutsideScope($phpcsFile, $stackPtr);
+		}
+
+		if (empty($skipPtrs) === false) {
+			return min($skipPtrs);
+		}
+
+		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

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