Symplify / PHP7_CodeSniffer

src/Files/FileList.php

Doc Comments +1 added lines, -1 removed lines

@@ -193,7 +193,7 @@
     /**
      * Return the file path of the current file being processed.
      *
-     * @return void
+     * @return string
      */
     function key()
     {

Spacing +1 added lines, -1 removed lines

@@ -106,7 +106,7 @@
      *
      * @return void
      */
-    public function addFile($path, $file=null)
+    public function addFile($path, $file = null)
     {
         // No filtering is done for STDIN.
         if ($path === 'STDIN'

Unused Use Statements -1 removed lines

@@ -10,7 +10,6 @@
 namespace PHP_CodeSniffer\Reports;
 
 use PHP_CodeSniffer\Files\File;
-use PHP_CodeSniffer\Util;
 
 class Diff implements Report
 {

src/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 +3 added lines, -3 removed lines

@@ -529,9 +529,9 @@
 
         if (isset($this->_oldTokenValues[$stackPtr]) === false) {
             $this->_oldTokenValues[$stackPtr] = array(
-                                                 'curr' => $content,
-                                                 'prev' => $this->_tokens[$stackPtr],
-                                                 'loop' => $this->loops,
+                                                    'curr' => $content,
+                                                    'prev' => $this->_tokens[$stackPtr],
+                                                    'loop' => $this->loops,
                                                 );
         } else {
             if ($this->_oldTokenValues[$stackPtr]['prev'] === $content

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 +2 added lines, -2 removed lines

@@ -237,7 +237,7 @@ 
      *
      * @return string
      */
-    public function generateDiff($filePath=null, $colors=true)
+    public function generateDiff($filePath = null, $colors = true)
     {
         if ($filePath === null) {
             $filePath = $this->_currentFile->getFilename();
@@ -654,7 +654,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);
 

src/Generators/Generator.php

Unused Use Statements -1 removed lines

@@ -14,7 +14,6 @@
 
 use PHP_CodeSniffer\Ruleset;
 use PHP_CodeSniffer\Autoload;
-use PHP_CodeSniffer\Util\Common;
 
 abstract class Generator
 {

src/Reports/Cbf.php

Doc Comments +2 added lines, -2 removed lines

@@ -27,11 +27,11 @@
      * 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 File $phpcsFile   The file being reported on.
      * @param bool                  $showSources Show sources?
      * @param int                   $width       Maximum allowed line width.
      *
-     * @return bool
+     * @return null|boolean
      */
     public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)
     {

Spacing +5 added lines, -5 removed lines

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

src/Reports/Diff.php

Unused Use Statements -1 removed lines

@@ -10,7 +10,6 @@
 namespace PHP_CodeSniffer\Reports;
 
 use PHP_CodeSniffer\Files\File;
-use PHP_CodeSniffer\Util;
 
 class Diff implements Report
 {

Doc Comments +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
      * 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 File $phpcsFile   The file being reported on.
      * @param bool                  $showSources Show sources?
      * @param int                   $width       Maximum allowed line width.
      *

Spacing +5 added lines, -5 removed lines

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

src/Reports/Xml.php

Doc Comments +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
      * 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 File $phpcsFile   The file being reported on.
      * @param bool                  $showSources Show sources?
      * @param int                   $width       Maximum allowed line width.
      *

Spacing +5 added lines, -5 removed lines

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

src/Sniffs/AbstractPatternSniff.php

Doc Comments +3 added lines, -3 removed lines

@@ -177,7 +177,7 @@ 
     /**
      * Processes the test.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where the
+     * @param File $phpcsFile The PHP_CodeSniffer file where the
      *                                        token occurred.
      * @param int                  $stackPtr  The position in the tokens stack
      *                                        where the listening token type was
@@ -247,7 +247,7 @@ 
      *                                          for checking, which includes are
      *                                          parsed token representation of the
      *                                          pattern.
-     * @param PHP_CodeSniffer_File $phpcsFile   The PHP_CodeSniffer file where the
+     * @param File $phpcsFile   The PHP_CodeSniffer file where the
      *                                          token occurred.
      * @param int                  $stackPtr    The position in the tokens stack where
      *                                          the listening token type was found.
@@ -746,7 +746,7 @@ 
      /**
       * Processes any tokens registered with registerSupplementary().
       *
-      * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where to
+      * @param File $phpcsFile The PHP_CodeSniffer file where to
       *                                        process the skip.
       * @param int                  $stackPtr  The position in the tokens stack to
       *                                        process.

Unused Use Statements -1 removed lines

@@ -10,7 +10,6 @@
 namespace PHP_CodeSniffer\Sniffs;
 
 use PHP_CodeSniffer\Files\File;
-use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Util\Tokens;
 use PHP_CodeSniffer\Tokenizers\PHP;
 use PHP_CodeSniffer\Exceptions\RuntimeException;

Indentation +18 added lines, -18 removed lines

@@ -114,9 +114,9 @@ 
             $listenTypes[] = $tokenType;
 
             $patternArray = array(
-                             'listen_pos'   => $pos,
-                             'pattern'      => $parsedPattern,
-                             'pattern_code' => $pattern,
+                                'listen_pos'   => $pos,
+                                'pattern'      => $parsedPattern,
+                                'pattern_code' => $pattern,
                             );
 
             if (isset($this->_parsedPatterns[$tokenType]) === false) {
@@ -763,17 +763,17 @@ 
     }//end registerSupplementary()
 
 
-     /**
-      * Processes any tokens registered with registerSupplementary().
-      *
-      * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where to
-      *                                        process the skip.
-      * @param int                  $stackPtr  The position in the tokens stack to
-      *                                        process.
-      *
-      * @return void
-      * @see    registerSupplementary()
-      */
+        /**
+         * Processes any tokens registered with registerSupplementary().
+         *
+         * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where to
+         *                                        process the skip.
+         * @param int                  $stackPtr  The position in the tokens stack to
+         *                                        process.
+         *
+         * @return void
+         * @see    registerSupplementary()
+         */
     protected function processSupplementary(
         PHP_CodeSniffer_File $phpcsFile,
         $stackPtr
@@ -948,10 +948,10 @@ 
         $patterns = array();
         foreach ($tokens as $patternInfo) {
             $patterns[] = array(
-                           'type'  => 'token',
-                           'token' => $patternInfo['code'],
-                           'value' => $patternInfo['content'],
-                          );
+                            'type'  => 'token',
+                            'token' => $patternInfo['code'],
+                            'value' => $patternInfo['content'],
+                            );
         }
 
         return $patterns;

Switch Indentation +18 added lines, -18 removed lines

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

Spacing +1 added lines, -1 removed lines

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

src/Sniffs/AbstractVariableSniff.php

Doc Comments +5 added lines, -5 removed lines

@@ -69,7 +69,7 @@ 
     /**
      * Processes the token in the specified PHP_CodeSniffer_File.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this
+     * @param File $phpcsFile The PHP_CodeSniffer file where this
      *                                        token was found.
      * @param int                  $stackPtr  The position where the token was found.
      * @param array                $currScope The current scope opener token.
@@ -143,7 +143,7 @@ 
     /**
      * Processes the token outside the scope in the file.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this
+     * @param File $phpcsFile The PHP_CodeSniffer file where this
      *                                        token was found.
      * @param int                  $stackPtr  The position where the token was found.
      *
@@ -171,7 +171,7 @@ 
     /**
      * Called to process class member vars.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this
+     * @param File $phpcsFile The PHP_CodeSniffer file where this
      *                                        token was found.
      * @param int                  $stackPtr  The position where the token was found.
      *
@@ -183,7 +183,7 @@ 
     /**
      * Called to process normal member vars.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this
+     * @param File $phpcsFile The PHP_CodeSniffer file where this
      *                                        token was found.
      * @param int                  $stackPtr  The position where the token was found.
      *
@@ -198,7 +198,7 @@ 
      * Note that there may be more than one variable in the string, which will
      * result only in one call for the string or one call per line for heredocs.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this
+     * @param File $phpcsFile The PHP_CodeSniffer file where this
      *                                        token was found.
      * @param int                  $stackPtr  The position where the double quoted
      *                                        string was found.

Unused Use Statements -1 removed lines

@@ -16,7 +16,6 @@
 namespace PHP_CodeSniffer\Sniffs;
 
 use PHP_CodeSniffer\Files\File;
-use PHP_CodeSniffer\Exceptions\RuntimeException;
 
 abstract class AbstractVariableSniff extends AbstractScopeSniff
 {

Indentation +9 added lines, -9 removed lines

@@ -67,17 +67,17 @@
     public function __construct()
     {
         $scopes = array(
-                   T_CLASS,
-                   T_TRAIT,
-                   T_INTERFACE,
-                  );
+                    T_CLASS,
+                    T_TRAIT,
+                    T_INTERFACE,
+                    );
 
         $listen = array(
-                   T_FUNCTION,
-                   T_VARIABLE,
-                   T_DOUBLE_QUOTED_STRING,
-                   T_HEREDOC,
-                  );
+                    T_FUNCTION,
+                    T_VARIABLE,
+                    T_DOUBLE_QUOTED_STRING,
+                    T_HEREDOC,
+                    );
 
         parent::__construct($scopes, $listen, true);
 

src/Tokenizers/Tokenizer.php

Doc Comments +1 added lines

@@ -57,6 +57,7 @@
      * @param string                         $content The content to tokenize,
      * @param \PHP_CodeSniffer\Config | null $config  The config data for the run.
      * @param string                         $eolChar The EOL char used in the content.
+     * @param null|\PHP_CodeSniffer\Config $config
      *
      * @return void
      * @throws TokenizerException If the file appears to be minified.

Indentation +11 added lines, -11 removed lines

@@ -160,16 +160,16 @@ 
         }
 
         $this->tokensWithTabs = array(
-                                 T_WHITESPACE               => true,
-                                 T_COMMENT                  => true,
-                                 T_DOC_COMMENT              => true,
-                                 T_DOC_COMMENT_WHITESPACE   => true,
-                                 T_DOC_COMMENT_STRING       => true,
-                                 T_CONSTANT_ENCAPSED_STRING => true,
-                                 T_DOUBLE_QUOTED_STRING     => true,
-                                 T_HEREDOC                  => true,
-                                 T_NOWDOC                   => true,
-                                 T_INLINE_HTML              => true,
+                                    T_WHITESPACE               => true,
+                                    T_COMMENT                  => true,
+                                    T_DOC_COMMENT              => true,
+                                    T_DOC_COMMENT_WHITESPACE   => true,
+                                    T_DOC_COMMENT_STRING       => true,
+                                    T_CONSTANT_ENCAPSED_STRING => true,
+                                    T_DOUBLE_QUOTED_STRING     => true,
+                                    T_HEREDOC                  => true,
+                                    T_NOWDOC                   => true,
+                                    T_INLINE_HTML              => true,
                                 );
 
         $this->numTokens = count($this->tokens);
@@ -673,7 +673,7 @@ 
                     $todo        = array(
                                     $stackPtr,
                                     $opener,
-                                   );
+                                    );
 
                     if (PHP_CODESNIFFER_VERBOSITY > 1) {
                         $type       = $this->tokens[$stackPtr]['type'];

Switch Indentation +45 added lines, -45 removed lines

@@ -406,60 +406,60 @@
             */
 
             switch ($this->tokens[$i]['code']) {
-            case T_OPEN_SQUARE_BRACKET:
-                $squareOpeners[] = $i;
-
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo str_repeat("\t", count($squareOpeners));
-                    echo str_repeat("\t", count($curlyOpeners));
-                    echo "=> Found square bracket opener at $i".PHP_EOL;
-                }
-                break;
-            case T_OPEN_CURLY_BRACKET:
-                if (isset($this->tokens[$i]['scope_closer']) === false) {
-                    $curlyOpeners[] = $i;
+                case T_OPEN_SQUARE_BRACKET:
+                    $squareOpeners[] = $i;
 
                     if (PHP_CODESNIFFER_VERBOSITY > 1) {
                         echo str_repeat("\t", count($squareOpeners));
                         echo str_repeat("\t", count($curlyOpeners));
-                        echo "=> Found curly bracket opener at $i".PHP_EOL;
+                        echo "=> Found square bracket opener at $i".PHP_EOL;
                     }
-                }
-                break;
-            case T_CLOSE_SQUARE_BRACKET:
-                if (empty($squareOpeners) === false) {
-                    $opener = array_pop($squareOpeners);
-                    $this->tokens[$i]['bracket_opener']      = $opener;
-                    $this->tokens[$i]['bracket_closer']      = $i;
-                    $this->tokens[$opener]['bracket_opener'] = $opener;
-                    $this->tokens[$opener]['bracket_closer'] = $i;
+                    break;
+                case T_OPEN_CURLY_BRACKET:
+                    if (isset($this->tokens[$i]['scope_closer']) === false) {
+                        $curlyOpeners[] = $i;
 
-                    if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                        echo str_repeat("\t", count($squareOpeners));
-                        echo str_repeat("\t", count($curlyOpeners));
-                        echo "\t=> Found square bracket closer at $i for $opener".PHP_EOL;
+                        if (PHP_CODESNIFFER_VERBOSITY > 1) {
+                            echo str_repeat("\t", count($squareOpeners));
+                            echo str_repeat("\t", count($curlyOpeners));
+                            echo "=> Found curly bracket opener at $i".PHP_EOL;
+                        }
                     }
-                }
-                break;
-            case T_CLOSE_CURLY_BRACKET:
-                if (empty($curlyOpeners) === false
-                    && isset($this->tokens[$i]['scope_opener']) === false
-                ) {
-                    $opener = array_pop($curlyOpeners);
-                    $this->tokens[$i]['bracket_opener']      = $opener;
-                    $this->tokens[$i]['bracket_closer']      = $i;
-                    $this->tokens[$opener]['bracket_opener'] = $opener;
-                    $this->tokens[$opener]['bracket_closer'] = $i;
+                    break;
+                case T_CLOSE_SQUARE_BRACKET:
+                    if (empty($squareOpeners) === false) {
+                        $opener = array_pop($squareOpeners);
+                        $this->tokens[$i]['bracket_opener']      = $opener;
+                        $this->tokens[$i]['bracket_closer']      = $i;
+                        $this->tokens[$opener]['bracket_opener'] = $opener;
+                        $this->tokens[$opener]['bracket_closer'] = $i;
 
-                    if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                        echo str_repeat("\t", count($squareOpeners));
-                        echo str_repeat("\t", count($curlyOpeners));
-                        echo "\t=> Found curly bracket closer at $i for $opener".PHP_EOL;
+                        if (PHP_CODESNIFFER_VERBOSITY > 1) {
+                            echo str_repeat("\t", count($squareOpeners));
+                            echo str_repeat("\t", count($curlyOpeners));
+                            echo "\t=> Found square bracket closer at $i for $opener".PHP_EOL;
+                        }
                     }
-                }
-                break;
-            default:
-                continue;
+                    break;
+                case T_CLOSE_CURLY_BRACKET:
+                    if (empty($curlyOpeners) === false
+                        && isset($this->tokens[$i]['scope_opener']) === false
+                    ) {
+                        $opener = array_pop($curlyOpeners);
+                        $this->tokens[$i]['bracket_opener']      = $opener;
+                        $this->tokens[$i]['bracket_closer']      = $i;
+                        $this->tokens[$opener]['bracket_opener'] = $opener;
+                        $this->tokens[$opener]['bracket_closer'] = $i;
+
+                        if (PHP_CODESNIFFER_VERBOSITY > 1) {
+                            echo str_repeat("\t", count($squareOpeners));
+                            echo str_repeat("\t", count($curlyOpeners));
+                            echo "\t=> Found curly bracket closer at $i for $opener".PHP_EOL;
+                        }
+                    }
+                    break;
+                default:
+                    continue;
             }//end switch
         }//end for
 

Spacing +4 added lines, -4 removed lines

@@ -61,7 +61,7 @@ 
      * @return void
      * @throws TokenizerException If the file appears to be minified.
      */
-    public function __construct($content, $config, $eolChar='\n')
+    public function __construct($content, $config, $eolChar = '\n')
     {
         $this->eolChar = $eolChar;
 
@@ -92,7 +92,7 @@ 
      *
      * @return boolean
      */
-    protected function isMinifiedContent($content, $eolChar='\n')
+    protected function isMinifiedContent($content, $eolChar = '\n')
     {
         // Minified files often have a very large number of characters per line
         // and cause issues when tokenizing.
@@ -263,7 +263,7 @@ 
      *
      * @return void
      */
-    public function replaceTabsInToken(&$token, $prefix=' ', $padding=' ')
+    public function replaceTabsInToken(&$token, $prefix = ' ', $padding = ' ')
     {
         $checkEncoding = false;
         if ($this->config->encoding !== 'iso-8859-1' && function_exists('iconv_strlen') === true) {
@@ -564,7 +564,7 @@ 
      *
      * @return int The position in the stack that closed the scope.
      */
-    private function recurseScopeMap($stackPtr, $depth=1, &$ignore=0)
+    private function recurseScopeMap($stackPtr, $depth = 1, &$ignore = 0)
     {
         if (PHP_CODESNIFFER_VERBOSITY > 1) {
             echo str_repeat("\t", $depth);