Symplify / PHP7_CodeSniffer

src/Standards/Generic/Sniffs/WhiteSpace/ScopeIndentSniff.php

Doc Comments +3 added lines, -3 removed lines

@@ -102,7 +102,7 @@ 
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return integer[]
      */
     public function register()
     {
@@ -118,11 +118,11 @@ 
     /**
      * Processes this test, when one of its tokens is encountered.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile All the tokens found in the document.
+     * @param File $phpcsFile All the tokens found in the document.
      * @param int                  $stackPtr  The position of the current token
      *                                        in the stack passed in $tokens.
      *
-     * @return void
+     * @return integer
      */
     public function process(File $phpcsFile, $stackPtr)
     {

Indentation +9 added lines, -9 removed lines

@@ -38,9 +38,9 @@ 
      * @var array
      */
     public $supportedTokenizers = array(
-                                   'PHP',
-                                   'JS',
-                                  );
+                                    'PHP',
+                                    'JS',
+                                    );
 
     /**
      * The number of spaces code should be indented.
@@ -810,15 +810,15 @@ 
                 if ($this->tabIndent === true) {
                     $error .= '%s tabs, found %s';
                     $data   = array(
-                               floor($checkIndent / $this->_tabWidth),
-                               floor($tokenIndent / $this->_tabWidth),
-                              );
+                                floor($checkIndent / $this->_tabWidth),
+                                floor($tokenIndent / $this->_tabWidth),
+                                );
                 } else {
                     $error .= '%s spaces, found %s';
                     $data   = array(
-                               $checkIndent,
-                               $tokenIndent,
-                              );
+                                $checkIndent,
+                                $tokenIndent,
+                                );
                 }
 
                 if ($this->_debug === true) {

src/Standards/Generic/Tests/PHP/SyntaxUnitTest.php

Doc Comments +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
     /**
      * Should this test be skipped for some reason.
      *
-     * @return void
+     * @return boolean
      */
     protected function shouldSkipTest()
     {

src/Standards/MySource/Sniffs/Channels/IncludeOwnSystemSniff.php

Doc Comments +3 added lines, -3 removed lines

@@ -19,7 +19,7 @@ 
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return integer[]
      */
     public function register()
     {
@@ -31,7 +31,7 @@ 
     /**
      * Processes this sniff, when one of its tokens is encountered.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+     * @param File $phpcsFile The file being scanned.
      * @param int                  $stackPtr  The position of the current token in
      *                                        the stack passed in $tokens.
      *
@@ -82,7 +82,7 @@ 
      * @param int                  $stackPtr  The position in the tokens array of the
      *                                        potentially included class.
      *
-     * @return string
+     * @return boolean
      */
     protected function getIncludedClassFromToken(
         $phpcsFile,

Switch Indentation +11 added lines, -11 removed lines

@@ -63,17 +63,17 @@
         $typeName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($stackPtr + 2), null, false, true);
         $typeName = trim($tokens[$typeName]['content'], " '");
         switch (strtolower($tokens[($stackPtr + 1)]['content'])) {
-        case 'includesystem' :
-            $included = strtolower($typeName);
-            break;
-        case 'includeasset' :
-            $included = strtolower($typeName).'assettype';
-            break;
-        case 'includewidget' :
-            $included = strtolower($typeName).'widgettype';
-            break;
-        default:
-            return;
+            case 'includesystem' :
+                $included = strtolower($typeName);
+                break;
+            case 'includeasset' :
+                $included = strtolower($typeName).'assettype';
+                break;
+            case 'includewidget' :
+                $included = strtolower($typeName).'widgettype';
+                break;
+            default:
+                return;
         }
 
         if ($included === strtolower($ownClass)) {

src/Standards/MySource/Tests/Channels/DisallowSelfActionsUnitTest.inc

Doc Comments +3 added lines

@@ -35,6 +35,9 @@
 
 abstract class AbstractEditingScreenModeWidgetActions extends AbstractEditingModeWidgetActions {
 
+    /**
+     * @param string $systemName
+     */
     public static function getScreens($systemName)
     {
 

src/Standards/PEAR/Sniffs/Commenting/FileCommentSniff.php

Doc Comments +3 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return integer[]
      */
     public function register()
     {
@@ -84,7 +84,7 @@ 
     /**
      * Processes this test, when one of its tokens is encountered.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+     * @param File $phpcsFile The file being scanned.
      * @param int                  $stackPtr  The position of the current token
      *                                        in the stack passed in $tokens.
      *
@@ -203,7 +203,7 @@ 
     /**
      * Processes each required or optional tag.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile    The file being scanned.
+     * @param File $phpcsFile    The file being scanned.
      * @param int                  $stackPtr     The position of the current token
      *                                           in the stack passed in $tokens.
      * @param int                  $commentStart Position in the stack where the comment started.

Indentation +73 added lines, -73 removed lines

@@ -35,51 +35,51 @@ 
      * @var array
      */
     protected $tags = array(
-                       '@category'   => array(
-                                         'required'       => true,
-                                         'allow_multiple' => false,
+                        '@category'   => array(
+                                            'required'       => true,
+                                            'allow_multiple' => false,
                                         ),
-                       '@package'    => array(
-                                         'required'       => true,
-                                         'allow_multiple' => false,
+                        '@package'    => array(
+                                            'required'       => true,
+                                            'allow_multiple' => false,
                                         ),
-                       '@subpackage' => array(
-                                         'required'       => false,
-                                         'allow_multiple' => false,
+                        '@subpackage' => array(
+                                            'required'       => false,
+                                            'allow_multiple' => false,
                                         ),
-                       '@author'     => array(
-                                         'required'       => true,
-                                         'allow_multiple' => true,
+                        '@author'     => array(
+                                            'required'       => true,
+                                            'allow_multiple' => true,
                                         ),
-                       '@copyright'  => array(
-                                         'required'       => false,
-                                         'allow_multiple' => true,
+                        '@copyright'  => array(
+                                            'required'       => false,
+                                            'allow_multiple' => true,
                                         ),
-                       '@license'    => array(
-                                         'required'       => true,
-                                         'allow_multiple' => false,
+                        '@license'    => array(
+                                            'required'       => true,
+                                            'allow_multiple' => false,
                                         ),
-                       '@version'    => array(
-                                         'required'       => false,
-                                         'allow_multiple' => false,
+                        '@version'    => array(
+                                            'required'       => false,
+                                            'allow_multiple' => false,
                                         ),
-                       '@link'       => array(
-                                         'required'       => true,
-                                         'allow_multiple' => true,
+                        '@link'       => array(
+                                            'required'       => true,
+                                            'allow_multiple' => true,
                                         ),
-                       '@see'        => array(
-                                         'required'       => false,
-                                         'allow_multiple' => true,
+                        '@see'        => array(
+                                            'required'       => false,
+                                            'allow_multiple' => true,
                                         ),
-                       '@since'      => array(
-                                         'required'       => false,
-                                         'allow_multiple' => false,
+                        '@since'      => array(
+                                            'required'       => false,
+                                            'allow_multiple' => false,
                                         ),
-                       '@deprecated' => array(
-                                         'required'       => false,
-                                         'allow_multiple' => false,
+                        '@deprecated' => array(
+                                            'required'       => false,
+                                            'allow_multiple' => false,
                                         ),
-                      );
+                        );
 
 
     /**
@@ -159,24 +159,24 @@ 
         );
 
         $ignore = array(
-                   T_CLASS,
-                   T_INTERFACE,
-                   T_TRAIT,
-                   T_FUNCTION,
-                   T_CLOSURE,
-                   T_PUBLIC,
-                   T_PRIVATE,
-                   T_PROTECTED,
-                   T_FINAL,
-                   T_STATIC,
-                   T_ABSTRACT,
-                   T_CONST,
-                   T_PROPERTY,
-                   T_INCLUDE,
-                   T_INCLUDE_ONCE,
-                   T_REQUIRE,
-                   T_REQUIRE_ONCE,
-                  );
+                    T_CLASS,
+                    T_INTERFACE,
+                    T_TRAIT,
+                    T_FUNCTION,
+                    T_CLOSURE,
+                    T_PUBLIC,
+                    T_PRIVATE,
+                    T_PROTECTED,
+                    T_FINAL,
+                    T_STATIC,
+                    T_ABSTRACT,
+                    T_CONST,
+                    T_PROPERTY,
+                    T_INCLUDE,
+                    T_INCLUDE_ONCE,
+                    T_REQUIRE,
+                    T_REQUIRE_ONCE,
+                    );
 
         if (in_array($tokens[$nextToken]['code'], $ignore) === true) {
             $phpcsFile->addError('Missing file doc comment', $stackPtr, 'Missing');
@@ -246,9 +246,9 @@ 
             if ($this->tags[$name]['allow_multiple'] === false && isset($tagTokens[$name]) === true) {
                 $error = 'Only one %s tag is allowed in a %s comment';
                 $data  = array(
-                          $name,
-                          $docBlock,
-                         );
+                            $name,
+                            $docBlock,
+                            );
                 $phpcsFile->addError($error, $tag, 'Duplicate'.ucfirst(substr($name, 1)).'Tag', $data);
             }
 
@@ -259,9 +259,9 @@ 
             if ($string === false || $tokens[$string]['line'] !== $tokens[$tag]['line']) {
                 $error = 'Content missing for %s tag in %s comment';
                 $data  = array(
-                          $name,
-                          $docBlock,
-                         );
+                            $name,
+                            $docBlock,
+                            );
                 $phpcsFile->addError($error, $tag, 'Empty'.ucfirst(substr($name, 1)).'Tag', $data);
                 continue;
             }
@@ -274,9 +274,9 @@ 
                 if ($tagData['required'] === true) {
                     $error = 'Missing %s tag in %s comment';
                     $data  = array(
-                              $tag,
-                              $docBlock,
-                             );
+                                $tag,
+                                $docBlock,
+                                );
                     $phpcsFile->addError($error, $commentEnd, 'Missing'.ucfirst(substr($tag, 1)).'Tag', $data);
                 }
 
@@ -296,9 +296,9 @@ 
             if ($foundTags[$pos] !== $tag) {
                 $error = 'The tag in position %s should be the %s tag';
                 $data  = array(
-                          ($pos + 1),
-                          $tag,
-                         );
+                            ($pos + 1),
+                            $tag,
+                            );
                 $phpcsFile->addError($error, $tokens[$commentStart]['comment_tags'][$pos], ucfirst(substr($tag, 1)).'TagOrder', $data);
             }
 
@@ -344,9 +344,9 @@ 
                 $error     = 'Category name "%s" is not valid; consider "%s" instead';
                 $validName = trim($newName, '_');
                 $data      = array(
-                              $content,
-                              $validName,
-                             );
+                                $content,
+                                $validName,
+                                );
                 $phpcsFile->addError($error, $tag, 'InvalidCategory', $data);
             }
         }//end foreach
@@ -397,9 +397,9 @@ 
                 $error     = 'Package name "%s" is not valid; consider "%s" instead';
                 $validName = trim($newName, '_');
                 $data      = array(
-                              $content,
-                              $validName,
-                             );
+                                $content,
+                                $validName,
+                                );
                 $phpcsFile->addError($error, $tag, 'InvalidPackage', $data);
             }//end if
         }//end foreach
@@ -442,9 +442,9 @@ 
             $error     = 'Subpackage name "%s" is not valid; consider "%s" instead';
             $validName = trim($newName, '_');
             $data      = array(
-                          $content,
-                          $validName,
-                         );
+                            $content,
+                            $validName,
+                            );
             $phpcsFile->addError($error, $tag, 'InvalidSubpackage', $data);
         }//end foreach
 

src/Standards/PEAR/Sniffs/Commenting/FunctionCommentSniff.php

Doc Comments +5 added lines, -5 removed lines

@@ -20,7 +20,7 @@ 
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return integer[]
      */
     public function register()
     {
@@ -32,7 +32,7 @@ 
     /**
      * Processes this test, when one of its tokens is encountered.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+     * @param File $phpcsFile The file being scanned.
      * @param int                  $stackPtr  The position of the current token
      *                                        in the stack passed in $tokens.
      *
@@ -98,7 +98,7 @@ 
     /**
      * Process the return comment of this function comment.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile    The file being scanned.
+     * @param File $phpcsFile    The file being scanned.
      * @param int                  $stackPtr     The position of the current token
      *                                           in the stack passed in $tokens.
      * @param int                  $commentStart The position in the stack where the comment started.
@@ -147,7 +147,7 @@ 
     /**
      * Process any throw tags that this function comment has.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile    The file being scanned.
+     * @param File $phpcsFile    The file being scanned.
      * @param int                  $stackPtr     The position of the current token
      *                                           in the stack passed in $tokens.
      * @param int                  $commentStart The position in the stack where the comment started.
@@ -187,7 +187,7 @@ 
     /**
      * Process the function parameter comments.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile    The file being scanned.
+     * @param File $phpcsFile    The file being scanned.
      * @param int                  $stackPtr     The position of the current token
      *                                           in the stack passed in $tokens.
      * @param int                  $commentStart The position in the stack where the comment started.

Indentation +14 added lines, -14 removed lines

@@ -272,12 +272,12 @@ 
             }//end if
 
             $params[] = array(
-                         'tag'        => $tag,
-                         'type'       => $type,
-                         'var'        => $var,
-                         'comment'    => $comment,
-                         'type_space' => $typeSpace,
-                         'var_space'  => $varSpace,
+                            'tag'        => $tag,
+                            'type'       => $type,
+                            'var'        => $var,
+                            'comment'    => $comment,
+                            'type_space' => $typeSpace,
+                            'var_space'  => $varSpace,
                         );
         }//end foreach
 
@@ -304,9 +304,9 @@ 
             if ($param['type_space'] !== $spaces) {
                 $error = 'Expected %s spaces after parameter type; %s found';
                 $data  = array(
-                          $spaces,
-                          $param['type_space'],
-                         );
+                            $spaces,
+                            $param['type_space'],
+                            );
 
                 $fix = $phpcsFile->addFixableError($error, $param['tag'], 'SpacingAfterParamType', $data);
                 if ($fix === true) {
@@ -325,8 +325,8 @@ 
                 if ($realName !== $param['var']) {
                     $code = 'ParamNameNoMatch';
                     $data = array(
-                             $param['var'],
-                             $realName,
+                                $param['var'],
+                                $realName,
                             );
 
                     $error = 'Doc comment for parameter %s does not match ';
@@ -354,9 +354,9 @@ 
             if ($param['var_space'] !== $spaces) {
                 $error = 'Expected %s spaces after parameter name; %s found';
                 $data  = array(
-                          $spaces,
-                          $param['var_space'],
-                         );
+                            $spaces,
+                            $param['var_space'],
+                            );
 
                 $fix = $phpcsFile->addFixableError($error, $param['tag'], 'SpacingAfterParamName', $data);
                 if ($fix === true) {

src/Standards/PEAR/Sniffs/Functions/FunctionCallSignatureSniff.php

Doc Comments +5 added lines, -5 removed lines

@@ -70,7 +70,7 @@ 
     /**
      * Processes this test, when one of its tokens is encountered.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+     * @param File $phpcsFile The file being scanned.
      * @param int                  $stackPtr  The position of the current token
      *                                        in the stack passed in $tokens.
      *
@@ -155,7 +155,7 @@ 
     /**
      * Determine if this is a multi-line function call.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile   The file being scanned.
+     * @param File $phpcsFile   The file being scanned.
      * @param int                  $stackPtr    The position of the current token
      *                                          in the stack passed in $tokens.
      * @param int                  $openBracket The position of the opening bracket
@@ -163,7 +163,7 @@ 
      * @param array                $tokens      The stack of tokens that make up
      *                                          the file.
      *
-     * @return void
+     * @return boolean
      */
     public function isMultiLineCall(File $phpcsFile, $stackPtr, $openBracket, $tokens)
     {
@@ -180,7 +180,7 @@ 
     /**
      * Processes single-line calls.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile   The file being scanned.
+     * @param File $phpcsFile   The file being scanned.
      * @param int                  $stackPtr    The position of the current token
      *                                          in the stack passed in $tokens.
      * @param int                  $openBracket The position of the opening bracket
@@ -265,7 +265,7 @@ 
     /**
      * Processes multi-line calls.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile   The file being scanned.
+     * @param File $phpcsFile   The file being scanned.
      * @param int                  $stackPtr    The position of the current token
      *                                          in the stack passed in $tokens.
      * @param int                  $openBracket The position of the opening bracket

Indentation +12 added lines, -12 removed lines

@@ -34,9 +34,9 @@ 
      * @var array
      */
     public $supportedTokenizers = array(
-                                   'PHP',
-                                   'JS',
-                                  );
+                                    'PHP',
+                                    'JS',
+                                    );
 
     /**
      * The number of spaces code should be indented.
@@ -225,9 +225,9 @@ 
             if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) {
                 $error = 'Expected %s spaces after opening bracket; %s found';
                 $data  = array(
-                          $this->requiredSpacesAfterOpen,
-                          $spaceAfterOpen,
-                         );
+                            $this->requiredSpacesAfterOpen,
+                            $spaceAfterOpen,
+                            );
                 $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpenBracket', $data);
                 if ($fix === true) {
                     $padding = str_repeat(' ', $this->requiredSpacesAfterOpen);
@@ -257,9 +257,9 @@ 
         if ($spaceBeforeClose !== $this->requiredSpacesBeforeClose) {
             $error = 'Expected %s spaces before closing bracket; %s found';
             $data  = array(
-                      $this->requiredSpacesBeforeClose,
-                      $spaceBeforeClose,
-                     );
+                        $this->requiredSpacesBeforeClose,
+                        $spaceBeforeClose,
+                        );
             $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeCloseBracket', $data);
             if ($fix === true) {
                 $padding = str_repeat(' ', $this->requiredSpacesBeforeClose);
@@ -447,9 +447,9 @@ 
                     ) {
                         $error = 'Multi-line function call not indented correctly; expected %s spaces but found %s';
                         $data  = array(
-                                  $expectedIndent,
-                                  $foundIndent,
-                                 );
+                                    $expectedIndent,
+                                    $foundIndent,
+                                    );
 
                         $fix = $phpcsFile->addFixableError($error, $i, 'Indent', $data);
                         if ($fix === true) {

Spacing +2 added lines, -2 removed lines

@@ -228,7 +228,7 @@ 
                           $this->requiredSpacesAfterOpen,
                           $spaceAfterOpen,
                          );
-                $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpenBracket', $data);
+                $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpenBracket', $data);
                 if ($fix === true) {
                     $padding = str_repeat(' ', $this->requiredSpacesAfterOpen);
                     if ($spaceAfterOpen === 0) {
@@ -260,7 +260,7 @@ 
                       $this->requiredSpacesBeforeClose,
                       $spaceBeforeClose,
                      );
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeCloseBracket', $data);
+            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeCloseBracket', $data);
             if ($fix === true) {
                 $padding = str_repeat(' ', $this->requiredSpacesBeforeClose);
                 if ($spaceBeforeClose === 0) {

src/Standards/PEAR/Sniffs/Functions/FunctionDeclarationSniff.php

Doc Comments +4 added lines, -4 removed lines

@@ -44,7 +44,7 @@ 
     /**
      * Processes this test, when one of its tokens is encountered.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+     * @param File $phpcsFile The file being scanned.
      * @param int                  $stackPtr  The position of the current token
      *                                        in the stack passed in $tokens.
      *
@@ -169,7 +169,7 @@ 
     /**
      * Determine if this is a multi-line function declaration.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile   The file being scanned.
+     * @param File $phpcsFile   The file being scanned.
      * @param int                  $stackPtr    The position of the current token
      *                                          in the stack passed in $tokens.
      * @param int                  $openBracket The position of the opening bracket
@@ -177,7 +177,7 @@ 
      * @param array                $tokens      The stack of tokens that make up
      *                                          the file.
      *
-     * @return void
+     * @return boolean
      */
     public function isMultiLineDeclaration($phpcsFile, $stackPtr, $openBracket, $tokens)
     {
@@ -210,7 +210,7 @@ 
      *
      * Just uses the Generic BSD-Allman brace sniff.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+     * @param File $phpcsFile The file being scanned.
      * @param int                  $stackPtr  The position of the current token
      *                                        in the stack passed in $tokens.
      * @param array                $tokens    The stack of tokens that make up

Indentation +4 added lines, -4 removed lines

@@ -46,7 +46,7 @@ 
         return array(
                 T_FUNCTION,
                 T_CLOSURE,
-               );
+                );
 
     }//end register()
 
@@ -353,9 +353,9 @@ 
                 if ($expectedIndent !== $foundIndent) {
                     $error = 'Multi-line function declaration not indented correctly; expected %s spaces but found %s';
                     $data  = array(
-                              $expectedIndent,
-                              $foundIndent,
-                             );
+                                $expectedIndent,
+                                $foundIndent,
+                                );
 
                     $fix = $phpcsFile->addFixableError($error, $i, 'Indent', $data);
                     if ($fix === true) {

src/Standards/PEAR/Sniffs/Functions/ValidDefaultValueSniff.php

Doc Comments +3 added lines, -3 removed lines

@@ -20,7 +20,7 @@ 
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return int[]
+     * @return integer[]
      */
     public function register()
     {
@@ -32,7 +32,7 @@ 
     /**
      * Processes this test, when one of its tokens is encountered.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+     * @param File $phpcsFile The file being scanned.
      * @param int                  $stackPtr  The position of the current token in the
      *                                        stack passed in $tokens.
      *
@@ -73,7 +73,7 @@ 
     /**
      * Returns true if the passed argument has a default value.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+     * @param File $phpcsFile The file being scanned.
      * @param int                  $argPtr    The position of the argument
      *                                        in the stack.
      *