jazzsequence / games-collector

vendor/squizlabs/php_codesniffer/CodeSniffer/Fixer.php

Doc Comments +2 added lines, -2 removed lines

@@ -356,7 +356,7 @@ 
     /**
      * Start recording actions for a changeset.
      *
-     * @return void
+     * @return false|null
      */
     public function beginChangeset()
     {
@@ -383,7 +383,7 @@ 
     /**
      * Stop recording actions for a changeset, and apply logged changes.
      *
-     * @return boolean
+     * @return false|null
      */
     public function endChangeset()
     {

Indentation +700 added lines, -700 removed lines

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

Switch Indentation +8 added lines, -8 removed lines

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

Spacing +164 added lines, -164 removed lines

@@ -124,7 +124,7 @@ 
      *
      * @return void
      */
-    public function startFile($phpcsFile)
+    public function startFile( $phpcsFile )
     {
         $this->_currentFile = $phpcsFile;
         $this->_numFixes    = 0;
@@ -132,11 +132,11 @@ 
 
         $tokens        = $phpcsFile->getTokens();
         $this->_tokens = array();
-        foreach ($tokens as $index => $token) {
-            if (isset($token['orig_content']) === true) {
-                $this->_tokens[$index] = $token['orig_content'];
+        foreach ( $tokens as $index => $token ) {
+            if ( isset( $token[ 'orig_content' ] ) === true ) {
+                $this->_tokens[ $index ] = $token[ 'orig_content' ];
             } else {
-                $this->_tokens[$index] = $token['content'];
+                $this->_tokens[ $index ] = $token[ 'content' ];
             }
         }
 
@@ -151,71 +151,71 @@ 
     public function fixFile()
     {
         $fixable = $this->_currentFile->getFixableCount();
-        if ($fixable === 0) {
+        if ( $fixable === 0 ) {
             // Nothing to fix.
             return false;
         }
 
         $stdin     = false;
         $cliValues = $this->_currentFile->phpcs->cli->getCommandLineValues();
-        if (empty($cliValues['files']) === true) {
+        if ( empty( $cliValues[ 'files' ] ) === true ) {
             $stdin = true;
         }
 
         $this->enabled = true;
 
         $this->loops = 0;
-        while ($this->loops < 50) {
+        while ( $this->loops < 50 ) {
             ob_start();
 
             // Only needed once file content has changed.
             $contents = $this->getContents();
 
-            if (PHP_CODESNIFFER_VERBOSITY > 2) {
+            if ( PHP_CODESNIFFER_VERBOSITY > 2 ) {
                 @ob_end_clean();
-                echo '---START FILE CONTENT---'.PHP_EOL;
-                $lines = explode($this->_currentFile->eolChar, $contents);
-                $max   = strlen(count($lines));
-                foreach ($lines as $lineNum => $line) {
+                echo '---START FILE CONTENT---' . PHP_EOL;
+                $lines = explode( $this->_currentFile->eolChar, $contents );
+                $max   = strlen( count( $lines ) );
+                foreach ( $lines as $lineNum => $line ) {
                     $lineNum++;
-                    echo str_pad($lineNum, $max, ' ', STR_PAD_LEFT).'|'.$line.PHP_EOL;
+                    echo str_pad( $lineNum, $max, ' ', STR_PAD_LEFT ) . '|' . $line . PHP_EOL;
                 }
 
-                echo '--- END FILE CONTENT ---'.PHP_EOL;
+                echo '--- END FILE CONTENT ---' . PHP_EOL;
                 ob_start();
             }
 
             $this->_inConflict = false;
             $this->_currentFile->refreshTokenListeners();
-            $this->_currentFile->start($contents);
+            $this->_currentFile->start( $contents );
             ob_end_clean();
 
             $this->loops++;
 
-            if (PHP_CODESNIFFER_CBF === true && $stdin === false) {
-                echo "\r".str_repeat(' ', 80)."\r";
+            if ( PHP_CODESNIFFER_CBF === true && $stdin === false ) {
+                echo "\r" . str_repeat( ' ', 80 ) . "\r";
                 echo "\t=> Fixing file: $this->_numFixes/$fixable violations remaining [made $this->loops pass";
-                if ($this->loops > 1) {
+                if ( $this->loops > 1 ) {
                     echo 'es';
                 }
 
                 echo ']... ';
             }
 
-            if ($this->_numFixes === 0 && $this->_inConflict === false) {
+            if ( $this->_numFixes === 0 && $this->_inConflict === false ) {
                 // Nothing left to do.
                 break;
-            } else if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                echo "\t* fixed $this->_numFixes violations, starting loop ".($this->loops + 1).' *'.PHP_EOL;
+            } else if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
+                echo "\t* fixed $this->_numFixes violations, starting loop " . ( $this->loops + 1 ) . ' *' . PHP_EOL;
             }
         }//end while
 
         $this->enabled = false;
 
-        if ($this->_numFixes > 0) {
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
+        if ( $this->_numFixes > 0 ) {
+            if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
                 @ob_end_clean();
-                echo "\t*** Reached maximum number of loops with $this->_numFixes violations left unfixed ***".PHP_EOL;
+                echo "\t*** Reached maximum number of loops with $this->_numFixes violations left unfixed ***" . PHP_EOL;
                 ob_start();
             }
 
@@ -237,65 +237,65 @@ 
      *
      * @return string
      */
-    public function generateDiff($filePath=null, $colors=true)
+    public function generateDiff( $filePath = null, $colors = true )
     {
-        if ($filePath === null) {
+        if ( $filePath === null ) {
             $filePath = $this->_currentFile->getFilename();
         }
 
-        $cwd      = getcwd().DIRECTORY_SEPARATOR;
-        $filename = str_replace($cwd, '', $filePath);
+        $cwd      = getcwd() . DIRECTORY_SEPARATOR;
+        $filename = str_replace( $cwd, '', $filePath );
         $contents = $this->getContents();
 
-        if (function_exists('sys_get_temp_dir') === true) {
+        if ( function_exists( 'sys_get_temp_dir' ) === true ) {
             // This is needed for HHVM support, but only available from 5.2.1.
-            $tempName  = tempnam(sys_get_temp_dir(), 'phpcs-fixer');
-            $fixedFile = fopen($tempName, 'w');
+            $tempName  = tempnam( sys_get_temp_dir(), 'phpcs-fixer' );
+            $fixedFile = fopen( $tempName, 'w' );
         } else {
             $fixedFile = tmpfile();
-            $data      = stream_get_meta_data($fixedFile);
-            $tempName  = $data['uri'];
+            $data      = stream_get_meta_data( $fixedFile );
+            $tempName  = $data[ 'uri' ];
         }
 
-        fwrite($fixedFile, $contents);
+        fwrite( $fixedFile, $contents );
 
         // We must use something like shell_exec() because whitespace at the end
         // of lines is critical to diff files.
         $cmd  = "diff -u -L\"$filename\" -LPHP_CodeSniffer \"$filename\" \"$tempName\"";
-        $diff = shell_exec($cmd);
+        $diff = shell_exec( $cmd );
 
-        fclose($fixedFile);
-        if (is_file($tempName) === true) {
-            unlink($tempName);
+        fclose( $fixedFile );
+        if ( is_file( $tempName ) === true ) {
+            unlink( $tempName );
         }
 
-        if ($colors === false) {
+        if ( $colors === false ) {
             return $diff;
         }
 
-        $diffLines = explode(PHP_EOL, $diff);
-        if (count($diffLines) === 1) {
+        $diffLines = explode( PHP_EOL, $diff );
+        if ( count( $diffLines ) === 1 ) {
             // Seems to be required for cygwin.
-            $diffLines = explode("\n", $diff);
+            $diffLines = explode( "\n", $diff );
         }
 
         $diff = array();
-        foreach ($diffLines as $line) {
-            if (isset($line[0]) === true) {
-                switch ($line[0]) {
+        foreach ( $diffLines as $line ) {
+            if ( isset( $line[ 0 ] ) === true ) {
+                switch ( $line[ 0 ] ) {
                 case '-':
-                    $diff[] = "\033[31m$line\033[0m";
+                    $diff[ ] = "\033[31m$line\033[0m";
                     break;
                 case '+':
-                    $diff[] = "\033[32m$line\033[0m";
+                    $diff[ ] = "\033[32m$line\033[0m";
                     break;
                 default:
-                    $diff[] = $line;
+                    $diff[ ] = $line;
                 }
             }
         }
 
-        $diff = implode(PHP_EOL, $diff);
+        $diff = implode( PHP_EOL, $diff );
 
         return $diff;
 
@@ -324,7 +324,7 @@ 
      */
     public function getContents()
     {
-        $contents = implode($this->_tokens);
+        $contents = implode( $this->_tokens );
         return $contents;
 
     }//end getContents()
@@ -340,14 +340,14 @@ 
      *
      * @return string
      */
-    public function getTokenContent($stackPtr)
+    public function getTokenContent( $stackPtr )
     {
-        if ($this->_inChangeset === true
-            && isset($this->_changeset[$stackPtr]) === true
+        if ( $this->_inChangeset === true
+            && isset( $this->_changeset[ $stackPtr ] ) === true
         ) {
-            return $this->_changeset[$stackPtr];
+            return $this->_changeset[ $stackPtr ];
         } else {
-            return $this->_tokens[$stackPtr];
+            return $this->_tokens[ $stackPtr ];
         }
 
     }//end getTokenContent()
@@ -360,17 +360,17 @@ 
      */
     public function beginChangeset()
     {
-        if ($this->_inConflict === true) {
+        if ( $this->_inConflict === true ) {
             return false;
         }
 
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
+        if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
             $bt    = debug_backtrace();
-            $sniff = $bt[1]['class'];
-            $line  = $bt[0]['line'];
+            $sniff = $bt[ 1 ][ 'class' ];
+            $line  = $bt[ 0 ][ 'line' ];
 
             @ob_end_clean();
-            echo "\t=> Changeset started by $sniff (line $line)".PHP_EOL;
+            echo "\t=> Changeset started by $sniff (line $line)" . PHP_EOL;
             ob_start();
         }
 
@@ -387,7 +387,7 @@ 
      */
     public function endChangeset()
     {
-        if ($this->_inConflict === true) {
+        if ( $this->_inConflict === true ) {
             return false;
         }
 
@@ -395,30 +395,30 @@ 
 
         $success = true;
         $applied = array();
-        foreach ($this->_changeset as $stackPtr => $content) {
-            $success = $this->replaceToken($stackPtr, $content);
-            if ($success === false) {
+        foreach ( $this->_changeset as $stackPtr => $content ) {
+            $success = $this->replaceToken( $stackPtr, $content );
+            if ( $success === false ) {
                 break;
             } else {
-                $applied[] = $stackPtr;
+                $applied[ ] = $stackPtr;
             }
         }
 
-        if ($success === false) {
+        if ( $success === false ) {
             // Rolling back all changes.
-            foreach ($applied as $stackPtr) {
-                $this->revertToken($stackPtr);
+            foreach ( $applied as $stackPtr ) {
+                $this->revertToken( $stackPtr );
             }
 
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
+            if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
                 @ob_end_clean();
-                echo "\t=> Changeset failed to apply".PHP_EOL;
+                echo "\t=> Changeset failed to apply" . PHP_EOL;
                 ob_start();
             }
-        } else if (PHP_CODESNIFFER_VERBOSITY > 1) {
-            $fixes = count($this->_changeset);
+        } else if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
+            $fixes = count( $this->_changeset );
             @ob_end_clean();
-            echo "\t=> Changeset ended: $fixes changes applied".PHP_EOL;
+            echo "\t=> Changeset ended: $fixes changes applied" . PHP_EOL;
             ob_start();
         }
 
@@ -437,22 +437,22 @@ 
         $this->_inChangeset = false;
         $this->_inConflict  = false;
 
-        if (empty($this->_changeset) === false) {
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
+        if ( empty( $this->_changeset ) === false ) {
+            if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
                 $bt = debug_backtrace();
-                if ($bt[1]['class'] === 'PHP_CodeSniffer_Fixer') {
-                    $sniff = $bt[2]['class'];
-                    $line  = $bt[1]['line'];
+                if ( $bt[ 1 ][ 'class' ] === 'PHP_CodeSniffer_Fixer' ) {
+                    $sniff = $bt[ 2 ][ 'class' ];
+                    $line  = $bt[ 1 ][ 'line' ];
                 } else {
-                    $sniff = $bt[1]['class'];
-                    $line  = $bt[0]['line'];
+                    $sniff = $bt[ 1 ][ 'class' ];
+                    $line  = $bt[ 0 ][ 'line' ];
                 }
 
-                $numChanges = count($this->_changeset);
+                $numChanges = count( $this->_changeset );
 
                 @ob_end_clean();
-                echo "\t\tR: $sniff (line $line) rolled back the changeset ($numChanges changes)".PHP_EOL;
-                echo "\t=> Changeset rolled back".PHP_EOL;
+                echo "\t\tR: $sniff (line $line) rolled back the changeset ($numChanges changes)" . PHP_EOL;
+                echo "\t=> Changeset rolled back" . PHP_EOL;
                 ob_start();
             }
 
@@ -470,117 +470,117 @@ 
      *
      * @return bool If the change was accepted.
      */
-    public function replaceToken($stackPtr, $content)
+    public function replaceToken( $stackPtr, $content )
     {
-        if ($this->_inConflict === true) {
+        if ( $this->_inConflict === true ) {
             return false;
         }
 
-        if ($this->_inChangeset === false
-            && isset($this->_fixedTokens[$stackPtr]) === true
+        if ( $this->_inChangeset === false
+            && isset( $this->_fixedTokens[ $stackPtr ] ) === true
         ) {
             $indent = "\t";
-            if (empty($this->_changeset) === false) {
+            if ( empty( $this->_changeset ) === false ) {
                 $indent .= "\t";
             }
 
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
+            if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
                 @ob_end_clean();
-                echo "$indent* token $stackPtr has already been modified, skipping *".PHP_EOL;
+                echo "$indent* token $stackPtr has already been modified, skipping *" . PHP_EOL;
                 ob_start();
             }
 
             return false;
         }
 
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
+        if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
             $bt = debug_backtrace();
-            if ($bt[1]['class'] === 'PHP_CodeSniffer_Fixer') {
-                $sniff = $bt[2]['class'];
-                $line  = $bt[1]['line'];
+            if ( $bt[ 1 ][ 'class' ] === 'PHP_CodeSniffer_Fixer' ) {
+                $sniff = $bt[ 2 ][ 'class' ];
+                $line  = $bt[ 1 ][ 'line' ];
             } else {
-                $sniff = $bt[1]['class'];
-                $line  = $bt[0]['line'];
+                $sniff = $bt[ 1 ][ 'class' ];
+                $line  = $bt[ 0 ][ 'line' ];
             }
 
             $tokens     = $this->_currentFile->getTokens();
-            $type       = $tokens[$stackPtr]['type'];
-            $oldContent = PHP_CodeSniffer::prepareForOutput($this->_tokens[$stackPtr]);
-            $newContent = PHP_CodeSniffer::prepareForOutput($content);
-            if (trim($this->_tokens[$stackPtr]) === '' && isset($this->_tokens[($stackPtr + 1)]) === true) {
+            $type       = $tokens[ $stackPtr ][ 'type' ];
+            $oldContent = PHP_CodeSniffer::prepareForOutput( $this->_tokens[ $stackPtr ] );
+            $newContent = PHP_CodeSniffer::prepareForOutput( $content );
+            if ( trim( $this->_tokens[ $stackPtr ] ) === '' && isset( $this->_tokens[ ( $stackPtr + 1 ) ] ) === true ) {
                 // Add some context for whitespace only changes.
-                $append      = PHP_CodeSniffer::prepareForOutput($this->_tokens[($stackPtr + 1)]);
+                $append      = PHP_CodeSniffer::prepareForOutput( $this->_tokens[ ( $stackPtr + 1 ) ] );
                 $oldContent .= $append;
                 $newContent .= $append;
             }
         }//end if
 
-        if ($this->_inChangeset === true) {
-            $this->_changeset[$stackPtr] = $content;
+        if ( $this->_inChangeset === true ) {
+            $this->_changeset[ $stackPtr ] = $content;
 
-            if (PHP_CODESNIFFER_VERBOSITY > 1) {
+            if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
                 @ob_end_clean();
-                echo "\t\tQ: $sniff (line $line) replaced token $stackPtr ($type) \"$oldContent\" => \"$newContent\"".PHP_EOL;
+                echo "\t\tQ: $sniff (line $line) replaced token $stackPtr ($type) \"$oldContent\" => \"$newContent\"" . PHP_EOL;
                 ob_start();
             }
 
             return true;
         }
 
-        if (isset($this->_oldTokenValues[$stackPtr]) === false) {
-            $this->_oldTokenValues[$stackPtr] = array(
+        if ( isset( $this->_oldTokenValues[ $stackPtr ] ) === false ) {
+            $this->_oldTokenValues[ $stackPtr ] = array(
                                                  'curr' => $content,
-                                                 'prev' => $this->_tokens[$stackPtr],
+                                                 'prev' => $this->_tokens[ $stackPtr ],
                                                  'loop' => $this->loops,
                                                 );
         } else {
-            if ($this->_oldTokenValues[$stackPtr]['prev'] === $content
-                && $this->_oldTokenValues[$stackPtr]['loop'] === ($this->loops - 1)
+            if ( $this->_oldTokenValues[ $stackPtr ][ 'prev' ] === $content
+                && $this->_oldTokenValues[ $stackPtr ][ 'loop' ] === ( $this->loops - 1 )
             ) {
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
+                if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
                     $indent = "\t";
-                    if (empty($this->_changeset) === false) {
+                    if ( empty( $this->_changeset ) === false ) {
                         $indent .= "\t";
                     }
 
-                    $loop = $this->_oldTokenValues[$stackPtr]['loop'];
+                    $loop = $this->_oldTokenValues[ $stackPtr ][ 'loop' ];
 
                     @ob_end_clean();
-                    echo "$indent**** $sniff (line $line) has possible conflict with another sniff on loop $loop; caused by the following change ****".PHP_EOL;
-                    echo "$indent**** replaced token $stackPtr ($type) \"$oldContent\" => \"$newContent\" ****".PHP_EOL;
+                    echo "$indent**** $sniff (line $line) has possible conflict with another sniff on loop $loop; caused by the following change ****" . PHP_EOL;
+                    echo "$indent**** replaced token $stackPtr ($type) \"$oldContent\" => \"$newContent\" ****" . PHP_EOL;
                 }
 
-                if ($this->_oldTokenValues[$stackPtr]['loop'] >= ($this->loops - 1)) {
+                if ( $this->_oldTokenValues[ $stackPtr ][ 'loop' ] >= ( $this->loops - 1 ) ) {
                     $this->_inConflict = true;
-                    if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                        echo "$indent**** ignoring all changes until next loop ****".PHP_EOL;
+                    if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
+                        echo "$indent**** ignoring all changes until next loop ****" . PHP_EOL;
                     }
                 }
 
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
+                if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
                     ob_start();
                 }
 
                 return false;
             }//end if
 
-            $this->_oldTokenValues[$stackPtr]['prev'] = $this->_oldTokenValues[$stackPtr]['curr'];
-            $this->_oldTokenValues[$stackPtr]['curr'] = $content;
-            $this->_oldTokenValues[$stackPtr]['loop'] = $this->loops;
+            $this->_oldTokenValues[ $stackPtr ][ 'prev' ] = $this->_oldTokenValues[ $stackPtr ][ 'curr' ];
+            $this->_oldTokenValues[ $stackPtr ][ 'curr' ] = $content;
+            $this->_oldTokenValues[ $stackPtr ][ 'loop' ] = $this->loops;
         }//end if
 
-        $this->_fixedTokens[$stackPtr] = $this->_tokens[$stackPtr];
-        $this->_tokens[$stackPtr]      = $content;
+        $this->_fixedTokens[ $stackPtr ] = $this->_tokens[ $stackPtr ];
+        $this->_tokens[ $stackPtr ]      = $content;
         $this->_numFixes++;
 
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
+        if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
             $indent = "\t";
-            if (empty($this->_changeset) === false) {
+            if ( empty( $this->_changeset ) === false ) {
                 $indent .= "\tA: ";
             }
 
             @ob_end_clean();
-            echo "$indent$sniff (line $line) replaced token $stackPtr ($type) \"$oldContent\" => \"$newContent\"".PHP_EOL;
+            echo "$indent$sniff (line $line) replaced token $stackPtr ($type) \"$oldContent\" => \"$newContent\"" . PHP_EOL;
             ob_start();
         }
 
@@ -596,46 +596,46 @@ 
      *
      * @return bool If a change was reverted.
      */
-    public function revertToken($stackPtr)
+    public function revertToken( $stackPtr )
     {
-        if (isset($this->_fixedTokens[$stackPtr]) === false) {
+        if ( isset( $this->_fixedTokens[ $stackPtr ] ) === false ) {
             return false;
         }
 
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
+        if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
             $bt = debug_backtrace();
-            if ($bt[1]['class'] === 'PHP_CodeSniffer_Fixer') {
-                $sniff = $bt[2]['class'];
-                $line  = $bt[1]['line'];
+            if ( $bt[ 1 ][ 'class' ] === 'PHP_CodeSniffer_Fixer' ) {
+                $sniff = $bt[ 2 ][ 'class' ];
+                $line  = $bt[ 1 ][ 'line' ];
             } else {
-                $sniff = $bt[1]['class'];
-                $line  = $bt[0]['line'];
+                $sniff = $bt[ 1 ][ 'class' ];
+                $line  = $bt[ 0 ][ 'line' ];
             }
 
             $tokens     = $this->_currentFile->getTokens();
-            $type       = $tokens[$stackPtr]['type'];
-            $oldContent = PHP_CodeSniffer::prepareForOutput($this->_tokens[$stackPtr]);
-            $newContent = PHP_CodeSniffer::prepareForOutput($this->_fixedTokens[$stackPtr]);
-            if (trim($this->_tokens[$stackPtr]) === '' && isset($tokens[($stackPtr + 1)]) === true) {
+            $type       = $tokens[ $stackPtr ][ 'type' ];
+            $oldContent = PHP_CodeSniffer::prepareForOutput( $this->_tokens[ $stackPtr ] );
+            $newContent = PHP_CodeSniffer::prepareForOutput( $this->_fixedTokens[ $stackPtr ] );
+            if ( trim( $this->_tokens[ $stackPtr ] ) === '' && isset( $tokens[ ( $stackPtr + 1 ) ] ) === true ) {
                 // Add some context for whitespace only changes.
-                $append      = PHP_CodeSniffer::prepareForOutput($this->_tokens[($stackPtr + 1)]);
+                $append      = PHP_CodeSniffer::prepareForOutput( $this->_tokens[ ( $stackPtr + 1 ) ] );
                 $oldContent .= $append;
                 $newContent .= $append;
             }
         }//end if
 
-        $this->_tokens[$stackPtr] = $this->_fixedTokens[$stackPtr];
-        unset($this->_fixedTokens[$stackPtr]);
+        $this->_tokens[ $stackPtr ] = $this->_fixedTokens[ $stackPtr ];
+        unset( $this->_fixedTokens[ $stackPtr ] );
         $this->_numFixes--;
 
-        if (PHP_CODESNIFFER_VERBOSITY > 1) {
+        if ( PHP_CODESNIFFER_VERBOSITY > 1 ) {
             $indent = "\t";
-            if (empty($this->_changeset) === false) {
+            if ( empty( $this->_changeset ) === false ) {
                 $indent .= "\tR: ";
             }
 
             @ob_end_clean();
-            echo "$indent$sniff (line $line) reverted token $stackPtr ($type) \"$oldContent\" => \"$newContent\"".PHP_EOL;
+            echo "$indent$sniff (line $line) reverted token $stackPtr ($type) \"$oldContent\" => \"$newContent\"" . PHP_EOL;
             ob_start();
         }
 
@@ -654,17 +654,17 @@ 
      *
      * @return bool If the change was accepted.
      */
-    public function substrToken($stackPtr, $start, $length=null)
+    public function substrToken( $stackPtr, $start, $length = null )
     {
-        $current = $this->getTokenContent($stackPtr);
+        $current = $this->getTokenContent( $stackPtr );
 
-        if ($length === null) {
-            $newContent = substr($current, $start);
+        if ( $length === null ) {
+            $newContent = substr( $current, $start );
         } else {
-            $newContent = substr($current, $start, $length);
+            $newContent = substr( $current, $start, $length );
         }
 
-        return $this->replaceToken($stackPtr, $newContent);
+        return $this->replaceToken( $stackPtr, $newContent );
 
     }//end substrToken()
 
@@ -676,10 +676,10 @@ 
      *
      * @return bool If the change was accepted.
      */
-    public function addNewline($stackPtr)
+    public function addNewline( $stackPtr )
     {
-        $current = $this->getTokenContent($stackPtr);
-        return $this->replaceToken($stackPtr, $current.$this->_currentFile->eolChar);
+        $current = $this->getTokenContent( $stackPtr );
+        return $this->replaceToken( $stackPtr, $current . $this->_currentFile->eolChar );
 
     }//end addNewline()
 
@@ -691,10 +691,10 @@ 
      *
      * @return bool If the change was accepted.
      */
-    public function addNewlineBefore($stackPtr)
+    public function addNewlineBefore( $stackPtr )
     {
-        $current = $this->getTokenContent($stackPtr);
-        return $this->replaceToken($stackPtr, $this->_currentFile->eolChar.$current);
+        $current = $this->getTokenContent( $stackPtr );
+        return $this->replaceToken( $stackPtr, $this->_currentFile->eolChar . $current );
 
     }//end addNewlineBefore()
 
@@ -707,10 +707,10 @@ 
      *
      * @return bool If the change was accepted.
      */
-    public function addContent($stackPtr, $content)
+    public function addContent( $stackPtr, $content )
     {
-        $current = $this->getTokenContent($stackPtr);
-        return $this->replaceToken($stackPtr, $current.$content);
+        $current = $this->getTokenContent( $stackPtr );
+        return $this->replaceToken( $stackPtr, $current . $content );
 
     }//end addContent()
 
@@ -723,10 +723,10 @@ 
      *
      * @return bool If the change was accepted.
      */
-    public function addContentBefore($stackPtr, $content)
+    public function addContentBefore( $stackPtr, $content )
     {
-        $current = $this->getTokenContent($stackPtr);
-        return $this->replaceToken($stackPtr, $content.$current);
+        $current = $this->getTokenContent( $stackPtr );
+        return $this->replaceToken( $stackPtr, $content . $current );
 
     }//end addContentBefore()
 

Braces +17 added lines, -34 removed lines

@@ -26,8 +26,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class PHP_CodeSniffer_Fixer
-{
+class PHP_CodeSniffer_Fixer {
 
     /**
      * Is the fixer enabled and fixing a file?
@@ -124,8 +123,7 @@ 
      *
      * @return void
      */
-    public function startFile($phpcsFile)
-    {
+    public function startFile($phpcsFile) {
         $this->_currentFile = $phpcsFile;
         $this->_numFixes    = 0;
         $this->_fixedTokens = array();
@@ -148,8 +146,7 @@ 
      *
      * @return boolean
      */
-    public function fixFile()
-    {
+    public function fixFile() {
         $fixable = $this->_currentFile->getFixableCount();
         if ($fixable === 0) {
             // Nothing to fix.
@@ -237,8 +234,7 @@ 
      *
      * @return string
      */
-    public function generateDiff($filePath=null, $colors=true)
-    {
+    public function generateDiff($filePath=null, $colors=true) {
         if ($filePath === null) {
             $filePath = $this->_currentFile->getFilename();
         }
@@ -310,8 +306,7 @@ 
      *
      * @return int
      */
-    public function getFixCount()
-    {
+    public function getFixCount() {
         return $this->_numFixes;
 
     }//end getFixCount()
@@ -322,8 +317,7 @@ 
      *
      * @return string
      */
-    public function getContents()
-    {
+    public function getContents() {
         $contents = implode($this->_tokens);
         return $contents;
 
@@ -340,8 +334,7 @@ 
      *
      * @return string
      */
-    public function getTokenContent($stackPtr)
-    {
+    public function getTokenContent($stackPtr) {
         if ($this->_inChangeset === true
             && isset($this->_changeset[$stackPtr]) === true
         ) {
@@ -358,8 +351,7 @@ 
      *
      * @return void
      */
-    public function beginChangeset()
-    {
+    public function beginChangeset() {
         if ($this->_inConflict === true) {
             return false;
         }
@@ -385,8 +377,7 @@ 
      *
      * @return boolean
      */
-    public function endChangeset()
-    {
+    public function endChangeset() {
         if ($this->_inConflict === true) {
             return false;
         }
@@ -432,8 +423,7 @@ 
      *
      * @return void
      */
-    public function rollbackChangeset()
-    {
+    public function rollbackChangeset() {
         $this->_inChangeset = false;
         $this->_inConflict  = false;
 
@@ -470,8 +460,7 @@ 
      *
      * @return bool If the change was accepted.
      */
-    public function replaceToken($stackPtr, $content)
-    {
+    public function replaceToken($stackPtr, $content) {
         if ($this->_inConflict === true) {
             return false;
         }
@@ -596,8 +585,7 @@ 
      *
      * @return bool If a change was reverted.
      */
-    public function revertToken($stackPtr)
-    {
+    public function revertToken($stackPtr) {
         if (isset($this->_fixedTokens[$stackPtr]) === false) {
             return false;
         }
@@ -654,8 +642,7 @@ 
      *
      * @return bool If the change was accepted.
      */
-    public function substrToken($stackPtr, $start, $length=null)
-    {
+    public function substrToken($stackPtr, $start, $length=null) {
         $current = $this->getTokenContent($stackPtr);
 
         if ($length === null) {
@@ -676,8 +663,7 @@ 
      *
      * @return bool If the change was accepted.
      */
-    public function addNewline($stackPtr)
-    {
+    public function addNewline($stackPtr) {
         $current = $this->getTokenContent($stackPtr);
         return $this->replaceToken($stackPtr, $current.$this->_currentFile->eolChar);
 
@@ -691,8 +677,7 @@ 
      *
      * @return bool If the change was accepted.
      */
-    public function addNewlineBefore($stackPtr)
-    {
+    public function addNewlineBefore($stackPtr) {
         $current = $this->getTokenContent($stackPtr);
         return $this->replaceToken($stackPtr, $this->_currentFile->eolChar.$current);
 
@@ -707,8 +692,7 @@ 
      *
      * @return bool If the change was accepted.
      */
-    public function addContent($stackPtr, $content)
-    {
+    public function addContent($stackPtr, $content) {
         $current = $this->getTokenContent($stackPtr);
         return $this->replaceToken($stackPtr, $current.$content);
 
@@ -723,8 +707,7 @@ 
      *
      * @return bool If the change was accepted.
      */
-    public function addContentBefore($stackPtr, $content)
-    {
+    public function addContentBefore($stackPtr, $content) {
         $current = $this->getTokenContent($stackPtr);
         return $this->replaceToken($stackPtr, $content.$current);
 

vendor/squizlabs/php_codesniffer/CodeSniffer/Reports/Cbf.php

Doc Comments +1 added lines, -1 removed lines

@@ -49,7 +49,7 @@
      * @param boolean              $showSources Show sources?
      * @param int                  $width       Maximum allowed line width.
      *
-     * @return boolean
+     * @return null|boolean
      */
     public function generateFileReport(
         $report,

Indentation +109 added lines, -109 removed lines

@@ -37,115 +37,115 @@
 {
 
 
-    /**
-     * Generate a partial report for a single processed file.
-     *
-     * Function should return TRUE if it printed or stored data about the file
-     * and FALSE if it ignored the file. Returning TRUE indicates that the file and
-     * its data should be counted in the grand totals.
-     *
-     * @param array                $report      Prepared report data.
-     * @param PHP_CodeSniffer_File $phpcsFile   The file being reported on.
-     * @param boolean              $showSources Show sources?
-     * @param int                  $width       Maximum allowed line width.
-     *
-     * @return boolean
-     */
-    public function generateFileReport(
-        $report,
-        PHP_CodeSniffer_File $phpcsFile,
-        $showSources=false,
-        $width=80
-    ) {
-        $cliValues = $phpcsFile->phpcs->cli->getCommandLineValues();
-        $errors    = $phpcsFile->getFixableCount();
-        if ($errors !== 0) {
-            if (empty($cliValues['files']) === false) {
-                ob_end_clean();
-                $errors    = $phpcsFile->getFixableCount();
-                $startTime = microtime(true);
-                echo "\t=> Fixing file: $errors/$errors violations remaining";
-            }
-
-            $fixed = $phpcsFile->fixer->fixFile();
-        }
-
-        if (empty($cliValues['files']) === true) {
-            // Replacing STDIN, so output current file to STDOUT
-            // even if nothing was fixed. Exit here because we
-            // can't process any more than 1 file in this setup.
-            echo $phpcsFile->fixer->getContents();
-            ob_end_flush();
-            exit(1);
-        }
-
-        if ($errors === 0) {
-            return false;
-        }
-
-        if ($fixed === false) {
-            echo 'ERROR';
-        } else {
-            echo 'DONE';
-        }
-
-        $timeTaken = ((microtime(true) - $startTime) * 1000);
-        if ($timeTaken < 1000) {
-            $timeTaken = round($timeTaken);
-            echo " in {$timeTaken}ms".PHP_EOL;
-        } else {
-            $timeTaken = round(($timeTaken / 1000), 2);
-            echo " in $timeTaken secs".PHP_EOL;
-        }
-
-        if ($fixed === true) {
-            $newFilename = $report['filename'].$cliValues['phpcbf-suffix'];
-            $newContent  = $phpcsFile->fixer->getContents();
-            file_put_contents($newFilename, $newContent);
-
-            if ($newFilename === $report['filename']) {
-                echo "\t=> File was overwritten".PHP_EOL;
-            } else {
-                echo "\t=> Fixed file written to ".basename($newFilename).PHP_EOL;
-            }
-        }
-
-        ob_start();
-
-        return $fixed;
-
-    }//end generateFileReport()
-
-
-    /**
-     * Prints all errors and warnings for each file processed.
-     *
-     * @param string  $cachedData    Any partial report data that was returned from
-     *                               generateFileReport during the run.
-     * @param int     $totalFiles    Total number of files processed during the run.
-     * @param int     $totalErrors   Total number of errors found during the run.
-     * @param int     $totalWarnings Total number of warnings found during the run.
-     * @param int     $totalFixable  Total number of problems that can be fixed.
-     * @param boolean $showSources   Show sources?
-     * @param int     $width         Maximum allowed line width.
-     * @param boolean $toScreen      Is the report being printed to screen?
-     *
-     * @return void
-     */
-    public function generate(
-        $cachedData,
-        $totalFiles,
-        $totalErrors,
-        $totalWarnings,
-        $totalFixable,
-        $showSources=false,
-        $width=80,
-        $toScreen=true
-    ) {
-        echo $cachedData;
-        echo "Fixed $totalFiles files".PHP_EOL;
-
-    }//end generate()
+	 /**
+	  * Generate a partial report for a single processed file.
+	  *
+	  * Function should return TRUE if it printed or stored data about the file
+	  * and FALSE if it ignored the file. Returning TRUE indicates that the file and
+	  * its data should be counted in the grand totals.
+	  *
+	  * @param array                $report      Prepared report data.
+	  * @param PHP_CodeSniffer_File $phpcsFile   The file being reported on.
+	  * @param boolean              $showSources Show sources?
+	  * @param int                  $width       Maximum allowed line width.
+	  *
+	  * @return boolean
+	  */
+	 public function generateFileReport(
+		  $report,
+		  PHP_CodeSniffer_File $phpcsFile,
+		  $showSources=false,
+		  $width=80
+	 ) {
+		  $cliValues = $phpcsFile->phpcs->cli->getCommandLineValues();
+		  $errors    = $phpcsFile->getFixableCount();
+		  if ($errors !== 0) {
+				if (empty($cliValues['files']) === false) {
+					 ob_end_clean();
+					 $errors    = $phpcsFile->getFixableCount();
+					 $startTime = microtime(true);
+					 echo "\t=> Fixing file: $errors/$errors violations remaining";
+				}
+
+				$fixed = $phpcsFile->fixer->fixFile();
+		  }
+
+		  if (empty($cliValues['files']) === true) {
+				// Replacing STDIN, so output current file to STDOUT
+				// even if nothing was fixed. Exit here because we
+				// can't process any more than 1 file in this setup.
+				echo $phpcsFile->fixer->getContents();
+				ob_end_flush();
+				exit(1);
+		  }
+
+		  if ($errors === 0) {
+				return false;
+		  }
+
+		  if ($fixed === false) {
+				echo 'ERROR';
+		  } else {
+				echo 'DONE';
+		  }
+
+		  $timeTaken = ((microtime(true) - $startTime) * 1000);
+		  if ($timeTaken < 1000) {
+				$timeTaken = round($timeTaken);
+				echo " in {$timeTaken}ms".PHP_EOL;
+		  } else {
+				$timeTaken = round(($timeTaken / 1000), 2);
+				echo " in $timeTaken secs".PHP_EOL;
+		  }
+
+		  if ($fixed === true) {
+				$newFilename = $report['filename'].$cliValues['phpcbf-suffix'];
+				$newContent  = $phpcsFile->fixer->getContents();
+				file_put_contents($newFilename, $newContent);
+
+				if ($newFilename === $report['filename']) {
+					 echo "\t=> File was overwritten".PHP_EOL;
+				} else {
+					 echo "\t=> Fixed file written to ".basename($newFilename).PHP_EOL;
+				}
+		  }
+
+		  ob_start();
+
+		  return $fixed;
+
+	 }//end generateFileReport()
+
+
+	 /**
+	  * Prints all errors and warnings for each file processed.
+	  *
+	  * @param string  $cachedData    Any partial report data that was returned from
+	  *                               generateFileReport during the run.
+	  * @param int     $totalFiles    Total number of files processed during the run.
+	  * @param int     $totalErrors   Total number of errors found during the run.
+	  * @param int     $totalWarnings Total number of warnings found during the run.
+	  * @param int     $totalFixable  Total number of problems that can be fixed.
+	  * @param boolean $showSources   Show sources?
+	  * @param int     $width         Maximum allowed line width.
+	  * @param boolean $toScreen      Is the report being printed to screen?
+	  *
+	  * @return void
+	  */
+	 public function generate(
+		  $cachedData,
+		  $totalFiles,
+		  $totalErrors,
+		  $totalWarnings,
+		  $totalFixable,
+		  $showSources=false,
+		  $width=80,
+		  $toScreen=true
+	 ) {
+		  echo $cachedData;
+		  echo "Fixed $totalFiles files".PHP_EOL;
+
+	 }//end generate()
 
 
 }//end class

Spacing +25 added lines, -25 removed lines

@@ -54,59 +54,59 @@ 
     public function generateFileReport(
         $report,
         PHP_CodeSniffer_File $phpcsFile,
-        $showSources=false,
-        $width=80
+        $showSources = false,
+        $width = 80
     ) {
         $cliValues = $phpcsFile->phpcs->cli->getCommandLineValues();
         $errors    = $phpcsFile->getFixableCount();
-        if ($errors !== 0) {
-            if (empty($cliValues['files']) === false) {
+        if ( $errors !== 0 ) {
+            if ( empty( $cliValues[ 'files' ] ) === false ) {
                 ob_end_clean();
                 $errors    = $phpcsFile->getFixableCount();
-                $startTime = microtime(true);
+                $startTime = microtime( true );
                 echo "\t=> Fixing file: $errors/$errors violations remaining";
             }
 
             $fixed = $phpcsFile->fixer->fixFile();
         }
 
-        if (empty($cliValues['files']) === true) {
+        if ( empty( $cliValues[ 'files' ] ) === true ) {
             // Replacing STDIN, so output current file to STDOUT
             // even if nothing was fixed. Exit here because we
             // can't process any more than 1 file in this setup.
             echo $phpcsFile->fixer->getContents();
             ob_end_flush();
-            exit(1);
+            exit( 1 );
         }
 
-        if ($errors === 0) {
+        if ( $errors === 0 ) {
             return false;
         }
 
-        if ($fixed === false) {
+        if ( $fixed === false ) {
             echo 'ERROR';
         } else {
             echo 'DONE';
         }
 
-        $timeTaken = ((microtime(true) - $startTime) * 1000);
-        if ($timeTaken < 1000) {
-            $timeTaken = round($timeTaken);
-            echo " in {$timeTaken}ms".PHP_EOL;
+        $timeTaken = ( ( microtime( true ) - $startTime ) * 1000 );
+        if ( $timeTaken < 1000 ) {
+            $timeTaken = round( $timeTaken );
+            echo " in {$timeTaken}ms" . PHP_EOL;
         } else {
-            $timeTaken = round(($timeTaken / 1000), 2);
-            echo " in $timeTaken secs".PHP_EOL;
+            $timeTaken = round( ( $timeTaken / 1000 ), 2 );
+            echo " in $timeTaken secs" . PHP_EOL;
         }
 
-        if ($fixed === true) {
-            $newFilename = $report['filename'].$cliValues['phpcbf-suffix'];
+        if ( $fixed === true ) {
+            $newFilename = $report[ 'filename' ] . $cliValues[ 'phpcbf-suffix' ];
             $newContent  = $phpcsFile->fixer->getContents();
-            file_put_contents($newFilename, $newContent);
+            file_put_contents( $newFilename, $newContent );
 
-            if ($newFilename === $report['filename']) {
-                echo "\t=> File was overwritten".PHP_EOL;
+            if ( $newFilename === $report[ 'filename' ] ) {
+                echo "\t=> File was overwritten" . PHP_EOL;
             } else {
-                echo "\t=> Fixed file written to ".basename($newFilename).PHP_EOL;
+                echo "\t=> Fixed file written to " . basename( $newFilename ) . PHP_EOL;
             }
         }
 
@@ -138,12 +138,12 @@ 
         $totalErrors,
         $totalWarnings,
         $totalFixable,
-        $showSources=false,
-        $width=80,
-        $toScreen=true
+        $showSources = false,
+        $width = 80,
+        $toScreen = true
     ) {
         echo $cachedData;
-        echo "Fixed $totalFiles files".PHP_EOL;
+        echo "Fixed $totalFiles files" . PHP_EOL;
 
     }//end generate()
 

Braces +1 added lines, -2 removed lines

@@ -33,8 +33,7 @@
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class PHP_CodeSniffer_Reports_Cbf implements PHP_CodeSniffer_Report
-{
+class PHP_CodeSniffer_Reports_Cbf implements PHP_CodeSniffer_Report {
 
 
     /**

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/JumbledIncrementerSniff.php

Doc Comments +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
     /**
      * Registers the tokens that this sniff wants to listen for.
      *
-     * @return int[]
+     * @return integer[]
      */
     public function register()
     {

Indentation +93 added lines, -93 removed lines

@@ -48,99 +48,99 @@
 {
 
 
-    /**
-     * Registers the tokens that this sniff wants to listen for.
-     *
-     * @return int[]
-     */
-    public function register()
-    {
-        return array(T_FOR);
-
-    }//end register()
-
-
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-        $token  = $tokens[$stackPtr];
-
-        // Skip for-loop without body.
-        if (isset($token['scope_opener']) === false) {
-            return;
-        }
-
-        // Find incrementors for outer loop.
-        $outer = $this->findIncrementers($tokens, $token);
-
-        // Skip if empty.
-        if (count($outer) === 0) {
-            return;
-        }
-
-        // Find nested for loops.
-        $start = ++$token['scope_opener'];
-        $end   = --$token['scope_closer'];
-
-        for (; $start <= $end; ++$start) {
-            if ($tokens[$start]['code'] !== T_FOR) {
-                continue;
-            }
-
-            $inner = $this->findIncrementers($tokens, $tokens[$start]);
-            $diff  = array_intersect($outer, $inner);
-
-            if (count($diff) !== 0) {
-                $error = 'Loop incrementor (%s) jumbling with inner loop';
-                $data  = array(join(', ', $diff));
-                $phpcsFile->addWarning($error, $stackPtr, 'Found', $data);
-            }
-        }
-
-    }//end process()
-
-
-    /**
-     * Get all used variables in the incrementer part of a for statement.
-     *
-     * @param array(integer=>array) $tokens Array with all code sniffer tokens.
-     * @param array(string=>mixed)  $token  Current for loop token
-     *
-     * @return string[] List of all found incrementer variables.
-     */
-    protected function findIncrementers(array $tokens, array $token)
-    {
-        // Skip invalid statement.
-        if (isset($token['parenthesis_opener']) === false) {
-            return array();
-        }
-
-        $start = ++$token['parenthesis_opener'];
-        $end   = --$token['parenthesis_closer'];
-
-        $incrementers = array();
-        $semicolons   = 0;
-        for ($next = $start; $next <= $end; ++$next) {
-            $code = $tokens[$next]['code'];
-            if ($code === T_SEMICOLON) {
-                ++$semicolons;
-            } else if ($semicolons === 2 && $code === T_VARIABLE) {
-                $incrementers[] = $tokens[$next]['content'];
-            }
-        }
-
-        return $incrementers;
-
-    }//end findIncrementers()
+	 /**
+	  * Registers the tokens that this sniff wants to listen for.
+	  *
+	  * @return int[]
+	  */
+	 public function register()
+	 {
+		  return array(T_FOR);
+
+	 }//end register()
+
+
+	 /**
+	  * Processes this test, when one of its tokens is encountered.
+	  *
+	  * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+	  * @param int                  $stackPtr  The position of the current token
+	  *                                        in the stack passed in $tokens.
+	  *
+	  * @return void
+	  */
+	 public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+	 {
+		  $tokens = $phpcsFile->getTokens();
+		  $token  = $tokens[$stackPtr];
+
+		  // Skip for-loop without body.
+		  if (isset($token['scope_opener']) === false) {
+				return;
+		  }
+
+		  // Find incrementors for outer loop.
+		  $outer = $this->findIncrementers($tokens, $token);
+
+		  // Skip if empty.
+		  if (count($outer) === 0) {
+				return;
+		  }
+
+		  // Find nested for loops.
+		  $start = ++$token['scope_opener'];
+		  $end   = --$token['scope_closer'];
+
+		  for (; $start <= $end; ++$start) {
+				if ($tokens[$start]['code'] !== T_FOR) {
+					 continue;
+				}
+
+				$inner = $this->findIncrementers($tokens, $tokens[$start]);
+				$diff  = array_intersect($outer, $inner);
+
+				if (count($diff) !== 0) {
+					 $error = 'Loop incrementor (%s) jumbling with inner loop';
+					 $data  = array(join(', ', $diff));
+					 $phpcsFile->addWarning($error, $stackPtr, 'Found', $data);
+				}
+		  }
+
+	 }//end process()
+
+
+	 /**
+	  * Get all used variables in the incrementer part of a for statement.
+	  *
+	  * @param array(integer=>array) $tokens Array with all code sniffer tokens.
+	  * @param array(string=>mixed)  $token  Current for loop token
+	  *
+	  * @return string[] List of all found incrementer variables.
+	  */
+	 protected function findIncrementers(array $tokens, array $token)
+	 {
+		  // Skip invalid statement.
+		  if (isset($token['parenthesis_opener']) === false) {
+				return array();
+		  }
+
+		  $start = ++$token['parenthesis_opener'];
+		  $end   = --$token['parenthesis_closer'];
+
+		  $incrementers = array();
+		  $semicolons   = 0;
+		  for ($next = $start; $next <= $end; ++$next) {
+				$code = $tokens[$next]['code'];
+				if ($code === T_SEMICOLON) {
+					 ++$semicolons;
+				} else if ($semicolons === 2 && $code === T_VARIABLE) {
+					 $incrementers[] = $tokens[$next]['content'];
+				}
+		  }
+
+		  return $incrementers;
+
+	 }//end findIncrementers()
 
 
 }//end class

Spacing +24 added lines, -24 removed lines

@@ -55,7 +55,7 @@ 
      */
     public function register()
     {
-        return array(T_FOR);
+        return array( T_FOR );
 
     }//end register()
 
@@ -69,40 +69,40 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $tokens = $phpcsFile->getTokens();
-        $token  = $tokens[$stackPtr];
+        $token  = $tokens[ $stackPtr ];
 
         // Skip for-loop without body.
-        if (isset($token['scope_opener']) === false) {
+        if ( isset( $token[ 'scope_opener' ] ) === false ) {
             return;
         }
 
         // Find incrementors for outer loop.
-        $outer = $this->findIncrementers($tokens, $token);
+        $outer = $this->findIncrementers( $tokens, $token );
 
         // Skip if empty.
-        if (count($outer) === 0) {
+        if ( count( $outer ) === 0 ) {
             return;
         }
 
         // Find nested for loops.
-        $start = ++$token['scope_opener'];
-        $end   = --$token['scope_closer'];
+        $start = ++$token[ 'scope_opener' ];
+        $end   = --$token[ 'scope_closer' ];
 
-        for (; $start <= $end; ++$start) {
-            if ($tokens[$start]['code'] !== T_FOR) {
+        for ( ; $start <= $end; ++$start ) {
+            if ( $tokens[ $start ][ 'code' ] !== T_FOR ) {
                 continue;
             }
 
-            $inner = $this->findIncrementers($tokens, $tokens[$start]);
-            $diff  = array_intersect($outer, $inner);
+            $inner = $this->findIncrementers( $tokens, $tokens[ $start ] );
+            $diff  = array_intersect( $outer, $inner );
 
-            if (count($diff) !== 0) {
+            if ( count( $diff ) !== 0 ) {
                 $error = 'Loop incrementor (%s) jumbling with inner loop';
-                $data  = array(join(', ', $diff));
-                $phpcsFile->addWarning($error, $stackPtr, 'Found', $data);
+                $data  = array( join( ', ', $diff ) );
+                $phpcsFile->addWarning( $error, $stackPtr, 'Found', $data );
             }
         }
 
@@ -117,24 +117,24 @@ 
      *
      * @return string[] List of all found incrementer variables.
      */
-    protected function findIncrementers(array $tokens, array $token)
+    protected function findIncrementers( array $tokens, array $token )
     {
         // Skip invalid statement.
-        if (isset($token['parenthesis_opener']) === false) {
+        if ( isset( $token[ 'parenthesis_opener' ] ) === false ) {
             return array();
         }
 
-        $start = ++$token['parenthesis_opener'];
-        $end   = --$token['parenthesis_closer'];
+        $start = ++$token[ 'parenthesis_opener' ];
+        $end   = --$token[ 'parenthesis_closer' ];
 
         $incrementers = array();
         $semicolons   = 0;
-        for ($next = $start; $next <= $end; ++$next) {
-            $code = $tokens[$next]['code'];
-            if ($code === T_SEMICOLON) {
+        for ( $next = $start; $next <= $end; ++$next ) {
+            $code = $tokens[ $next ][ 'code' ];
+            if ( $code === T_SEMICOLON ) {
                 ++$semicolons;
-            } else if ($semicolons === 2 && $code === T_VARIABLE) {
-                $incrementers[] = $tokens[$next]['content'];
+            } else if ( $semicolons === 2 && $code === T_VARIABLE ) {
+                $incrementers[ ] = $tokens[ $next ][ 'content' ];
             }
         }
 

Braces +4 added lines, -8 removed lines

@@ -44,8 +44,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class Generic_Sniffs_CodeAnalysis_JumbledIncrementerSniff implements PHP_CodeSniffer_Sniff
-{
+class Generic_Sniffs_CodeAnalysis_JumbledIncrementerSniff implements PHP_CodeSniffer_Sniff {
 
 
     /**
@@ -53,8 +52,7 @@ 
      *
      * @return int[]
      */
-    public function register()
-    {
+    public function register() {
         return array(T_FOR);
 
     }//end register()
@@ -69,8 +67,7 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $tokens = $phpcsFile->getTokens();
         $token  = $tokens[$stackPtr];
 
@@ -117,8 +114,7 @@ 
      *
      * @return string[] List of all found incrementer variables.
      */
-    protected function findIncrementers(array $tokens, array $token)
-    {
+    protected function findIncrementers(array $tokens, array $token) {
         // Skip invalid statement.
         if (isset($token['parenthesis_opener']) === false) {
             return array();

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/UselessOverridingMethodSniff.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
     /**
      * Registers the tokens that this sniff wants to listen for.
      *
-     * @return int[]
+     * @return integer[]
      */
     public function register()
     {

Indentation +133 added lines, -133 removed lines

@@ -40,139 +40,139 @@
 {
 
 
-    /**
-     * Registers the tokens that this sniff wants to listen for.
-     *
-     * @return int[]
-     */
-    public function register()
-    {
-        return array(T_FUNCTION);
-
-    }//end register()
-
-
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-        $token  = $tokens[$stackPtr];
-
-        // Skip function without body.
-        if (isset($token['scope_opener']) === false) {
-            return;
-        }
-
-        // Get function name.
-        $methodName = $phpcsFile->getDeclarationName($stackPtr);
-
-        // Get all parameters from method signature.
-        $signature = array();
-        foreach ($phpcsFile->getMethodParameters($stackPtr) as $param) {
-            $signature[] = $param['name'];
-        }
-
-        $next = ++$token['scope_opener'];
-        $end  = --$token['scope_closer'];
-
-        for (; $next <= $end; ++$next) {
-            $code = $tokens[$next]['code'];
-
-            if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === true) {
-                continue;
-            } else if ($code === T_RETURN) {
-                continue;
-            }
-
-            break;
-        }
-
-        // Any token except 'parent' indicates correct code.
-        if ($tokens[$next]['code'] !== T_PARENT) {
-            return;
-        }
-
-        // Find next non empty token index, should be double colon.
-        $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
-
-        // Skip for invalid code.
-        if ($next === false || $tokens[$next]['code'] !== T_DOUBLE_COLON) {
-            return;
-        }
-
-        // Find next non empty token index, should be the function name.
-        $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
-
-        // Skip for invalid code or other method.
-        if ($next === false || $tokens[$next]['content'] !== $methodName) {
-            return;
-        }
-
-        // Find next non empty token index, should be the open parenthesis.
-        $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
-
-        // Skip for invalid code.
-        if ($next === false || $tokens[$next]['code'] !== T_OPEN_PARENTHESIS) {
-            return;
-        }
-
-        $validParameterTypes = array(
-                                T_VARIABLE,
-                                T_LNUMBER,
-                                T_CONSTANT_ENCAPSED_STRING,
-                               );
-
-        $parameters       = array('');
-        $parenthesisCount = 1;
-        $count            = count($tokens);
-        for (++$next; $next < $count; ++$next) {
-            $code = $tokens[$next]['code'];
-
-            if ($code === T_OPEN_PARENTHESIS) {
-                ++$parenthesisCount;
-            } else if ($code === T_CLOSE_PARENTHESIS) {
-                --$parenthesisCount;
-            } else if ($parenthesisCount === 1 && $code === T_COMMA) {
-                $parameters[] = '';
-            } else if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === false) {
-                $parameters[(count($parameters) - 1)] .= $tokens[$next]['content'];
-            }
-
-            if ($parenthesisCount === 0) {
-                break;
-            }
-        }//end for
-
-        $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
-        if ($next === false || $tokens[$next]['code'] !== T_SEMICOLON) {
-            return;
-        }
-
-        // Check rest of the scope.
-        for (++$next; $next <= $end; ++$next) {
-            $code = $tokens[$next]['code'];
-            // Skip for any other content.
-            if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === false) {
-                return;
-            }
-        }
-
-        $parameters = array_map('trim', $parameters);
-        $parameters = array_filter($parameters);
-
-        if (count($parameters) === count($signature) && $parameters === $signature) {
-            $phpcsFile->addWarning('Possible useless method overriding detected', $stackPtr, 'Found');
-        }
-
-    }//end process()
+	 /**
+	  * Registers the tokens that this sniff wants to listen for.
+	  *
+	  * @return int[]
+	  */
+	 public function register()
+	 {
+		  return array(T_FUNCTION);
+
+	 }//end register()
+
+
+	 /**
+	  * Processes this test, when one of its tokens is encountered.
+	  *
+	  * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+	  * @param int                  $stackPtr  The position of the current token
+	  *                                        in the stack passed in $tokens.
+	  *
+	  * @return void
+	  */
+	 public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+	 {
+		  $tokens = $phpcsFile->getTokens();
+		  $token  = $tokens[$stackPtr];
+
+		  // Skip function without body.
+		  if (isset($token['scope_opener']) === false) {
+				return;
+		  }
+
+		  // Get function name.
+		  $methodName = $phpcsFile->getDeclarationName($stackPtr);
+
+		  // Get all parameters from method signature.
+		  $signature = array();
+		  foreach ($phpcsFile->getMethodParameters($stackPtr) as $param) {
+				$signature[] = $param['name'];
+		  }
+
+		  $next = ++$token['scope_opener'];
+		  $end  = --$token['scope_closer'];
+
+		  for (; $next <= $end; ++$next) {
+				$code = $tokens[$next]['code'];
+
+				if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === true) {
+					 continue;
+				} else if ($code === T_RETURN) {
+					 continue;
+				}
+
+				break;
+		  }
+
+		  // Any token except 'parent' indicates correct code.
+		  if ($tokens[$next]['code'] !== T_PARENT) {
+				return;
+		  }
+
+		  // Find next non empty token index, should be double colon.
+		  $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
+
+		  // Skip for invalid code.
+		  if ($next === false || $tokens[$next]['code'] !== T_DOUBLE_COLON) {
+				return;
+		  }
+
+		  // Find next non empty token index, should be the function name.
+		  $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
+
+		  // Skip for invalid code or other method.
+		  if ($next === false || $tokens[$next]['content'] !== $methodName) {
+				return;
+		  }
+
+		  // Find next non empty token index, should be the open parenthesis.
+		  $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
+
+		  // Skip for invalid code.
+		  if ($next === false || $tokens[$next]['code'] !== T_OPEN_PARENTHESIS) {
+				return;
+		  }
+
+		  $validParameterTypes = array(
+										  T_VARIABLE,
+										  T_LNUMBER,
+										  T_CONSTANT_ENCAPSED_STRING,
+										 );
+
+		  $parameters       = array('');
+		  $parenthesisCount = 1;
+		  $count            = count($tokens);
+		  for (++$next; $next < $count; ++$next) {
+				$code = $tokens[$next]['code'];
+
+				if ($code === T_OPEN_PARENTHESIS) {
+					 ++$parenthesisCount;
+				} else if ($code === T_CLOSE_PARENTHESIS) {
+					 --$parenthesisCount;
+				} else if ($parenthesisCount === 1 && $code === T_COMMA) {
+					 $parameters[] = '';
+				} else if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === false) {
+					 $parameters[(count($parameters) - 1)] .= $tokens[$next]['content'];
+				}
+
+				if ($parenthesisCount === 0) {
+					 break;
+				}
+		  }//end for
+
+		  $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
+		  if ($next === false || $tokens[$next]['code'] !== T_SEMICOLON) {
+				return;
+		  }
+
+		  // Check rest of the scope.
+		  for (++$next; $next <= $end; ++$next) {
+				$code = $tokens[$next]['code'];
+				// Skip for any other content.
+				if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === false) {
+					 return;
+				}
+		  }
+
+		  $parameters = array_map('trim', $parameters);
+		  $parameters = array_filter($parameters);
+
+		  if (count($parameters) === count($signature) && $parameters === $signature) {
+				$phpcsFile->addWarning('Possible useless method overriding detected', $stackPtr, 'Found');
+		  }
+
+	 }//end process()
 
 
 }//end class

Spacing +38 added lines, -38 removed lines

@@ -47,7 +47,7 @@ 
      */
     public function register()
     {
-        return array(T_FUNCTION);
+        return array( T_FUNCTION );
 
     }//end register()
 
@@ -61,34 +61,34 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $tokens = $phpcsFile->getTokens();
-        $token  = $tokens[$stackPtr];
+        $token  = $tokens[ $stackPtr ];
 
         // Skip function without body.
-        if (isset($token['scope_opener']) === false) {
+        if ( isset( $token[ 'scope_opener' ] ) === false ) {
             return;
         }
 
         // Get function name.
-        $methodName = $phpcsFile->getDeclarationName($stackPtr);
+        $methodName = $phpcsFile->getDeclarationName( $stackPtr );
 
         // Get all parameters from method signature.
         $signature = array();
-        foreach ($phpcsFile->getMethodParameters($stackPtr) as $param) {
-            $signature[] = $param['name'];
+        foreach ( $phpcsFile->getMethodParameters( $stackPtr ) as $param ) {
+            $signature[ ] = $param[ 'name' ];
         }
 
-        $next = ++$token['scope_opener'];
-        $end  = --$token['scope_closer'];
+        $next = ++$token[ 'scope_opener' ];
+        $end  = --$token[ 'scope_closer' ];
 
-        for (; $next <= $end; ++$next) {
-            $code = $tokens[$next]['code'];
+        for ( ; $next <= $end; ++$next ) {
+            $code = $tokens[ $next ][ 'code' ];
 
-            if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === true) {
+            if ( isset( PHP_CodeSniffer_Tokens::$emptyTokens[ $code ] ) === true ) {
                 continue;
-            } else if ($code === T_RETURN) {
+            } else if ( $code === T_RETURN ) {
                 continue;
             }
 
@@ -96,31 +96,31 @@ 
         }
 
         // Any token except 'parent' indicates correct code.
-        if ($tokens[$next]['code'] !== T_PARENT) {
+        if ( $tokens[ $next ][ 'code' ] !== T_PARENT ) {
             return;
         }
 
         // Find next non empty token index, should be double colon.
-        $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
+        $next = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ( $next + 1 ), null, true );
 
         // Skip for invalid code.
-        if ($next === false || $tokens[$next]['code'] !== T_DOUBLE_COLON) {
+        if ( $next === false || $tokens[ $next ][ 'code' ] !== T_DOUBLE_COLON ) {
             return;
         }
 
         // Find next non empty token index, should be the function name.
-        $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
+        $next = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ( $next + 1 ), null, true );
 
         // Skip for invalid code or other method.
-        if ($next === false || $tokens[$next]['content'] !== $methodName) {
+        if ( $next === false || $tokens[ $next ][ 'content' ] !== $methodName ) {
             return;
         }
 
         // Find next non empty token index, should be the open parenthesis.
-        $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
+        $next = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ( $next + 1 ), null, true );
 
         // Skip for invalid code.
-        if ($next === false || $tokens[$next]['code'] !== T_OPEN_PARENTHESIS) {
+        if ( $next === false || $tokens[ $next ][ 'code' ] !== T_OPEN_PARENTHESIS ) {
             return;
         }
 
@@ -130,46 +130,46 @@ 
                                 T_CONSTANT_ENCAPSED_STRING,
                                );
 
-        $parameters       = array('');
+        $parameters       = array( '' );
         $parenthesisCount = 1;
-        $count            = count($tokens);
+        $count            = count( $tokens );
         for (++$next; $next < $count; ++$next) {
-            $code = $tokens[$next]['code'];
+            $code = $tokens[ $next ][ 'code' ];
 
-            if ($code === T_OPEN_PARENTHESIS) {
+            if ( $code === T_OPEN_PARENTHESIS ) {
                 ++$parenthesisCount;
-            } else if ($code === T_CLOSE_PARENTHESIS) {
+            } else if ( $code === T_CLOSE_PARENTHESIS ) {
                 --$parenthesisCount;
-            } else if ($parenthesisCount === 1 && $code === T_COMMA) {
-                $parameters[] = '';
-            } else if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === false) {
-                $parameters[(count($parameters) - 1)] .= $tokens[$next]['content'];
+            } else if ( $parenthesisCount === 1 && $code === T_COMMA ) {
+                $parameters[ ] = '';
+            } else if ( isset( PHP_CodeSniffer_Tokens::$emptyTokens[ $code ] ) === false ) {
+                $parameters[ ( count( $parameters ) - 1 ) ] .= $tokens[ $next ][ 'content' ];
             }
 
-            if ($parenthesisCount === 0) {
+            if ( $parenthesisCount === 0 ) {
                 break;
             }
         }//end for
 
-        $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
-        if ($next === false || $tokens[$next]['code'] !== T_SEMICOLON) {
+        $next = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ( $next + 1 ), null, true );
+        if ( $next === false || $tokens[ $next ][ 'code' ] !== T_SEMICOLON ) {
             return;
         }
 
         // Check rest of the scope.
         for (++$next; $next <= $end; ++$next) {
-            $code = $tokens[$next]['code'];
+            $code = $tokens[ $next ][ 'code' ];
             // Skip for any other content.
-            if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === false) {
+            if ( isset( PHP_CodeSniffer_Tokens::$emptyTokens[ $code ] ) === false ) {
                 return;
             }
         }
 
-        $parameters = array_map('trim', $parameters);
-        $parameters = array_filter($parameters);
+        $parameters = array_map( 'trim', $parameters );
+        $parameters = array_filter( $parameters );
 
-        if (count($parameters) === count($signature) && $parameters === $signature) {
-            $phpcsFile->addWarning('Possible useless method overriding detected', $stackPtr, 'Found');
+        if ( count( $parameters ) === count( $signature ) && $parameters === $signature ) {
+            $phpcsFile->addWarning( 'Possible useless method overriding detected', $stackPtr, 'Found' );
         }
 
     }//end process()

Braces +3 added lines, -6 removed lines

@@ -36,8 +36,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class Generic_Sniffs_CodeAnalysis_UselessOverridingMethodSniff implements PHP_CodeSniffer_Sniff
-{
+class Generic_Sniffs_CodeAnalysis_UselessOverridingMethodSniff implements PHP_CodeSniffer_Sniff {
 
 
     /**
@@ -45,8 +44,7 @@ 
      *
      * @return int[]
      */
-    public function register()
-    {
+    public function register() {
         return array(T_FUNCTION);
 
     }//end register()
@@ -61,8 +59,7 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $tokens = $phpcsFile->getTokens();
         $token  = $tokens[$stackPtr];
 

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/Generic/Sniffs/Commenting/DocCommentSniff.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return string[]
      */
     public function register()
     {

Indentation +319 added lines, -319 removed lines

@@ -26,325 +26,325 @@
 class Generic_Sniffs_Commenting_DocCommentSniff implements PHP_CodeSniffer_Sniff
 {
 
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = array(
-                                   'PHP',
-                                   'JS',
-                                  );
-
-
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(T_DOC_COMMENT_OPEN_TAG);
-
-    }//end register()
-
-
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
-        $tokens       = $phpcsFile->getTokens();
-        $commentStart = $stackPtr;
-        $commentEnd   = $tokens[$stackPtr]['comment_closer'];
-
-        $empty = array(
-                  T_DOC_COMMENT_WHITESPACE,
-                  T_DOC_COMMENT_STAR,
-                 );
-
-        $short = $phpcsFile->findNext($empty, ($stackPtr + 1), $commentEnd, true);
-        if ($short === false) {
-            // No content at all.
-            $error = 'Doc comment is empty';
-            $phpcsFile->addError($error, $stackPtr, 'Empty');
-            return;
-        }
-
-        // The first line of the comment should just be the /** code.
-        if ($tokens[$short]['line'] === $tokens[$stackPtr]['line']) {
-            $error = 'The open comment tag must be the only content on the line';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'ContentAfterOpen');
-            if ($fix === true) {
-                $phpcsFile->fixer->beginChangeset();
-                $phpcsFile->fixer->addNewline($stackPtr);
-                $phpcsFile->fixer->addContentBefore($short, '* ');
-                $phpcsFile->fixer->endChangeset();
-            }
-        }
-
-        // The last line of the comment should just be the */ code.
-        $prev = $phpcsFile->findPrevious($empty, ($commentEnd - 1), $stackPtr, true);
-        if ($tokens[$prev]['line'] === $tokens[$commentEnd]['line']) {
-            $error = 'The close comment tag must be the only content on the line';
-            $fix   = $phpcsFile->addFixableError($error, $commentEnd, 'ContentBeforeClose');
-            if ($fix === true) {
-                $phpcsFile->fixer->addNewlineBefore($commentEnd);
-            }
-        }
-
-        // Check for additional blank lines at the end of the comment.
-        if ($tokens[$prev]['line'] < ($tokens[$commentEnd]['line'] - 1)) {
-            $error = 'Additional blank lines found at end of doc comment';
-            $fix   = $phpcsFile->addFixableError($error, $commentEnd, 'SpacingAfter');
-            if ($fix === true) {
-                $phpcsFile->fixer->beginChangeset();
-                for ($i = ($prev + 1); $i < $commentEnd; $i++) {
-                    if ($tokens[($i + 1)]['line'] === $tokens[$commentEnd]['line']) {
-                        break;
-                    }
-
-                    $phpcsFile->fixer->replaceToken($i, '');
-                }
-
-                $phpcsFile->fixer->endChangeset();
-            }
-        }
-
-        // Check for a comment description.
-        if ($tokens[$short]['code'] !== T_DOC_COMMENT_STRING) {
-            $error = 'Missing short description in doc comment';
-            $phpcsFile->addError($error, $stackPtr, 'MissingShort');
-            return;
-        }
-
-        // No extra newline before short description.
-        if ($tokens[$short]['line'] !== ($tokens[$stackPtr]['line'] + 1)) {
-            $error = 'Doc comment short description must be on the first line';
-            $fix   = $phpcsFile->addFixableError($error, $short, 'SpacingBeforeShort');
-            if ($fix === true) {
-                $phpcsFile->fixer->beginChangeset();
-                for ($i = $stackPtr; $i < $short; $i++) {
-                    if ($tokens[$i]['line'] === $tokens[$stackPtr]['line']) {
-                        continue;
-                    } else if ($tokens[$i]['line'] === $tokens[$short]['line']) {
-                        break;
-                    }
-
-                    $phpcsFile->fixer->replaceToken($i, '');
-                }
-
-                $phpcsFile->fixer->endChangeset();
-            }
-        }
-
-        // Account for the fact that a short description might cover
-        // multiple lines.
-        $shortContent = $tokens[$short]['content'];
-        $shortEnd     = $short;
-        for ($i = ($short + 1); $i < $commentEnd; $i++) {
-            if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) {
-                if ($tokens[$i]['line'] === ($tokens[$shortEnd]['line'] + 1)) {
-                    $shortContent .= $tokens[$i]['content'];
-                    $shortEnd      = $i;
-                } else {
-                    break;
-                }
-            }
-        }
-
-        if (preg_match('/^\p{Ll}/u', $shortContent) === 1) {
-            $error = 'Doc comment short description must start with a capital letter';
-            $phpcsFile->addError($error, $short, 'ShortNotCapital');
-        }
-
-        $long = $phpcsFile->findNext($empty, ($shortEnd + 1), ($commentEnd - 1), true);
-        if ($long !== false && $tokens[$long]['code'] === T_DOC_COMMENT_STRING) {
-            if ($tokens[$long]['line'] !== ($tokens[$shortEnd]['line'] + 2)) {
-                $error = 'There must be exactly one blank line between descriptions in a doc comment';
-                $fix   = $phpcsFile->addFixableError($error, $long, 'SpacingBetween');
-                if ($fix === true) {
-                    $phpcsFile->fixer->beginChangeset();
-                    for ($i = ($shortEnd + 1); $i < $long; $i++) {
-                        if ($tokens[$i]['line'] === $tokens[$shortEnd]['line']) {
-                            continue;
-                        } else if ($tokens[$i]['line'] === ($tokens[$long]['line'] - 1)) {
-                            break;
-                        }
-
-                        $phpcsFile->fixer->replaceToken($i, '');
-                    }
-
-                    $phpcsFile->fixer->endChangeset();
-                }
-            }
-
-            if (preg_match('/^\p{Ll}/u', $tokens[$long]['content']) === 1) {
-                $error = 'Doc comment long description must start with a capital letter';
-                $phpcsFile->addError($error, $long, 'LongNotCapital');
-            }
-        }//end if
-
-        if (empty($tokens[$commentStart]['comment_tags']) === true) {
-            // No tags in the comment.
-            return;
-        }
-
-        $firstTag = $tokens[$commentStart]['comment_tags'][0];
-        $prev     = $phpcsFile->findPrevious($empty, ($firstTag - 1), $stackPtr, true);
-        if ($tokens[$firstTag]['line'] !== ($tokens[$prev]['line'] + 2)) {
-            $error = 'There must be exactly one blank line before the tags in a doc comment';
-            $fix   = $phpcsFile->addFixableError($error, $firstTag, 'SpacingBeforeTags');
-            if ($fix === true) {
-                $phpcsFile->fixer->beginChangeset();
-                for ($i = ($prev + 1); $i < $firstTag; $i++) {
-                    if ($tokens[$i]['line'] === $tokens[$firstTag]['line']) {
-                        break;
-                    }
-
-                    $phpcsFile->fixer->replaceToken($i, '');
-                }
-
-                $indent = str_repeat(' ', $tokens[$stackPtr]['column']);
-                $phpcsFile->fixer->addContent($prev, $phpcsFile->eolChar.$indent.'*'.$phpcsFile->eolChar);
-                $phpcsFile->fixer->endChangeset();
-            }
-        }
-
-        // Break out the tags into groups and check alignment within each.
-        // A tag group is one where there are no blank lines between tags.
-        // The param tag group is special as it requires all @param tags to be inside.
-        $tagGroups    = array();
-        $groupid      = 0;
-        $paramGroupid = null;
-        foreach ($tokens[$commentStart]['comment_tags'] as $pos => $tag) {
-            if ($pos > 0) {
-                $prev = $phpcsFile->findPrevious(
-                    T_DOC_COMMENT_STRING,
-                    ($tag - 1),
-                    $tokens[$commentStart]['comment_tags'][($pos - 1)]
-                );
-
-                if ($prev === false) {
-                    $prev = $tokens[$commentStart]['comment_tags'][($pos - 1)];
-                }
-
-                if ($tokens[$prev]['line'] !== ($tokens[$tag]['line'] - 1)) {
-                    $groupid++;
-                }
-            }
-
-            if ($tokens[$tag]['content'] === '@param') {
-                if (($paramGroupid === null
-                    && empty($tagGroups[$groupid]) === false)
-                    || ($paramGroupid !== null
-                    && $paramGroupid !== $groupid)
-                ) {
-                    $error = 'Parameter tags must be grouped together in a doc comment';
-                    $phpcsFile->addError($error, $tag, 'ParamGroup');
-                }
-
-                if ($paramGroupid === null) {
-                    $paramGroupid = $groupid;
-                }
-            } else if ($groupid === $paramGroupid) {
-                $error = 'Tag cannot be grouped with parameter tags in a doc comment';
-                $phpcsFile->addError($error, $tag, 'NonParamGroup');
-            }//end if
-
-            $tagGroups[$groupid][] = $tag;
-        }//end foreach
-
-        foreach ($tagGroups as $group) {
-            $maxLength = 0;
-            $paddings  = array();
-            foreach ($group as $pos => $tag) {
-                $tagLength = strlen($tokens[$tag]['content']);
-                if ($tagLength > $maxLength) {
-                    $maxLength = $tagLength;
-                }
-
-                // Check for a value. No value means no padding needed.
-                $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $tag, $commentEnd);
-                if ($string !== false && $tokens[$string]['line'] === $tokens[$tag]['line']) {
-                    $paddings[$tag] = strlen($tokens[($tag + 1)]['content']);
-                }
-            }
-
-            // Check that there was single blank line after the tag block
-            // but account for a multi-line tag comments.
-            $lastTag = $group[$pos];
-            $next    = $phpcsFile->findNext(T_DOC_COMMENT_TAG, ($lastTag + 3), $commentEnd);
-            if ($next !== false) {
-                $prev = $phpcsFile->findPrevious(array(T_DOC_COMMENT_TAG, T_DOC_COMMENT_STRING), ($next - 1), $commentStart);
-                if ($tokens[$next]['line'] !== ($tokens[$prev]['line'] + 2)) {
-                    $error = 'There must be a single blank line after a tag group';
-                    $fix   = $phpcsFile->addFixableError($error, $lastTag, 'SpacingAfterTagGroup');
-                    if ($fix === true) {
-                        $phpcsFile->fixer->beginChangeset();
-                        for ($i = ($prev + 1); $i < $next; $i++) {
-                            if ($tokens[$i]['line'] === $tokens[$next]['line']) {
-                                break;
-                            }
-
-                            $phpcsFile->fixer->replaceToken($i, '');
-                        }
-
-                        $indent = str_repeat(' ', $tokens[$stackPtr]['column']);
-                        $phpcsFile->fixer->addContent($prev, $phpcsFile->eolChar.$indent.'*'.$phpcsFile->eolChar);
-                        $phpcsFile->fixer->endChangeset();
-                    }
-                }
-            }//end if
-
-            // Now check paddings.
-            foreach ($paddings as $tag => $padding) {
-                $required = ($maxLength - strlen($tokens[$tag]['content']) + 1);
-
-                if ($padding !== $required) {
-                    $error = 'Tag value indented incorrectly; expected %s spaces but found %s';
-                    $data  = array(
-                              $required,
-                              $padding,
-                             );
-
-                    $fix = $phpcsFile->addFixableError($error, ($tag + 1), 'TagValueIndent', $data);
-                    if ($fix === true) {
-                        $phpcsFile->fixer->replaceToken(($tag + 1), str_repeat(' ', $required));
-                    }
-                }
-            }
-        }//end foreach
-
-        // If there is a param group, it needs to be first.
-        if ($paramGroupid !== null && $paramGroupid !== 0) {
-            $error = 'Parameter tags must be defined first in a doc comment';
-            $phpcsFile->addError($error, $tagGroups[$paramGroupid][0], 'ParamNotFirst');
-        }
-
-        $foundTags = array();
-        foreach ($tokens[$stackPtr]['comment_tags'] as $pos => $tag) {
-            $tagName = $tokens[$tag]['content'];
-            if (isset($foundTags[$tagName]) === true) {
-                $lastTag = $tokens[$stackPtr]['comment_tags'][($pos - 1)];
-                if ($tokens[$lastTag]['content'] !== $tagName) {
-                    $error = 'Tags must be grouped together in a doc comment';
-                    $phpcsFile->addError($error, $tag, 'TagsNotGrouped');
-                }
-
-                continue;
-            }
-
-            $foundTags[$tagName] = true;
-        }
-
-    }//end process()
+	 /**
+	  * A list of tokenizers this sniff supports.
+	  *
+	  * @var array
+	  */
+	 public $supportedTokenizers = array(
+											  'PHP',
+											  'JS',
+											 );
+
+
+	 /**
+	  * Returns an array of tokens this test wants to listen for.
+	  *
+	  * @return array
+	  */
+	 public function register()
+	 {
+		  return array(T_DOC_COMMENT_OPEN_TAG);
+
+	 }//end register()
+
+
+	 /**
+	  * Processes this test, when one of its tokens is encountered.
+	  *
+	  * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+	  * @param int                  $stackPtr  The position of the current token
+	  *                                        in the stack passed in $tokens.
+	  *
+	  * @return void
+	  */
+	 public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+	 {
+		  $tokens       = $phpcsFile->getTokens();
+		  $commentStart = $stackPtr;
+		  $commentEnd   = $tokens[$stackPtr]['comment_closer'];
+
+		  $empty = array(
+						T_DOC_COMMENT_WHITESPACE,
+						T_DOC_COMMENT_STAR,
+					  );
+
+		  $short = $phpcsFile->findNext($empty, ($stackPtr + 1), $commentEnd, true);
+		  if ($short === false) {
+				// No content at all.
+				$error = 'Doc comment is empty';
+				$phpcsFile->addError($error, $stackPtr, 'Empty');
+				return;
+		  }
+
+		  // The first line of the comment should just be the /** code.
+		  if ($tokens[$short]['line'] === $tokens[$stackPtr]['line']) {
+				$error = 'The open comment tag must be the only content on the line';
+				$fix   = $phpcsFile->addFixableError($error, $stackPtr, 'ContentAfterOpen');
+				if ($fix === true) {
+					 $phpcsFile->fixer->beginChangeset();
+					 $phpcsFile->fixer->addNewline($stackPtr);
+					 $phpcsFile->fixer->addContentBefore($short, '* ');
+					 $phpcsFile->fixer->endChangeset();
+				}
+		  }
+
+		  // The last line of the comment should just be the */ code.
+		  $prev = $phpcsFile->findPrevious($empty, ($commentEnd - 1), $stackPtr, true);
+		  if ($tokens[$prev]['line'] === $tokens[$commentEnd]['line']) {
+				$error = 'The close comment tag must be the only content on the line';
+				$fix   = $phpcsFile->addFixableError($error, $commentEnd, 'ContentBeforeClose');
+				if ($fix === true) {
+					 $phpcsFile->fixer->addNewlineBefore($commentEnd);
+				}
+		  }
+
+		  // Check for additional blank lines at the end of the comment.
+		  if ($tokens[$prev]['line'] < ($tokens[$commentEnd]['line'] - 1)) {
+				$error = 'Additional blank lines found at end of doc comment';
+				$fix   = $phpcsFile->addFixableError($error, $commentEnd, 'SpacingAfter');
+				if ($fix === true) {
+					 $phpcsFile->fixer->beginChangeset();
+					 for ($i = ($prev + 1); $i < $commentEnd; $i++) {
+						  if ($tokens[($i + 1)]['line'] === $tokens[$commentEnd]['line']) {
+								break;
+						  }
+
+						  $phpcsFile->fixer->replaceToken($i, '');
+					 }
+
+					 $phpcsFile->fixer->endChangeset();
+				}
+		  }
+
+		  // Check for a comment description.
+		  if ($tokens[$short]['code'] !== T_DOC_COMMENT_STRING) {
+				$error = 'Missing short description in doc comment';
+				$phpcsFile->addError($error, $stackPtr, 'MissingShort');
+				return;
+		  }
+
+		  // No extra newline before short description.
+		  if ($tokens[$short]['line'] !== ($tokens[$stackPtr]['line'] + 1)) {
+				$error = 'Doc comment short description must be on the first line';
+				$fix   = $phpcsFile->addFixableError($error, $short, 'SpacingBeforeShort');
+				if ($fix === true) {
+					 $phpcsFile->fixer->beginChangeset();
+					 for ($i = $stackPtr; $i < $short; $i++) {
+						  if ($tokens[$i]['line'] === $tokens[$stackPtr]['line']) {
+								continue;
+						  } else if ($tokens[$i]['line'] === $tokens[$short]['line']) {
+								break;
+						  }
+
+						  $phpcsFile->fixer->replaceToken($i, '');
+					 }
+
+					 $phpcsFile->fixer->endChangeset();
+				}
+		  }
+
+		  // Account for the fact that a short description might cover
+		  // multiple lines.
+		  $shortContent = $tokens[$short]['content'];
+		  $shortEnd     = $short;
+		  for ($i = ($short + 1); $i < $commentEnd; $i++) {
+				if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) {
+					 if ($tokens[$i]['line'] === ($tokens[$shortEnd]['line'] + 1)) {
+						  $shortContent .= $tokens[$i]['content'];
+						  $shortEnd      = $i;
+					 } else {
+						  break;
+					 }
+				}
+		  }
+
+		  if (preg_match('/^\p{Ll}/u', $shortContent) === 1) {
+				$error = 'Doc comment short description must start with a capital letter';
+				$phpcsFile->addError($error, $short, 'ShortNotCapital');
+		  }
+
+		  $long = $phpcsFile->findNext($empty, ($shortEnd + 1), ($commentEnd - 1), true);
+		  if ($long !== false && $tokens[$long]['code'] === T_DOC_COMMENT_STRING) {
+				if ($tokens[$long]['line'] !== ($tokens[$shortEnd]['line'] + 2)) {
+					 $error = 'There must be exactly one blank line between descriptions in a doc comment';
+					 $fix   = $phpcsFile->addFixableError($error, $long, 'SpacingBetween');
+					 if ($fix === true) {
+						  $phpcsFile->fixer->beginChangeset();
+						  for ($i = ($shortEnd + 1); $i < $long; $i++) {
+								if ($tokens[$i]['line'] === $tokens[$shortEnd]['line']) {
+									 continue;
+								} else if ($tokens[$i]['line'] === ($tokens[$long]['line'] - 1)) {
+									 break;
+								}
+
+								$phpcsFile->fixer->replaceToken($i, '');
+						  }
+
+						  $phpcsFile->fixer->endChangeset();
+					 }
+				}
+
+				if (preg_match('/^\p{Ll}/u', $tokens[$long]['content']) === 1) {
+					 $error = 'Doc comment long description must start with a capital letter';
+					 $phpcsFile->addError($error, $long, 'LongNotCapital');
+				}
+		  }//end if
+
+		  if (empty($tokens[$commentStart]['comment_tags']) === true) {
+				// No tags in the comment.
+				return;
+		  }
+
+		  $firstTag = $tokens[$commentStart]['comment_tags'][0];
+		  $prev     = $phpcsFile->findPrevious($empty, ($firstTag - 1), $stackPtr, true);
+		  if ($tokens[$firstTag]['line'] !== ($tokens[$prev]['line'] + 2)) {
+				$error = 'There must be exactly one blank line before the tags in a doc comment';
+				$fix   = $phpcsFile->addFixableError($error, $firstTag, 'SpacingBeforeTags');
+				if ($fix === true) {
+					 $phpcsFile->fixer->beginChangeset();
+					 for ($i = ($prev + 1); $i < $firstTag; $i++) {
+						  if ($tokens[$i]['line'] === $tokens[$firstTag]['line']) {
+								break;
+						  }
+
+						  $phpcsFile->fixer->replaceToken($i, '');
+					 }
+
+					 $indent = str_repeat(' ', $tokens[$stackPtr]['column']);
+					 $phpcsFile->fixer->addContent($prev, $phpcsFile->eolChar.$indent.'*'.$phpcsFile->eolChar);
+					 $phpcsFile->fixer->endChangeset();
+				}
+		  }
+
+		  // Break out the tags into groups and check alignment within each.
+		  // A tag group is one where there are no blank lines between tags.
+		  // The param tag group is special as it requires all @param tags to be inside.
+		  $tagGroups    = array();
+		  $groupid      = 0;
+		  $paramGroupid = null;
+		  foreach ($tokens[$commentStart]['comment_tags'] as $pos => $tag) {
+				if ($pos > 0) {
+					 $prev = $phpcsFile->findPrevious(
+						  T_DOC_COMMENT_STRING,
+						  ($tag - 1),
+						  $tokens[$commentStart]['comment_tags'][($pos - 1)]
+					 );
+
+					 if ($prev === false) {
+						  $prev = $tokens[$commentStart]['comment_tags'][($pos - 1)];
+					 }
+
+					 if ($tokens[$prev]['line'] !== ($tokens[$tag]['line'] - 1)) {
+						  $groupid++;
+					 }
+				}
+
+				if ($tokens[$tag]['content'] === '@param') {
+					 if (($paramGroupid === null
+						  && empty($tagGroups[$groupid]) === false)
+						  || ($paramGroupid !== null
+						  && $paramGroupid !== $groupid)
+					 ) {
+						  $error = 'Parameter tags must be grouped together in a doc comment';
+						  $phpcsFile->addError($error, $tag, 'ParamGroup');
+					 }
+
+					 if ($paramGroupid === null) {
+						  $paramGroupid = $groupid;
+					 }
+				} else if ($groupid === $paramGroupid) {
+					 $error = 'Tag cannot be grouped with parameter tags in a doc comment';
+					 $phpcsFile->addError($error, $tag, 'NonParamGroup');
+				}//end if
+
+				$tagGroups[$groupid][] = $tag;
+		  }//end foreach
+
+		  foreach ($tagGroups as $group) {
+				$maxLength = 0;
+				$paddings  = array();
+				foreach ($group as $pos => $tag) {
+					 $tagLength = strlen($tokens[$tag]['content']);
+					 if ($tagLength > $maxLength) {
+						  $maxLength = $tagLength;
+					 }
+
+					 // Check for a value. No value means no padding needed.
+					 $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $tag, $commentEnd);
+					 if ($string !== false && $tokens[$string]['line'] === $tokens[$tag]['line']) {
+						  $paddings[$tag] = strlen($tokens[($tag + 1)]['content']);
+					 }
+				}
+
+				// Check that there was single blank line after the tag block
+				// but account for a multi-line tag comments.
+				$lastTag = $group[$pos];
+				$next    = $phpcsFile->findNext(T_DOC_COMMENT_TAG, ($lastTag + 3), $commentEnd);
+				if ($next !== false) {
+					 $prev = $phpcsFile->findPrevious(array(T_DOC_COMMENT_TAG, T_DOC_COMMENT_STRING), ($next - 1), $commentStart);
+					 if ($tokens[$next]['line'] !== ($tokens[$prev]['line'] + 2)) {
+						  $error = 'There must be a single blank line after a tag group';
+						  $fix   = $phpcsFile->addFixableError($error, $lastTag, 'SpacingAfterTagGroup');
+						  if ($fix === true) {
+								$phpcsFile->fixer->beginChangeset();
+								for ($i = ($prev + 1); $i < $next; $i++) {
+									 if ($tokens[$i]['line'] === $tokens[$next]['line']) {
+										  break;
+									 }
+
+									 $phpcsFile->fixer->replaceToken($i, '');
+								}
+
+								$indent = str_repeat(' ', $tokens[$stackPtr]['column']);
+								$phpcsFile->fixer->addContent($prev, $phpcsFile->eolChar.$indent.'*'.$phpcsFile->eolChar);
+								$phpcsFile->fixer->endChangeset();
+						  }
+					 }
+				}//end if
+
+				// Now check paddings.
+				foreach ($paddings as $tag => $padding) {
+					 $required = ($maxLength - strlen($tokens[$tag]['content']) + 1);
+
+					 if ($padding !== $required) {
+						  $error = 'Tag value indented incorrectly; expected %s spaces but found %s';
+						  $data  = array(
+										$required,
+										$padding,
+									  );
+
+						  $fix = $phpcsFile->addFixableError($error, ($tag + 1), 'TagValueIndent', $data);
+						  if ($fix === true) {
+								$phpcsFile->fixer->replaceToken(($tag + 1), str_repeat(' ', $required));
+						  }
+					 }
+				}
+		  }//end foreach
+
+		  // If there is a param group, it needs to be first.
+		  if ($paramGroupid !== null && $paramGroupid !== 0) {
+				$error = 'Parameter tags must be defined first in a doc comment';
+				$phpcsFile->addError($error, $tagGroups[$paramGroupid][0], 'ParamNotFirst');
+		  }
+
+		  $foundTags = array();
+		  foreach ($tokens[$stackPtr]['comment_tags'] as $pos => $tag) {
+				$tagName = $tokens[$tag]['content'];
+				if (isset($foundTags[$tagName]) === true) {
+					 $lastTag = $tokens[$stackPtr]['comment_tags'][($pos - 1)];
+					 if ($tokens[$lastTag]['content'] !== $tagName) {
+						  $error = 'Tags must be grouped together in a doc comment';
+						  $phpcsFile->addError($error, $tag, 'TagsNotGrouped');
+					 }
+
+					 continue;
+				}
+
+				$foundTags[$tagName] = true;
+		  }
+
+	 }//end process()
 
 
 }//end class

Spacing +111 added lines, -111 removed lines

@@ -44,7 +44,7 @@ 
      */
     public function register()
     {
-        return array(T_DOC_COMMENT_OPEN_TAG);
+        return array( T_DOC_COMMENT_OPEN_TAG );
 
     }//end register()
 
@@ -58,59 +58,59 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $tokens       = $phpcsFile->getTokens();
         $commentStart = $stackPtr;
-        $commentEnd   = $tokens[$stackPtr]['comment_closer'];
+        $commentEnd   = $tokens[ $stackPtr ][ 'comment_closer' ];
 
         $empty = array(
                   T_DOC_COMMENT_WHITESPACE,
                   T_DOC_COMMENT_STAR,
                  );
 
-        $short = $phpcsFile->findNext($empty, ($stackPtr + 1), $commentEnd, true);
-        if ($short === false) {
+        $short = $phpcsFile->findNext( $empty, ( $stackPtr + 1 ), $commentEnd, true );
+        if ( $short === false ) {
             // No content at all.
             $error = 'Doc comment is empty';
-            $phpcsFile->addError($error, $stackPtr, 'Empty');
+            $phpcsFile->addError( $error, $stackPtr, 'Empty' );
             return;
         }
 
         // The first line of the comment should just be the /** code.
-        if ($tokens[$short]['line'] === $tokens[$stackPtr]['line']) {
+        if ( $tokens[ $short ][ 'line' ] === $tokens[ $stackPtr ][ 'line' ] ) {
             $error = 'The open comment tag must be the only content on the line';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'ContentAfterOpen');
-            if ($fix === true) {
+            $fix   = $phpcsFile->addFixableError( $error, $stackPtr, 'ContentAfterOpen' );
+            if ( $fix === true ) {
                 $phpcsFile->fixer->beginChangeset();
-                $phpcsFile->fixer->addNewline($stackPtr);
-                $phpcsFile->fixer->addContentBefore($short, '* ');
+                $phpcsFile->fixer->addNewline( $stackPtr );
+                $phpcsFile->fixer->addContentBefore( $short, '* ' );
                 $phpcsFile->fixer->endChangeset();
             }
         }
 
         // The last line of the comment should just be the */ code.
-        $prev = $phpcsFile->findPrevious($empty, ($commentEnd - 1), $stackPtr, true);
-        if ($tokens[$prev]['line'] === $tokens[$commentEnd]['line']) {
+        $prev = $phpcsFile->findPrevious( $empty, ( $commentEnd - 1 ), $stackPtr, true );
+        if ( $tokens[ $prev ][ 'line' ] === $tokens[ $commentEnd ][ 'line' ] ) {
             $error = 'The close comment tag must be the only content on the line';
-            $fix   = $phpcsFile->addFixableError($error, $commentEnd, 'ContentBeforeClose');
-            if ($fix === true) {
-                $phpcsFile->fixer->addNewlineBefore($commentEnd);
+            $fix   = $phpcsFile->addFixableError( $error, $commentEnd, 'ContentBeforeClose' );
+            if ( $fix === true ) {
+                $phpcsFile->fixer->addNewlineBefore( $commentEnd );
             }
         }
 
         // Check for additional blank lines at the end of the comment.
-        if ($tokens[$prev]['line'] < ($tokens[$commentEnd]['line'] - 1)) {
+        if ( $tokens[ $prev ][ 'line' ] < ( $tokens[ $commentEnd ][ 'line' ] - 1 ) ) {
             $error = 'Additional blank lines found at end of doc comment';
-            $fix   = $phpcsFile->addFixableError($error, $commentEnd, 'SpacingAfter');
-            if ($fix === true) {
+            $fix   = $phpcsFile->addFixableError( $error, $commentEnd, 'SpacingAfter' );
+            if ( $fix === true ) {
                 $phpcsFile->fixer->beginChangeset();
-                for ($i = ($prev + 1); $i < $commentEnd; $i++) {
-                    if ($tokens[($i + 1)]['line'] === $tokens[$commentEnd]['line']) {
+                for ( $i = ( $prev + 1 ); $i < $commentEnd; $i++ ) {
+                    if ( $tokens[ ( $i + 1 ) ][ 'line' ] === $tokens[ $commentEnd ][ 'line' ] ) {
                         break;
                     }
 
-                    $phpcsFile->fixer->replaceToken($i, '');
+                    $phpcsFile->fixer->replaceToken( $i, '' );
                 }
 
                 $phpcsFile->fixer->endChangeset();
@@ -118,26 +118,26 @@ 
         }
 
         // Check for a comment description.
-        if ($tokens[$short]['code'] !== T_DOC_COMMENT_STRING) {
+        if ( $tokens[ $short ][ 'code' ] !== T_DOC_COMMENT_STRING ) {
             $error = 'Missing short description in doc comment';
-            $phpcsFile->addError($error, $stackPtr, 'MissingShort');
+            $phpcsFile->addError( $error, $stackPtr, 'MissingShort' );
             return;
         }
 
         // No extra newline before short description.
-        if ($tokens[$short]['line'] !== ($tokens[$stackPtr]['line'] + 1)) {
+        if ( $tokens[ $short ][ 'line' ] !== ( $tokens[ $stackPtr ][ 'line' ] + 1 ) ) {
             $error = 'Doc comment short description must be on the first line';
-            $fix   = $phpcsFile->addFixableError($error, $short, 'SpacingBeforeShort');
-            if ($fix === true) {
+            $fix   = $phpcsFile->addFixableError( $error, $short, 'SpacingBeforeShort' );
+            if ( $fix === true ) {
                 $phpcsFile->fixer->beginChangeset();
-                for ($i = $stackPtr; $i < $short; $i++) {
-                    if ($tokens[$i]['line'] === $tokens[$stackPtr]['line']) {
+                for ( $i = $stackPtr; $i < $short; $i++ ) {
+                    if ( $tokens[ $i ][ 'line' ] === $tokens[ $stackPtr ][ 'line' ] ) {
                         continue;
-                    } else if ($tokens[$i]['line'] === $tokens[$short]['line']) {
+                    } else if ( $tokens[ $i ][ 'line' ] === $tokens[ $short ][ 'line' ] ) {
                         break;
                     }
 
-                    $phpcsFile->fixer->replaceToken($i, '');
+                    $phpcsFile->fixer->replaceToken( $i, '' );
                 }
 
                 $phpcsFile->fixer->endChangeset();
@@ -146,12 +146,12 @@ 
 
         // Account for the fact that a short description might cover
         // multiple lines.
-        $shortContent = $tokens[$short]['content'];
+        $shortContent = $tokens[ $short ][ 'content' ];
         $shortEnd     = $short;
-        for ($i = ($short + 1); $i < $commentEnd; $i++) {
-            if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) {
-                if ($tokens[$i]['line'] === ($tokens[$shortEnd]['line'] + 1)) {
-                    $shortContent .= $tokens[$i]['content'];
+        for ( $i = ( $short + 1 ); $i < $commentEnd; $i++ ) {
+            if ( $tokens[ $i ][ 'code' ] === T_DOC_COMMENT_STRING ) {
+                if ( $tokens[ $i ][ 'line' ] === ( $tokens[ $shortEnd ][ 'line' ] + 1 ) ) {
+                    $shortContent .= $tokens[ $i ][ 'content' ];
                     $shortEnd      = $i;
                 } else {
                     break;
@@ -159,60 +159,60 @@ 
             }
         }
 
-        if (preg_match('/^\p{Ll}/u', $shortContent) === 1) {
+        if ( preg_match( '/^\p{Ll}/u', $shortContent ) === 1 ) {
             $error = 'Doc comment short description must start with a capital letter';
-            $phpcsFile->addError($error, $short, 'ShortNotCapital');
+            $phpcsFile->addError( $error, $short, 'ShortNotCapital' );
         }
 
-        $long = $phpcsFile->findNext($empty, ($shortEnd + 1), ($commentEnd - 1), true);
-        if ($long !== false && $tokens[$long]['code'] === T_DOC_COMMENT_STRING) {
-            if ($tokens[$long]['line'] !== ($tokens[$shortEnd]['line'] + 2)) {
+        $long = $phpcsFile->findNext( $empty, ( $shortEnd + 1 ), ( $commentEnd - 1 ), true );
+        if ( $long !== false && $tokens[ $long ][ 'code' ] === T_DOC_COMMENT_STRING ) {
+            if ( $tokens[ $long ][ 'line' ] !== ( $tokens[ $shortEnd ][ 'line' ] + 2 ) ) {
                 $error = 'There must be exactly one blank line between descriptions in a doc comment';
-                $fix   = $phpcsFile->addFixableError($error, $long, 'SpacingBetween');
-                if ($fix === true) {
+                $fix   = $phpcsFile->addFixableError( $error, $long, 'SpacingBetween' );
+                if ( $fix === true ) {
                     $phpcsFile->fixer->beginChangeset();
-                    for ($i = ($shortEnd + 1); $i < $long; $i++) {
-                        if ($tokens[$i]['line'] === $tokens[$shortEnd]['line']) {
+                    for ( $i = ( $shortEnd + 1 ); $i < $long; $i++ ) {
+                        if ( $tokens[ $i ][ 'line' ] === $tokens[ $shortEnd ][ 'line' ] ) {
                             continue;
-                        } else if ($tokens[$i]['line'] === ($tokens[$long]['line'] - 1)) {
+                        } else if ( $tokens[ $i ][ 'line' ] === ( $tokens[ $long ][ 'line' ] - 1 ) ) {
                             break;
                         }
 
-                        $phpcsFile->fixer->replaceToken($i, '');
+                        $phpcsFile->fixer->replaceToken( $i, '' );
                     }
 
                     $phpcsFile->fixer->endChangeset();
                 }
             }
 
-            if (preg_match('/^\p{Ll}/u', $tokens[$long]['content']) === 1) {
+            if ( preg_match( '/^\p{Ll}/u', $tokens[ $long ][ 'content' ] ) === 1 ) {
                 $error = 'Doc comment long description must start with a capital letter';
-                $phpcsFile->addError($error, $long, 'LongNotCapital');
+                $phpcsFile->addError( $error, $long, 'LongNotCapital' );
             }
         }//end if
 
-        if (empty($tokens[$commentStart]['comment_tags']) === true) {
+        if ( empty( $tokens[ $commentStart ][ 'comment_tags' ] ) === true ) {
             // No tags in the comment.
             return;
         }
 
-        $firstTag = $tokens[$commentStart]['comment_tags'][0];
-        $prev     = $phpcsFile->findPrevious($empty, ($firstTag - 1), $stackPtr, true);
-        if ($tokens[$firstTag]['line'] !== ($tokens[$prev]['line'] + 2)) {
+        $firstTag = $tokens[ $commentStart ][ 'comment_tags' ][ 0 ];
+        $prev     = $phpcsFile->findPrevious( $empty, ( $firstTag - 1 ), $stackPtr, true );
+        if ( $tokens[ $firstTag ][ 'line' ] !== ( $tokens[ $prev ][ 'line' ] + 2 ) ) {
             $error = 'There must be exactly one blank line before the tags in a doc comment';
-            $fix   = $phpcsFile->addFixableError($error, $firstTag, 'SpacingBeforeTags');
-            if ($fix === true) {
+            $fix   = $phpcsFile->addFixableError( $error, $firstTag, 'SpacingBeforeTags' );
+            if ( $fix === true ) {
                 $phpcsFile->fixer->beginChangeset();
-                for ($i = ($prev + 1); $i < $firstTag; $i++) {
-                    if ($tokens[$i]['line'] === $tokens[$firstTag]['line']) {
+                for ( $i = ( $prev + 1 ); $i < $firstTag; $i++ ) {
+                    if ( $tokens[ $i ][ 'line' ] === $tokens[ $firstTag ][ 'line' ] ) {
                         break;
                     }
 
-                    $phpcsFile->fixer->replaceToken($i, '');
+                    $phpcsFile->fixer->replaceToken( $i, '' );
                 }
 
-                $indent = str_repeat(' ', $tokens[$stackPtr]['column']);
-                $phpcsFile->fixer->addContent($prev, $phpcsFile->eolChar.$indent.'*'.$phpcsFile->eolChar);
+                $indent = str_repeat( ' ', $tokens[ $stackPtr ][ 'column' ] );
+                $phpcsFile->fixer->addContent( $prev, $phpcsFile->eolChar . $indent . '*' . $phpcsFile->eolChar );
                 $phpcsFile->fixer->endChangeset();
             }
         }
@@ -223,125 +223,125 @@ 
         $tagGroups    = array();
         $groupid      = 0;
         $paramGroupid = null;
-        foreach ($tokens[$commentStart]['comment_tags'] as $pos => $tag) {
-            if ($pos > 0) {
+        foreach ( $tokens[ $commentStart ][ 'comment_tags' ] as $pos => $tag ) {
+            if ( $pos > 0 ) {
                 $prev = $phpcsFile->findPrevious(
                     T_DOC_COMMENT_STRING,
-                    ($tag - 1),
-                    $tokens[$commentStart]['comment_tags'][($pos - 1)]
+                    ( $tag - 1 ),
+                    $tokens[ $commentStart ][ 'comment_tags' ][ ( $pos - 1 ) ]
                 );
 
-                if ($prev === false) {
-                    $prev = $tokens[$commentStart]['comment_tags'][($pos - 1)];
+                if ( $prev === false ) {
+                    $prev = $tokens[ $commentStart ][ 'comment_tags' ][ ( $pos - 1 ) ];
                 }
 
-                if ($tokens[$prev]['line'] !== ($tokens[$tag]['line'] - 1)) {
+                if ( $tokens[ $prev ][ 'line' ] !== ( $tokens[ $tag ][ 'line' ] - 1 ) ) {
                     $groupid++;
                 }
             }
 
-            if ($tokens[$tag]['content'] === '@param') {
-                if (($paramGroupid === null
-                    && empty($tagGroups[$groupid]) === false)
-                    || ($paramGroupid !== null
-                    && $paramGroupid !== $groupid)
+            if ( $tokens[ $tag ][ 'content' ] === '@param' ) {
+                if ( ( $paramGroupid === null
+                    && empty( $tagGroups[ $groupid ] ) === false )
+                    || ( $paramGroupid !== null
+                    && $paramGroupid !== $groupid )
                 ) {
                     $error = 'Parameter tags must be grouped together in a doc comment';
-                    $phpcsFile->addError($error, $tag, 'ParamGroup');
+                    $phpcsFile->addError( $error, $tag, 'ParamGroup' );
                 }
 
-                if ($paramGroupid === null) {
+                if ( $paramGroupid === null ) {
                     $paramGroupid = $groupid;
                 }
-            } else if ($groupid === $paramGroupid) {
+            } else if ( $groupid === $paramGroupid ) {
                 $error = 'Tag cannot be grouped with parameter tags in a doc comment';
-                $phpcsFile->addError($error, $tag, 'NonParamGroup');
+                $phpcsFile->addError( $error, $tag, 'NonParamGroup' );
             }//end if
 
-            $tagGroups[$groupid][] = $tag;
+            $tagGroups[ $groupid ][ ] = $tag;
         }//end foreach
 
-        foreach ($tagGroups as $group) {
+        foreach ( $tagGroups as $group ) {
             $maxLength = 0;
             $paddings  = array();
-            foreach ($group as $pos => $tag) {
-                $tagLength = strlen($tokens[$tag]['content']);
-                if ($tagLength > $maxLength) {
+            foreach ( $group as $pos => $tag ) {
+                $tagLength = strlen( $tokens[ $tag ][ 'content' ] );
+                if ( $tagLength > $maxLength ) {
                     $maxLength = $tagLength;
                 }
 
                 // Check for a value. No value means no padding needed.
-                $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $tag, $commentEnd);
-                if ($string !== false && $tokens[$string]['line'] === $tokens[$tag]['line']) {
-                    $paddings[$tag] = strlen($tokens[($tag + 1)]['content']);
+                $string = $phpcsFile->findNext( T_DOC_COMMENT_STRING, $tag, $commentEnd );
+                if ( $string !== false && $tokens[ $string ][ 'line' ] === $tokens[ $tag ][ 'line' ] ) {
+                    $paddings[ $tag ] = strlen( $tokens[ ( $tag + 1 ) ][ 'content' ] );
                 }
             }
 
             // Check that there was single blank line after the tag block
             // but account for a multi-line tag comments.
-            $lastTag = $group[$pos];
-            $next    = $phpcsFile->findNext(T_DOC_COMMENT_TAG, ($lastTag + 3), $commentEnd);
-            if ($next !== false) {
-                $prev = $phpcsFile->findPrevious(array(T_DOC_COMMENT_TAG, T_DOC_COMMENT_STRING), ($next - 1), $commentStart);
-                if ($tokens[$next]['line'] !== ($tokens[$prev]['line'] + 2)) {
+            $lastTag = $group[ $pos ];
+            $next    = $phpcsFile->findNext( T_DOC_COMMENT_TAG, ( $lastTag + 3 ), $commentEnd );
+            if ( $next !== false ) {
+                $prev = $phpcsFile->findPrevious( array( T_DOC_COMMENT_TAG, T_DOC_COMMENT_STRING ), ( $next - 1 ), $commentStart );
+                if ( $tokens[ $next ][ 'line' ] !== ( $tokens[ $prev ][ 'line' ] + 2 ) ) {
                     $error = 'There must be a single blank line after a tag group';
-                    $fix   = $phpcsFile->addFixableError($error, $lastTag, 'SpacingAfterTagGroup');
-                    if ($fix === true) {
+                    $fix   = $phpcsFile->addFixableError( $error, $lastTag, 'SpacingAfterTagGroup' );
+                    if ( $fix === true ) {
                         $phpcsFile->fixer->beginChangeset();
-                        for ($i = ($prev + 1); $i < $next; $i++) {
-                            if ($tokens[$i]['line'] === $tokens[$next]['line']) {
+                        for ( $i = ( $prev + 1 ); $i < $next; $i++ ) {
+                            if ( $tokens[ $i ][ 'line' ] === $tokens[ $next ][ 'line' ] ) {
                                 break;
                             }
 
-                            $phpcsFile->fixer->replaceToken($i, '');
+                            $phpcsFile->fixer->replaceToken( $i, '' );
                         }
 
-                        $indent = str_repeat(' ', $tokens[$stackPtr]['column']);
-                        $phpcsFile->fixer->addContent($prev, $phpcsFile->eolChar.$indent.'*'.$phpcsFile->eolChar);
+                        $indent = str_repeat( ' ', $tokens[ $stackPtr ][ 'column' ] );
+                        $phpcsFile->fixer->addContent( $prev, $phpcsFile->eolChar . $indent . '*' . $phpcsFile->eolChar );
                         $phpcsFile->fixer->endChangeset();
                     }
                 }
             }//end if
 
             // Now check paddings.
-            foreach ($paddings as $tag => $padding) {
-                $required = ($maxLength - strlen($tokens[$tag]['content']) + 1);
+            foreach ( $paddings as $tag => $padding ) {
+                $required = ( $maxLength - strlen( $tokens[ $tag ][ 'content' ] ) + 1 );
 
-                if ($padding !== $required) {
+                if ( $padding !== $required ) {
                     $error = 'Tag value indented incorrectly; expected %s spaces but found %s';
                     $data  = array(
                               $required,
                               $padding,
                              );
 
-                    $fix = $phpcsFile->addFixableError($error, ($tag + 1), 'TagValueIndent', $data);
-                    if ($fix === true) {
-                        $phpcsFile->fixer->replaceToken(($tag + 1), str_repeat(' ', $required));
+                    $fix = $phpcsFile->addFixableError( $error, ( $tag + 1 ), 'TagValueIndent', $data );
+                    if ( $fix === true ) {
+                        $phpcsFile->fixer->replaceToken( ( $tag + 1 ), str_repeat( ' ', $required ) );
                     }
                 }
             }
         }//end foreach
 
         // If there is a param group, it needs to be first.
-        if ($paramGroupid !== null && $paramGroupid !== 0) {
+        if ( $paramGroupid !== null && $paramGroupid !== 0 ) {
             $error = 'Parameter tags must be defined first in a doc comment';
-            $phpcsFile->addError($error, $tagGroups[$paramGroupid][0], 'ParamNotFirst');
+            $phpcsFile->addError( $error, $tagGroups[ $paramGroupid ][ 0 ], 'ParamNotFirst' );
         }
 
         $foundTags = array();
-        foreach ($tokens[$stackPtr]['comment_tags'] as $pos => $tag) {
-            $tagName = $tokens[$tag]['content'];
-            if (isset($foundTags[$tagName]) === true) {
-                $lastTag = $tokens[$stackPtr]['comment_tags'][($pos - 1)];
-                if ($tokens[$lastTag]['content'] !== $tagName) {
+        foreach ( $tokens[ $stackPtr ][ 'comment_tags' ] as $pos => $tag ) {
+            $tagName = $tokens[ $tag ][ 'content' ];
+            if ( isset( $foundTags[ $tagName ] ) === true ) {
+                $lastTag = $tokens[ $stackPtr ][ 'comment_tags' ][ ( $pos - 1 ) ];
+                if ( $tokens[ $lastTag ][ 'content' ] !== $tagName ) {
                     $error = 'Tags must be grouped together in a doc comment';
-                    $phpcsFile->addError($error, $tag, 'TagsNotGrouped');
+                    $phpcsFile->addError( $error, $tag, 'TagsNotGrouped' );
                 }
 
                 continue;
             }
 
-            $foundTags[$tagName] = true;
+            $foundTags[ $tagName ] = true;
         }
 
     }//end process()

Braces +3 added lines, -6 removed lines

@@ -23,8 +23,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class Generic_Sniffs_Commenting_DocCommentSniff implements PHP_CodeSniffer_Sniff
-{
+class Generic_Sniffs_Commenting_DocCommentSniff implements PHP_CodeSniffer_Sniff {
 
     /**
      * A list of tokenizers this sniff supports.
@@ -42,8 +41,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return array(T_DOC_COMMENT_OPEN_TAG);
 
     }//end register()
@@ -58,8 +56,7 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $tokens       = $phpcsFile->getTokens();
         $commentStart = $stackPtr;
         $commentEnd   = $tokens[$stackPtr]['comment_closer'];

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/Generic/Sniffs/Debug/ClosureLinterSniff.php

Doc Comments +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
     /**
      * Returns the token types that this sniff is interested in.
      *
-     * @return int[]
+     * @return integer[]
      */
     public function register()
     {
@@ -71,7 +71,7 @@ 
      * @param int                  $stackPtr  The position in the stack where
      *                                        the token was found.
      *
-     * @return void
+     * @return null|integer
      * @throws PHP_CodeSniffer_Exception If jslint.js could not be run
      */
     public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)

Indentation +94 added lines, -94 removed lines

@@ -28,100 +28,100 @@
 class Generic_Sniffs_Debug_ClosureLinterSniff implements PHP_CodeSniffer_Sniff
 {
 
-    /**
-     * A list of error codes that should show errors.
-     *
-     * All other error codes will show warnings.
-     *
-     * @var int
-     */
-    public $errorCodes = array();
-
-    /**
-     * A list of error codes to ignore.
-     *
-     * @var int
-     */
-    public $ignoreCodes = array();
-
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = array('JS');
-
-
-    /**
-     * Returns the token types that this sniff is interested in.
-     *
-     * @return int[]
-     */
-    public function register()
-    {
-        return array(T_OPEN_TAG);
-
-    }//end register()
-
-
-    /**
-     * Processes the tokens that this sniff is interested in.
-     *
-     * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
-     * @param int                  $stackPtr  The position in the stack where
-     *                                        the token was found.
-     *
-     * @return void
-     * @throws PHP_CodeSniffer_Exception If jslint.js could not be run
-     */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
-        $fileName = $phpcsFile->getFilename();
-
-        $lintPath = PHP_CodeSniffer::getConfigData('gjslint_path');
-        if ($lintPath === null) {
-            return;
-        }
-
-        $cmd = "$lintPath --nosummary --notime --unix_mode \"$fileName\"";
-        $msg = exec($cmd, $output, $retval);
-
-        if (is_array($output) === false) {
-            return;
-        }
-
-        foreach ($output as $finding) {
-            $matches    = array();
-            $numMatches = preg_match('/^(.*):([0-9]+):\(.*?([0-9]+)\)(.*)$/', $finding, $matches);
-            if ($numMatches === 0) {
-                continue;
-            }
-
-            // Skip error codes we are ignoring.
-            $code = $matches[3];
-            if (in_array($code, $this->ignoreCodes) === true) {
-                continue;
-            }
-
-            $line  = (int) $matches[2];
-            $error = trim($matches[4]);
-
-            $message = 'gjslint says: (%s) %s';
-            $data    = array(
-                        $code,
-                        $error,
-                       );
-            if (in_array($code, $this->errorCodes) === true) {
-                $phpcsFile->addErrorOnLine($message, $line, 'ExternalToolError', $data);
-            } else {
-                $phpcsFile->addWarningOnLine($message, $line, 'ExternalTool', $data);
-            }
-        }//end foreach
-
-        // Ignore the rest of the file.
-        return ($phpcsFile->numTokens + 1);
-
-    }//end process()
+	 /**
+	  * A list of error codes that should show errors.
+	  *
+	  * All other error codes will show warnings.
+	  *
+	  * @var int
+	  */
+	 public $errorCodes = array();
+
+	 /**
+	  * A list of error codes to ignore.
+	  *
+	  * @var int
+	  */
+	 public $ignoreCodes = array();
+
+	 /**
+	  * A list of tokenizers this sniff supports.
+	  *
+	  * @var array
+	  */
+	 public $supportedTokenizers = array('JS');
+
+
+	 /**
+	  * Returns the token types that this sniff is interested in.
+	  *
+	  * @return int[]
+	  */
+	 public function register()
+	 {
+		  return array(T_OPEN_TAG);
+
+	 }//end register()
+
+
+	 /**
+	  * Processes the tokens that this sniff is interested in.
+	  *
+	  * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
+	  * @param int                  $stackPtr  The position in the stack where
+	  *                                        the token was found.
+	  *
+	  * @return void
+	  * @throws PHP_CodeSniffer_Exception If jslint.js could not be run
+	  */
+	 public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+	 {
+		  $fileName = $phpcsFile->getFilename();
+
+		  $lintPath = PHP_CodeSniffer::getConfigData('gjslint_path');
+		  if ($lintPath === null) {
+				return;
+		  }
+
+		  $cmd = "$lintPath --nosummary --notime --unix_mode \"$fileName\"";
+		  $msg = exec($cmd, $output, $retval);
+
+		  if (is_array($output) === false) {
+				return;
+		  }
+
+		  foreach ($output as $finding) {
+				$matches    = array();
+				$numMatches = preg_match('/^(.*):([0-9]+):\(.*?([0-9]+)\)(.*)$/', $finding, $matches);
+				if ($numMatches === 0) {
+					 continue;
+				}
+
+				// Skip error codes we are ignoring.
+				$code = $matches[3];
+				if (in_array($code, $this->ignoreCodes) === true) {
+					 continue;
+				}
+
+				$line  = (int) $matches[2];
+				$error = trim($matches[4]);
+
+				$message = 'gjslint says: (%s) %s';
+				$data    = array(
+								$code,
+								$error,
+							  );
+				if (in_array($code, $this->errorCodes) === true) {
+					 $phpcsFile->addErrorOnLine($message, $line, 'ExternalToolError', $data);
+				} else {
+					 $phpcsFile->addWarningOnLine($message, $line, 'ExternalTool', $data);
+				}
+		  }//end foreach
+
+		  // Ignore the rest of the file.
+		  return ($phpcsFile->numTokens + 1);
+
+	 }//end process()
 
 
 }//end class

Spacing +18 added lines, -18 removed lines

@@ -49,7 +49,7 @@ 
      *
      * @var array
      */
-    public $supportedTokenizers = array('JS');
+    public $supportedTokenizers = array( 'JS' );
 
 
     /**
@@ -59,7 +59,7 @@ 
      */
     public function register()
     {
-        return array(T_OPEN_TAG);
+        return array( T_OPEN_TAG );
 
     }//end register()
 
@@ -74,52 +74,52 @@ 
      * @return void
      * @throws PHP_CodeSniffer_Exception If jslint.js could not be run
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $fileName = $phpcsFile->getFilename();
 
-        $lintPath = PHP_CodeSniffer::getConfigData('gjslint_path');
-        if ($lintPath === null) {
+        $lintPath = PHP_CodeSniffer::getConfigData( 'gjslint_path' );
+        if ( $lintPath === null ) {
             return;
         }
 
         $cmd = "$lintPath --nosummary --notime --unix_mode \"$fileName\"";
-        $msg = exec($cmd, $output, $retval);
+        $msg = exec( $cmd, $output, $retval );
 
-        if (is_array($output) === false) {
+        if ( is_array( $output ) === false ) {
             return;
         }
 
-        foreach ($output as $finding) {
+        foreach ( $output as $finding ) {
             $matches    = array();
-            $numMatches = preg_match('/^(.*):([0-9]+):\(.*?([0-9]+)\)(.*)$/', $finding, $matches);
-            if ($numMatches === 0) {
+            $numMatches = preg_match( '/^(.*):([0-9]+):\(.*?([0-9]+)\)(.*)$/', $finding, $matches );
+            if ( $numMatches === 0 ) {
                 continue;
             }
 
             // Skip error codes we are ignoring.
-            $code = $matches[3];
-            if (in_array($code, $this->ignoreCodes) === true) {
+            $code = $matches[ 3 ];
+            if ( in_array( $code, $this->ignoreCodes ) === true ) {
                 continue;
             }
 
-            $line  = (int) $matches[2];
-            $error = trim($matches[4]);
+            $line  = (int) $matches[ 2 ];
+            $error = trim( $matches[ 4 ] );
 
             $message = 'gjslint says: (%s) %s';
             $data    = array(
                         $code,
                         $error,
                        );
-            if (in_array($code, $this->errorCodes) === true) {
-                $phpcsFile->addErrorOnLine($message, $line, 'ExternalToolError', $data);
+            if ( in_array( $code, $this->errorCodes ) === true ) {
+                $phpcsFile->addErrorOnLine( $message, $line, 'ExternalToolError', $data );
             } else {
-                $phpcsFile->addWarningOnLine($message, $line, 'ExternalTool', $data);
+                $phpcsFile->addWarningOnLine( $message, $line, 'ExternalTool', $data );
             }
         }//end foreach
 
         // Ignore the rest of the file.
-        return ($phpcsFile->numTokens + 1);
+        return ( $phpcsFile->numTokens + 1 );
 
     }//end process()
 

Braces +3 added lines, -6 removed lines

@@ -25,8 +25,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class Generic_Sniffs_Debug_ClosureLinterSniff implements PHP_CodeSniffer_Sniff
-{
+class Generic_Sniffs_Debug_ClosureLinterSniff implements PHP_CodeSniffer_Sniff {
 
     /**
      * A list of error codes that should show errors.
@@ -57,8 +56,7 @@ 
      *
      * @return int[]
      */
-    public function register()
-    {
+    public function register() {
         return array(T_OPEN_TAG);
 
     }//end register()
@@ -74,8 +72,7 @@ 
      * @return void
      * @throws PHP_CodeSniffer_Exception If jslint.js could not be run
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $fileName = $phpcsFile->getFilename();
 
         $lintPath = PHP_CodeSniffer::getConfigData('gjslint_path');

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/Generic/Sniffs/Debug/JSHintSniff.php

Doc Comments +2 added lines, -2 removed lines

@@ -41,7 +41,7 @@ 
     /**
      * Returns the token types that this sniff is interested in.
      *
-     * @return int[]
+     * @return integer[]
      */
     public function register()
     {
@@ -57,7 +57,7 @@ 
      * @param int                  $stackPtr  The position in the stack where
      *                                        the token was found.
      *
-     * @return void
+     * @return null|integer
      * @throws PHP_CodeSniffer_Exception If jshint.js could not be run
      */
     public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)

Indentation +50 added lines, -50 removed lines

@@ -30,67 +30,67 @@
 class Generic_Sniffs_Debug_JSHintSniff implements PHP_CodeSniffer_Sniff
 {
 
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = array('JS');
+	 /**
+	  * A list of tokenizers this sniff supports.
+	  *
+	  * @var array
+	  */
+	 public $supportedTokenizers = array('JS');
 
 
-    /**
-     * Returns the token types that this sniff is interested in.
-     *
-     * @return int[]
-     */
-    public function register()
-    {
-        return array(T_OPEN_TAG);
+	 /**
+	  * Returns the token types that this sniff is interested in.
+	  *
+	  * @return int[]
+	  */
+	 public function register()
+	 {
+		  return array(T_OPEN_TAG);
 
-    }//end register()
+	 }//end register()
 
 
-    /**
-     * Processes the tokens that this sniff is interested in.
-     *
-     * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
-     * @param int                  $stackPtr  The position in the stack where
-     *                                        the token was found.
-     *
-     * @return void
-     * @throws PHP_CodeSniffer_Exception If jshint.js could not be run
-     */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
-        $fileName = $phpcsFile->getFilename();
+	 /**
+	  * Processes the tokens that this sniff is interested in.
+	  *
+	  * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
+	  * @param int                  $stackPtr  The position in the stack where
+	  *                                        the token was found.
+	  *
+	  * @return void
+	  * @throws PHP_CodeSniffer_Exception If jshint.js could not be run
+	  */
+	 public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+	 {
+		  $fileName = $phpcsFile->getFilename();
 
-        $rhinoPath  = PHP_CodeSniffer::getConfigData('rhino_path');
-        $jshintPath = PHP_CodeSniffer::getConfigData('jshint_path');
-        if ($rhinoPath === null || $jshintPath === null) {
-            return;
-        }
+		  $rhinoPath  = PHP_CodeSniffer::getConfigData('rhino_path');
+		  $jshintPath = PHP_CodeSniffer::getConfigData('jshint_path');
+		  if ($rhinoPath === null || $jshintPath === null) {
+				return;
+		  }
 
-        $cmd = "$rhinoPath \"$jshintPath\" \"$fileName\"";
-        $msg = exec($cmd, $output, $retval);
+		  $cmd = "$rhinoPath \"$jshintPath\" \"$fileName\"";
+		  $msg = exec($cmd, $output, $retval);
 
-        if (is_array($output) === true) {
-            foreach ($output as $finding) {
-                $matches    = array();
-                $numMatches = preg_match('/^(.+)\(.+:([0-9]+).*:[0-9]+\)$/', $finding, $matches);
-                if ($numMatches === 0) {
-                    continue;
-                }
+		  if (is_array($output) === true) {
+				foreach ($output as $finding) {
+					 $matches    = array();
+					 $numMatches = preg_match('/^(.+)\(.+:([0-9]+).*:[0-9]+\)$/', $finding, $matches);
+					 if ($numMatches === 0) {
+						  continue;
+					 }
 
-                $line    = (int) $matches[2];
-                $message = 'jshint says: '.trim($matches[1]);
-                $phpcsFile->addWarningOnLine($message, $line, 'ExternalTool');
-            }
-        }
+					 $line    = (int) $matches[2];
+					 $message = 'jshint says: '.trim($matches[1]);
+					 $phpcsFile->addWarningOnLine($message, $line, 'ExternalTool');
+				}
+		  }
 
-        // Ignore the rest of the file.
-        return ($phpcsFile->numTokens + 1);
+		  // Ignore the rest of the file.
+		  return ($phpcsFile->numTokens + 1);
 
-    }//end process()
+	 }//end process()
 
 
 }//end class

Spacing +15 added lines, -15 removed lines

@@ -35,7 +35,7 @@ 
      *
      * @var array
      */
-    public $supportedTokenizers = array('JS');
+    public $supportedTokenizers = array( 'JS' );
 
 
     /**
@@ -45,7 +45,7 @@ 
      */
     public function register()
     {
-        return array(T_OPEN_TAG);
+        return array( T_OPEN_TAG );
 
     }//end register()
 
@@ -60,35 +60,35 @@ 
      * @return void
      * @throws PHP_CodeSniffer_Exception If jshint.js could not be run
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $fileName = $phpcsFile->getFilename();
 
-        $rhinoPath  = PHP_CodeSniffer::getConfigData('rhino_path');
-        $jshintPath = PHP_CodeSniffer::getConfigData('jshint_path');
-        if ($rhinoPath === null || $jshintPath === null) {
+        $rhinoPath  = PHP_CodeSniffer::getConfigData( 'rhino_path' );
+        $jshintPath = PHP_CodeSniffer::getConfigData( 'jshint_path' );
+        if ( $rhinoPath === null || $jshintPath === null ) {
             return;
         }
 
         $cmd = "$rhinoPath \"$jshintPath\" \"$fileName\"";
-        $msg = exec($cmd, $output, $retval);
+        $msg = exec( $cmd, $output, $retval );
 
-        if (is_array($output) === true) {
-            foreach ($output as $finding) {
+        if ( is_array( $output ) === true ) {
+            foreach ( $output as $finding ) {
                 $matches    = array();
-                $numMatches = preg_match('/^(.+)\(.+:([0-9]+).*:[0-9]+\)$/', $finding, $matches);
-                if ($numMatches === 0) {
+                $numMatches = preg_match( '/^(.+)\(.+:([0-9]+).*:[0-9]+\)$/', $finding, $matches );
+                if ( $numMatches === 0 ) {
                     continue;
                 }
 
-                $line    = (int) $matches[2];
-                $message = 'jshint says: '.trim($matches[1]);
-                $phpcsFile->addWarningOnLine($message, $line, 'ExternalTool');
+                $line    = (int) $matches[ 2 ];
+                $message = 'jshint says: ' . trim( $matches[ 1 ] );
+                $phpcsFile->addWarningOnLine( $message, $line, 'ExternalTool' );
             }
         }
 
         // Ignore the rest of the file.
-        return ($phpcsFile->numTokens + 1);
+        return ( $phpcsFile->numTokens + 1 );
 
     }//end process()
 

Braces +3 added lines, -6 removed lines

@@ -27,8 +27,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class Generic_Sniffs_Debug_JSHintSniff implements PHP_CodeSniffer_Sniff
-{
+class Generic_Sniffs_Debug_JSHintSniff implements PHP_CodeSniffer_Sniff {
 
     /**
      * A list of tokenizers this sniff supports.
@@ -43,8 +42,7 @@ 
      *
      * @return int[]
      */
-    public function register()
-    {
+    public function register() {
         return array(T_OPEN_TAG);
 
     }//end register()
@@ -60,8 +58,7 @@ 
      * @return void
      * @throws PHP_CodeSniffer_Exception If jshint.js could not be run
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $fileName = $phpcsFile->getFilename();
 
         $rhinoPath  = PHP_CodeSniffer::getConfigData('rhino_path');

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/Generic/Sniffs/Formatting/DisallowMultipleStatementsSniff.php

Doc Comments +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return string[]
      */
     public function register()
     {

Indentation +58 added lines, -58 removed lines

@@ -29,74 +29,74 @@
 {
 
 
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(T_SEMICOLON);
+	 /**
+	  * Returns an array of tokens this test wants to listen for.
+	  *
+	  * @return array
+	  */
+	 public function register()
+	 {
+		  return array(T_SEMICOLON);
 
-    }//end register()
+	 }//end register()
 
 
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
-     * @param int                  $stackPtr  The position of the current token in
-     *                                        the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
+	 /**
+	  * Processes this test, when one of its tokens is encountered.
+	  *
+	  * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+	  * @param int                  $stackPtr  The position of the current token in
+	  *                                        the stack passed in $tokens.
+	  *
+	  * @return void
+	  */
+	 public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+	 {
+		  $tokens = $phpcsFile->getTokens();
 
-        $prev = $phpcsFile->findPrevious(array(T_SEMICOLON, T_OPEN_TAG, T_OPEN_TAG_WITH_ECHO), ($stackPtr - 1));
-        if ($prev === false
-            || $tokens[$prev]['code'] === T_OPEN_TAG
-            || $tokens[$prev]['code'] === T_OPEN_TAG_WITH_ECHO
-        ) {
-            $phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'no');
-            return;
-        }
+		  $prev = $phpcsFile->findPrevious(array(T_SEMICOLON, T_OPEN_TAG, T_OPEN_TAG_WITH_ECHO), ($stackPtr - 1));
+		  if ($prev === false
+				|| $tokens[$prev]['code'] === T_OPEN_TAG
+				|| $tokens[$prev]['code'] === T_OPEN_TAG_WITH_ECHO
+		  ) {
+				$phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'no');
+				return;
+		  }
 
-        // Ignore multiple statements in a FOR condition.
-        if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
-            foreach ($tokens[$stackPtr]['nested_parenthesis'] as $bracket) {
-                if (isset($tokens[$bracket]['parenthesis_owner']) === false) {
-                    // Probably a closure sitting inside a function call.
-                    continue;
-                }
+		  // Ignore multiple statements in a FOR condition.
+		  if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
+				foreach ($tokens[$stackPtr]['nested_parenthesis'] as $bracket) {
+					 if (isset($tokens[$bracket]['parenthesis_owner']) === false) {
+						  // Probably a closure sitting inside a function call.
+						  continue;
+					 }
 
-                $owner = $tokens[$bracket]['parenthesis_owner'];
-                if ($tokens[$owner]['code'] === T_FOR) {
-                    return;
-                }
-            }
-        }
+					 $owner = $tokens[$bracket]['parenthesis_owner'];
+					 if ($tokens[$owner]['code'] === T_FOR) {
+						  return;
+					 }
+				}
+		  }
 
-        if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
-            $phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'yes');
+		  if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
+				$phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'yes');
 
-            $error = 'Each PHP statement must be on a line by itself';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SameLine');
-            if ($fix === true) {
-                $phpcsFile->fixer->beginChangeset();
-                $phpcsFile->fixer->addNewline($prev);
-                if ($tokens[($prev + 1)]['code'] === T_WHITESPACE) {
-                    $phpcsFile->fixer->replaceToken(($prev + 1), '');
-                }
+				$error = 'Each PHP statement must be on a line by itself';
+				$fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SameLine');
+				if ($fix === true) {
+					 $phpcsFile->fixer->beginChangeset();
+					 $phpcsFile->fixer->addNewline($prev);
+					 if ($tokens[($prev + 1)]['code'] === T_WHITESPACE) {
+						  $phpcsFile->fixer->replaceToken(($prev + 1), '');
+					 }
 
-                $phpcsFile->fixer->endChangeset();
-            }
-        } else {
-            $phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'no');
-        }
+					 $phpcsFile->fixer->endChangeset();
+				}
+		  } else {
+				$phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'no');
+		  }
 
-    }//end process()
+	 }//end process()
 
 
 }//end class

Spacing +20 added lines, -20 removed lines

@@ -36,7 +36,7 @@ 
      */
     public function register()
     {
-        return array(T_SEMICOLON);
+        return array( T_SEMICOLON );
 
     }//end register()
 
@@ -50,50 +50,50 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $tokens = $phpcsFile->getTokens();
 
-        $prev = $phpcsFile->findPrevious(array(T_SEMICOLON, T_OPEN_TAG, T_OPEN_TAG_WITH_ECHO), ($stackPtr - 1));
-        if ($prev === false
-            || $tokens[$prev]['code'] === T_OPEN_TAG
-            || $tokens[$prev]['code'] === T_OPEN_TAG_WITH_ECHO
+        $prev = $phpcsFile->findPrevious( array( T_SEMICOLON, T_OPEN_TAG, T_OPEN_TAG_WITH_ECHO ), ( $stackPtr - 1 ) );
+        if ( $prev === false
+            || $tokens[ $prev ][ 'code' ] === T_OPEN_TAG
+            || $tokens[ $prev ][ 'code' ] === T_OPEN_TAG_WITH_ECHO
         ) {
-            $phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'no');
+            $phpcsFile->recordMetric( $stackPtr, 'Multiple statements on same line', 'no' );
             return;
         }
 
         // Ignore multiple statements in a FOR condition.
-        if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
-            foreach ($tokens[$stackPtr]['nested_parenthesis'] as $bracket) {
-                if (isset($tokens[$bracket]['parenthesis_owner']) === false) {
+        if ( isset( $tokens[ $stackPtr ][ 'nested_parenthesis' ] ) === true ) {
+            foreach ( $tokens[ $stackPtr ][ 'nested_parenthesis' ] as $bracket ) {
+                if ( isset( $tokens[ $bracket ][ 'parenthesis_owner' ] ) === false ) {
                     // Probably a closure sitting inside a function call.
                     continue;
                 }
 
-                $owner = $tokens[$bracket]['parenthesis_owner'];
-                if ($tokens[$owner]['code'] === T_FOR) {
+                $owner = $tokens[ $bracket ][ 'parenthesis_owner' ];
+                if ( $tokens[ $owner ][ 'code' ] === T_FOR ) {
                     return;
                 }
             }
         }
 
-        if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
-            $phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'yes');
+        if ( $tokens[ $prev ][ 'line' ] === $tokens[ $stackPtr ][ 'line' ] ) {
+            $phpcsFile->recordMetric( $stackPtr, 'Multiple statements on same line', 'yes' );
 
             $error = 'Each PHP statement must be on a line by itself';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SameLine');
-            if ($fix === true) {
+            $fix   = $phpcsFile->addFixableError( $error, $stackPtr, 'SameLine' );
+            if ( $fix === true ) {
                 $phpcsFile->fixer->beginChangeset();
-                $phpcsFile->fixer->addNewline($prev);
-                if ($tokens[($prev + 1)]['code'] === T_WHITESPACE) {
-                    $phpcsFile->fixer->replaceToken(($prev + 1), '');
+                $phpcsFile->fixer->addNewline( $prev );
+                if ( $tokens[ ( $prev + 1 ) ][ 'code' ] === T_WHITESPACE ) {
+                    $phpcsFile->fixer->replaceToken( ( $prev + 1 ), '' );
                 }
 
                 $phpcsFile->fixer->endChangeset();
             }
         } else {
-            $phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'no');
+            $phpcsFile->recordMetric( $stackPtr, 'Multiple statements on same line', 'no' );
         }
 
     }//end process()

Braces +3 added lines, -6 removed lines

@@ -25,8 +25,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class Generic_Sniffs_Formatting_DisallowMultipleStatementsSniff implements PHP_CodeSniffer_Sniff
-{
+class Generic_Sniffs_Formatting_DisallowMultipleStatementsSniff implements PHP_CodeSniffer_Sniff {
 
 
     /**
@@ -34,8 +33,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return array(T_SEMICOLON);
 
     }//end register()
@@ -50,8 +48,7 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $tokens = $phpcsFile->getTokens();
 
         $prev = $phpcsFile->findPrevious(array(T_SEMICOLON, T_OPEN_TAG, T_OPEN_TAG_WITH_ECHO), ($stackPtr - 1));

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/Generic/Sniffs/Functions/CallTimePassByReferenceSniff.php

Doc Comments +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return integer[]
      */
     public function register()
     {

Indentation +125 added lines, -125 removed lines

@@ -29,131 +29,131 @@
 {
 
 
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-                T_STRING,
-                T_VARIABLE,
-               );
-
-    }//end register()
-
-
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-
-        $findTokens = array_merge(
-            PHP_CodeSniffer_Tokens::$emptyTokens,
-            array(T_BITWISE_AND)
-        );
-
-        $prev = $phpcsFile->findPrevious($findTokens, ($stackPtr - 1), null, true);
-
-        // Skip tokens that are the names of functions or classes
-        // within their definitions. For example: function myFunction...
-        // "myFunction" is T_STRING but we should skip because it is not a
-        // function or method *call*.
-        $prevCode = $tokens[$prev]['code'];
-        if ($prevCode === T_FUNCTION || $prevCode === T_CLASS) {
-            return;
-        }
-
-        // If the next non-whitespace token after the function or method call
-        // is not an opening parenthesis then it cant really be a *call*.
-        $functionName = $stackPtr;
-        $openBracket  = $phpcsFile->findNext(
-            PHP_CodeSniffer_Tokens::$emptyTokens,
-            ($functionName + 1),
-            null,
-            true
-        );
-
-        if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
-            return;
-        }
-
-        if (isset($tokens[$openBracket]['parenthesis_closer']) === false) {
-            return;
-        }
-
-        $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
-
-        $nextSeparator = $openBracket;
-        $find          = array(
-                          T_VARIABLE,
-                          T_OPEN_SHORT_ARRAY,
-                         );
-
-        while (($nextSeparator = $phpcsFile->findNext($find, ($nextSeparator + 1), $closeBracket)) !== false) {
-            if (isset($tokens[$nextSeparator]['nested_parenthesis']) === false) {
-                continue;
-            }
-
-            if ($tokens[$nextSeparator]['code'] === T_OPEN_SHORT_ARRAY) {
-                $nextSeparator = $tokens[$nextSeparator]['bracket_closer'];
-                continue;
-            }
-
-            // Make sure the variable belongs directly to this function call
-            // and is not inside a nested function call or array.
-            $brackets    = $tokens[$nextSeparator]['nested_parenthesis'];
-            $lastBracket = array_pop($brackets);
-            if ($lastBracket !== $closeBracket) {
-                continue;
-            }
-
-            // Checking this: $value = my_function(...[*]$arg...).
-            $tokenBefore = $phpcsFile->findPrevious(
-                PHP_CodeSniffer_Tokens::$emptyTokens,
-                ($nextSeparator - 1),
-                null,
-                true
-            );
-
-            if ($tokens[$tokenBefore]['code'] === T_BITWISE_AND) {
-                // Checking this: $value = my_function(...[*]&$arg...).
-                $tokenBefore = $phpcsFile->findPrevious(
-                    PHP_CodeSniffer_Tokens::$emptyTokens,
-                    ($tokenBefore - 1),
-                    null,
-                    true
-                );
-
-                // We have to exclude all uses of T_BITWISE_AND that are not
-                // references. We use a blacklist approach as we prefer false
-                // positives to not identifying a pass-by-reference call at all.
-                $tokenCode = $tokens[$tokenBefore]['code'];
-                if ($tokenCode === T_VARIABLE
-                    || $tokenCode === T_CLOSE_PARENTHESIS
-                    || $tokenCode === T_CLOSE_SQUARE_BRACKET
-                    || $tokenCode === T_LNUMBER
-                    || isset(PHP_CodeSniffer_Tokens::$assignmentTokens[$tokenCode]) === true
-                ) {
-                    continue;
-                }
-
-                // T_BITWISE_AND represents a pass-by-reference.
-                $error = 'Call-time pass-by-reference calls are prohibited';
-                $phpcsFile->addError($error, $tokenBefore, 'NotAllowed');
-            }//end if
-        }//end while
-
-    }//end process()
+	 /**
+	  * Returns an array of tokens this test wants to listen for.
+	  *
+	  * @return array
+	  */
+	 public function register()
+	 {
+		  return array(
+					 T_STRING,
+					 T_VARIABLE,
+					);
+
+	 }//end register()
+
+
+	 /**
+	  * Processes this test, when one of its tokens is encountered.
+	  *
+	  * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+	  * @param int                  $stackPtr  The position of the current token
+	  *                                        in the stack passed in $tokens.
+	  *
+	  * @return void
+	  */
+	 public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+	 {
+		  $tokens = $phpcsFile->getTokens();
+
+		  $findTokens = array_merge(
+				PHP_CodeSniffer_Tokens::$emptyTokens,
+				array(T_BITWISE_AND)
+		  );
+
+		  $prev = $phpcsFile->findPrevious($findTokens, ($stackPtr - 1), null, true);
+
+		  // Skip tokens that are the names of functions or classes
+		  // within their definitions. For example: function myFunction...
+		  // "myFunction" is T_STRING but we should skip because it is not a
+		  // function or method *call*.
+		  $prevCode = $tokens[$prev]['code'];
+		  if ($prevCode === T_FUNCTION || $prevCode === T_CLASS) {
+				return;
+		  }
+
+		  // If the next non-whitespace token after the function or method call
+		  // is not an opening parenthesis then it cant really be a *call*.
+		  $functionName = $stackPtr;
+		  $openBracket  = $phpcsFile->findNext(
+				PHP_CodeSniffer_Tokens::$emptyTokens,
+				($functionName + 1),
+				null,
+				true
+		  );
+
+		  if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
+				return;
+		  }
+
+		  if (isset($tokens[$openBracket]['parenthesis_closer']) === false) {
+				return;
+		  }
+
+		  $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
+
+		  $nextSeparator = $openBracket;
+		  $find          = array(
+								  T_VARIABLE,
+								  T_OPEN_SHORT_ARRAY,
+								 );
+
+		  while (($nextSeparator = $phpcsFile->findNext($find, ($nextSeparator + 1), $closeBracket)) !== false) {
+				if (isset($tokens[$nextSeparator]['nested_parenthesis']) === false) {
+					 continue;
+				}
+
+				if ($tokens[$nextSeparator]['code'] === T_OPEN_SHORT_ARRAY) {
+					 $nextSeparator = $tokens[$nextSeparator]['bracket_closer'];
+					 continue;
+				}
+
+				// Make sure the variable belongs directly to this function call
+				// and is not inside a nested function call or array.
+				$brackets    = $tokens[$nextSeparator]['nested_parenthesis'];
+				$lastBracket = array_pop($brackets);
+				if ($lastBracket !== $closeBracket) {
+					 continue;
+				}
+
+				// Checking this: $value = my_function(...[*]$arg...).
+				$tokenBefore = $phpcsFile->findPrevious(
+					 PHP_CodeSniffer_Tokens::$emptyTokens,
+					 ($nextSeparator - 1),
+					 null,
+					 true
+				);
+
+				if ($tokens[$tokenBefore]['code'] === T_BITWISE_AND) {
+					 // Checking this: $value = my_function(...[*]&$arg...).
+					 $tokenBefore = $phpcsFile->findPrevious(
+						  PHP_CodeSniffer_Tokens::$emptyTokens,
+						  ($tokenBefore - 1),
+						  null,
+						  true
+					 );
+
+					 // We have to exclude all uses of T_BITWISE_AND that are not
+					 // references. We use a blacklist approach as we prefer false
+					 // positives to not identifying a pass-by-reference call at all.
+					 $tokenCode = $tokens[$tokenBefore]['code'];
+					 if ($tokenCode === T_VARIABLE
+						  || $tokenCode === T_CLOSE_PARENTHESIS
+						  || $tokenCode === T_CLOSE_SQUARE_BRACKET
+						  || $tokenCode === T_LNUMBER
+						  || isset(PHP_CodeSniffer_Tokens::$assignmentTokens[$tokenCode]) === true
+					 ) {
+						  continue;
+					 }
+
+					 // T_BITWISE_AND represents a pass-by-reference.
+					 $error = 'Call-time pass-by-reference calls are prohibited';
+					 $phpcsFile->addError($error, $tokenBefore, 'NotAllowed');
+				}//end if
+		  }//end while
+
+	 }//end process()
 
 
 }//end class

Spacing +23 added lines, -23 removed lines

@@ -53,23 +53,23 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $tokens = $phpcsFile->getTokens();
 
         $findTokens = array_merge(
             PHP_CodeSniffer_Tokens::$emptyTokens,
-            array(T_BITWISE_AND)
+            array( T_BITWISE_AND )
         );
 
-        $prev = $phpcsFile->findPrevious($findTokens, ($stackPtr - 1), null, true);
+        $prev = $phpcsFile->findPrevious( $findTokens, ( $stackPtr - 1 ), null, true );
 
         // Skip tokens that are the names of functions or classes
         // within their definitions. For example: function myFunction...
         // "myFunction" is T_STRING but we should skip because it is not a
         // function or method *call*.
-        $prevCode = $tokens[$prev]['code'];
-        if ($prevCode === T_FUNCTION || $prevCode === T_CLASS) {
+        $prevCode = $tokens[ $prev ][ 'code' ];
+        if ( $prevCode === T_FUNCTION || $prevCode === T_CLASS ) {
             return;
         }
 
@@ -78,20 +78,20 @@ 
         $functionName = $stackPtr;
         $openBracket  = $phpcsFile->findNext(
             PHP_CodeSniffer_Tokens::$emptyTokens,
-            ($functionName + 1),
+            ( $functionName + 1 ),
             null,
             true
         );
 
-        if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
+        if ( $tokens[ $openBracket ][ 'code' ] !== T_OPEN_PARENTHESIS ) {
             return;
         }
 
-        if (isset($tokens[$openBracket]['parenthesis_closer']) === false) {
+        if ( isset( $tokens[ $openBracket ][ 'parenthesis_closer' ] ) === false ) {
             return;
         }
 
-        $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
+        $closeBracket = $tokens[ $openBracket ][ 'parenthesis_closer' ];
 
         $nextSeparator = $openBracket;
         $find          = array(
@@ -99,37 +99,37 @@ 
                           T_OPEN_SHORT_ARRAY,
                          );
 
-        while (($nextSeparator = $phpcsFile->findNext($find, ($nextSeparator + 1), $closeBracket)) !== false) {
-            if (isset($tokens[$nextSeparator]['nested_parenthesis']) === false) {
+        while ( ( $nextSeparator = $phpcsFile->findNext( $find, ( $nextSeparator + 1 ), $closeBracket ) ) !== false ) {
+            if ( isset( $tokens[ $nextSeparator ][ 'nested_parenthesis' ] ) === false ) {
                 continue;
             }
 
-            if ($tokens[$nextSeparator]['code'] === T_OPEN_SHORT_ARRAY) {
-                $nextSeparator = $tokens[$nextSeparator]['bracket_closer'];
+            if ( $tokens[ $nextSeparator ][ 'code' ] === T_OPEN_SHORT_ARRAY ) {
+                $nextSeparator = $tokens[ $nextSeparator ][ 'bracket_closer' ];
                 continue;
             }
 
             // Make sure the variable belongs directly to this function call
             // and is not inside a nested function call or array.
-            $brackets    = $tokens[$nextSeparator]['nested_parenthesis'];
-            $lastBracket = array_pop($brackets);
-            if ($lastBracket !== $closeBracket) {
+            $brackets    = $tokens[ $nextSeparator ][ 'nested_parenthesis' ];
+            $lastBracket = array_pop( $brackets );
+            if ( $lastBracket !== $closeBracket ) {
                 continue;
             }
 
             // Checking this: $value = my_function(...[*]$arg...).
             $tokenBefore = $phpcsFile->findPrevious(
                 PHP_CodeSniffer_Tokens::$emptyTokens,
-                ($nextSeparator - 1),
+                ( $nextSeparator - 1 ),
                 null,
                 true
             );
 
-            if ($tokens[$tokenBefore]['code'] === T_BITWISE_AND) {
+            if ( $tokens[ $tokenBefore ][ 'code' ] === T_BITWISE_AND ) {
                 // Checking this: $value = my_function(...[*]&$arg...).
                 $tokenBefore = $phpcsFile->findPrevious(
                     PHP_CodeSniffer_Tokens::$emptyTokens,
-                    ($tokenBefore - 1),
+                    ( $tokenBefore - 1 ),
                     null,
                     true
                 );
@@ -137,19 +137,19 @@ 
                 // We have to exclude all uses of T_BITWISE_AND that are not
                 // references. We use a blacklist approach as we prefer false
                 // positives to not identifying a pass-by-reference call at all.
-                $tokenCode = $tokens[$tokenBefore]['code'];
-                if ($tokenCode === T_VARIABLE
+                $tokenCode = $tokens[ $tokenBefore ][ 'code' ];
+                if ( $tokenCode === T_VARIABLE
                     || $tokenCode === T_CLOSE_PARENTHESIS
                     || $tokenCode === T_CLOSE_SQUARE_BRACKET
                     || $tokenCode === T_LNUMBER
-                    || isset(PHP_CodeSniffer_Tokens::$assignmentTokens[$tokenCode]) === true
+                    || isset( PHP_CodeSniffer_Tokens::$assignmentTokens[ $tokenCode ] ) === true
                 ) {
                     continue;
                 }
 
                 // T_BITWISE_AND represents a pass-by-reference.
                 $error = 'Call-time pass-by-reference calls are prohibited';
-                $phpcsFile->addError($error, $tokenBefore, 'NotAllowed');
+                $phpcsFile->addError( $error, $tokenBefore, 'NotAllowed' );
             }//end if
         }//end while
 

Braces +3 added lines, -6 removed lines

@@ -25,8 +25,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class Generic_Sniffs_Functions_CallTimePassByReferenceSniff implements PHP_CodeSniffer_Sniff
-{
+class Generic_Sniffs_Functions_CallTimePassByReferenceSniff implements PHP_CodeSniffer_Sniff {
 
 
     /**
@@ -34,8 +33,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return array(
                 T_STRING,
                 T_VARIABLE,
@@ -53,8 +51,7 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $tokens = $phpcsFile->getTokens();
 
         $findTokens = array_merge(