jazzsequence / games-collector

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/PEAR/Sniffs/Commenting/ClassCommentSniff.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 +83 added lines, -83 removed lines

@@ -29,89 +29,89 @@
 {
 
 
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-                T_CLASS,
-                T_INTERFACE,
-               );
-
-    }//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)
-    {
-        $this->currentFile = $phpcsFile;
-
-        $tokens    = $phpcsFile->getTokens();
-        $type      = strtolower($tokens[$stackPtr]['content']);
-        $errorData = array($type);
-
-        $find   = PHP_CodeSniffer_Tokens::$methodPrefixes;
-        $find[] = T_WHITESPACE;
-
-        $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);
-        if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
-            && $tokens[$commentEnd]['code'] !== T_COMMENT
-        ) {
-            $phpcsFile->addError('Missing class doc comment', $stackPtr, 'Missing');
-            $phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'no');
-            return;
-        }
-
-        $phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'yes');
-
-        if ($tokens[$commentEnd]['code'] === T_COMMENT) {
-            $phpcsFile->addError('You must use "/**" style comments for a class comment', $stackPtr, 'WrongStyle');
-            return;
-        }
-
-        // Check each tag.
-        $this->processTags($phpcsFile, $stackPtr, $tokens[$commentEnd]['comment_opener']);
-
-    }//end process()
-
-
-    /**
-     * Process the version tag.
-     *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
-     * @param array                $tags      The tokens for these tags.
-     *
-     * @return void
-     */
-    protected function processVersion(PHP_CodeSniffer_File $phpcsFile, array $tags)
-    {
-        $tokens = $phpcsFile->getTokens();
-        foreach ($tags as $tag) {
-            if ($tokens[($tag + 2)]['code'] !== T_DOC_COMMENT_STRING) {
-                // No content.
-                continue;
-            }
-
-            $content = $tokens[($tag + 2)]['content'];
-            if ((strstr($content, 'Release:') === false)) {
-                $error = 'Invalid version "%s" in doc comment; consider "Release: <package_version>" instead';
-                $data  = array($content);
-                $phpcsFile->addWarning($error, $tag, 'InvalidVersion', $data);
-            }
-        }
-
-    }//end processVersion()
+	 /**
+	  * Returns an array of tokens this test wants to listen for.
+	  *
+	  * @return array
+	  */
+	 public function register()
+	 {
+		  return array(
+					 T_CLASS,
+					 T_INTERFACE,
+					);
+
+	 }//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)
+	 {
+		  $this->currentFile = $phpcsFile;
+
+		  $tokens    = $phpcsFile->getTokens();
+		  $type      = strtolower($tokens[$stackPtr]['content']);
+		  $errorData = array($type);
+
+		  $find   = PHP_CodeSniffer_Tokens::$methodPrefixes;
+		  $find[] = T_WHITESPACE;
+
+		  $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);
+		  if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
+				&& $tokens[$commentEnd]['code'] !== T_COMMENT
+		  ) {
+				$phpcsFile->addError('Missing class doc comment', $stackPtr, 'Missing');
+				$phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'no');
+				return;
+		  }
+
+		  $phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'yes');
+
+		  if ($tokens[$commentEnd]['code'] === T_COMMENT) {
+				$phpcsFile->addError('You must use "/**" style comments for a class comment', $stackPtr, 'WrongStyle');
+				return;
+		  }
+
+		  // Check each tag.
+		  $this->processTags($phpcsFile, $stackPtr, $tokens[$commentEnd]['comment_opener']);
+
+	 }//end process()
+
+
+	 /**
+	  * Process the version tag.
+	  *
+	  * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+	  * @param array                $tags      The tokens for these tags.
+	  *
+	  * @return void
+	  */
+	 protected function processVersion(PHP_CodeSniffer_File $phpcsFile, array $tags)
+	 {
+		  $tokens = $phpcsFile->getTokens();
+		  foreach ($tags as $tag) {
+				if ($tokens[($tag + 2)]['code'] !== T_DOC_COMMENT_STRING) {
+					 // No content.
+					 continue;
+				}
+
+				$content = $tokens[($tag + 2)]['content'];
+				if ((strstr($content, 'Release:') === false)) {
+					 $error = 'Invalid version "%s" in doc comment; consider "Release: <package_version>" instead';
+					 $data  = array($content);
+					 $phpcsFile->addWarning($error, $tag, 'InvalidVersion', $data);
+				}
+		  }
+
+	 }//end processVersion()
 
 
 }//end class

Spacing +20 added lines, -20 removed lines

@@ -53,35 +53,35 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $this->currentFile = $phpcsFile;
 
         $tokens    = $phpcsFile->getTokens();
-        $type      = strtolower($tokens[$stackPtr]['content']);
-        $errorData = array($type);
+        $type      = strtolower( $tokens[ $stackPtr ][ 'content' ] );
+        $errorData = array( $type );
 
         $find   = PHP_CodeSniffer_Tokens::$methodPrefixes;
-        $find[] = T_WHITESPACE;
+        $find[ ] = T_WHITESPACE;
 
-        $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);
-        if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
-            && $tokens[$commentEnd]['code'] !== T_COMMENT
+        $commentEnd = $phpcsFile->findPrevious( $find, ( $stackPtr - 1 ), null, true );
+        if ( $tokens[ $commentEnd ][ 'code' ] !== T_DOC_COMMENT_CLOSE_TAG
+            && $tokens[ $commentEnd ][ 'code' ] !== T_COMMENT
         ) {
-            $phpcsFile->addError('Missing class doc comment', $stackPtr, 'Missing');
-            $phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'no');
+            $phpcsFile->addError( 'Missing class doc comment', $stackPtr, 'Missing' );
+            $phpcsFile->recordMetric( $stackPtr, 'Class has doc comment', 'no' );
             return;
         }
 
-        $phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'yes');
+        $phpcsFile->recordMetric( $stackPtr, 'Class has doc comment', 'yes' );
 
-        if ($tokens[$commentEnd]['code'] === T_COMMENT) {
-            $phpcsFile->addError('You must use "/**" style comments for a class comment', $stackPtr, 'WrongStyle');
+        if ( $tokens[ $commentEnd ][ 'code' ] === T_COMMENT ) {
+            $phpcsFile->addError( 'You must use "/**" style comments for a class comment', $stackPtr, 'WrongStyle' );
             return;
         }
 
         // Check each tag.
-        $this->processTags($phpcsFile, $stackPtr, $tokens[$commentEnd]['comment_opener']);
+        $this->processTags( $phpcsFile, $stackPtr, $tokens[ $commentEnd ][ 'comment_opener' ] );
 
     }//end process()
 
@@ -94,20 +94,20 @@ 
      *
      * @return void
      */
-    protected function processVersion(PHP_CodeSniffer_File $phpcsFile, array $tags)
+    protected function processVersion( PHP_CodeSniffer_File $phpcsFile, array $tags )
     {
         $tokens = $phpcsFile->getTokens();
-        foreach ($tags as $tag) {
-            if ($tokens[($tag + 2)]['code'] !== T_DOC_COMMENT_STRING) {
+        foreach ( $tags as $tag ) {
+            if ( $tokens[ ( $tag + 2 ) ][ 'code' ] !== T_DOC_COMMENT_STRING ) {
                 // No content.
                 continue;
             }
 
-            $content = $tokens[($tag + 2)]['content'];
-            if ((strstr($content, 'Release:') === false)) {
+            $content = $tokens[ ( $tag + 2 ) ][ 'content' ];
+            if ( ( strstr( $content, 'Release:' ) === false ) ) {
                 $error = 'Invalid version "%s" in doc comment; consider "Release: <package_version>" instead';
-                $data  = array($content);
-                $phpcsFile->addWarning($error, $tag, 'InvalidVersion', $data);
+                $data  = array( $content );
+                $phpcsFile->addWarning( $error, $tag, 'InvalidVersion', $data );
             }
         }
 

Braces +4 added lines, -8 removed lines

@@ -25,8 +25,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class PEAR_Sniffs_Commenting_ClassCommentSniff extends PEAR_Sniffs_Commenting_FileCommentSniff
-{
+class PEAR_Sniffs_Commenting_ClassCommentSniff extends PEAR_Sniffs_Commenting_FileCommentSniff {
 
 
     /**
@@ -34,8 +33,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return array(
                 T_CLASS,
                 T_INTERFACE,
@@ -53,8 +51,7 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $this->currentFile = $phpcsFile;
 
         $tokens    = $phpcsFile->getTokens();
@@ -94,8 +91,7 @@ 
      *
      * @return void
      */
-    protected function processVersion(PHP_CodeSniffer_File $phpcsFile, array $tags)
-    {
+    protected function processVersion(PHP_CodeSniffer_File $phpcsFile, array $tags) {
         $tokens = $phpcsFile->getTokens();
         foreach ($tags as $tag) {
             if ($tokens[($tag + 2)]['code'] !== T_DOC_COMMENT_STRING) {

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/PEAR/Sniffs/Commenting/FunctionCommentSniff.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 +357 added lines, -357 removed lines

@@ -29,363 +29,363 @@
 {
 
 
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    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();
-        $find   = PHP_CodeSniffer_Tokens::$methodPrefixes;
-        $find[] = T_WHITESPACE;
-
-        $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);
-        if ($tokens[$commentEnd]['code'] === T_COMMENT) {
-            // Inline comments might just be closing comments for
-            // control structures or functions instead of function comments
-            // using the wrong comment type. If there is other code on the line,
-            // assume they relate to that code.
-            $prev = $phpcsFile->findPrevious($find, ($commentEnd - 1), null, true);
-            if ($prev !== false && $tokens[$prev]['line'] === $tokens[$commentEnd]['line']) {
-                $commentEnd = $prev;
-            }
-        }
-
-        if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
-            && $tokens[$commentEnd]['code'] !== T_COMMENT
-        ) {
-            $phpcsFile->addError('Missing function doc comment', $stackPtr, 'Missing');
-            $phpcsFile->recordMetric($stackPtr, 'Function has doc comment', 'no');
-            return;
-        } else {
-            $phpcsFile->recordMetric($stackPtr, 'Function has doc comment', 'yes');
-        }
-
-        if ($tokens[$commentEnd]['code'] === T_COMMENT) {
-            $phpcsFile->addError('You must use "/**" style comments for a function comment', $stackPtr, 'WrongStyle');
-            return;
-        }
-
-        if ($tokens[$commentEnd]['line'] !== ($tokens[$stackPtr]['line'] - 1)) {
-            $error = 'There must be no blank lines after the function comment';
-            $phpcsFile->addError($error, $commentEnd, 'SpacingAfter');
-        }
-
-        $commentStart = $tokens[$commentEnd]['comment_opener'];
-        foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
-            if ($tokens[$tag]['content'] === '@see') {
-                // Make sure the tag isn't empty.
-                $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $tag, $commentEnd);
-                if ($string === false || $tokens[$string]['line'] !== $tokens[$tag]['line']) {
-                    $error = 'Content missing for @see tag in function comment';
-                    $phpcsFile->addError($error, $tag, 'EmptySees');
-                }
-            }
-        }
-
-        $this->processReturn($phpcsFile, $stackPtr, $commentStart);
-        $this->processThrows($phpcsFile, $stackPtr, $commentStart);
-        $this->processParams($phpcsFile, $stackPtr, $commentStart);
-
-    }//end process()
-
-
-    /**
-     * Process the return comment of this function comment.
-     *
-     * @param PHP_CodeSniffer_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.
-     *
-     * @return void
-     */
-    protected function processReturn(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart)
-    {
-        $tokens = $phpcsFile->getTokens();
-
-        // Skip constructor and destructor.
-        $methodName      = $phpcsFile->getDeclarationName($stackPtr);
-        $isSpecialMethod = ($methodName === '__construct' || $methodName === '__destruct');
-
-        $return = null;
-        foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
-            if ($tokens[$tag]['content'] === '@return') {
-                if ($return !== null) {
-                    $error = 'Only 1 @return tag is allowed in a function comment';
-                    $phpcsFile->addError($error, $tag, 'DuplicateReturn');
-                    return;
-                }
-
-                $return = $tag;
-            }
-        }
-
-        if ($isSpecialMethod === true) {
-            return;
-        }
-
-        if ($return !== null) {
-            $content = $tokens[($return + 2)]['content'];
-            if (empty($content) === true || $tokens[($return + 2)]['code'] !== T_DOC_COMMENT_STRING) {
-                $error = 'Return type missing for @return tag in function comment';
-                $phpcsFile->addError($error, $return, 'MissingReturnType');
-            }
-        } else {
-            $error = 'Missing @return tag in function comment';
-            $phpcsFile->addError($error, $tokens[$commentStart]['comment_closer'], 'MissingReturn');
-        }//end if
-
-    }//end processReturn()
-
-
-    /**
-     * Process any throw tags that this function comment has.
-     *
-     * @param PHP_CodeSniffer_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.
-     *
-     * @return void
-     */
-    protected function processThrows(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart)
-    {
-        $tokens = $phpcsFile->getTokens();
-
-        $throws = array();
-        foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
-            if ($tokens[$tag]['content'] !== '@throws') {
-                continue;
-            }
-
-            $exception = null;
-            $comment   = null;
-            if ($tokens[($tag + 2)]['code'] === T_DOC_COMMENT_STRING) {
-                $matches = array();
-                preg_match('/([^\s]+)(?:\s+(.*))?/', $tokens[($tag + 2)]['content'], $matches);
-                $exception = $matches[1];
-                if (isset($matches[2]) === true) {
-                    $comment = $matches[2];
-                }
-            }
-
-            if ($exception === null) {
-                $error = 'Exception type missing for @throws tag in function comment';
-                $phpcsFile->addError($error, $tag, 'InvalidThrows');
-            }
-        }//end foreach
-
-    }//end processThrows()
-
-
-    /**
-     * Process the function parameter comments.
-     *
-     * @param PHP_CodeSniffer_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.
-     *
-     * @return void
-     */
-    protected function processParams(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart)
-    {
-        $tokens = $phpcsFile->getTokens();
-
-        $params  = array();
-        $maxType = 0;
-        $maxVar  = 0;
-        foreach ($tokens[$commentStart]['comment_tags'] as $pos => $tag) {
-            if ($tokens[$tag]['content'] !== '@param') {
-                continue;
-            }
-
-            $type      = '';
-            $typeSpace = 0;
-            $var       = '';
-            $varSpace  = 0;
-            $comment   = '';
-            if ($tokens[($tag + 2)]['code'] === T_DOC_COMMENT_STRING) {
-                $matches = array();
-                preg_match('/([^$&.]+)(?:((?:\.\.\.)?(?:\$|&)[^\s]+)(?:(\s+)(.*))?)?/', $tokens[($tag + 2)]['content'], $matches);
-
-                if (empty($matches) === false) {
-                    $typeLen   = strlen($matches[1]);
-                    $type      = trim($matches[1]);
-                    $typeSpace = ($typeLen - strlen($type));
-                    $typeLen   = strlen($type);
-                    if ($typeLen > $maxType) {
-                        $maxType = $typeLen;
-                    }
-                }
-
-                if (isset($matches[2]) === true) {
-                    $var    = $matches[2];
-                    $varLen = strlen($var);
-                    if ($varLen > $maxVar) {
-                        $maxVar = $varLen;
-                    }
-
-                    if (isset($matches[4]) === true) {
-                        $varSpace = strlen($matches[3]);
-                        $comment  = $matches[4];
-
-                        // Any strings until the next tag belong to this comment.
-                        if (isset($tokens[$commentStart]['comment_tags'][($pos + 1)]) === true) {
-                            $end = $tokens[$commentStart]['comment_tags'][($pos + 1)];
-                        } else {
-                            $end = $tokens[$commentStart]['comment_closer'];
-                        }
-
-                        for ($i = ($tag + 3); $i < $end; $i++) {
-                            if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) {
-                                $comment .= ' '.$tokens[$i]['content'];
-                            }
-                        }
-                    } else {
-                        $error = 'Missing parameter comment';
-                        $phpcsFile->addError($error, $tag, 'MissingParamComment');
-                    }
-                } else {
-                    $error = 'Missing parameter name';
-                    $phpcsFile->addError($error, $tag, 'MissingParamName');
-                }//end if
-            } else {
-                $error = 'Missing parameter type';
-                $phpcsFile->addError($error, $tag, 'MissingParamType');
-            }//end if
-
-            $params[] = array(
-                         'tag'        => $tag,
-                         'type'       => $type,
-                         'var'        => $var,
-                         'comment'    => $comment,
-                         'type_space' => $typeSpace,
-                         'var_space'  => $varSpace,
-                        );
-        }//end foreach
-
-        $realParams  = $phpcsFile->getMethodParameters($stackPtr);
-        $foundParams = array();
-
-        // We want to use ... for all variable length arguments, so added
-        // this prefix to the variable name so comparisons are easier.
-        foreach ($realParams as $pos => $param) {
-            if ($param['variable_length'] === true) {
-                $realParams[$pos]['name'] = '...'.$realParams[$pos]['name'];
-            }
-        }
-
-        foreach ($params as $pos => $param) {
-            if ($param['var'] === '') {
-                continue;
-            }
-
-            $foundParams[] = $param['var'];
-
-            // Check number of spaces after the type.
-            $spaces = ($maxType - strlen($param['type']) + 1);
-            if ($param['type_space'] !== $spaces) {
-                $error = 'Expected %s spaces after parameter type; %s found';
-                $data  = array(
-                          $spaces,
-                          $param['type_space'],
-                         );
-
-                $fix = $phpcsFile->addFixableError($error, $param['tag'], 'SpacingAfterParamType', $data);
-                if ($fix === true) {
-                    $content  = $param['type'];
-                    $content .= str_repeat(' ', $spaces);
-                    $content .= $param['var'];
-                    $content .= str_repeat(' ', $param['var_space']);
-                    $content .= $param['comment'];
-                    $phpcsFile->fixer->replaceToken(($param['tag'] + 2), $content);
-                }
-            }
-
-            // Make sure the param name is correct.
-            if (isset($realParams[$pos]) === true) {
-                $realName = $realParams[$pos]['name'];
-                if ($realName !== $param['var']) {
-                    $code = 'ParamNameNoMatch';
-                    $data = array(
-                             $param['var'],
-                             $realName,
-                            );
-
-                    $error = 'Doc comment for parameter %s does not match ';
-                    if (strtolower($param['var']) === strtolower($realName)) {
-                        $error .= 'case of ';
-                        $code   = 'ParamNameNoCaseMatch';
-                    }
-
-                    $error .= 'actual variable name %s';
-
-                    $phpcsFile->addError($error, $param['tag'], $code, $data);
-                }
-            } else if (substr($param['var'], -4) !== ',...') {
-                // We must have an extra parameter comment.
-                $error = 'Superfluous parameter comment';
-                $phpcsFile->addError($error, $param['tag'], 'ExtraParamComment');
-            }//end if
-
-            if ($param['comment'] === '') {
-                continue;
-            }
-
-            // Check number of spaces after the var name.
-            $spaces = ($maxVar - strlen($param['var']) + 1);
-            if ($param['var_space'] !== $spaces) {
-                $error = 'Expected %s spaces after parameter name; %s found';
-                $data  = array(
-                          $spaces,
-                          $param['var_space'],
-                         );
-
-                $fix = $phpcsFile->addFixableError($error, $param['tag'], 'SpacingAfterParamName', $data);
-                if ($fix === true) {
-                    $content  = $param['type'];
-                    $content .= str_repeat(' ', $param['type_space']);
-                    $content .= $param['var'];
-                    $content .= str_repeat(' ', $spaces);
-                    $content .= $param['comment'];
-                    $phpcsFile->fixer->replaceToken(($param['tag'] + 2), $content);
-                }
-            }
-        }//end foreach
-
-        $realNames = array();
-        foreach ($realParams as $realParam) {
-            $realNames[] = $realParam['name'];
-        }
-
-        // Report missing comments.
-        $diff = array_diff($realNames, $foundParams);
-        foreach ($diff as $neededParam) {
-            $error = 'Doc comment for parameter "%s" missing';
-            $data  = array($neededParam);
-            $phpcsFile->addError($error, $commentStart, 'MissingParamTag', $data);
-        }
-
-    }//end processParams()
+	 /**
+	  * Returns an array of tokens this test wants to listen for.
+	  *
+	  * @return array
+	  */
+	 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();
+		  $find   = PHP_CodeSniffer_Tokens::$methodPrefixes;
+		  $find[] = T_WHITESPACE;
+
+		  $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);
+		  if ($tokens[$commentEnd]['code'] === T_COMMENT) {
+				// Inline comments might just be closing comments for
+				// control structures or functions instead of function comments
+				// using the wrong comment type. If there is other code on the line,
+				// assume they relate to that code.
+				$prev = $phpcsFile->findPrevious($find, ($commentEnd - 1), null, true);
+				if ($prev !== false && $tokens[$prev]['line'] === $tokens[$commentEnd]['line']) {
+					 $commentEnd = $prev;
+				}
+		  }
+
+		  if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
+				&& $tokens[$commentEnd]['code'] !== T_COMMENT
+		  ) {
+				$phpcsFile->addError('Missing function doc comment', $stackPtr, 'Missing');
+				$phpcsFile->recordMetric($stackPtr, 'Function has doc comment', 'no');
+				return;
+		  } else {
+				$phpcsFile->recordMetric($stackPtr, 'Function has doc comment', 'yes');
+		  }
+
+		  if ($tokens[$commentEnd]['code'] === T_COMMENT) {
+				$phpcsFile->addError('You must use "/**" style comments for a function comment', $stackPtr, 'WrongStyle');
+				return;
+		  }
+
+		  if ($tokens[$commentEnd]['line'] !== ($tokens[$stackPtr]['line'] - 1)) {
+				$error = 'There must be no blank lines after the function comment';
+				$phpcsFile->addError($error, $commentEnd, 'SpacingAfter');
+		  }
+
+		  $commentStart = $tokens[$commentEnd]['comment_opener'];
+		  foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
+				if ($tokens[$tag]['content'] === '@see') {
+					 // Make sure the tag isn't empty.
+					 $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $tag, $commentEnd);
+					 if ($string === false || $tokens[$string]['line'] !== $tokens[$tag]['line']) {
+						  $error = 'Content missing for @see tag in function comment';
+						  $phpcsFile->addError($error, $tag, 'EmptySees');
+					 }
+				}
+		  }
+
+		  $this->processReturn($phpcsFile, $stackPtr, $commentStart);
+		  $this->processThrows($phpcsFile, $stackPtr, $commentStart);
+		  $this->processParams($phpcsFile, $stackPtr, $commentStart);
+
+	 }//end process()
+
+
+	 /**
+	  * Process the return comment of this function comment.
+	  *
+	  * @param PHP_CodeSniffer_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.
+	  *
+	  * @return void
+	  */
+	 protected function processReturn(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart)
+	 {
+		  $tokens = $phpcsFile->getTokens();
+
+		  // Skip constructor and destructor.
+		  $methodName      = $phpcsFile->getDeclarationName($stackPtr);
+		  $isSpecialMethod = ($methodName === '__construct' || $methodName === '__destruct');
+
+		  $return = null;
+		  foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
+				if ($tokens[$tag]['content'] === '@return') {
+					 if ($return !== null) {
+						  $error = 'Only 1 @return tag is allowed in a function comment';
+						  $phpcsFile->addError($error, $tag, 'DuplicateReturn');
+						  return;
+					 }
+
+					 $return = $tag;
+				}
+		  }
+
+		  if ($isSpecialMethod === true) {
+				return;
+		  }
+
+		  if ($return !== null) {
+				$content = $tokens[($return + 2)]['content'];
+				if (empty($content) === true || $tokens[($return + 2)]['code'] !== T_DOC_COMMENT_STRING) {
+					 $error = 'Return type missing for @return tag in function comment';
+					 $phpcsFile->addError($error, $return, 'MissingReturnType');
+				}
+		  } else {
+				$error = 'Missing @return tag in function comment';
+				$phpcsFile->addError($error, $tokens[$commentStart]['comment_closer'], 'MissingReturn');
+		  }//end if
+
+	 }//end processReturn()
+
+
+	 /**
+	  * Process any throw tags that this function comment has.
+	  *
+	  * @param PHP_CodeSniffer_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.
+	  *
+	  * @return void
+	  */
+	 protected function processThrows(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart)
+	 {
+		  $tokens = $phpcsFile->getTokens();
+
+		  $throws = array();
+		  foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
+				if ($tokens[$tag]['content'] !== '@throws') {
+					 continue;
+				}
+
+				$exception = null;
+				$comment   = null;
+				if ($tokens[($tag + 2)]['code'] === T_DOC_COMMENT_STRING) {
+					 $matches = array();
+					 preg_match('/([^\s]+)(?:\s+(.*))?/', $tokens[($tag + 2)]['content'], $matches);
+					 $exception = $matches[1];
+					 if (isset($matches[2]) === true) {
+						  $comment = $matches[2];
+					 }
+				}
+
+				if ($exception === null) {
+					 $error = 'Exception type missing for @throws tag in function comment';
+					 $phpcsFile->addError($error, $tag, 'InvalidThrows');
+				}
+		  }//end foreach
+
+	 }//end processThrows()
+
+
+	 /**
+	  * Process the function parameter comments.
+	  *
+	  * @param PHP_CodeSniffer_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.
+	  *
+	  * @return void
+	  */
+	 protected function processParams(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart)
+	 {
+		  $tokens = $phpcsFile->getTokens();
+
+		  $params  = array();
+		  $maxType = 0;
+		  $maxVar  = 0;
+		  foreach ($tokens[$commentStart]['comment_tags'] as $pos => $tag) {
+				if ($tokens[$tag]['content'] !== '@param') {
+					 continue;
+				}
+
+				$type      = '';
+				$typeSpace = 0;
+				$var       = '';
+				$varSpace  = 0;
+				$comment   = '';
+				if ($tokens[($tag + 2)]['code'] === T_DOC_COMMENT_STRING) {
+					 $matches = array();
+					 preg_match('/([^$&.]+)(?:((?:\.\.\.)?(?:\$|&)[^\s]+)(?:(\s+)(.*))?)?/', $tokens[($tag + 2)]['content'], $matches);
+
+					 if (empty($matches) === false) {
+						  $typeLen   = strlen($matches[1]);
+						  $type      = trim($matches[1]);
+						  $typeSpace = ($typeLen - strlen($type));
+						  $typeLen   = strlen($type);
+						  if ($typeLen > $maxType) {
+								$maxType = $typeLen;
+						  }
+					 }
+
+					 if (isset($matches[2]) === true) {
+						  $var    = $matches[2];
+						  $varLen = strlen($var);
+						  if ($varLen > $maxVar) {
+								$maxVar = $varLen;
+						  }
+
+						  if (isset($matches[4]) === true) {
+								$varSpace = strlen($matches[3]);
+								$comment  = $matches[4];
+
+								// Any strings until the next tag belong to this comment.
+								if (isset($tokens[$commentStart]['comment_tags'][($pos + 1)]) === true) {
+									 $end = $tokens[$commentStart]['comment_tags'][($pos + 1)];
+								} else {
+									 $end = $tokens[$commentStart]['comment_closer'];
+								}
+
+								for ($i = ($tag + 3); $i < $end; $i++) {
+									 if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) {
+										  $comment .= ' '.$tokens[$i]['content'];
+									 }
+								}
+						  } else {
+								$error = 'Missing parameter comment';
+								$phpcsFile->addError($error, $tag, 'MissingParamComment');
+						  }
+					 } else {
+						  $error = 'Missing parameter name';
+						  $phpcsFile->addError($error, $tag, 'MissingParamName');
+					 }//end if
+				} else {
+					 $error = 'Missing parameter type';
+					 $phpcsFile->addError($error, $tag, 'MissingParamType');
+				}//end if
+
+				$params[] = array(
+								 'tag'        => $tag,
+								 'type'       => $type,
+								 'var'        => $var,
+								 'comment'    => $comment,
+								 'type_space' => $typeSpace,
+								 'var_space'  => $varSpace,
+								);
+		  }//end foreach
+
+		  $realParams  = $phpcsFile->getMethodParameters($stackPtr);
+		  $foundParams = array();
+
+		  // We want to use ... for all variable length arguments, so added
+		  // this prefix to the variable name so comparisons are easier.
+		  foreach ($realParams as $pos => $param) {
+				if ($param['variable_length'] === true) {
+					 $realParams[$pos]['name'] = '...'.$realParams[$pos]['name'];
+				}
+		  }
+
+		  foreach ($params as $pos => $param) {
+				if ($param['var'] === '') {
+					 continue;
+				}
+
+				$foundParams[] = $param['var'];
+
+				// Check number of spaces after the type.
+				$spaces = ($maxType - strlen($param['type']) + 1);
+				if ($param['type_space'] !== $spaces) {
+					 $error = 'Expected %s spaces after parameter type; %s found';
+					 $data  = array(
+								  $spaces,
+								  $param['type_space'],
+								 );
+
+					 $fix = $phpcsFile->addFixableError($error, $param['tag'], 'SpacingAfterParamType', $data);
+					 if ($fix === true) {
+						  $content  = $param['type'];
+						  $content .= str_repeat(' ', $spaces);
+						  $content .= $param['var'];
+						  $content .= str_repeat(' ', $param['var_space']);
+						  $content .= $param['comment'];
+						  $phpcsFile->fixer->replaceToken(($param['tag'] + 2), $content);
+					 }
+				}
+
+				// Make sure the param name is correct.
+				if (isset($realParams[$pos]) === true) {
+					 $realName = $realParams[$pos]['name'];
+					 if ($realName !== $param['var']) {
+						  $code = 'ParamNameNoMatch';
+						  $data = array(
+									  $param['var'],
+									  $realName,
+									 );
+
+						  $error = 'Doc comment for parameter %s does not match ';
+						  if (strtolower($param['var']) === strtolower($realName)) {
+								$error .= 'case of ';
+								$code   = 'ParamNameNoCaseMatch';
+						  }
+
+						  $error .= 'actual variable name %s';
+
+						  $phpcsFile->addError($error, $param['tag'], $code, $data);
+					 }
+				} else if (substr($param['var'], -4) !== ',...') {
+					 // We must have an extra parameter comment.
+					 $error = 'Superfluous parameter comment';
+					 $phpcsFile->addError($error, $param['tag'], 'ExtraParamComment');
+				}//end if
+
+				if ($param['comment'] === '') {
+					 continue;
+				}
+
+				// Check number of spaces after the var name.
+				$spaces = ($maxVar - strlen($param['var']) + 1);
+				if ($param['var_space'] !== $spaces) {
+					 $error = 'Expected %s spaces after parameter name; %s found';
+					 $data  = array(
+								  $spaces,
+								  $param['var_space'],
+								 );
+
+					 $fix = $phpcsFile->addFixableError($error, $param['tag'], 'SpacingAfterParamName', $data);
+					 if ($fix === true) {
+						  $content  = $param['type'];
+						  $content .= str_repeat(' ', $param['type_space']);
+						  $content .= $param['var'];
+						  $content .= str_repeat(' ', $spaces);
+						  $content .= $param['comment'];
+						  $phpcsFile->fixer->replaceToken(($param['tag'] + 2), $content);
+					 }
+				}
+		  }//end foreach
+
+		  $realNames = array();
+		  foreach ($realParams as $realParam) {
+				$realNames[] = $realParam['name'];
+		  }
+
+		  // Report missing comments.
+		  $diff = array_diff($realNames, $foundParams);
+		  foreach ($diff as $neededParam) {
+				$error = 'Doc comment for parameter "%s" missing';
+				$data  = array($neededParam);
+				$phpcsFile->addError($error, $commentStart, 'MissingParamTag', $data);
+		  }
+
+	 }//end processParams()
 
 
 }//end class

Spacing +121 added lines, -121 removed lines

@@ -36,7 +36,7 @@ 
      */
     public function register()
     {
-        return array(T_FUNCTION);
+        return array( T_FUNCTION );
 
     }//end register()
 
@@ -50,59 +50,59 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $tokens = $phpcsFile->getTokens();
         $find   = PHP_CodeSniffer_Tokens::$methodPrefixes;
-        $find[] = T_WHITESPACE;
+        $find[ ] = T_WHITESPACE;
 
-        $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);
-        if ($tokens[$commentEnd]['code'] === T_COMMENT) {
+        $commentEnd = $phpcsFile->findPrevious( $find, ( $stackPtr - 1 ), null, true );
+        if ( $tokens[ $commentEnd ][ 'code' ] === T_COMMENT ) {
             // Inline comments might just be closing comments for
             // control structures or functions instead of function comments
             // using the wrong comment type. If there is other code on the line,
             // assume they relate to that code.
-            $prev = $phpcsFile->findPrevious($find, ($commentEnd - 1), null, true);
-            if ($prev !== false && $tokens[$prev]['line'] === $tokens[$commentEnd]['line']) {
+            $prev = $phpcsFile->findPrevious( $find, ( $commentEnd - 1 ), null, true );
+            if ( $prev !== false && $tokens[ $prev ][ 'line' ] === $tokens[ $commentEnd ][ 'line' ] ) {
                 $commentEnd = $prev;
             }
         }
 
-        if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
-            && $tokens[$commentEnd]['code'] !== T_COMMENT
+        if ( $tokens[ $commentEnd ][ 'code' ] !== T_DOC_COMMENT_CLOSE_TAG
+            && $tokens[ $commentEnd ][ 'code' ] !== T_COMMENT
         ) {
-            $phpcsFile->addError('Missing function doc comment', $stackPtr, 'Missing');
-            $phpcsFile->recordMetric($stackPtr, 'Function has doc comment', 'no');
+            $phpcsFile->addError( 'Missing function doc comment', $stackPtr, 'Missing' );
+            $phpcsFile->recordMetric( $stackPtr, 'Function has doc comment', 'no' );
             return;
         } else {
-            $phpcsFile->recordMetric($stackPtr, 'Function has doc comment', 'yes');
+            $phpcsFile->recordMetric( $stackPtr, 'Function has doc comment', 'yes' );
         }
 
-        if ($tokens[$commentEnd]['code'] === T_COMMENT) {
-            $phpcsFile->addError('You must use "/**" style comments for a function comment', $stackPtr, 'WrongStyle');
+        if ( $tokens[ $commentEnd ][ 'code' ] === T_COMMENT ) {
+            $phpcsFile->addError( 'You must use "/**" style comments for a function comment', $stackPtr, 'WrongStyle' );
             return;
         }
 
-        if ($tokens[$commentEnd]['line'] !== ($tokens[$stackPtr]['line'] - 1)) {
+        if ( $tokens[ $commentEnd ][ 'line' ] !== ( $tokens[ $stackPtr ][ 'line' ] - 1 ) ) {
             $error = 'There must be no blank lines after the function comment';
-            $phpcsFile->addError($error, $commentEnd, 'SpacingAfter');
+            $phpcsFile->addError( $error, $commentEnd, 'SpacingAfter' );
         }
 
-        $commentStart = $tokens[$commentEnd]['comment_opener'];
-        foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
-            if ($tokens[$tag]['content'] === '@see') {
+        $commentStart = $tokens[ $commentEnd ][ 'comment_opener' ];
+        foreach ( $tokens[ $commentStart ][ 'comment_tags' ] as $tag ) {
+            if ( $tokens[ $tag ][ 'content' ] === '@see' ) {
                 // Make sure the tag isn't empty.
-                $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $tag, $commentEnd);
-                if ($string === false || $tokens[$string]['line'] !== $tokens[$tag]['line']) {
+                $string = $phpcsFile->findNext( T_DOC_COMMENT_STRING, $tag, $commentEnd );
+                if ( $string === false || $tokens[ $string ][ 'line' ] !== $tokens[ $tag ][ 'line' ] ) {
                     $error = 'Content missing for @see tag in function comment';
-                    $phpcsFile->addError($error, $tag, 'EmptySees');
+                    $phpcsFile->addError( $error, $tag, 'EmptySees' );
                 }
             }
         }
 
-        $this->processReturn($phpcsFile, $stackPtr, $commentStart);
-        $this->processThrows($phpcsFile, $stackPtr, $commentStart);
-        $this->processParams($phpcsFile, $stackPtr, $commentStart);
+        $this->processReturn( $phpcsFile, $stackPtr, $commentStart );
+        $this->processThrows( $phpcsFile, $stackPtr, $commentStart );
+        $this->processParams( $phpcsFile, $stackPtr, $commentStart );
 
     }//end process()
 
@@ -117,20 +117,20 @@ 
      *
      * @return void
      */
-    protected function processReturn(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart)
+    protected function processReturn( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart )
     {
         $tokens = $phpcsFile->getTokens();
 
         // Skip constructor and destructor.
-        $methodName      = $phpcsFile->getDeclarationName($stackPtr);
-        $isSpecialMethod = ($methodName === '__construct' || $methodName === '__destruct');
+        $methodName      = $phpcsFile->getDeclarationName( $stackPtr );
+        $isSpecialMethod = ( $methodName === '__construct' || $methodName === '__destruct' );
 
         $return = null;
-        foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
-            if ($tokens[$tag]['content'] === '@return') {
-                if ($return !== null) {
+        foreach ( $tokens[ $commentStart ][ 'comment_tags' ] as $tag ) {
+            if ( $tokens[ $tag ][ 'content' ] === '@return' ) {
+                if ( $return !== null ) {
                     $error = 'Only 1 @return tag is allowed in a function comment';
-                    $phpcsFile->addError($error, $tag, 'DuplicateReturn');
+                    $phpcsFile->addError( $error, $tag, 'DuplicateReturn' );
                     return;
                 }
 
@@ -138,19 +138,19 @@ 
             }
         }
 
-        if ($isSpecialMethod === true) {
+        if ( $isSpecialMethod === true ) {
             return;
         }
 
-        if ($return !== null) {
-            $content = $tokens[($return + 2)]['content'];
-            if (empty($content) === true || $tokens[($return + 2)]['code'] !== T_DOC_COMMENT_STRING) {
+        if ( $return !== null ) {
+            $content = $tokens[ ( $return + 2 ) ][ 'content' ];
+            if ( empty( $content ) === true || $tokens[ ( $return + 2 ) ][ 'code' ] !== T_DOC_COMMENT_STRING ) {
                 $error = 'Return type missing for @return tag in function comment';
-                $phpcsFile->addError($error, $return, 'MissingReturnType');
+                $phpcsFile->addError( $error, $return, 'MissingReturnType' );
             }
         } else {
             $error = 'Missing @return tag in function comment';
-            $phpcsFile->addError($error, $tokens[$commentStart]['comment_closer'], 'MissingReturn');
+            $phpcsFile->addError( $error, $tokens[ $commentStart ][ 'comment_closer' ], 'MissingReturn' );
         }//end if
 
     }//end processReturn()
@@ -166,30 +166,30 @@ 
      *
      * @return void
      */
-    protected function processThrows(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart)
+    protected function processThrows( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart )
     {
         $tokens = $phpcsFile->getTokens();
 
         $throws = array();
-        foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
-            if ($tokens[$tag]['content'] !== '@throws') {
+        foreach ( $tokens[ $commentStart ][ 'comment_tags' ] as $tag ) {
+            if ( $tokens[ $tag ][ 'content' ] !== '@throws' ) {
                 continue;
             }
 
             $exception = null;
             $comment   = null;
-            if ($tokens[($tag + 2)]['code'] === T_DOC_COMMENT_STRING) {
+            if ( $tokens[ ( $tag + 2 ) ][ 'code' ] === T_DOC_COMMENT_STRING ) {
                 $matches = array();
-                preg_match('/([^\s]+)(?:\s+(.*))?/', $tokens[($tag + 2)]['content'], $matches);
-                $exception = $matches[1];
-                if (isset($matches[2]) === true) {
-                    $comment = $matches[2];
+                preg_match( '/([^\s]+)(?:\s+(.*))?/', $tokens[ ( $tag + 2 ) ][ 'content' ], $matches );
+                $exception = $matches[ 1 ];
+                if ( isset( $matches[ 2 ] ) === true ) {
+                    $comment = $matches[ 2 ];
                 }
             }
 
-            if ($exception === null) {
+            if ( $exception === null ) {
                 $error = 'Exception type missing for @throws tag in function comment';
-                $phpcsFile->addError($error, $tag, 'InvalidThrows');
+                $phpcsFile->addError( $error, $tag, 'InvalidThrows' );
             }
         }//end foreach
 
@@ -206,15 +206,15 @@ 
      *
      * @return void
      */
-    protected function processParams(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart)
+    protected function processParams( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart )
     {
         $tokens = $phpcsFile->getTokens();
 
         $params  = array();
         $maxType = 0;
         $maxVar  = 0;
-        foreach ($tokens[$commentStart]['comment_tags'] as $pos => $tag) {
-            if ($tokens[$tag]['content'] !== '@param') {
+        foreach ( $tokens[ $commentStart ][ 'comment_tags' ] as $pos => $tag ) {
+            if ( $tokens[ $tag ][ 'content' ] !== '@param' ) {
                 continue;
             }
 
@@ -223,57 +223,57 @@ 
             $var       = '';
             $varSpace  = 0;
             $comment   = '';
-            if ($tokens[($tag + 2)]['code'] === T_DOC_COMMENT_STRING) {
+            if ( $tokens[ ( $tag + 2 ) ][ 'code' ] === T_DOC_COMMENT_STRING ) {
                 $matches = array();
-                preg_match('/([^$&.]+)(?:((?:\.\.\.)?(?:\$|&)[^\s]+)(?:(\s+)(.*))?)?/', $tokens[($tag + 2)]['content'], $matches);
-
-                if (empty($matches) === false) {
-                    $typeLen   = strlen($matches[1]);
-                    $type      = trim($matches[1]);
-                    $typeSpace = ($typeLen - strlen($type));
-                    $typeLen   = strlen($type);
-                    if ($typeLen > $maxType) {
+                preg_match( '/([^$&.]+)(?:((?:\.\.\.)?(?:\$|&)[^\s]+)(?:(\s+)(.*))?)?/', $tokens[ ( $tag + 2 ) ][ 'content' ], $matches );
+
+                if ( empty( $matches ) === false ) {
+                    $typeLen   = strlen( $matches[ 1 ] );
+                    $type      = trim( $matches[ 1 ] );
+                    $typeSpace = ( $typeLen - strlen( $type ) );
+                    $typeLen   = strlen( $type );
+                    if ( $typeLen > $maxType ) {
                         $maxType = $typeLen;
                     }
                 }
 
-                if (isset($matches[2]) === true) {
-                    $var    = $matches[2];
-                    $varLen = strlen($var);
-                    if ($varLen > $maxVar) {
+                if ( isset( $matches[ 2 ] ) === true ) {
+                    $var    = $matches[ 2 ];
+                    $varLen = strlen( $var );
+                    if ( $varLen > $maxVar ) {
                         $maxVar = $varLen;
                     }
 
-                    if (isset($matches[4]) === true) {
-                        $varSpace = strlen($matches[3]);
-                        $comment  = $matches[4];
+                    if ( isset( $matches[ 4 ] ) === true ) {
+                        $varSpace = strlen( $matches[ 3 ] );
+                        $comment  = $matches[ 4 ];
 
                         // Any strings until the next tag belong to this comment.
-                        if (isset($tokens[$commentStart]['comment_tags'][($pos + 1)]) === true) {
-                            $end = $tokens[$commentStart]['comment_tags'][($pos + 1)];
+                        if ( isset( $tokens[ $commentStart ][ 'comment_tags' ][ ( $pos + 1 ) ] ) === true ) {
+                            $end = $tokens[ $commentStart ][ 'comment_tags' ][ ( $pos + 1 ) ];
                         } else {
-                            $end = $tokens[$commentStart]['comment_closer'];
+                            $end = $tokens[ $commentStart ][ 'comment_closer' ];
                         }
 
-                        for ($i = ($tag + 3); $i < $end; $i++) {
-                            if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) {
-                                $comment .= ' '.$tokens[$i]['content'];
+                        for ( $i = ( $tag + 3 ); $i < $end; $i++ ) {
+                            if ( $tokens[ $i ][ 'code' ] === T_DOC_COMMENT_STRING ) {
+                                $comment .= ' ' . $tokens[ $i ][ 'content' ];
                             }
                         }
                     } else {
                         $error = 'Missing parameter comment';
-                        $phpcsFile->addError($error, $tag, 'MissingParamComment');
+                        $phpcsFile->addError( $error, $tag, 'MissingParamComment' );
                     }
                 } else {
                     $error = 'Missing parameter name';
-                    $phpcsFile->addError($error, $tag, 'MissingParamName');
+                    $phpcsFile->addError( $error, $tag, 'MissingParamName' );
                 }//end if
             } else {
                 $error = 'Missing parameter type';
-                $phpcsFile->addError($error, $tag, 'MissingParamType');
+                $phpcsFile->addError( $error, $tag, 'MissingParamType' );
             }//end if
 
-            $params[] = array(
+            $params[ ] = array(
                          'tag'        => $tag,
                          'type'       => $type,
                          'var'        => $var,
@@ -283,106 +283,106 @@ 
                         );
         }//end foreach
 
-        $realParams  = $phpcsFile->getMethodParameters($stackPtr);
+        $realParams  = $phpcsFile->getMethodParameters( $stackPtr );
         $foundParams = array();
 
         // We want to use ... for all variable length arguments, so added
         // this prefix to the variable name so comparisons are easier.
-        foreach ($realParams as $pos => $param) {
-            if ($param['variable_length'] === true) {
-                $realParams[$pos]['name'] = '...'.$realParams[$pos]['name'];
+        foreach ( $realParams as $pos => $param ) {
+            if ( $param[ 'variable_length' ] === true ) {
+                $realParams[ $pos ][ 'name' ] = '...' . $realParams[ $pos ][ 'name' ];
             }
         }
 
-        foreach ($params as $pos => $param) {
-            if ($param['var'] === '') {
+        foreach ( $params as $pos => $param ) {
+            if ( $param[ 'var' ] === '' ) {
                 continue;
             }
 
-            $foundParams[] = $param['var'];
+            $foundParams[ ] = $param[ 'var' ];
 
             // Check number of spaces after the type.
-            $spaces = ($maxType - strlen($param['type']) + 1);
-            if ($param['type_space'] !== $spaces) {
+            $spaces = ( $maxType - strlen( $param[ 'type' ] ) + 1 );
+            if ( $param[ 'type_space' ] !== $spaces ) {
                 $error = 'Expected %s spaces after parameter type; %s found';
                 $data  = array(
                           $spaces,
-                          $param['type_space'],
+                          $param[ 'type_space' ],
                          );
 
-                $fix = $phpcsFile->addFixableError($error, $param['tag'], 'SpacingAfterParamType', $data);
-                if ($fix === true) {
-                    $content  = $param['type'];
-                    $content .= str_repeat(' ', $spaces);
-                    $content .= $param['var'];
-                    $content .= str_repeat(' ', $param['var_space']);
-                    $content .= $param['comment'];
-                    $phpcsFile->fixer->replaceToken(($param['tag'] + 2), $content);
+                $fix = $phpcsFile->addFixableError( $error, $param[ 'tag' ], 'SpacingAfterParamType', $data );
+                if ( $fix === true ) {
+                    $content  = $param[ 'type' ];
+                    $content .= str_repeat( ' ', $spaces );
+                    $content .= $param[ 'var' ];
+                    $content .= str_repeat( ' ', $param[ 'var_space' ] );
+                    $content .= $param[ 'comment' ];
+                    $phpcsFile->fixer->replaceToken( ( $param[ 'tag' ] + 2 ), $content );
                 }
             }
 
             // Make sure the param name is correct.
-            if (isset($realParams[$pos]) === true) {
-                $realName = $realParams[$pos]['name'];
-                if ($realName !== $param['var']) {
+            if ( isset( $realParams[ $pos ] ) === true ) {
+                $realName = $realParams[ $pos ][ 'name' ];
+                if ( $realName !== $param[ 'var' ] ) {
                     $code = 'ParamNameNoMatch';
                     $data = array(
-                             $param['var'],
+                             $param[ 'var' ],
                              $realName,
                             );
 
                     $error = 'Doc comment for parameter %s does not match ';
-                    if (strtolower($param['var']) === strtolower($realName)) {
+                    if ( strtolower( $param[ 'var' ] ) === strtolower( $realName ) ) {
                         $error .= 'case of ';
                         $code   = 'ParamNameNoCaseMatch';
                     }
 
                     $error .= 'actual variable name %s';
 
-                    $phpcsFile->addError($error, $param['tag'], $code, $data);
+                    $phpcsFile->addError( $error, $param[ 'tag' ], $code, $data );
                 }
-            } else if (substr($param['var'], -4) !== ',...') {
+            } else if ( substr( $param[ 'var' ], -4 ) !== ',...' ) {
                 // We must have an extra parameter comment.
                 $error = 'Superfluous parameter comment';
-                $phpcsFile->addError($error, $param['tag'], 'ExtraParamComment');
+                $phpcsFile->addError( $error, $param[ 'tag' ], 'ExtraParamComment' );
             }//end if
 
-            if ($param['comment'] === '') {
+            if ( $param[ 'comment' ] === '' ) {
                 continue;
             }
 
             // Check number of spaces after the var name.
-            $spaces = ($maxVar - strlen($param['var']) + 1);
-            if ($param['var_space'] !== $spaces) {
+            $spaces = ( $maxVar - strlen( $param[ 'var' ] ) + 1 );
+            if ( $param[ 'var_space' ] !== $spaces ) {
                 $error = 'Expected %s spaces after parameter name; %s found';
                 $data  = array(
                           $spaces,
-                          $param['var_space'],
+                          $param[ 'var_space' ],
                          );
 
-                $fix = $phpcsFile->addFixableError($error, $param['tag'], 'SpacingAfterParamName', $data);
-                if ($fix === true) {
-                    $content  = $param['type'];
-                    $content .= str_repeat(' ', $param['type_space']);
-                    $content .= $param['var'];
-                    $content .= str_repeat(' ', $spaces);
-                    $content .= $param['comment'];
-                    $phpcsFile->fixer->replaceToken(($param['tag'] + 2), $content);
+                $fix = $phpcsFile->addFixableError( $error, $param[ 'tag' ], 'SpacingAfterParamName', $data );
+                if ( $fix === true ) {
+                    $content  = $param[ 'type' ];
+                    $content .= str_repeat( ' ', $param[ 'type_space' ] );
+                    $content .= $param[ 'var' ];
+                    $content .= str_repeat( ' ', $spaces );
+                    $content .= $param[ 'comment' ];
+                    $phpcsFile->fixer->replaceToken( ( $param[ 'tag' ] + 2 ), $content );
                 }
             }
         }//end foreach
 
         $realNames = array();
-        foreach ($realParams as $realParam) {
-            $realNames[] = $realParam['name'];
+        foreach ( $realParams as $realParam ) {
+            $realNames[ ] = $realParam[ 'name' ];
         }
 
         // Report missing comments.
-        $diff = array_diff($realNames, $foundParams);
-        foreach ($diff as $neededParam) {
+        $diff = array_diff( $realNames, $foundParams );
+        foreach ( $diff as $neededParam ) {
             $error = 'Doc comment for parameter "%s" missing';
-            $data  = array($neededParam);
-            $phpcsFile->addError($error, $commentStart, 'MissingParamTag', $data);
+            $data  = array( $neededParam );
+            $phpcsFile->addError( $error, $commentStart, 'MissingParamTag', $data );
         }
 
     }//end processParams()

Braces +6 added lines, -12 removed lines

@@ -25,8 +25,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class PEAR_Sniffs_Commenting_FunctionCommentSniff implements PHP_CodeSniffer_Sniff
-{
+class PEAR_Sniffs_Commenting_FunctionCommentSniff implements PHP_CodeSniffer_Sniff {
 
 
     /**
@@ -34,8 +33,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return array(T_FUNCTION);
 
     }//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();
         $find   = PHP_CodeSniffer_Tokens::$methodPrefixes;
         $find[] = T_WHITESPACE;
@@ -117,8 +114,7 @@ 
      *
      * @return void
      */
-    protected function processReturn(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart)
-    {
+    protected function processReturn(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) {
         $tokens = $phpcsFile->getTokens();
 
         // Skip constructor and destructor.
@@ -166,8 +162,7 @@ 
      *
      * @return void
      */
-    protected function processThrows(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart)
-    {
+    protected function processThrows(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) {
         $tokens = $phpcsFile->getTokens();
 
         $throws = array();
@@ -206,8 +201,7 @@ 
      *
      * @return void
      */
-    protected function processParams(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart)
-    {
+    protected function processParams(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) {
         $tokens = $phpcsFile->getTokens();
 
         $params  = array();

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/PEAR/Sniffs/ControlStructures/MultiLineConditionSniff.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +246 added lines, -246 removed lines

@@ -28,252 +28,252 @@
 class PEAR_Sniffs_ControlStructures_MultiLineConditionSniff implements PHP_CodeSniffer_Sniff
 {
 
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = array(
-                                   'PHP',
-                                   'JS',
-                                  );
-
-    /**
-     * The number of spaces code should be indented.
-     *
-     * @var int
-     */
-    public $indent = 4;
-
-
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-                T_IF,
-                T_ELSEIF,
-               );
-
-    }//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();
-
-        if (isset($tokens[$stackPtr]['parenthesis_opener']) === false) {
-            return;
-        }
-
-        $openBracket    = $tokens[$stackPtr]['parenthesis_opener'];
-        $closeBracket   = $tokens[$stackPtr]['parenthesis_closer'];
-        $spaceAfterOpen = 0;
-        if ($tokens[($openBracket + 1)]['code'] === T_WHITESPACE) {
-            if (strpos($tokens[($openBracket + 1)]['content'], $phpcsFile->eolChar) !== false) {
-                $spaceAfterOpen = 'newline';
-            } else {
-                $spaceAfterOpen = strlen($tokens[($openBracket + 1)]['content']);
-            }
-        }
-
-        if ($spaceAfterOpen !== 0) {
-            $error = 'First condition of a multi-line IF statement must directly follow the opening parenthesis';
-            $fix   = $phpcsFile->addFixableError($error, ($openBracket + 1), 'SpacingAfterOpenBrace');
-            if ($fix === true) {
-                if ($spaceAfterOpen === 'newline') {
-                    $phpcsFile->fixer->replaceToken(($openBracket + 1), '');
-                } else {
-                    $phpcsFile->fixer->replaceToken(($openBracket + 1), '');
-                }
-            }
-        }
-
-        // We need to work out how far indented the if statement
-        // itself is, so we can work out how far to indent conditions.
-        $statementIndent = 0;
-        for ($i = ($stackPtr - 1); $i >= 0; $i--) {
-            if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) {
-                $i++;
-                break;
-            }
-        }
-
-        if ($i >= 0 && $tokens[$i]['code'] === T_WHITESPACE) {
-            $statementIndent = strlen($tokens[$i]['content']);
-        }
-
-        // Each line between the parenthesis should be indented 4 spaces
-        // and start with an operator, unless the line is inside a
-        // function call, in which case it is ignored.
-        $prevLine = $tokens[$openBracket]['line'];
-        for ($i = ($openBracket + 1); $i <= $closeBracket; $i++) {
-            if ($i === $closeBracket && $tokens[$openBracket]['line'] !== $tokens[$i]['line']) {
-                $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($i - 1), null, true);
-                if ($tokens[$prev]['line'] === $tokens[$i]['line']) {
-                    // Closing bracket is on the same line as a condition.
-                    $error = 'Closing parenthesis of a multi-line IF statement must be on a new line';
-                    $fix   = $phpcsFile->addFixableError($error, $closeBracket, 'CloseBracketNewLine');
-                    if ($fix === true) {
-                        // Account for a comment at the end of the line.
-                        $next = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), null, true);
-                        if ($tokens[$next]['code'] !== T_COMMENT) {
-                            $phpcsFile->fixer->addNewlineBefore($closeBracket);
-                        } else {
-                            $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
-                            $phpcsFile->fixer->beginChangeset();
-                            $phpcsFile->fixer->replaceToken($closeBracket, '');
-                            $phpcsFile->fixer->addContentBefore($next, ')');
-                            $phpcsFile->fixer->endChangeset();
-                        }
-                    }
-                }
-            }//end if
-
-            if ($tokens[$i]['line'] !== $prevLine) {
-                if ($tokens[$i]['line'] === $tokens[$closeBracket]['line']) {
-                    $next = $phpcsFile->findNext(T_WHITESPACE, $i, null, true);
-                    if ($next !== $closeBracket) {
-                        $expectedIndent = ($statementIndent + $this->indent);
-                    } else {
-                        // Closing brace needs to be indented to the same level
-                        // as the statement.
-                        $expectedIndent = $statementIndent;
-                    }//end if
-                } else {
-                    $expectedIndent = ($statementIndent + $this->indent);
-                }//end if
-
-                if ($tokens[$i]['code'] === T_COMMENT) {
-                    $prevLine = $tokens[$i]['line'];
-                    continue;
-                }
-
-                // We changed lines, so this should be a whitespace indent token.
-                if ($tokens[$i]['code'] !== T_WHITESPACE) {
-                    $foundIndent = 0;
-                } else {
-                    $foundIndent = strlen($tokens[$i]['content']);
-                }
-
-                if ($expectedIndent !== $foundIndent) {
-                    $error = 'Multi-line IF statement not indented correctly; expected %s spaces but found %s';
-                    $data  = array(
-                              $expectedIndent,
-                              $foundIndent,
-                             );
-
-                    $fix = $phpcsFile->addFixableError($error, $i, 'Alignment', $data);
-                    if ($fix === true) {
-                        $spaces = str_repeat(' ', $expectedIndent);
-                        if ($foundIndent === 0) {
-                            $phpcsFile->fixer->addContentBefore($i, $spaces);
-                        } else {
-                            $phpcsFile->fixer->replaceToken($i, $spaces);
-                        }
-                    }
-                }
-
-                $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, $i, null, true);
-                if ($next !== $closeBracket) {
-                    if (isset(PHP_CodeSniffer_Tokens::$booleanOperators[$tokens[$next]['code']]) === false) {
-                        $error = 'Each line in a multi-line IF statement must begin with a boolean operator';
-                        $fix   = $phpcsFile->addFixableError($error, $i, 'StartWithBoolean');
-                        if ($fix === true) {
-                            $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($i - 1), $openBracket, true);
-                            if (isset(PHP_CodeSniffer_Tokens::$booleanOperators[$tokens[$prev]['code']]) === true) {
-                                $phpcsFile->fixer->beginChangeset();
-                                $phpcsFile->fixer->replaceToken($prev, '');
-                                $phpcsFile->fixer->addContentBefore($next, $tokens[$prev]['content'].' ');
-                                $phpcsFile->fixer->endChangeset();
-                            } else {
-                                for ($x = ($prev + 1); $x < $next; $x++) {
-                                    $phpcsFile->fixer->replaceToken($x, '');
-                                }
-                            }
-                        }
-                    }
-                }//end if
-
-                $prevLine = $tokens[$i]['line'];
-            }//end if
-
-            if ($tokens[$i]['code'] === T_STRING) {
-                $next = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), null, true);
-                if ($tokens[$next]['code'] === T_OPEN_PARENTHESIS) {
-                    // This is a function call, so skip to the end as they
-                    // have their own indentation rules.
-                    $i        = $tokens[$next]['parenthesis_closer'];
-                    $prevLine = $tokens[$i]['line'];
-                    continue;
-                }
-            }
-        }//end for
-
-        // From here on, we are checking the spacing of the opening and closing
-        // braces. If this IF statement does not use braces, we end here.
-        if (isset($tokens[$stackPtr]['scope_opener']) === false) {
-            return;
-        }
-
-        // The opening brace needs to be one space away from the closing parenthesis.
-        $openBrace = $tokens[$stackPtr]['scope_opener'];
-        $next      = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), $openBrace, true);
-        if ($next !== false) {
-            // Probably comments in between tokens, so don't check.
-            return;
-        }
-
-        if ($tokens[$openBrace]['line'] > $tokens[$closeBracket]['line']) {
-            $length = -1;
-        } else if ($openBrace === ($closeBracket + 1)) {
-            $length = 0;
-        } else if ($openBrace === ($closeBracket + 2)
-            && $tokens[($closeBracket + 1)]['code'] === T_WHITESPACE
-        ) {
-            $length = strlen($tokens[($closeBracket + 1)]['content']);
-        } else {
-            // Confused, so don't check.
-            $length = 1;
-        }
-
-        if ($length === 1) {
-            return;
-        }
-
-        $data = array($length);
-        $code = 'SpaceBeforeOpenBrace';
-
-        $error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement; found ';
-        if ($length === -1) {
-            $error .= 'newline';
-            $code   = 'NewlineBeforeOpenBrace';
-        } else {
-            $error .= '%s spaces';
-        }
-
-        $fix = $phpcsFile->addFixableError($error, ($closeBracket + 1), $code, $data);
-        if ($fix === true) {
-            if ($length === 0) {
-                $phpcsFile->fixer->addContent($closeBracket, ' ');
-            } else {
-                $phpcsFile->fixer->replaceToken(($closeBracket + 1), ' ');
-            }
-        }
-
-    }//end process()
+	 /**
+	  * A list of tokenizers this sniff supports.
+	  *
+	  * @var array
+	  */
+	 public $supportedTokenizers = array(
+											  'PHP',
+											  'JS',
+											 );
+
+	 /**
+	  * The number of spaces code should be indented.
+	  *
+	  * @var int
+	  */
+	 public $indent = 4;
+
+
+	 /**
+	  * Returns an array of tokens this test wants to listen for.
+	  *
+	  * @return array
+	  */
+	 public function register()
+	 {
+		  return array(
+					 T_IF,
+					 T_ELSEIF,
+					);
+
+	 }//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();
+
+		  if (isset($tokens[$stackPtr]['parenthesis_opener']) === false) {
+				return;
+		  }
+
+		  $openBracket    = $tokens[$stackPtr]['parenthesis_opener'];
+		  $closeBracket   = $tokens[$stackPtr]['parenthesis_closer'];
+		  $spaceAfterOpen = 0;
+		  if ($tokens[($openBracket + 1)]['code'] === T_WHITESPACE) {
+				if (strpos($tokens[($openBracket + 1)]['content'], $phpcsFile->eolChar) !== false) {
+					 $spaceAfterOpen = 'newline';
+				} else {
+					 $spaceAfterOpen = strlen($tokens[($openBracket + 1)]['content']);
+				}
+		  }
+
+		  if ($spaceAfterOpen !== 0) {
+				$error = 'First condition of a multi-line IF statement must directly follow the opening parenthesis';
+				$fix   = $phpcsFile->addFixableError($error, ($openBracket + 1), 'SpacingAfterOpenBrace');
+				if ($fix === true) {
+					 if ($spaceAfterOpen === 'newline') {
+						  $phpcsFile->fixer->replaceToken(($openBracket + 1), '');
+					 } else {
+						  $phpcsFile->fixer->replaceToken(($openBracket + 1), '');
+					 }
+				}
+		  }
+
+		  // We need to work out how far indented the if statement
+		  // itself is, so we can work out how far to indent conditions.
+		  $statementIndent = 0;
+		  for ($i = ($stackPtr - 1); $i >= 0; $i--) {
+				if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) {
+					 $i++;
+					 break;
+				}
+		  }
+
+		  if ($i >= 0 && $tokens[$i]['code'] === T_WHITESPACE) {
+				$statementIndent = strlen($tokens[$i]['content']);
+		  }
+
+		  // Each line between the parenthesis should be indented 4 spaces
+		  // and start with an operator, unless the line is inside a
+		  // function call, in which case it is ignored.
+		  $prevLine = $tokens[$openBracket]['line'];
+		  for ($i = ($openBracket + 1); $i <= $closeBracket; $i++) {
+				if ($i === $closeBracket && $tokens[$openBracket]['line'] !== $tokens[$i]['line']) {
+					 $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($i - 1), null, true);
+					 if ($tokens[$prev]['line'] === $tokens[$i]['line']) {
+						  // Closing bracket is on the same line as a condition.
+						  $error = 'Closing parenthesis of a multi-line IF statement must be on a new line';
+						  $fix   = $phpcsFile->addFixableError($error, $closeBracket, 'CloseBracketNewLine');
+						  if ($fix === true) {
+								// Account for a comment at the end of the line.
+								$next = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), null, true);
+								if ($tokens[$next]['code'] !== T_COMMENT) {
+									 $phpcsFile->fixer->addNewlineBefore($closeBracket);
+								} else {
+									 $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
+									 $phpcsFile->fixer->beginChangeset();
+									 $phpcsFile->fixer->replaceToken($closeBracket, '');
+									 $phpcsFile->fixer->addContentBefore($next, ')');
+									 $phpcsFile->fixer->endChangeset();
+								}
+						  }
+					 }
+				}//end if
+
+				if ($tokens[$i]['line'] !== $prevLine) {
+					 if ($tokens[$i]['line'] === $tokens[$closeBracket]['line']) {
+						  $next = $phpcsFile->findNext(T_WHITESPACE, $i, null, true);
+						  if ($next !== $closeBracket) {
+								$expectedIndent = ($statementIndent + $this->indent);
+						  } else {
+								// Closing brace needs to be indented to the same level
+								// as the statement.
+								$expectedIndent = $statementIndent;
+						  }//end if
+					 } else {
+						  $expectedIndent = ($statementIndent + $this->indent);
+					 }//end if
+
+					 if ($tokens[$i]['code'] === T_COMMENT) {
+						  $prevLine = $tokens[$i]['line'];
+						  continue;
+					 }
+
+					 // We changed lines, so this should be a whitespace indent token.
+					 if ($tokens[$i]['code'] !== T_WHITESPACE) {
+						  $foundIndent = 0;
+					 } else {
+						  $foundIndent = strlen($tokens[$i]['content']);
+					 }
+
+					 if ($expectedIndent !== $foundIndent) {
+						  $error = 'Multi-line IF statement not indented correctly; expected %s spaces but found %s';
+						  $data  = array(
+										$expectedIndent,
+										$foundIndent,
+									  );
+
+						  $fix = $phpcsFile->addFixableError($error, $i, 'Alignment', $data);
+						  if ($fix === true) {
+								$spaces = str_repeat(' ', $expectedIndent);
+								if ($foundIndent === 0) {
+									 $phpcsFile->fixer->addContentBefore($i, $spaces);
+								} else {
+									 $phpcsFile->fixer->replaceToken($i, $spaces);
+								}
+						  }
+					 }
+
+					 $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, $i, null, true);
+					 if ($next !== $closeBracket) {
+						  if (isset(PHP_CodeSniffer_Tokens::$booleanOperators[$tokens[$next]['code']]) === false) {
+								$error = 'Each line in a multi-line IF statement must begin with a boolean operator';
+								$fix   = $phpcsFile->addFixableError($error, $i, 'StartWithBoolean');
+								if ($fix === true) {
+									 $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($i - 1), $openBracket, true);
+									 if (isset(PHP_CodeSniffer_Tokens::$booleanOperators[$tokens[$prev]['code']]) === true) {
+										  $phpcsFile->fixer->beginChangeset();
+										  $phpcsFile->fixer->replaceToken($prev, '');
+										  $phpcsFile->fixer->addContentBefore($next, $tokens[$prev]['content'].' ');
+										  $phpcsFile->fixer->endChangeset();
+									 } else {
+										  for ($x = ($prev + 1); $x < $next; $x++) {
+												$phpcsFile->fixer->replaceToken($x, '');
+										  }
+									 }
+								}
+						  }
+					 }//end if
+
+					 $prevLine = $tokens[$i]['line'];
+				}//end if
+
+				if ($tokens[$i]['code'] === T_STRING) {
+					 $next = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), null, true);
+					 if ($tokens[$next]['code'] === T_OPEN_PARENTHESIS) {
+						  // This is a function call, so skip to the end as they
+						  // have their own indentation rules.
+						  $i        = $tokens[$next]['parenthesis_closer'];
+						  $prevLine = $tokens[$i]['line'];
+						  continue;
+					 }
+				}
+		  }//end for
+
+		  // From here on, we are checking the spacing of the opening and closing
+		  // braces. If this IF statement does not use braces, we end here.
+		  if (isset($tokens[$stackPtr]['scope_opener']) === false) {
+				return;
+		  }
+
+		  // The opening brace needs to be one space away from the closing parenthesis.
+		  $openBrace = $tokens[$stackPtr]['scope_opener'];
+		  $next      = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), $openBrace, true);
+		  if ($next !== false) {
+				// Probably comments in between tokens, so don't check.
+				return;
+		  }
+
+		  if ($tokens[$openBrace]['line'] > $tokens[$closeBracket]['line']) {
+				$length = -1;
+		  } else if ($openBrace === ($closeBracket + 1)) {
+				$length = 0;
+		  } else if ($openBrace === ($closeBracket + 2)
+				&& $tokens[($closeBracket + 1)]['code'] === T_WHITESPACE
+		  ) {
+				$length = strlen($tokens[($closeBracket + 1)]['content']);
+		  } else {
+				// Confused, so don't check.
+				$length = 1;
+		  }
+
+		  if ($length === 1) {
+				return;
+		  }
+
+		  $data = array($length);
+		  $code = 'SpaceBeforeOpenBrace';
+
+		  $error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement; found ';
+		  if ($length === -1) {
+				$error .= 'newline';
+				$code   = 'NewlineBeforeOpenBrace';
+		  } else {
+				$error .= '%s spaces';
+		  }
+
+		  $fix = $phpcsFile->addFixableError($error, ($closeBracket + 1), $code, $data);
+		  if ($fix === true) {
+				if ($length === 0) {
+					 $phpcsFile->fixer->addContent($closeBracket, ' ');
+				} else {
+					 $phpcsFile->fixer->replaceToken(($closeBracket + 1), ' ');
+				}
+		  }
+
+	 }//end process()
 
 
 }//end class

Spacing +81 added lines, -81 removed lines

@@ -70,33 +70,33 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $tokens = $phpcsFile->getTokens();
 
-        if (isset($tokens[$stackPtr]['parenthesis_opener']) === false) {
+        if ( isset( $tokens[ $stackPtr ][ 'parenthesis_opener' ] ) === false ) {
             return;
         }
 
-        $openBracket    = $tokens[$stackPtr]['parenthesis_opener'];
-        $closeBracket   = $tokens[$stackPtr]['parenthesis_closer'];
+        $openBracket    = $tokens[ $stackPtr ][ 'parenthesis_opener' ];
+        $closeBracket   = $tokens[ $stackPtr ][ 'parenthesis_closer' ];
         $spaceAfterOpen = 0;
-        if ($tokens[($openBracket + 1)]['code'] === T_WHITESPACE) {
-            if (strpos($tokens[($openBracket + 1)]['content'], $phpcsFile->eolChar) !== false) {
+        if ( $tokens[ ( $openBracket + 1 ) ][ 'code' ] === T_WHITESPACE ) {
+            if ( strpos( $tokens[ ( $openBracket + 1 ) ][ 'content' ], $phpcsFile->eolChar ) !== false ) {
                 $spaceAfterOpen = 'newline';
             } else {
-                $spaceAfterOpen = strlen($tokens[($openBracket + 1)]['content']);
+                $spaceAfterOpen = strlen( $tokens[ ( $openBracket + 1 ) ][ 'content' ] );
             }
         }
 
-        if ($spaceAfterOpen !== 0) {
+        if ( $spaceAfterOpen !== 0 ) {
             $error = 'First condition of a multi-line IF statement must directly follow the opening parenthesis';
-            $fix   = $phpcsFile->addFixableError($error, ($openBracket + 1), 'SpacingAfterOpenBrace');
-            if ($fix === true) {
-                if ($spaceAfterOpen === 'newline') {
-                    $phpcsFile->fixer->replaceToken(($openBracket + 1), '');
+            $fix   = $phpcsFile->addFixableError( $error, ( $openBracket + 1 ), 'SpacingAfterOpenBrace' );
+            if ( $fix === true ) {
+                if ( $spaceAfterOpen === 'newline' ) {
+                    $phpcsFile->fixer->replaceToken( ( $openBracket + 1 ), '' );
                 } else {
-                    $phpcsFile->fixer->replaceToken(($openBracket + 1), '');
+                    $phpcsFile->fixer->replaceToken( ( $openBracket + 1 ), '' );
                 }
             }
         }
@@ -104,119 +104,119 @@ 
         // We need to work out how far indented the if statement
         // itself is, so we can work out how far to indent conditions.
         $statementIndent = 0;
-        for ($i = ($stackPtr - 1); $i >= 0; $i--) {
-            if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) {
+        for ( $i = ( $stackPtr - 1 ); $i >= 0; $i-- ) {
+            if ( $tokens[ $i ][ 'line' ] !== $tokens[ $stackPtr ][ 'line' ] ) {
                 $i++;
                 break;
             }
         }
 
-        if ($i >= 0 && $tokens[$i]['code'] === T_WHITESPACE) {
-            $statementIndent = strlen($tokens[$i]['content']);
+        if ( $i >= 0 && $tokens[ $i ][ 'code' ] === T_WHITESPACE ) {
+            $statementIndent = strlen( $tokens[ $i ][ 'content' ] );
         }
 
         // Each line between the parenthesis should be indented 4 spaces
         // and start with an operator, unless the line is inside a
         // function call, in which case it is ignored.
-        $prevLine = $tokens[$openBracket]['line'];
-        for ($i = ($openBracket + 1); $i <= $closeBracket; $i++) {
-            if ($i === $closeBracket && $tokens[$openBracket]['line'] !== $tokens[$i]['line']) {
-                $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($i - 1), null, true);
-                if ($tokens[$prev]['line'] === $tokens[$i]['line']) {
+        $prevLine = $tokens[ $openBracket ][ 'line' ];
+        for ( $i = ( $openBracket + 1 ); $i <= $closeBracket; $i++ ) {
+            if ( $i === $closeBracket && $tokens[ $openBracket ][ 'line' ] !== $tokens[ $i ][ 'line' ] ) {
+                $prev = $phpcsFile->findPrevious( T_WHITESPACE, ( $i - 1 ), null, true );
+                if ( $tokens[ $prev ][ 'line' ] === $tokens[ $i ][ 'line' ] ) {
                     // Closing bracket is on the same line as a condition.
                     $error = 'Closing parenthesis of a multi-line IF statement must be on a new line';
-                    $fix   = $phpcsFile->addFixableError($error, $closeBracket, 'CloseBracketNewLine');
-                    if ($fix === true) {
+                    $fix   = $phpcsFile->addFixableError( $error, $closeBracket, 'CloseBracketNewLine' );
+                    if ( $fix === true ) {
                         // Account for a comment at the end of the line.
-                        $next = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), null, true);
-                        if ($tokens[$next]['code'] !== T_COMMENT) {
-                            $phpcsFile->fixer->addNewlineBefore($closeBracket);
+                        $next = $phpcsFile->findNext( T_WHITESPACE, ( $closeBracket + 1 ), null, true );
+                        if ( $tokens[ $next ][ 'code' ] !== T_COMMENT ) {
+                            $phpcsFile->fixer->addNewlineBefore( $closeBracket );
                         } else {
-                            $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
+                            $next = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ( $next + 1 ), null, true );
                             $phpcsFile->fixer->beginChangeset();
-                            $phpcsFile->fixer->replaceToken($closeBracket, '');
-                            $phpcsFile->fixer->addContentBefore($next, ')');
+                            $phpcsFile->fixer->replaceToken( $closeBracket, '' );
+                            $phpcsFile->fixer->addContentBefore( $next, ')' );
                             $phpcsFile->fixer->endChangeset();
                         }
                     }
                 }
             }//end if
 
-            if ($tokens[$i]['line'] !== $prevLine) {
-                if ($tokens[$i]['line'] === $tokens[$closeBracket]['line']) {
-                    $next = $phpcsFile->findNext(T_WHITESPACE, $i, null, true);
-                    if ($next !== $closeBracket) {
-                        $expectedIndent = ($statementIndent + $this->indent);
+            if ( $tokens[ $i ][ 'line' ] !== $prevLine ) {
+                if ( $tokens[ $i ][ 'line' ] === $tokens[ $closeBracket ][ 'line' ] ) {
+                    $next = $phpcsFile->findNext( T_WHITESPACE, $i, null, true );
+                    if ( $next !== $closeBracket ) {
+                        $expectedIndent = ( $statementIndent + $this->indent );
                     } else {
                         // Closing brace needs to be indented to the same level
                         // as the statement.
                         $expectedIndent = $statementIndent;
                     }//end if
                 } else {
-                    $expectedIndent = ($statementIndent + $this->indent);
+                    $expectedIndent = ( $statementIndent + $this->indent );
                 }//end if
 
-                if ($tokens[$i]['code'] === T_COMMENT) {
-                    $prevLine = $tokens[$i]['line'];
+                if ( $tokens[ $i ][ 'code' ] === T_COMMENT ) {
+                    $prevLine = $tokens[ $i ][ 'line' ];
                     continue;
                 }
 
                 // We changed lines, so this should be a whitespace indent token.
-                if ($tokens[$i]['code'] !== T_WHITESPACE) {
+                if ( $tokens[ $i ][ 'code' ] !== T_WHITESPACE ) {
                     $foundIndent = 0;
                 } else {
-                    $foundIndent = strlen($tokens[$i]['content']);
+                    $foundIndent = strlen( $tokens[ $i ][ 'content' ] );
                 }
 
-                if ($expectedIndent !== $foundIndent) {
+                if ( $expectedIndent !== $foundIndent ) {
                     $error = 'Multi-line IF statement not indented correctly; expected %s spaces but found %s';
                     $data  = array(
                               $expectedIndent,
                               $foundIndent,
                              );
 
-                    $fix = $phpcsFile->addFixableError($error, $i, 'Alignment', $data);
-                    if ($fix === true) {
-                        $spaces = str_repeat(' ', $expectedIndent);
-                        if ($foundIndent === 0) {
-                            $phpcsFile->fixer->addContentBefore($i, $spaces);
+                    $fix = $phpcsFile->addFixableError( $error, $i, 'Alignment', $data );
+                    if ( $fix === true ) {
+                        $spaces = str_repeat( ' ', $expectedIndent );
+                        if ( $foundIndent === 0 ) {
+                            $phpcsFile->fixer->addContentBefore( $i, $spaces );
                         } else {
-                            $phpcsFile->fixer->replaceToken($i, $spaces);
+                            $phpcsFile->fixer->replaceToken( $i, $spaces );
                         }
                     }
                 }
 
-                $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, $i, null, true);
-                if ($next !== $closeBracket) {
-                    if (isset(PHP_CodeSniffer_Tokens::$booleanOperators[$tokens[$next]['code']]) === false) {
+                $next = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, $i, null, true );
+                if ( $next !== $closeBracket ) {
+                    if ( isset( PHP_CodeSniffer_Tokens::$booleanOperators[ $tokens[ $next ][ 'code' ] ] ) === false ) {
                         $error = 'Each line in a multi-line IF statement must begin with a boolean operator';
-                        $fix   = $phpcsFile->addFixableError($error, $i, 'StartWithBoolean');
-                        if ($fix === true) {
-                            $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($i - 1), $openBracket, true);
-                            if (isset(PHP_CodeSniffer_Tokens::$booleanOperators[$tokens[$prev]['code']]) === true) {
+                        $fix   = $phpcsFile->addFixableError( $error, $i, 'StartWithBoolean' );
+                        if ( $fix === true ) {
+                            $prev = $phpcsFile->findPrevious( PHP_CodeSniffer_Tokens::$emptyTokens, ( $i - 1 ), $openBracket, true );
+                            if ( isset( PHP_CodeSniffer_Tokens::$booleanOperators[ $tokens[ $prev ][ 'code' ] ] ) === true ) {
                                 $phpcsFile->fixer->beginChangeset();
-                                $phpcsFile->fixer->replaceToken($prev, '');
-                                $phpcsFile->fixer->addContentBefore($next, $tokens[$prev]['content'].' ');
+                                $phpcsFile->fixer->replaceToken( $prev, '' );
+                                $phpcsFile->fixer->addContentBefore( $next, $tokens[ $prev ][ 'content' ] . ' ' );
                                 $phpcsFile->fixer->endChangeset();
                             } else {
-                                for ($x = ($prev + 1); $x < $next; $x++) {
-                                    $phpcsFile->fixer->replaceToken($x, '');
+                                for ( $x = ( $prev + 1 ); $x < $next; $x++ ) {
+                                    $phpcsFile->fixer->replaceToken( $x, '' );
                                 }
                             }
                         }
                     }
                 }//end if
 
-                $prevLine = $tokens[$i]['line'];
+                $prevLine = $tokens[ $i ][ 'line' ];
             }//end if
 
-            if ($tokens[$i]['code'] === T_STRING) {
-                $next = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), null, true);
-                if ($tokens[$next]['code'] === T_OPEN_PARENTHESIS) {
+            if ( $tokens[ $i ][ 'code' ] === T_STRING ) {
+                $next = $phpcsFile->findNext( T_WHITESPACE, ( $i + 1 ), null, true );
+                if ( $tokens[ $next ][ 'code' ] === T_OPEN_PARENTHESIS ) {
                     // This is a function call, so skip to the end as they
                     // have their own indentation rules.
-                    $i        = $tokens[$next]['parenthesis_closer'];
-                    $prevLine = $tokens[$i]['line'];
+                    $i        = $tokens[ $next ][ 'parenthesis_closer' ];
+                    $prevLine = $tokens[ $i ][ 'line' ];
                     continue;
                 }
             }
@@ -224,52 +224,52 @@ 
 
         // From here on, we are checking the spacing of the opening and closing
         // braces. If this IF statement does not use braces, we end here.
-        if (isset($tokens[$stackPtr]['scope_opener']) === false) {
+        if ( isset( $tokens[ $stackPtr ][ 'scope_opener' ] ) === false ) {
             return;
         }
 
         // The opening brace needs to be one space away from the closing parenthesis.
-        $openBrace = $tokens[$stackPtr]['scope_opener'];
-        $next      = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), $openBrace, true);
-        if ($next !== false) {
+        $openBrace = $tokens[ $stackPtr ][ 'scope_opener' ];
+        $next      = $phpcsFile->findNext( T_WHITESPACE, ( $closeBracket + 1 ), $openBrace, true );
+        if ( $next !== false ) {
             // Probably comments in between tokens, so don't check.
             return;
         }
 
-        if ($tokens[$openBrace]['line'] > $tokens[$closeBracket]['line']) {
+        if ( $tokens[ $openBrace ][ 'line' ] > $tokens[ $closeBracket ][ 'line' ] ) {
             $length = -1;
-        } else if ($openBrace === ($closeBracket + 1)) {
+        } else if ( $openBrace === ( $closeBracket + 1 ) ) {
             $length = 0;
-        } else if ($openBrace === ($closeBracket + 2)
-            && $tokens[($closeBracket + 1)]['code'] === T_WHITESPACE
+        } else if ( $openBrace === ( $closeBracket + 2 )
+            && $tokens[ ( $closeBracket + 1 ) ][ 'code' ] === T_WHITESPACE
         ) {
-            $length = strlen($tokens[($closeBracket + 1)]['content']);
+            $length = strlen( $tokens[ ( $closeBracket + 1 ) ][ 'content' ] );
         } else {
             // Confused, so don't check.
             $length = 1;
         }
 
-        if ($length === 1) {
+        if ( $length === 1 ) {
             return;
         }
 
-        $data = array($length);
+        $data = array( $length );
         $code = 'SpaceBeforeOpenBrace';
 
         $error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement; found ';
-        if ($length === -1) {
+        if ( $length === -1 ) {
             $error .= 'newline';
             $code   = 'NewlineBeforeOpenBrace';
         } else {
             $error .= '%s spaces';
         }
 
-        $fix = $phpcsFile->addFixableError($error, ($closeBracket + 1), $code, $data);
-        if ($fix === true) {
-            if ($length === 0) {
-                $phpcsFile->fixer->addContent($closeBracket, ' ');
+        $fix = $phpcsFile->addFixableError( $error, ( $closeBracket + 1 ), $code, $data );
+        if ( $fix === true ) {
+            if ( $length === 0 ) {
+                $phpcsFile->fixer->addContent( $closeBracket, ' ' );
             } else {
-                $phpcsFile->fixer->replaceToken(($closeBracket + 1), ' ');
+                $phpcsFile->fixer->replaceToken( ( $closeBracket + 1 ), ' ' );
             }
         }
 

Braces +3 added lines, -6 removed lines

@@ -25,8 +25,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class PEAR_Sniffs_ControlStructures_MultiLineConditionSniff implements PHP_CodeSniffer_Sniff
-{
+class PEAR_Sniffs_ControlStructures_MultiLineConditionSniff implements PHP_CodeSniffer_Sniff {
 
     /**
      * A list of tokenizers this sniff supports.
@@ -51,8 +50,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return array(
                 T_IF,
                 T_ELSEIF,
@@ -70,8 +68,7 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $tokens = $phpcsFile->getTokens();
 
         if (isset($tokens[$stackPtr]['parenthesis_opener']) === false) {

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/PEAR/Sniffs/Formatting/MultiLineAssignmentSniff.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +86 added lines, -86 removed lines

@@ -28,92 +28,92 @@
 class PEAR_Sniffs_Formatting_MultiLineAssignmentSniff implements PHP_CodeSniffer_Sniff
 {
 
-    /**
-     * The number of spaces code should be indented.
-     *
-     * @var int
-     */
-    public $indent = 4;
-
-
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(T_EQUAL);
-
-    }//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();
-
-        // Equal sign can't be the last thing on the line.
-        $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
-        if ($next === false) {
-            // Bad assignment.
-            return;
-        }
-
-        if ($tokens[$next]['line'] !== $tokens[$stackPtr]['line']) {
-            $error = 'Multi-line assignments must have the equal sign on the second line';
-            $phpcsFile->addError($error, $stackPtr, 'EqualSignLine');
-            return;
-        }
-
-        // Make sure it is the first thing on the line, otherwise we ignore it.
-        $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), false, true);
-        if ($prev === false) {
-            // Bad assignment.
-            return;
-        }
-
-        if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
-            return;
-        }
-
-        // Find the required indent based on the ident of the previous line.
-        $assignmentIndent = 0;
-        $prevLine         = $tokens[$prev]['line'];
-        for ($i = ($prev - 1); $i >= 0; $i--) {
-            if ($tokens[$i]['line'] !== $prevLine) {
-                $i++;
-                break;
-            }
-        }
-
-        if ($tokens[$i]['code'] === T_WHITESPACE) {
-            $assignmentIndent = strlen($tokens[$i]['content']);
-        }
-
-        // Find the actual indent.
-        $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1));
-
-        $expectedIndent = ($assignmentIndent + $this->indent);
-        $foundIndent    = strlen($tokens[$prev]['content']);
-        if ($foundIndent !== $expectedIndent) {
-            $error = 'Multi-line assignment not indented correctly; expected %s spaces but found %s';
-            $data  = array(
-                      $expectedIndent,
-                      $foundIndent,
-                     );
-            $phpcsFile->addError($error, $stackPtr, 'Indent', $data);
-        }
-
-    }//end process()
+	 /**
+	  * The number of spaces code should be indented.
+	  *
+	  * @var int
+	  */
+	 public $indent = 4;
+
+
+	 /**
+	  * Returns an array of tokens this test wants to listen for.
+	  *
+	  * @return array
+	  */
+	 public function register()
+	 {
+		  return array(T_EQUAL);
+
+	 }//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();
+
+		  // Equal sign can't be the last thing on the line.
+		  $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
+		  if ($next === false) {
+				// Bad assignment.
+				return;
+		  }
+
+		  if ($tokens[$next]['line'] !== $tokens[$stackPtr]['line']) {
+				$error = 'Multi-line assignments must have the equal sign on the second line';
+				$phpcsFile->addError($error, $stackPtr, 'EqualSignLine');
+				return;
+		  }
+
+		  // Make sure it is the first thing on the line, otherwise we ignore it.
+		  $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), false, true);
+		  if ($prev === false) {
+				// Bad assignment.
+				return;
+		  }
+
+		  if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
+				return;
+		  }
+
+		  // Find the required indent based on the ident of the previous line.
+		  $assignmentIndent = 0;
+		  $prevLine         = $tokens[$prev]['line'];
+		  for ($i = ($prev - 1); $i >= 0; $i--) {
+				if ($tokens[$i]['line'] !== $prevLine) {
+					 $i++;
+					 break;
+				}
+		  }
+
+		  if ($tokens[$i]['code'] === T_WHITESPACE) {
+				$assignmentIndent = strlen($tokens[$i]['content']);
+		  }
+
+		  // Find the actual indent.
+		  $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1));
+
+		  $expectedIndent = ($assignmentIndent + $this->indent);
+		  $foundIndent    = strlen($tokens[$prev]['content']);
+		  if ($foundIndent !== $expectedIndent) {
+				$error = 'Multi-line assignment not indented correctly; expected %s spaces but found %s';
+				$data  = array(
+							 $expectedIndent,
+							 $foundIndent,
+							);
+				$phpcsFile->addError($error, $stackPtr, 'Indent', $data);
+		  }
+
+	 }//end process()
 
 
 }//end class

Spacing +19 added lines, -19 removed lines

@@ -43,7 +43,7 @@ 
      */
     public function register()
     {
-        return array(T_EQUAL);
+        return array( T_EQUAL );
 
     }//end register()
 
@@ -57,60 +57,60 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $tokens = $phpcsFile->getTokens();
 
         // Equal sign can't be the last thing on the line.
-        $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
-        if ($next === false) {
+        $next = $phpcsFile->findNext( T_WHITESPACE, ( $stackPtr + 1 ), null, true );
+        if ( $next === false ) {
             // Bad assignment.
             return;
         }
 
-        if ($tokens[$next]['line'] !== $tokens[$stackPtr]['line']) {
+        if ( $tokens[ $next ][ 'line' ] !== $tokens[ $stackPtr ][ 'line' ] ) {
             $error = 'Multi-line assignments must have the equal sign on the second line';
-            $phpcsFile->addError($error, $stackPtr, 'EqualSignLine');
+            $phpcsFile->addError( $error, $stackPtr, 'EqualSignLine' );
             return;
         }
 
         // Make sure it is the first thing on the line, otherwise we ignore it.
-        $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), false, true);
-        if ($prev === false) {
+        $prev = $phpcsFile->findPrevious( T_WHITESPACE, ( $stackPtr - 1 ), false, true );
+        if ( $prev === false ) {
             // Bad assignment.
             return;
         }
 
-        if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
+        if ( $tokens[ $prev ][ 'line' ] === $tokens[ $stackPtr ][ 'line' ] ) {
             return;
         }
 
         // Find the required indent based on the ident of the previous line.
         $assignmentIndent = 0;
-        $prevLine         = $tokens[$prev]['line'];
-        for ($i = ($prev - 1); $i >= 0; $i--) {
-            if ($tokens[$i]['line'] !== $prevLine) {
+        $prevLine         = $tokens[ $prev ][ 'line' ];
+        for ( $i = ( $prev - 1 ); $i >= 0; $i-- ) {
+            if ( $tokens[ $i ][ 'line' ] !== $prevLine ) {
                 $i++;
                 break;
             }
         }
 
-        if ($tokens[$i]['code'] === T_WHITESPACE) {
-            $assignmentIndent = strlen($tokens[$i]['content']);
+        if ( $tokens[ $i ][ 'code' ] === T_WHITESPACE ) {
+            $assignmentIndent = strlen( $tokens[ $i ][ 'content' ] );
         }
 
         // Find the actual indent.
-        $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1));
+        $prev = $phpcsFile->findPrevious( T_WHITESPACE, ( $stackPtr - 1 ) );
 
-        $expectedIndent = ($assignmentIndent + $this->indent);
-        $foundIndent    = strlen($tokens[$prev]['content']);
-        if ($foundIndent !== $expectedIndent) {
+        $expectedIndent = ( $assignmentIndent + $this->indent );
+        $foundIndent    = strlen( $tokens[ $prev ][ 'content' ] );
+        if ( $foundIndent !== $expectedIndent ) {
             $error = 'Multi-line assignment not indented correctly; expected %s spaces but found %s';
             $data  = array(
                       $expectedIndent,
                       $foundIndent,
                      );
-            $phpcsFile->addError($error, $stackPtr, 'Indent', $data);
+            $phpcsFile->addError( $error, $stackPtr, 'Indent', $data );
         }
 
     }//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 PEAR_Sniffs_Formatting_MultiLineAssignmentSniff implements PHP_CodeSniffer_Sniff
-{
+class PEAR_Sniffs_Formatting_MultiLineAssignmentSniff implements PHP_CodeSniffer_Sniff {
 
     /**
      * The number of spaces code should be indented.
@@ -41,8 +40,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return array(T_EQUAL);
 
     }//end register()
@@ -57,8 +55,7 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $tokens = $phpcsFile->getTokens();
 
         // Equal sign can't be the last thing on the line.

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/PEAR/Sniffs/Functions/FunctionCallSignatureSniff.php

Doc Comments +1 added lines, -1 removed lines

@@ -175,7 +175,7 @@
      * @param array                $tokens      The stack of tokens that make up
      *                                          the file.
      *
-     * @return void
+     * @return boolean
      */
     public function isMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
     {

Indentation +486 added lines, -486 removed lines

@@ -28,492 +28,492 @@
 class PEAR_Sniffs_Functions_FunctionCallSignatureSniff implements PHP_CodeSniffer_Sniff
 {
 
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = array(
-                                   'PHP',
-                                   'JS',
-                                  );
-
-    /**
-     * The number of spaces code should be indented.
-     *
-     * @var int
-     */
-    public $indent = 4;
-
-    /**
-     * If TRUE, multiple arguments can be defined per line in a multi-line call.
-     *
-     * @var bool
-     */
-    public $allowMultipleArguments = true;
-
-    /**
-     * How many spaces should follow the opening bracket.
-     *
-     * @var int
-     */
-    public $requiredSpacesAfterOpen = 0;
-
-    /**
-     * How many spaces should precede the closing bracket.
-     *
-     * @var int
-     */
-    public $requiredSpacesBeforeClose = 0;
-
-
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return PHP_CodeSniffer_Tokens::$functionNameTokens;
-
-    }//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)
-    {
-        $this->requiredSpacesAfterOpen   = (int) $this->requiredSpacesAfterOpen;
-        $this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose;
-        $tokens = $phpcsFile->getTokens();
-
-        // Find the next non-empty token.
-        $openBracket = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true);
-
-        if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
-            // Not a function call.
-            return;
-        }
-
-        if (isset($tokens[$openBracket]['parenthesis_closer']) === false) {
-            // Not a function call.
-            return;
-        }
-
-        // Find the previous non-empty token.
-        $search   = PHP_CodeSniffer_Tokens::$emptyTokens;
-        $search[] = T_BITWISE_AND;
-        $previous = $phpcsFile->findPrevious($search, ($stackPtr - 1), null, true);
-        if ($tokens[$previous]['code'] === T_FUNCTION) {
-            // It's a function definition, not a function call.
-            return;
-        }
-
-        $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
-
-        if (($stackPtr + 1) !== $openBracket) {
-            // Checking this: $value = my_function[*](...).
-            $error = 'Space before opening parenthesis of function call prohibited';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeOpenBracket');
-            if ($fix === true) {
-                $phpcsFile->fixer->beginChangeset();
-                for ($i = ($stackPtr + 1); $i < $openBracket; $i++) {
-                    $phpcsFile->fixer->replaceToken($i, '');
-                }
-
-                // Modify the bracket as well to ensure a conflict if the bracket
-                // has been changed in some way by another sniff.
-                $phpcsFile->fixer->replaceToken($openBracket, '(');
-                $phpcsFile->fixer->endChangeset();
-            }
-        }
-
-        $next = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), null, true);
-        if ($tokens[$next]['code'] === T_SEMICOLON) {
-            if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[($closeBracket + 1)]['code']]) === true) {
-                $error = 'Space after closing parenthesis of function call prohibited';
-                $fix   = $phpcsFile->addFixableError($error, $closeBracket, 'SpaceAfterCloseBracket');
-                if ($fix === true) {
-                    $phpcsFile->fixer->beginChangeset();
-                    for ($i = ($closeBracket + 1); $i < $next; $i++) {
-                        $phpcsFile->fixer->replaceToken($i, '');
-                    }
-
-                    // Modify the bracket as well to ensure a conflict if the bracket
-                    // has been changed in some way by another sniff.
-                    $phpcsFile->fixer->replaceToken($closeBracket, ')');
-                    $phpcsFile->fixer->endChangeset();
-                }
-            }
-        }
-
-        // Check if this is a single line or multi-line function call.
-        if ($this->isMultiLineCall($phpcsFile, $stackPtr, $openBracket, $tokens) === true) {
-            $this->processMultiLineCall($phpcsFile, $stackPtr, $openBracket, $tokens);
-        } else {
-            $this->processSingleLineCall($phpcsFile, $stackPtr, $openBracket, $tokens);
-        }
-
-    }//end process()
-
-
-    /**
-     * Determine if this is a multi-line function call.
-     *
-     * @param PHP_CodeSniffer_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
-     *                                          in the stack passed in $tokens.
-     * @param array                $tokens      The stack of tokens that make up
-     *                                          the file.
-     *
-     * @return void
-     */
-    public function isMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
-    {
-        $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
-        if ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']) {
-            return true;
-        }
-
-        return false;
-
-    }//end isMultiLineCall()
-
-
-    /**
-     * Processes single-line calls.
-     *
-     * @param PHP_CodeSniffer_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
-     *                                          in the stack passed in $tokens.
-     * @param array                $tokens      The stack of tokens that make up
-     *                                          the file.
-     *
-     * @return void
-     */
-    public function processSingleLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
-    {
-        $closer = $tokens[$openBracket]['parenthesis_closer'];
-        if ($openBracket === ($closer - 1)) {
-            return;
-        }
-
-        if ($this->requiredSpacesAfterOpen === 0 && $tokens[($openBracket + 1)]['code'] === T_WHITESPACE) {
-            // Checking this: $value = my_function([*]...).
-            $error = 'Space after opening parenthesis of function call prohibited';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpenBracket');
-            if ($fix === true) {
-                $phpcsFile->fixer->replaceToken(($openBracket + 1), '');
-            }
-        } else if ($this->requiredSpacesAfterOpen > 0) {
-            $spaceAfterOpen = 0;
-            if ($tokens[($openBracket + 1)]['code'] === T_WHITESPACE) {
-                $spaceAfterOpen = strlen($tokens[($openBracket + 1)]['content']);
-            }
-
-            if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) {
-                $error = 'Expected %s spaces after opening bracket; %s found';
-                $data  = array(
-                          $this->requiredSpacesAfterOpen,
-                          $spaceAfterOpen,
-                         );
-                $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpenBracket', $data);
-                if ($fix === true) {
-                    $padding = str_repeat(' ', $this->requiredSpacesAfterOpen);
-                    if ($spaceAfterOpen === 0) {
-                        $phpcsFile->fixer->addContent($openBracket, $padding);
-                    } else {
-                        $phpcsFile->fixer->replaceToken(($openBracket + 1), $padding);
-                    }
-                }
-            }
-        }//end if
-
-        // Checking this: $value = my_function(...[*]).
-        $spaceBeforeClose = 0;
-        $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($closer - 1), $openBracket, true);
-        if ($tokens[$prev]['code'] === T_END_HEREDOC || $tokens[$prev]['code'] === T_END_NOWDOC) {
-            // Need a newline after these tokens, so ignore this rule.
-            return;
-        }
-
-        if ($tokens[$prev]['line'] !== $tokens[$closer]['line']) {
-            $spaceBeforeClose = 'newline';
-        } else if ($tokens[($closer - 1)]['code'] === T_WHITESPACE) {
-            $spaceBeforeClose = strlen($tokens[($closer - 1)]['content']);
-        }
-
-        if ($spaceBeforeClose !== $this->requiredSpacesBeforeClose) {
-            $error = 'Expected %s spaces before closing bracket; %s found';
-            $data  = array(
-                      $this->requiredSpacesBeforeClose,
-                      $spaceBeforeClose,
-                     );
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeCloseBracket', $data);
-            if ($fix === true) {
-                $padding = str_repeat(' ', $this->requiredSpacesBeforeClose);
-                if ($spaceBeforeClose === 0) {
-                    $phpcsFile->fixer->addContentBefore($closer, $padding);
-                } else {
-                    $phpcsFile->fixer->replaceToken(($closer - 1), $padding);
-                }
-            }
-        }
-
-    }//end processSingleLineCall()
-
-
-    /**
-     * Processes multi-line calls.
-     *
-     * @param PHP_CodeSniffer_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
-     *                                          in the stack passed in $tokens.
-     * @param array                $tokens      The stack of tokens that make up
-     *                                          the file.
-     *
-     * @return void
-     */
-    public function processMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
-    {
-        // We need to work out how far indented the function
-        // call itself is, so we can work out how far to
-        // indent the arguments.
-        $start = $phpcsFile->findStartOfStatement($stackPtr);
-        foreach (array('stackPtr', 'start') as $checkToken) {
-            $x = $$checkToken;
-            for ($i = ($x - 1); $i >= 0; $i--) {
-                if ($tokens[$i]['line'] !== $tokens[$x]['line']) {
-                    $i++;
-                    break;
-                }
-            }
-
-            if ($i <= 0) {
-                $functionIndent = 0;
-            } else if ($tokens[$i]['code'] === T_WHITESPACE) {
-                $functionIndent = strlen($tokens[$i]['content']);
-            } else if ($tokens[$i]['code'] === T_CONSTANT_ENCAPSED_STRING) {
-                $functionIndent = 0;
-            } else {
-                $trimmed = ltrim($tokens[$i]['content']);
-                if ($trimmed === '') {
-                    if ($tokens[$i]['code'] === T_INLINE_HTML) {
-                        $functionIndent = strlen($tokens[$i]['content']);
-                    } else {
-                        $functionIndent = ($tokens[$i]['column'] - 1);
-                    }
-                } else {
-                    $functionIndent = (strlen($tokens[$i]['content']) - strlen($trimmed));
-                }
-            }
-
-            $varName  = $checkToken.'Indent';
-            $$varName = $functionIndent;
-        }//end foreach
-
-        $functionIndent = max($startIndent, $stackPtrIndent);
-
-        $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($openBracket + 1), null, true);
-        if ($tokens[$next]['line'] === $tokens[$openBracket]['line']) {
-            $error = 'Opening parenthesis of a multi-line function call must be the last content on the line';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'ContentAfterOpenBracket');
-            if ($fix === true) {
-                $phpcsFile->fixer->addContent(
-                    $openBracket,
-                    $phpcsFile->eolChar.str_repeat(' ', ($functionIndent + $this->indent))
-                );
-            }
-        }
-
-        $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
-        $prev         = $phpcsFile->findPrevious(T_WHITESPACE, ($closeBracket - 1), null, true);
-        if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) {
-            $error = 'Closing parenthesis of a multi-line function call must be on a line by itself';
-            $fix   = $phpcsFile->addFixableError($error, $closeBracket, 'CloseBracketLine');
-            if ($fix === true) {
-                $phpcsFile->fixer->addContentBefore(
-                    $closeBracket,
-                    $phpcsFile->eolChar.str_repeat(' ', ($functionIndent + $this->indent))
-                );
-            }
-        }
-
-        // Each line between the parenthesis should be indented n spaces.
-        $lastLine = ($tokens[$openBracket]['line'] - 1);
-        $argStart = null;
-        $argEnd   = null;
-        $inArg    = false;
-
-        // Start processing at the first argument.
-        $i = $phpcsFile->findNext(T_WHITESPACE, ($openBracket + 1), null, true);
-        if ($tokens[($i - 1)]['code'] === T_WHITESPACE
-            && $tokens[($i - 1)]['line'] === $tokens[$i]['line']
-        ) {
-            // Make sure we check the indent.
-            $i--;
-        }
-
-        for ($i; $i < $closeBracket; $i++) {
-            if ($i > $argStart && $i < $argEnd) {
-                $inArg = true;
-            } else {
-                $inArg = false;
-            }
-
-            if ($tokens[$i]['line'] !== $lastLine) {
-                $lastLine = $tokens[$i]['line'];
-
-                // Ignore heredoc indentation.
-                if (isset(PHP_CodeSniffer_Tokens::$heredocTokens[$tokens[$i]['code']]) === true) {
-                    continue;
-                }
-
-                // Ignore multi-line string indentation.
-                if (isset(PHP_CodeSniffer_Tokens::$stringTokens[$tokens[$i]['code']]) === true
-                    && $tokens[$i]['code'] === $tokens[($i - 1)]['code']
-                ) {
-                    continue;
-                }
-
-                // Ignore inline HTML.
-                if ($tokens[$i]['code'] === T_INLINE_HTML) {
-                    continue;
-                }
-
-                if ($tokens[$i]['line'] !== $tokens[$openBracket]['line']) {
-                    // We changed lines, so this should be a whitespace indent token, but first make
-                    // sure it isn't a blank line because we don't need to check indent unless there
-                    // is actually some code to indent.
-                    if ($tokens[$i]['code'] === T_WHITESPACE) {
-                        $nextCode = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), ($closeBracket + 1), true);
-                        if ($tokens[$nextCode]['line'] !== $lastLine) {
-                            if ($inArg === false) {
-                                $error = 'Empty lines are not allowed in multi-line function calls';
-                                $fix   = $phpcsFile->addFixableError($error, $i, 'EmptyLine');
-                                if ($fix === true) {
-                                    $phpcsFile->fixer->replaceToken($i, '');
-                                }
-                            }
-
-                            continue;
-                        }
-                    } else {
-                        $nextCode = $i;
-                    }
-
-                    if ($tokens[$nextCode]['line'] === $tokens[$closeBracket]['line']) {
-                        // Closing brace needs to be indented to the same level
-                        // as the function call.
-                        $inArg          = false;
-                        $expectedIndent = $functionIndent;
-                    } else {
-                        $expectedIndent = ($functionIndent + $this->indent);
-                    }
-
-                    if ($tokens[$i]['code'] !== T_WHITESPACE
-                        && $tokens[$i]['code'] !== T_DOC_COMMENT_WHITESPACE
-                    ) {
-                        // Just check if it is a multi-line block comment. If so, we can
-                        // calculate the indent from the whitespace before the content.
-                        if ($tokens[$i]['code'] === T_COMMENT
-                            && $tokens[($i - 1)]['code'] === T_COMMENT
-                        ) {
-                            $trimmed     = ltrim($tokens[$i]['content']);
-                            $foundIndent = (strlen($tokens[$i]['content']) - strlen($trimmed));
-                        } else {
-                            $foundIndent = 0;
-                        }
-                    } else {
-                        $foundIndent = strlen($tokens[$i]['content']);
-                    }
-
-                    if ($foundIndent < $expectedIndent
-                        || ($inArg === false
-                        && $expectedIndent !== $foundIndent)
-                    ) {
-                        $error = 'Multi-line function call not indented correctly; expected %s spaces but found %s';
-                        $data  = array(
-                                  $expectedIndent,
-                                  $foundIndent,
-                                 );
-
-                        $fix = $phpcsFile->addFixableError($error, $i, 'Indent', $data);
-                        if ($fix === true) {
-                            $padding = str_repeat(' ', $expectedIndent);
-                            if ($foundIndent === 0) {
-                                $phpcsFile->fixer->addContentBefore($i, $padding);
-                            } else {
-                                if ($tokens[$i]['code'] === T_COMMENT) {
-                                    $comment = $padding.ltrim($tokens[$i]['content']);
-                                    $phpcsFile->fixer->replaceToken($i, $comment);
-                                } else {
-                                    $phpcsFile->fixer->replaceToken($i, $padding);
-                                }
-                            }
-                        }
-                    }//end if
-                } else {
-                    $nextCode = $i;
-                }//end if
-
-                if ($inArg === false) {
-                    $argStart = $nextCode;
-                    $argEnd   = $phpcsFile->findEndOfStatement($nextCode);
-                }
-            }//end if
-
-            // If we are within an argument we should be ignoring commas
-            // as these are not signaling the end of an argument.
-            if ($inArg === false && $tokens[$i]['code'] === T_COMMA) {
-                $next = $phpcsFile->findNext(array(T_WHITESPACE, T_COMMENT), ($i + 1), $closeBracket, true);
-                if ($next === false) {
-                    continue;
-                }
-
-                if ($this->allowMultipleArguments === false) {
-                    // Comma has to be the last token on the line.
-                    if ($tokens[$i]['line'] === $tokens[$next]['line']) {
-                        $error = 'Only one argument is allowed per line in a multi-line function call';
-                        $fix   = $phpcsFile->addFixableError($error, $next, 'MultipleArguments');
-                        if ($fix === true) {
-                            $phpcsFile->fixer->beginChangeset();
-                            for ($x = ($next - 1); $x > $i; $x--) {
-                                if ($tokens[$x]['code'] !== T_WHITESPACE) {
-                                    break;
-                                }
-
-                                $phpcsFile->fixer->replaceToken($x, '');
-                            }
-
-                            $phpcsFile->fixer->addContentBefore(
-                                $next,
-                                $phpcsFile->eolChar.str_repeat(' ', ($functionIndent + $this->indent))
-                            );
-                            $phpcsFile->fixer->endChangeset();
-                        }
-                    }
-                }//end if
-
-                $argStart = $next;
-                $argEnd   = $phpcsFile->findEndOfStatement($next);
-            }//end if
-        }//end for
-
-    }//end processMultiLineCall()
+	 /**
+	  * A list of tokenizers this sniff supports.
+	  *
+	  * @var array
+	  */
+	 public $supportedTokenizers = array(
+											  'PHP',
+											  'JS',
+											 );
+
+	 /**
+	  * The number of spaces code should be indented.
+	  *
+	  * @var int
+	  */
+	 public $indent = 4;
+
+	 /**
+	  * If TRUE, multiple arguments can be defined per line in a multi-line call.
+	  *
+	  * @var bool
+	  */
+	 public $allowMultipleArguments = true;
+
+	 /**
+	  * How many spaces should follow the opening bracket.
+	  *
+	  * @var int
+	  */
+	 public $requiredSpacesAfterOpen = 0;
+
+	 /**
+	  * How many spaces should precede the closing bracket.
+	  *
+	  * @var int
+	  */
+	 public $requiredSpacesBeforeClose = 0;
+
+
+	 /**
+	  * Returns an array of tokens this test wants to listen for.
+	  *
+	  * @return array
+	  */
+	 public function register()
+	 {
+		  return PHP_CodeSniffer_Tokens::$functionNameTokens;
+
+	 }//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)
+	 {
+		  $this->requiredSpacesAfterOpen   = (int) $this->requiredSpacesAfterOpen;
+		  $this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose;
+		  $tokens = $phpcsFile->getTokens();
+
+		  // Find the next non-empty token.
+		  $openBracket = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true);
+
+		  if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
+				// Not a function call.
+				return;
+		  }
+
+		  if (isset($tokens[$openBracket]['parenthesis_closer']) === false) {
+				// Not a function call.
+				return;
+		  }
+
+		  // Find the previous non-empty token.
+		  $search   = PHP_CodeSniffer_Tokens::$emptyTokens;
+		  $search[] = T_BITWISE_AND;
+		  $previous = $phpcsFile->findPrevious($search, ($stackPtr - 1), null, true);
+		  if ($tokens[$previous]['code'] === T_FUNCTION) {
+				// It's a function definition, not a function call.
+				return;
+		  }
+
+		  $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
+
+		  if (($stackPtr + 1) !== $openBracket) {
+				// Checking this: $value = my_function[*](...).
+				$error = 'Space before opening parenthesis of function call prohibited';
+				$fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeOpenBracket');
+				if ($fix === true) {
+					 $phpcsFile->fixer->beginChangeset();
+					 for ($i = ($stackPtr + 1); $i < $openBracket; $i++) {
+						  $phpcsFile->fixer->replaceToken($i, '');
+					 }
+
+					 // Modify the bracket as well to ensure a conflict if the bracket
+					 // has been changed in some way by another sniff.
+					 $phpcsFile->fixer->replaceToken($openBracket, '(');
+					 $phpcsFile->fixer->endChangeset();
+				}
+		  }
+
+		  $next = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), null, true);
+		  if ($tokens[$next]['code'] === T_SEMICOLON) {
+				if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[($closeBracket + 1)]['code']]) === true) {
+					 $error = 'Space after closing parenthesis of function call prohibited';
+					 $fix   = $phpcsFile->addFixableError($error, $closeBracket, 'SpaceAfterCloseBracket');
+					 if ($fix === true) {
+						  $phpcsFile->fixer->beginChangeset();
+						  for ($i = ($closeBracket + 1); $i < $next; $i++) {
+								$phpcsFile->fixer->replaceToken($i, '');
+						  }
+
+						  // Modify the bracket as well to ensure a conflict if the bracket
+						  // has been changed in some way by another sniff.
+						  $phpcsFile->fixer->replaceToken($closeBracket, ')');
+						  $phpcsFile->fixer->endChangeset();
+					 }
+				}
+		  }
+
+		  // Check if this is a single line or multi-line function call.
+		  if ($this->isMultiLineCall($phpcsFile, $stackPtr, $openBracket, $tokens) === true) {
+				$this->processMultiLineCall($phpcsFile, $stackPtr, $openBracket, $tokens);
+		  } else {
+				$this->processSingleLineCall($phpcsFile, $stackPtr, $openBracket, $tokens);
+		  }
+
+	 }//end process()
+
+
+	 /**
+	  * Determine if this is a multi-line function call.
+	  *
+	  * @param PHP_CodeSniffer_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
+	  *                                          in the stack passed in $tokens.
+	  * @param array                $tokens      The stack of tokens that make up
+	  *                                          the file.
+	  *
+	  * @return void
+	  */
+	 public function isMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
+	 {
+		  $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
+		  if ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']) {
+				return true;
+		  }
+
+		  return false;
+
+	 }//end isMultiLineCall()
+
+
+	 /**
+	  * Processes single-line calls.
+	  *
+	  * @param PHP_CodeSniffer_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
+	  *                                          in the stack passed in $tokens.
+	  * @param array                $tokens      The stack of tokens that make up
+	  *                                          the file.
+	  *
+	  * @return void
+	  */
+	 public function processSingleLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
+	 {
+		  $closer = $tokens[$openBracket]['parenthesis_closer'];
+		  if ($openBracket === ($closer - 1)) {
+				return;
+		  }
+
+		  if ($this->requiredSpacesAfterOpen === 0 && $tokens[($openBracket + 1)]['code'] === T_WHITESPACE) {
+				// Checking this: $value = my_function([*]...).
+				$error = 'Space after opening parenthesis of function call prohibited';
+				$fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpenBracket');
+				if ($fix === true) {
+					 $phpcsFile->fixer->replaceToken(($openBracket + 1), '');
+				}
+		  } else if ($this->requiredSpacesAfterOpen > 0) {
+				$spaceAfterOpen = 0;
+				if ($tokens[($openBracket + 1)]['code'] === T_WHITESPACE) {
+					 $spaceAfterOpen = strlen($tokens[($openBracket + 1)]['content']);
+				}
+
+				if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) {
+					 $error = 'Expected %s spaces after opening bracket; %s found';
+					 $data  = array(
+								  $this->requiredSpacesAfterOpen,
+								  $spaceAfterOpen,
+								 );
+					 $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpenBracket', $data);
+					 if ($fix === true) {
+						  $padding = str_repeat(' ', $this->requiredSpacesAfterOpen);
+						  if ($spaceAfterOpen === 0) {
+								$phpcsFile->fixer->addContent($openBracket, $padding);
+						  } else {
+								$phpcsFile->fixer->replaceToken(($openBracket + 1), $padding);
+						  }
+					 }
+				}
+		  }//end if
+
+		  // Checking this: $value = my_function(...[*]).
+		  $spaceBeforeClose = 0;
+		  $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($closer - 1), $openBracket, true);
+		  if ($tokens[$prev]['code'] === T_END_HEREDOC || $tokens[$prev]['code'] === T_END_NOWDOC) {
+				// Need a newline after these tokens, so ignore this rule.
+				return;
+		  }
+
+		  if ($tokens[$prev]['line'] !== $tokens[$closer]['line']) {
+				$spaceBeforeClose = 'newline';
+		  } else if ($tokens[($closer - 1)]['code'] === T_WHITESPACE) {
+				$spaceBeforeClose = strlen($tokens[($closer - 1)]['content']);
+		  }
+
+		  if ($spaceBeforeClose !== $this->requiredSpacesBeforeClose) {
+				$error = 'Expected %s spaces before closing bracket; %s found';
+				$data  = array(
+							 $this->requiredSpacesBeforeClose,
+							 $spaceBeforeClose,
+							);
+				$fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeCloseBracket', $data);
+				if ($fix === true) {
+					 $padding = str_repeat(' ', $this->requiredSpacesBeforeClose);
+					 if ($spaceBeforeClose === 0) {
+						  $phpcsFile->fixer->addContentBefore($closer, $padding);
+					 } else {
+						  $phpcsFile->fixer->replaceToken(($closer - 1), $padding);
+					 }
+				}
+		  }
+
+	 }//end processSingleLineCall()
+
+
+	 /**
+	  * Processes multi-line calls.
+	  *
+	  * @param PHP_CodeSniffer_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
+	  *                                          in the stack passed in $tokens.
+	  * @param array                $tokens      The stack of tokens that make up
+	  *                                          the file.
+	  *
+	  * @return void
+	  */
+	 public function processMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
+	 {
+		  // We need to work out how far indented the function
+		  // call itself is, so we can work out how far to
+		  // indent the arguments.
+		  $start = $phpcsFile->findStartOfStatement($stackPtr);
+		  foreach (array('stackPtr', 'start') as $checkToken) {
+				$x = $$checkToken;
+				for ($i = ($x - 1); $i >= 0; $i--) {
+					 if ($tokens[$i]['line'] !== $tokens[$x]['line']) {
+						  $i++;
+						  break;
+					 }
+				}
+
+				if ($i <= 0) {
+					 $functionIndent = 0;
+				} else if ($tokens[$i]['code'] === T_WHITESPACE) {
+					 $functionIndent = strlen($tokens[$i]['content']);
+				} else if ($tokens[$i]['code'] === T_CONSTANT_ENCAPSED_STRING) {
+					 $functionIndent = 0;
+				} else {
+					 $trimmed = ltrim($tokens[$i]['content']);
+					 if ($trimmed === '') {
+						  if ($tokens[$i]['code'] === T_INLINE_HTML) {
+								$functionIndent = strlen($tokens[$i]['content']);
+						  } else {
+								$functionIndent = ($tokens[$i]['column'] - 1);
+						  }
+					 } else {
+						  $functionIndent = (strlen($tokens[$i]['content']) - strlen($trimmed));
+					 }
+				}
+
+				$varName  = $checkToken.'Indent';
+				$$varName = $functionIndent;
+		  }//end foreach
+
+		  $functionIndent = max($startIndent, $stackPtrIndent);
+
+		  $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($openBracket + 1), null, true);
+		  if ($tokens[$next]['line'] === $tokens[$openBracket]['line']) {
+				$error = 'Opening parenthesis of a multi-line function call must be the last content on the line';
+				$fix   = $phpcsFile->addFixableError($error, $stackPtr, 'ContentAfterOpenBracket');
+				if ($fix === true) {
+					 $phpcsFile->fixer->addContent(
+						  $openBracket,
+						  $phpcsFile->eolChar.str_repeat(' ', ($functionIndent + $this->indent))
+					 );
+				}
+		  }
+
+		  $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
+		  $prev         = $phpcsFile->findPrevious(T_WHITESPACE, ($closeBracket - 1), null, true);
+		  if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) {
+				$error = 'Closing parenthesis of a multi-line function call must be on a line by itself';
+				$fix   = $phpcsFile->addFixableError($error, $closeBracket, 'CloseBracketLine');
+				if ($fix === true) {
+					 $phpcsFile->fixer->addContentBefore(
+						  $closeBracket,
+						  $phpcsFile->eolChar.str_repeat(' ', ($functionIndent + $this->indent))
+					 );
+				}
+		  }
+
+		  // Each line between the parenthesis should be indented n spaces.
+		  $lastLine = ($tokens[$openBracket]['line'] - 1);
+		  $argStart = null;
+		  $argEnd   = null;
+		  $inArg    = false;
+
+		  // Start processing at the first argument.
+		  $i = $phpcsFile->findNext(T_WHITESPACE, ($openBracket + 1), null, true);
+		  if ($tokens[($i - 1)]['code'] === T_WHITESPACE
+				&& $tokens[($i - 1)]['line'] === $tokens[$i]['line']
+		  ) {
+				// Make sure we check the indent.
+				$i--;
+		  }
+
+		  for ($i; $i < $closeBracket; $i++) {
+				if ($i > $argStart && $i < $argEnd) {
+					 $inArg = true;
+				} else {
+					 $inArg = false;
+				}
+
+				if ($tokens[$i]['line'] !== $lastLine) {
+					 $lastLine = $tokens[$i]['line'];
+
+					 // Ignore heredoc indentation.
+					 if (isset(PHP_CodeSniffer_Tokens::$heredocTokens[$tokens[$i]['code']]) === true) {
+						  continue;
+					 }
+
+					 // Ignore multi-line string indentation.
+					 if (isset(PHP_CodeSniffer_Tokens::$stringTokens[$tokens[$i]['code']]) === true
+						  && $tokens[$i]['code'] === $tokens[($i - 1)]['code']
+					 ) {
+						  continue;
+					 }
+
+					 // Ignore inline HTML.
+					 if ($tokens[$i]['code'] === T_INLINE_HTML) {
+						  continue;
+					 }
+
+					 if ($tokens[$i]['line'] !== $tokens[$openBracket]['line']) {
+						  // We changed lines, so this should be a whitespace indent token, but first make
+						  // sure it isn't a blank line because we don't need to check indent unless there
+						  // is actually some code to indent.
+						  if ($tokens[$i]['code'] === T_WHITESPACE) {
+								$nextCode = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), ($closeBracket + 1), true);
+								if ($tokens[$nextCode]['line'] !== $lastLine) {
+									 if ($inArg === false) {
+										  $error = 'Empty lines are not allowed in multi-line function calls';
+										  $fix   = $phpcsFile->addFixableError($error, $i, 'EmptyLine');
+										  if ($fix === true) {
+												$phpcsFile->fixer->replaceToken($i, '');
+										  }
+									 }
+
+									 continue;
+								}
+						  } else {
+								$nextCode = $i;
+						  }
+
+						  if ($tokens[$nextCode]['line'] === $tokens[$closeBracket]['line']) {
+								// Closing brace needs to be indented to the same level
+								// as the function call.
+								$inArg          = false;
+								$expectedIndent = $functionIndent;
+						  } else {
+								$expectedIndent = ($functionIndent + $this->indent);
+						  }
+
+						  if ($tokens[$i]['code'] !== T_WHITESPACE
+								&& $tokens[$i]['code'] !== T_DOC_COMMENT_WHITESPACE
+						  ) {
+								// Just check if it is a multi-line block comment. If so, we can
+								// calculate the indent from the whitespace before the content.
+								if ($tokens[$i]['code'] === T_COMMENT
+									 && $tokens[($i - 1)]['code'] === T_COMMENT
+								) {
+									 $trimmed     = ltrim($tokens[$i]['content']);
+									 $foundIndent = (strlen($tokens[$i]['content']) - strlen($trimmed));
+								} else {
+									 $foundIndent = 0;
+								}
+						  } else {
+								$foundIndent = strlen($tokens[$i]['content']);
+						  }
+
+						  if ($foundIndent < $expectedIndent
+								|| ($inArg === false
+								&& $expectedIndent !== $foundIndent)
+						  ) {
+								$error = 'Multi-line function call not indented correctly; expected %s spaces but found %s';
+								$data  = array(
+											 $expectedIndent,
+											 $foundIndent,
+											);
+
+								$fix = $phpcsFile->addFixableError($error, $i, 'Indent', $data);
+								if ($fix === true) {
+									 $padding = str_repeat(' ', $expectedIndent);
+									 if ($foundIndent === 0) {
+										  $phpcsFile->fixer->addContentBefore($i, $padding);
+									 } else {
+										  if ($tokens[$i]['code'] === T_COMMENT) {
+												$comment = $padding.ltrim($tokens[$i]['content']);
+												$phpcsFile->fixer->replaceToken($i, $comment);
+										  } else {
+												$phpcsFile->fixer->replaceToken($i, $padding);
+										  }
+									 }
+								}
+						  }//end if
+					 } else {
+						  $nextCode = $i;
+					 }//end if
+
+					 if ($inArg === false) {
+						  $argStart = $nextCode;
+						  $argEnd   = $phpcsFile->findEndOfStatement($nextCode);
+					 }
+				}//end if
+
+				// If we are within an argument we should be ignoring commas
+				// as these are not signaling the end of an argument.
+				if ($inArg === false && $tokens[$i]['code'] === T_COMMA) {
+					 $next = $phpcsFile->findNext(array(T_WHITESPACE, T_COMMENT), ($i + 1), $closeBracket, true);
+					 if ($next === false) {
+						  continue;
+					 }
+
+					 if ($this->allowMultipleArguments === false) {
+						  // Comma has to be the last token on the line.
+						  if ($tokens[$i]['line'] === $tokens[$next]['line']) {
+								$error = 'Only one argument is allowed per line in a multi-line function call';
+								$fix   = $phpcsFile->addFixableError($error, $next, 'MultipleArguments');
+								if ($fix === true) {
+									 $phpcsFile->fixer->beginChangeset();
+									 for ($x = ($next - 1); $x > $i; $x--) {
+										  if ($tokens[$x]['code'] !== T_WHITESPACE) {
+												break;
+										  }
+
+										  $phpcsFile->fixer->replaceToken($x, '');
+									 }
+
+									 $phpcsFile->fixer->addContentBefore(
+										  $next,
+										  $phpcsFile->eolChar.str_repeat(' ', ($functionIndent + $this->indent))
+									 );
+									 $phpcsFile->fixer->endChangeset();
+								}
+						  }
+					 }//end if
+
+					 $argStart = $next;
+					 $argEnd   = $phpcsFile->findEndOfStatement($next);
+				}//end if
+		  }//end for
+
+	 }//end processMultiLineCall()
 
 
 }//end class

Spacing +140 added lines, -140 removed lines

@@ -88,77 +88,77 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $this->requiredSpacesAfterOpen   = (int) $this->requiredSpacesAfterOpen;
         $this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose;
         $tokens = $phpcsFile->getTokens();
 
         // Find the next non-empty token.
-        $openBracket = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true);
+        $openBracket = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ( $stackPtr + 1 ), null, true );
 
-        if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
+        if ( $tokens[ $openBracket ][ 'code' ] !== T_OPEN_PARENTHESIS ) {
             // Not a function call.
             return;
         }
 
-        if (isset($tokens[$openBracket]['parenthesis_closer']) === false) {
+        if ( isset( $tokens[ $openBracket ][ 'parenthesis_closer' ] ) === false ) {
             // Not a function call.
             return;
         }
 
         // Find the previous non-empty token.
         $search   = PHP_CodeSniffer_Tokens::$emptyTokens;
-        $search[] = T_BITWISE_AND;
-        $previous = $phpcsFile->findPrevious($search, ($stackPtr - 1), null, true);
-        if ($tokens[$previous]['code'] === T_FUNCTION) {
+        $search[ ] = T_BITWISE_AND;
+        $previous = $phpcsFile->findPrevious( $search, ( $stackPtr - 1 ), null, true );
+        if ( $tokens[ $previous ][ 'code' ] === T_FUNCTION ) {
             // It's a function definition, not a function call.
             return;
         }
 
-        $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
+        $closeBracket = $tokens[ $openBracket ][ 'parenthesis_closer' ];
 
-        if (($stackPtr + 1) !== $openBracket) {
+        if ( ( $stackPtr + 1 ) !== $openBracket ) {
             // Checking this: $value = my_function[*](...).
             $error = 'Space before opening parenthesis of function call prohibited';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeOpenBracket');
-            if ($fix === true) {
+            $fix   = $phpcsFile->addFixableError( $error, $stackPtr, 'SpaceBeforeOpenBracket' );
+            if ( $fix === true ) {
                 $phpcsFile->fixer->beginChangeset();
-                for ($i = ($stackPtr + 1); $i < $openBracket; $i++) {
-                    $phpcsFile->fixer->replaceToken($i, '');
+                for ( $i = ( $stackPtr + 1 ); $i < $openBracket; $i++ ) {
+                    $phpcsFile->fixer->replaceToken( $i, '' );
                 }
 
                 // Modify the bracket as well to ensure a conflict if the bracket
                 // has been changed in some way by another sniff.
-                $phpcsFile->fixer->replaceToken($openBracket, '(');
+                $phpcsFile->fixer->replaceToken( $openBracket, '(' );
                 $phpcsFile->fixer->endChangeset();
             }
         }
 
-        $next = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), null, true);
-        if ($tokens[$next]['code'] === T_SEMICOLON) {
-            if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[($closeBracket + 1)]['code']]) === true) {
+        $next = $phpcsFile->findNext( T_WHITESPACE, ( $closeBracket + 1 ), null, true );
+        if ( $tokens[ $next ][ 'code' ] === T_SEMICOLON ) {
+            if ( isset( PHP_CodeSniffer_Tokens::$emptyTokens[ $tokens[ ( $closeBracket + 1 ) ][ 'code' ] ] ) === true ) {
                 $error = 'Space after closing parenthesis of function call prohibited';
-                $fix   = $phpcsFile->addFixableError($error, $closeBracket, 'SpaceAfterCloseBracket');
-                if ($fix === true) {
+                $fix   = $phpcsFile->addFixableError( $error, $closeBracket, 'SpaceAfterCloseBracket' );
+                if ( $fix === true ) {
                     $phpcsFile->fixer->beginChangeset();
-                    for ($i = ($closeBracket + 1); $i < $next; $i++) {
-                        $phpcsFile->fixer->replaceToken($i, '');
+                    for ( $i = ( $closeBracket + 1 ); $i < $next; $i++ ) {
+                        $phpcsFile->fixer->replaceToken( $i, '' );
                     }
 
                     // Modify the bracket as well to ensure a conflict if the bracket
                     // has been changed in some way by another sniff.
-                    $phpcsFile->fixer->replaceToken($closeBracket, ')');
+                    $phpcsFile->fixer->replaceToken( $closeBracket, ')' );
                     $phpcsFile->fixer->endChangeset();
                 }
             }
         }
 
         // Check if this is a single line or multi-line function call.
-        if ($this->isMultiLineCall($phpcsFile, $stackPtr, $openBracket, $tokens) === true) {
-            $this->processMultiLineCall($phpcsFile, $stackPtr, $openBracket, $tokens);
+        if ( $this->isMultiLineCall( $phpcsFile, $stackPtr, $openBracket, $tokens ) === true ) {
+            $this->processMultiLineCall( $phpcsFile, $stackPtr, $openBracket, $tokens );
         } else {
-            $this->processSingleLineCall($phpcsFile, $stackPtr, $openBracket, $tokens);
+            $this->processSingleLineCall( $phpcsFile, $stackPtr, $openBracket, $tokens );
         }
 
     }//end process()
@@ -177,10 +177,10 @@ 
      *
      * @return void
      */
-    public function isMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
+    public function isMultiLineCall( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens )
     {
-        $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
-        if ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']) {
+        $closeBracket = $tokens[ $openBracket ][ 'parenthesis_closer' ];
+        if ( $tokens[ $openBracket ][ 'line' ] !== $tokens[ $closeBracket ][ 'line' ] ) {
             return true;
         }
 
@@ -202,39 +202,39 @@ 
      *
      * @return void
      */
-    public function processSingleLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
+    public function processSingleLineCall( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens )
     {
-        $closer = $tokens[$openBracket]['parenthesis_closer'];
-        if ($openBracket === ($closer - 1)) {
+        $closer = $tokens[ $openBracket ][ 'parenthesis_closer' ];
+        if ( $openBracket === ( $closer - 1 ) ) {
             return;
         }
 
-        if ($this->requiredSpacesAfterOpen === 0 && $tokens[($openBracket + 1)]['code'] === T_WHITESPACE) {
+        if ( $this->requiredSpacesAfterOpen === 0 && $tokens[ ( $openBracket + 1 ) ][ 'code' ] === T_WHITESPACE ) {
             // Checking this: $value = my_function([*]...).
             $error = 'Space after opening parenthesis of function call prohibited';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpenBracket');
-            if ($fix === true) {
-                $phpcsFile->fixer->replaceToken(($openBracket + 1), '');
+            $fix   = $phpcsFile->addFixableError( $error, $stackPtr, 'SpaceAfterOpenBracket' );
+            if ( $fix === true ) {
+                $phpcsFile->fixer->replaceToken( ( $openBracket + 1 ), '' );
             }
-        } else if ($this->requiredSpacesAfterOpen > 0) {
+        } else if ( $this->requiredSpacesAfterOpen > 0 ) {
             $spaceAfterOpen = 0;
-            if ($tokens[($openBracket + 1)]['code'] === T_WHITESPACE) {
-                $spaceAfterOpen = strlen($tokens[($openBracket + 1)]['content']);
+            if ( $tokens[ ( $openBracket + 1 ) ][ 'code' ] === T_WHITESPACE ) {
+                $spaceAfterOpen = strlen( $tokens[ ( $openBracket + 1 ) ][ 'content' ] );
             }
 
-            if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) {
+            if ( $spaceAfterOpen !== $this->requiredSpacesAfterOpen ) {
                 $error = 'Expected %s spaces after opening bracket; %s found';
                 $data  = array(
                           $this->requiredSpacesAfterOpen,
                           $spaceAfterOpen,
                          );
-                $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpenBracket', $data);
-                if ($fix === true) {
-                    $padding = str_repeat(' ', $this->requiredSpacesAfterOpen);
-                    if ($spaceAfterOpen === 0) {
-                        $phpcsFile->fixer->addContent($openBracket, $padding);
+                $fix = $phpcsFile->addFixableError( $error, $stackPtr, 'SpaceAfterOpenBracket', $data );
+                if ( $fix === true ) {
+                    $padding = str_repeat( ' ', $this->requiredSpacesAfterOpen );
+                    if ( $spaceAfterOpen === 0 ) {
+                        $phpcsFile->fixer->addContent( $openBracket, $padding );
                     } else {
-                        $phpcsFile->fixer->replaceToken(($openBracket + 1), $padding);
+                        $phpcsFile->fixer->replaceToken( ( $openBracket + 1 ), $padding );
                     }
                 }
             }
@@ -242,31 +242,31 @@ 
 
         // Checking this: $value = my_function(...[*]).
         $spaceBeforeClose = 0;
-        $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($closer - 1), $openBracket, true);
-        if ($tokens[$prev]['code'] === T_END_HEREDOC || $tokens[$prev]['code'] === T_END_NOWDOC) {
+        $prev = $phpcsFile->findPrevious( PHP_CodeSniffer_Tokens::$emptyTokens, ( $closer - 1 ), $openBracket, true );
+        if ( $tokens[ $prev ][ 'code' ] === T_END_HEREDOC || $tokens[ $prev ][ 'code' ] === T_END_NOWDOC ) {
             // Need a newline after these tokens, so ignore this rule.
             return;
         }
 
-        if ($tokens[$prev]['line'] !== $tokens[$closer]['line']) {
+        if ( $tokens[ $prev ][ 'line' ] !== $tokens[ $closer ][ 'line' ] ) {
             $spaceBeforeClose = 'newline';
-        } else if ($tokens[($closer - 1)]['code'] === T_WHITESPACE) {
-            $spaceBeforeClose = strlen($tokens[($closer - 1)]['content']);
+        } else if ( $tokens[ ( $closer - 1 ) ][ 'code' ] === T_WHITESPACE ) {
+            $spaceBeforeClose = strlen( $tokens[ ( $closer - 1 ) ][ 'content' ] );
         }
 
-        if ($spaceBeforeClose !== $this->requiredSpacesBeforeClose) {
+        if ( $spaceBeforeClose !== $this->requiredSpacesBeforeClose ) {
             $error = 'Expected %s spaces before closing bracket; %s found';
             $data  = array(
                       $this->requiredSpacesBeforeClose,
                       $spaceBeforeClose,
                      );
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeCloseBracket', $data);
-            if ($fix === true) {
-                $padding = str_repeat(' ', $this->requiredSpacesBeforeClose);
-                if ($spaceBeforeClose === 0) {
-                    $phpcsFile->fixer->addContentBefore($closer, $padding);
+            $fix = $phpcsFile->addFixableError( $error, $stackPtr, 'SpaceBeforeCloseBracket', $data );
+            if ( $fix === true ) {
+                $padding = str_repeat( ' ', $this->requiredSpacesBeforeClose );
+                if ( $spaceBeforeClose === 0 ) {
+                    $phpcsFile->fixer->addContentBefore( $closer, $padding );
                 } else {
-                    $phpcsFile->fixer->replaceToken(($closer - 1), $padding);
+                    $phpcsFile->fixer->replaceToken( ( $closer - 1 ), $padding );
                 }
             }
         }
@@ -287,125 +287,125 @@ 
      *
      * @return void
      */
-    public function processMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
+    public function processMultiLineCall( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens )
     {
         // We need to work out how far indented the function
         // call itself is, so we can work out how far to
         // indent the arguments.
-        $start = $phpcsFile->findStartOfStatement($stackPtr);
-        foreach (array('stackPtr', 'start') as $checkToken) {
+        $start = $phpcsFile->findStartOfStatement( $stackPtr );
+        foreach ( array( 'stackPtr', 'start' ) as $checkToken ) {
             $x = $$checkToken;
-            for ($i = ($x - 1); $i >= 0; $i--) {
-                if ($tokens[$i]['line'] !== $tokens[$x]['line']) {
+            for ( $i = ( $x - 1 ); $i >= 0; $i-- ) {
+                if ( $tokens[ $i ][ 'line' ] !== $tokens[ $x ][ 'line' ] ) {
                     $i++;
                     break;
                 }
             }
 
-            if ($i <= 0) {
+            if ( $i <= 0 ) {
                 $functionIndent = 0;
-            } else if ($tokens[$i]['code'] === T_WHITESPACE) {
-                $functionIndent = strlen($tokens[$i]['content']);
-            } else if ($tokens[$i]['code'] === T_CONSTANT_ENCAPSED_STRING) {
+            } else if ( $tokens[ $i ][ 'code' ] === T_WHITESPACE ) {
+                $functionIndent = strlen( $tokens[ $i ][ 'content' ] );
+            } else if ( $tokens[ $i ][ 'code' ] === T_CONSTANT_ENCAPSED_STRING ) {
                 $functionIndent = 0;
             } else {
-                $trimmed = ltrim($tokens[$i]['content']);
-                if ($trimmed === '') {
-                    if ($tokens[$i]['code'] === T_INLINE_HTML) {
-                        $functionIndent = strlen($tokens[$i]['content']);
+                $trimmed = ltrim( $tokens[ $i ][ 'content' ] );
+                if ( $trimmed === '' ) {
+                    if ( $tokens[ $i ][ 'code' ] === T_INLINE_HTML ) {
+                        $functionIndent = strlen( $tokens[ $i ][ 'content' ] );
                     } else {
-                        $functionIndent = ($tokens[$i]['column'] - 1);
+                        $functionIndent = ( $tokens[ $i ][ 'column' ] - 1 );
                     }
                 } else {
-                    $functionIndent = (strlen($tokens[$i]['content']) - strlen($trimmed));
+                    $functionIndent = ( strlen( $tokens[ $i ][ 'content' ] ) - strlen( $trimmed ) );
                 }
             }
 
-            $varName  = $checkToken.'Indent';
+            $varName  = $checkToken . 'Indent';
             $$varName = $functionIndent;
         }//end foreach
 
-        $functionIndent = max($startIndent, $stackPtrIndent);
+        $functionIndent = max( $startIndent, $stackPtrIndent );
 
-        $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($openBracket + 1), null, true);
-        if ($tokens[$next]['line'] === $tokens[$openBracket]['line']) {
+        $next = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ( $openBracket + 1 ), null, true );
+        if ( $tokens[ $next ][ 'line' ] === $tokens[ $openBracket ][ 'line' ] ) {
             $error = 'Opening parenthesis of a multi-line function call must be the last content on the line';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'ContentAfterOpenBracket');
-            if ($fix === true) {
+            $fix   = $phpcsFile->addFixableError( $error, $stackPtr, 'ContentAfterOpenBracket' );
+            if ( $fix === true ) {
                 $phpcsFile->fixer->addContent(
                     $openBracket,
-                    $phpcsFile->eolChar.str_repeat(' ', ($functionIndent + $this->indent))
+                    $phpcsFile->eolChar . str_repeat( ' ', ( $functionIndent + $this->indent ) )
                 );
             }
         }
 
-        $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
-        $prev         = $phpcsFile->findPrevious(T_WHITESPACE, ($closeBracket - 1), null, true);
-        if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) {
+        $closeBracket = $tokens[ $openBracket ][ 'parenthesis_closer' ];
+        $prev         = $phpcsFile->findPrevious( T_WHITESPACE, ( $closeBracket - 1 ), null, true );
+        if ( $tokens[ $prev ][ 'line' ] === $tokens[ $closeBracket ][ 'line' ] ) {
             $error = 'Closing parenthesis of a multi-line function call must be on a line by itself';
-            $fix   = $phpcsFile->addFixableError($error, $closeBracket, 'CloseBracketLine');
-            if ($fix === true) {
+            $fix   = $phpcsFile->addFixableError( $error, $closeBracket, 'CloseBracketLine' );
+            if ( $fix === true ) {
                 $phpcsFile->fixer->addContentBefore(
                     $closeBracket,
-                    $phpcsFile->eolChar.str_repeat(' ', ($functionIndent + $this->indent))
+                    $phpcsFile->eolChar . str_repeat( ' ', ( $functionIndent + $this->indent ) )
                 );
             }
         }
 
         // Each line between the parenthesis should be indented n spaces.
-        $lastLine = ($tokens[$openBracket]['line'] - 1);
+        $lastLine = ( $tokens[ $openBracket ][ 'line' ] - 1 );
         $argStart = null;
         $argEnd   = null;
         $inArg    = false;
 
         // Start processing at the first argument.
-        $i = $phpcsFile->findNext(T_WHITESPACE, ($openBracket + 1), null, true);
-        if ($tokens[($i - 1)]['code'] === T_WHITESPACE
-            && $tokens[($i - 1)]['line'] === $tokens[$i]['line']
+        $i = $phpcsFile->findNext( T_WHITESPACE, ( $openBracket + 1 ), null, true );
+        if ( $tokens[ ( $i - 1 ) ][ 'code' ] === T_WHITESPACE
+            && $tokens[ ( $i - 1 ) ][ 'line' ] === $tokens[ $i ][ 'line' ]
         ) {
             // Make sure we check the indent.
             $i--;
         }
 
-        for ($i; $i < $closeBracket; $i++) {
-            if ($i > $argStart && $i < $argEnd) {
+        for ( $i; $i < $closeBracket; $i++ ) {
+            if ( $i > $argStart && $i < $argEnd ) {
                 $inArg = true;
             } else {
                 $inArg = false;
             }
 
-            if ($tokens[$i]['line'] !== $lastLine) {
-                $lastLine = $tokens[$i]['line'];
+            if ( $tokens[ $i ][ 'line' ] !== $lastLine ) {
+                $lastLine = $tokens[ $i ][ 'line' ];
 
                 // Ignore heredoc indentation.
-                if (isset(PHP_CodeSniffer_Tokens::$heredocTokens[$tokens[$i]['code']]) === true) {
+                if ( isset( PHP_CodeSniffer_Tokens::$heredocTokens[ $tokens[ $i ][ 'code' ] ] ) === true ) {
                     continue;
                 }
 
                 // Ignore multi-line string indentation.
-                if (isset(PHP_CodeSniffer_Tokens::$stringTokens[$tokens[$i]['code']]) === true
-                    && $tokens[$i]['code'] === $tokens[($i - 1)]['code']
+                if ( isset( PHP_CodeSniffer_Tokens::$stringTokens[ $tokens[ $i ][ 'code' ] ] ) === true
+                    && $tokens[ $i ][ 'code' ] === $tokens[ ( $i - 1 ) ][ 'code' ]
                 ) {
                     continue;
                 }
 
                 // Ignore inline HTML.
-                if ($tokens[$i]['code'] === T_INLINE_HTML) {
+                if ( $tokens[ $i ][ 'code' ] === T_INLINE_HTML ) {
                     continue;
                 }
 
-                if ($tokens[$i]['line'] !== $tokens[$openBracket]['line']) {
+                if ( $tokens[ $i ][ 'line' ] !== $tokens[ $openBracket ][ 'line' ] ) {
                     // We changed lines, so this should be a whitespace indent token, but first make
                     // sure it isn't a blank line because we don't need to check indent unless there
                     // is actually some code to indent.
-                    if ($tokens[$i]['code'] === T_WHITESPACE) {
-                        $nextCode = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), ($closeBracket + 1), true);
-                        if ($tokens[$nextCode]['line'] !== $lastLine) {
-                            if ($inArg === false) {
+                    if ( $tokens[ $i ][ 'code' ] === T_WHITESPACE ) {
+                        $nextCode = $phpcsFile->findNext( T_WHITESPACE, ( $i + 1 ), ( $closeBracket + 1 ), true );
+                        if ( $tokens[ $nextCode ][ 'line' ] !== $lastLine ) {
+                            if ( $inArg === false ) {
                                 $error = 'Empty lines are not allowed in multi-line function calls';
-                                $fix   = $phpcsFile->addFixableError($error, $i, 'EmptyLine');
-                                if ($fix === true) {
-                                    $phpcsFile->fixer->replaceToken($i, '');
+                                $fix   = $phpcsFile->addFixableError( $error, $i, 'EmptyLine' );
+                                if ( $fix === true ) {
+                                    $phpcsFile->fixer->replaceToken( $i, '' );
                                 }
                             }
 
@@ -415,35 +415,35 @@ 
                         $nextCode = $i;
                     }
 
-                    if ($tokens[$nextCode]['line'] === $tokens[$closeBracket]['line']) {
+                    if ( $tokens[ $nextCode ][ 'line' ] === $tokens[ $closeBracket ][ 'line' ] ) {
                         // Closing brace needs to be indented to the same level
                         // as the function call.
                         $inArg          = false;
                         $expectedIndent = $functionIndent;
                     } else {
-                        $expectedIndent = ($functionIndent + $this->indent);
+                        $expectedIndent = ( $functionIndent + $this->indent );
                     }
 
-                    if ($tokens[$i]['code'] !== T_WHITESPACE
-                        && $tokens[$i]['code'] !== T_DOC_COMMENT_WHITESPACE
+                    if ( $tokens[ $i ][ 'code' ] !== T_WHITESPACE
+                        && $tokens[ $i ][ 'code' ] !== T_DOC_COMMENT_WHITESPACE
                     ) {
                         // Just check if it is a multi-line block comment. If so, we can
                         // calculate the indent from the whitespace before the content.
-                        if ($tokens[$i]['code'] === T_COMMENT
-                            && $tokens[($i - 1)]['code'] === T_COMMENT
+                        if ( $tokens[ $i ][ 'code' ] === T_COMMENT
+                            && $tokens[ ( $i - 1 ) ][ 'code' ] === T_COMMENT
                         ) {
-                            $trimmed     = ltrim($tokens[$i]['content']);
-                            $foundIndent = (strlen($tokens[$i]['content']) - strlen($trimmed));
+                            $trimmed     = ltrim( $tokens[ $i ][ 'content' ] );
+                            $foundIndent = ( strlen( $tokens[ $i ][ 'content' ] ) - strlen( $trimmed ) );
                         } else {
                             $foundIndent = 0;
                         }
                     } else {
-                        $foundIndent = strlen($tokens[$i]['content']);
+                        $foundIndent = strlen( $tokens[ $i ][ 'content' ] );
                     }
 
-                    if ($foundIndent < $expectedIndent
-                        || ($inArg === false
-                        && $expectedIndent !== $foundIndent)
+                    if ( $foundIndent < $expectedIndent
+                        || ( $inArg === false
+                        && $expectedIndent !== $foundIndent )
                     ) {
                         $error = 'Multi-line function call not indented correctly; expected %s spaces but found %s';
                         $data  = array(
@@ -451,17 +451,17 @@ 
                                   $foundIndent,
                                  );
 
-                        $fix = $phpcsFile->addFixableError($error, $i, 'Indent', $data);
-                        if ($fix === true) {
-                            $padding = str_repeat(' ', $expectedIndent);
-                            if ($foundIndent === 0) {
-                                $phpcsFile->fixer->addContentBefore($i, $padding);
+                        $fix = $phpcsFile->addFixableError( $error, $i, 'Indent', $data );
+                        if ( $fix === true ) {
+                            $padding = str_repeat( ' ', $expectedIndent );
+                            if ( $foundIndent === 0 ) {
+                                $phpcsFile->fixer->addContentBefore( $i, $padding );
                             } else {
-                                if ($tokens[$i]['code'] === T_COMMENT) {
-                                    $comment = $padding.ltrim($tokens[$i]['content']);
-                                    $phpcsFile->fixer->replaceToken($i, $comment);
+                                if ( $tokens[ $i ][ 'code' ] === T_COMMENT ) {
+                                    $comment = $padding . ltrim( $tokens[ $i ][ 'content' ] );
+                                    $phpcsFile->fixer->replaceToken( $i, $comment );
                                 } else {
-                                    $phpcsFile->fixer->replaceToken($i, $padding);
+                                    $phpcsFile->fixer->replaceToken( $i, $padding );
                                 }
                             }
                         }
@@ -470,38 +470,38 @@ 
                     $nextCode = $i;
                 }//end if
 
-                if ($inArg === false) {
+                if ( $inArg === false ) {
                     $argStart = $nextCode;
-                    $argEnd   = $phpcsFile->findEndOfStatement($nextCode);
+                    $argEnd   = $phpcsFile->findEndOfStatement( $nextCode );
                 }
             }//end if
 
             // If we are within an argument we should be ignoring commas
             // as these are not signaling the end of an argument.
-            if ($inArg === false && $tokens[$i]['code'] === T_COMMA) {
-                $next = $phpcsFile->findNext(array(T_WHITESPACE, T_COMMENT), ($i + 1), $closeBracket, true);
-                if ($next === false) {
+            if ( $inArg === false && $tokens[ $i ][ 'code' ] === T_COMMA ) {
+                $next = $phpcsFile->findNext( array( T_WHITESPACE, T_COMMENT ), ( $i + 1 ), $closeBracket, true );
+                if ( $next === false ) {
                     continue;
                 }
 
-                if ($this->allowMultipleArguments === false) {
+                if ( $this->allowMultipleArguments === false ) {
                     // Comma has to be the last token on the line.
-                    if ($tokens[$i]['line'] === $tokens[$next]['line']) {
+                    if ( $tokens[ $i ][ 'line' ] === $tokens[ $next ][ 'line' ] ) {
                         $error = 'Only one argument is allowed per line in a multi-line function call';
-                        $fix   = $phpcsFile->addFixableError($error, $next, 'MultipleArguments');
-                        if ($fix === true) {
+                        $fix   = $phpcsFile->addFixableError( $error, $next, 'MultipleArguments' );
+                        if ( $fix === true ) {
                             $phpcsFile->fixer->beginChangeset();
-                            for ($x = ($next - 1); $x > $i; $x--) {
-                                if ($tokens[$x]['code'] !== T_WHITESPACE) {
+                            for ( $x = ( $next - 1 ); $x > $i; $x-- ) {
+                                if ( $tokens[ $x ][ 'code' ] !== T_WHITESPACE ) {
                                     break;
                                 }
 
-                                $phpcsFile->fixer->replaceToken($x, '');
+                                $phpcsFile->fixer->replaceToken( $x, '' );
                             }
 
                             $phpcsFile->fixer->addContentBefore(
                                 $next,
-                                $phpcsFile->eolChar.str_repeat(' ', ($functionIndent + $this->indent))
+                                $phpcsFile->eolChar . str_repeat( ' ', ( $functionIndent + $this->indent ) )
                             );
                             $phpcsFile->fixer->endChangeset();
                         }
@@ -509,7 +509,7 @@ 
                 }//end if
 
                 $argStart = $next;
-                $argEnd   = $phpcsFile->findEndOfStatement($next);
+                $argEnd   = $phpcsFile->findEndOfStatement( $next );
             }//end if
         }//end for
 

Braces +6 added lines, -12 removed lines

@@ -25,8 +25,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class PEAR_Sniffs_Functions_FunctionCallSignatureSniff implements PHP_CodeSniffer_Sniff
-{
+class PEAR_Sniffs_Functions_FunctionCallSignatureSniff implements PHP_CodeSniffer_Sniff {
 
     /**
      * A list of tokenizers this sniff supports.
@@ -72,8 +71,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return PHP_CodeSniffer_Tokens::$functionNameTokens;
 
     }//end register()
@@ -88,8 +86,7 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $this->requiredSpacesAfterOpen   = (int) $this->requiredSpacesAfterOpen;
         $this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose;
         $tokens = $phpcsFile->getTokens();
@@ -177,8 +174,7 @@ 
      *
      * @return void
      */
-    public function isMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
-    {
+    public function isMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens) {
         $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
         if ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']) {
             return true;
@@ -202,8 +198,7 @@ 
      *
      * @return void
      */
-    public function processSingleLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
-    {
+    public function processSingleLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens) {
         $closer = $tokens[$openBracket]['parenthesis_closer'];
         if ($openBracket === ($closer - 1)) {
             return;
@@ -287,8 +282,7 @@ 
      *
      * @return void
      */
-    public function processMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
-    {
+    public function processMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens) {
         // We need to work out how far indented the function
         // call itself is, so we can work out how far to
         // indent the arguments.

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/PEAR/Sniffs/Functions/FunctionDeclarationSniff.php

Doc Comments +1 added lines, -1 removed lines

@@ -187,7 +187,7 @@
      * @param array                $tokens      The stack of tokens that make up
      *                                          the file.
      *
-     * @return void
+     * @return boolean
      */
     public function isMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
     {

Indentation +396 added lines, -396 removed lines

@@ -28,402 +28,402 @@
 class PEAR_Sniffs_Functions_FunctionDeclarationSniff implements PHP_CodeSniffer_Sniff
 {
 
-    /**
-     * The number of spaces code should be indented.
-     *
-     * @var int
-     */
-    public $indent = 4;
-
-
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-                T_FUNCTION,
-                T_CLOSURE,
-               );
-
-    }//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();
-
-        if (isset($tokens[$stackPtr]['parenthesis_opener']) === false
-            || isset($tokens[$stackPtr]['parenthesis_closer']) === false
-            || $tokens[$stackPtr]['parenthesis_opener'] === null
-            || $tokens[$stackPtr]['parenthesis_closer'] === null
-        ) {
-            return;
-        }
-
-        $openBracket  = $tokens[$stackPtr]['parenthesis_opener'];
-        $closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
-
-        // Must be one space after the FUNCTION keyword.
-        if ($tokens[($stackPtr + 1)]['content'] === $phpcsFile->eolChar) {
-            $spaces = 'newline';
-        } else if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) {
-            $spaces = strlen($tokens[($stackPtr + 1)]['content']);
-        } else {
-            $spaces = 0;
-        }
-
-        if ($spaces !== 1) {
-            $error = 'Expected 1 space after FUNCTION keyword; %s found';
-            $data  = array($spaces);
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterFunction', $data);
-            if ($fix === true) {
-                if ($spaces === 0) {
-                    $phpcsFile->fixer->addContent($stackPtr, ' ');
-                } else {
-                    $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' ');
-                }
-            }
-        }
-
-        // Must be one space before the opening parenthesis. For closures, this is
-        // enforced by the first check because there is no content between the keywords
-        // and the opening parenthesis.
-        if ($tokens[$stackPtr]['code'] === T_FUNCTION) {
-            if ($tokens[($openBracket - 1)]['content'] === $phpcsFile->eolChar) {
-                $spaces = 'newline';
-            } else if ($tokens[($openBracket - 1)]['code'] === T_WHITESPACE) {
-                $spaces = strlen($tokens[($openBracket - 1)]['content']);
-            } else {
-                $spaces = 0;
-            }
-
-            if ($spaces !== 0) {
-                $error = 'Expected 0 spaces before opening parenthesis; %s found';
-                $data  = array($spaces);
-                $fix   = $phpcsFile->addFixableError($error, $openBracket, 'SpaceBeforeOpenParen', $data);
-                if ($fix === true) {
-                    $phpcsFile->fixer->replaceToken(($openBracket - 1), '');
-                }
-            }
-        }//end if
-
-        // Must be one space before and after USE keyword for closures.
-        if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
-            $use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']);
-            if ($use !== false) {
-                if ($tokens[($use + 1)]['code'] !== T_WHITESPACE) {
-                    $length = 0;
-                } else if ($tokens[($use + 1)]['content'] === "\t") {
-                    $length = '\t';
-                } else {
-                    $length = strlen($tokens[($use + 1)]['content']);
-                }
-
-                if ($length !== 1) {
-                    $error = 'Expected 1 space after USE keyword; found %s';
-                    $data  = array($length);
-                    $fix   = $phpcsFile->addFixableError($error, $use, 'SpaceAfterUse', $data);
-                    if ($fix === true) {
-                        if ($length === 0) {
-                            $phpcsFile->fixer->addContent($use, ' ');
-                        } else {
-                            $phpcsFile->fixer->replaceToken(($use + 1), ' ');
-                        }
-                    }
-                }
-
-                if ($tokens[($use - 1)]['code'] !== T_WHITESPACE) {
-                    $length = 0;
-                } else if ($tokens[($use - 1)]['content'] === "\t") {
-                    $length = '\t';
-                } else {
-                    $length = strlen($tokens[($use - 1)]['content']);
-                }
-
-                if ($length !== 1) {
-                    $error = 'Expected 1 space before USE keyword; found %s';
-                    $data  = array($length);
-                    $fix   = $phpcsFile->addFixableError($error, $use, 'SpaceBeforeUse', $data);
-                    if ($fix === true) {
-                        if ($length === 0) {
-                            $phpcsFile->fixer->addContentBefore($use, ' ');
-                        } else {
-                            $phpcsFile->fixer->replaceToken(($use - 1), ' ');
-                        }
-                    }
-                }
-            }//end if
-        }//end if
-
-        if ($this->isMultiLineDeclaration($phpcsFile, $stackPtr, $openBracket, $tokens) === true) {
-            $this->processMultiLineDeclaration($phpcsFile, $stackPtr, $tokens);
-        } else {
-            $this->processSingleLineDeclaration($phpcsFile, $stackPtr, $tokens);
-        }
-
-    }//end process()
-
-
-    /**
-     * Determine if this is a multi-line function declaration.
-     *
-     * @param PHP_CodeSniffer_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
-     *                                          in the stack passed in $tokens.
-     * @param array                $tokens      The stack of tokens that make up
-     *                                          the file.
-     *
-     * @return void
-     */
-    public function isMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
-    {
-        $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
-        if ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']) {
-            return true;
-        }
-
-        // Closures may use the USE keyword and so be multi-line in this way.
-        if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
-            $use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']);
-            if ($use !== false) {
-                // If the opening and closing parenthesis of the use statement
-                // are also on the same line, this is a single line declaration.
-                $open  = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1));
-                $close = $tokens[$open]['parenthesis_closer'];
-                if ($tokens[$open]['line'] !== $tokens[$close]['line']) {
-                    return true;
-                }
-            }
-        }
-
-        return false;
-
-    }//end isMultiLineDeclaration()
-
-
-    /**
-     * Processes single-line declarations.
-     *
-     * Just uses the Generic BSD-Allman brace sniff.
-     *
-     * @param PHP_CodeSniffer_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
-     *                                        the file.
-     *
-     * @return void
-     */
-    public function processSingleLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens)
-    {
-        if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
-            if (class_exists('Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff', true) === false) {
-                throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff not found');
-            }
-
-            $sniff = new Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff();
-        } else {
-            if (class_exists('Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff', true) === false) {
-                throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff not found');
-            }
-
-            $sniff = new Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff();
-        }
-
-        $sniff->checkClosures = true;
-        $sniff->process($phpcsFile, $stackPtr);
-
-    }//end processSingleLineDeclaration()
-
-
-    /**
-     * Processes multi-line declarations.
-     *
-     * @param PHP_CodeSniffer_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
-     *                                        the file.
-     *
-     * @return void
-     */
-    public function processMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens)
-    {
-        // We need to work out how far indented the function
-        // declaration itself is, so we can work out how far to
-        // indent parameters.
-        $functionIndent = 0;
-        for ($i = ($stackPtr - 1); $i >= 0; $i--) {
-            if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) {
-                $i++;
-                break;
-            }
-        }
-
-        if ($tokens[$i]['code'] === T_WHITESPACE) {
-            $functionIndent = strlen($tokens[$i]['content']);
-        }
-
-        // The closing parenthesis must be on a new line, even
-        // when checking abstract function definitions.
-        $closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
-        $prev         = $phpcsFile->findPrevious(
-            T_WHITESPACE,
-            ($closeBracket - 1),
-            null,
-            true
-        );
-
-        if ($tokens[$closeBracket]['line'] !== $tokens[$tokens[$closeBracket]['parenthesis_opener']]['line']) {
-            if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) {
-                $error = 'The closing parenthesis of a multi-line function declaration must be on a new line';
-                $fix   = $phpcsFile->addFixableError($error, $closeBracket, 'CloseBracketLine');
-                if ($fix === true) {
-                    $phpcsFile->fixer->addNewlineBefore($closeBracket);
-                }
-            }
-        }
-
-        // If this is a closure and is using a USE statement, the closing
-        // parenthesis we need to look at from now on is the closing parenthesis
-        // of the USE statement.
-        if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
-            $use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']);
-            if ($use !== false) {
-                $open         = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1));
-                $closeBracket = $tokens[$open]['parenthesis_closer'];
-
-                $prev = $phpcsFile->findPrevious(
-                    T_WHITESPACE,
-                    ($closeBracket - 1),
-                    null,
-                    true
-                );
-
-                if ($tokens[$closeBracket]['line'] !== $tokens[$tokens[$closeBracket]['parenthesis_opener']]['line']) {
-                    if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) {
-                        $error = 'The closing parenthesis of a multi-line use declaration must be on a new line';
-                        $fix   = $phpcsFile->addFixableError($error, $closeBracket, 'UseCloseBracketLine');
-                        if ($fix === true) {
-                            $phpcsFile->fixer->addNewlineBefore($closeBracket);
-                        }
-                    }
-                }
-            }//end if
-        }//end if
-
-        // Each line between the parenthesis should be indented 4 spaces.
-        $openBracket = $tokens[$stackPtr]['parenthesis_opener'];
-        $lastLine    = $tokens[$openBracket]['line'];
-        for ($i = ($openBracket + 1); $i < $closeBracket; $i++) {
-            if ($tokens[$i]['line'] !== $lastLine) {
-                if ($i === $tokens[$stackPtr]['parenthesis_closer']
-                    || ($tokens[$i]['code'] === T_WHITESPACE
-                    && (($i + 1) === $closeBracket
-                    || ($i + 1) === $tokens[$stackPtr]['parenthesis_closer']))
-                ) {
-                    // Closing braces need to be indented to the same level
-                    // as the function.
-                    $expectedIndent = $functionIndent;
-                } else {
-                    $expectedIndent = ($functionIndent + $this->indent);
-                }
-
-                // We changed lines, so this should be a whitespace indent token.
-                if ($tokens[$i]['code'] !== T_WHITESPACE) {
-                    $foundIndent = 0;
-                } else {
-                    $foundIndent = strlen($tokens[$i]['content']);
-                }
-
-                if ($expectedIndent !== $foundIndent) {
-                    $error = 'Multi-line function declaration not indented correctly; expected %s spaces but found %s';
-                    $data  = array(
-                              $expectedIndent,
-                              $foundIndent,
-                             );
-
-                    $fix = $phpcsFile->addFixableError($error, $i, 'Indent', $data);
-                    if ($fix === true) {
-                        $spaces = str_repeat(' ', $expectedIndent);
-                        if ($foundIndent === 0) {
-                            $phpcsFile->fixer->addContentBefore($i, $spaces);
-                        } else {
-                            $phpcsFile->fixer->replaceToken($i, $spaces);
-                        }
-                    }
-                }
-
-                $lastLine = $tokens[$i]['line'];
-            }//end if
-
-            if ($tokens[$i]['code'] === T_ARRAY || $tokens[$i]['code'] === T_OPEN_SHORT_ARRAY) {
-                // Skip arrays as they have their own indentation rules.
-                if ($tokens[$i]['code'] === T_OPEN_SHORT_ARRAY) {
-                    $i = $tokens[$i]['bracket_closer'];
-                } else {
-                    $i = $tokens[$i]['parenthesis_closer'];
-                }
-
-                $lastLine = $tokens[$i]['line'];
-                continue;
-            }
-        }//end for
-
-        if (isset($tokens[$stackPtr]['scope_opener']) === false) {
-            return;
-        }
-
-        // The opening brace needs to be one space away from the closing parenthesis.
-        $opener = $tokens[$stackPtr]['scope_opener'];
-        if ($tokens[$opener]['line'] !== $tokens[$closeBracket]['line']) {
-            $error = 'The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line';
-            $fix   = $phpcsFile->addFixableError($error, $opener, 'NewlineBeforeOpenBrace');
-            if ($fix === true) {
-                $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($opener - 1), $closeBracket, true);
-                $phpcsFile->fixer->beginChangeset();
-                $phpcsFile->fixer->addContent($prev, ' {');
-                $phpcsFile->fixer->replaceToken($opener, '');
-                $phpcsFile->fixer->endChangeset();
-            }
-        } else {
-            $prev = $tokens[($opener - 1)];
-            if ($prev['code'] !== T_WHITESPACE) {
-                $length = 0;
-            } else {
-                $length = strlen($prev['content']);
-            }
-
-            if ($length !== 1) {
-                $error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found %s spaces';
-                $fix   = $phpcsFile->addFixableError($error, ($opener - 1), 'SpaceBeforeOpenBrace', array($length));
-                if ($fix === true) {
-                    if ($length === 0) {
-                        $phpcsFile->fixer->addContentBefore($opener, ' ');
-                    } else {
-                        $phpcsFile->fixer->replaceToken(($opener - 1), ' ');
-                    }
-                }
-
-                return;
-            }//end if
-        }//end if
-
-    }//end processMultiLineDeclaration()
+	 /**
+	  * The number of spaces code should be indented.
+	  *
+	  * @var int
+	  */
+	 public $indent = 4;
+
+
+	 /**
+	  * Returns an array of tokens this test wants to listen for.
+	  *
+	  * @return array
+	  */
+	 public function register()
+	 {
+		  return array(
+					 T_FUNCTION,
+					 T_CLOSURE,
+					);
+
+	 }//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();
+
+		  if (isset($tokens[$stackPtr]['parenthesis_opener']) === false
+				|| isset($tokens[$stackPtr]['parenthesis_closer']) === false
+				|| $tokens[$stackPtr]['parenthesis_opener'] === null
+				|| $tokens[$stackPtr]['parenthesis_closer'] === null
+		  ) {
+				return;
+		  }
+
+		  $openBracket  = $tokens[$stackPtr]['parenthesis_opener'];
+		  $closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
+
+		  // Must be one space after the FUNCTION keyword.
+		  if ($tokens[($stackPtr + 1)]['content'] === $phpcsFile->eolChar) {
+				$spaces = 'newline';
+		  } else if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) {
+				$spaces = strlen($tokens[($stackPtr + 1)]['content']);
+		  } else {
+				$spaces = 0;
+		  }
+
+		  if ($spaces !== 1) {
+				$error = 'Expected 1 space after FUNCTION keyword; %s found';
+				$data  = array($spaces);
+				$fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterFunction', $data);
+				if ($fix === true) {
+					 if ($spaces === 0) {
+						  $phpcsFile->fixer->addContent($stackPtr, ' ');
+					 } else {
+						  $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' ');
+					 }
+				}
+		  }
+
+		  // Must be one space before the opening parenthesis. For closures, this is
+		  // enforced by the first check because there is no content between the keywords
+		  // and the opening parenthesis.
+		  if ($tokens[$stackPtr]['code'] === T_FUNCTION) {
+				if ($tokens[($openBracket - 1)]['content'] === $phpcsFile->eolChar) {
+					 $spaces = 'newline';
+				} else if ($tokens[($openBracket - 1)]['code'] === T_WHITESPACE) {
+					 $spaces = strlen($tokens[($openBracket - 1)]['content']);
+				} else {
+					 $spaces = 0;
+				}
+
+				if ($spaces !== 0) {
+					 $error = 'Expected 0 spaces before opening parenthesis; %s found';
+					 $data  = array($spaces);
+					 $fix   = $phpcsFile->addFixableError($error, $openBracket, 'SpaceBeforeOpenParen', $data);
+					 if ($fix === true) {
+						  $phpcsFile->fixer->replaceToken(($openBracket - 1), '');
+					 }
+				}
+		  }//end if
+
+		  // Must be one space before and after USE keyword for closures.
+		  if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
+				$use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']);
+				if ($use !== false) {
+					 if ($tokens[($use + 1)]['code'] !== T_WHITESPACE) {
+						  $length = 0;
+					 } else if ($tokens[($use + 1)]['content'] === "\t") {
+						  $length = '\t';
+					 } else {
+						  $length = strlen($tokens[($use + 1)]['content']);
+					 }
+
+					 if ($length !== 1) {
+						  $error = 'Expected 1 space after USE keyword; found %s';
+						  $data  = array($length);
+						  $fix   = $phpcsFile->addFixableError($error, $use, 'SpaceAfterUse', $data);
+						  if ($fix === true) {
+								if ($length === 0) {
+									 $phpcsFile->fixer->addContent($use, ' ');
+								} else {
+									 $phpcsFile->fixer->replaceToken(($use + 1), ' ');
+								}
+						  }
+					 }
+
+					 if ($tokens[($use - 1)]['code'] !== T_WHITESPACE) {
+						  $length = 0;
+					 } else if ($tokens[($use - 1)]['content'] === "\t") {
+						  $length = '\t';
+					 } else {
+						  $length = strlen($tokens[($use - 1)]['content']);
+					 }
+
+					 if ($length !== 1) {
+						  $error = 'Expected 1 space before USE keyword; found %s';
+						  $data  = array($length);
+						  $fix   = $phpcsFile->addFixableError($error, $use, 'SpaceBeforeUse', $data);
+						  if ($fix === true) {
+								if ($length === 0) {
+									 $phpcsFile->fixer->addContentBefore($use, ' ');
+								} else {
+									 $phpcsFile->fixer->replaceToken(($use - 1), ' ');
+								}
+						  }
+					 }
+				}//end if
+		  }//end if
+
+		  if ($this->isMultiLineDeclaration($phpcsFile, $stackPtr, $openBracket, $tokens) === true) {
+				$this->processMultiLineDeclaration($phpcsFile, $stackPtr, $tokens);
+		  } else {
+				$this->processSingleLineDeclaration($phpcsFile, $stackPtr, $tokens);
+		  }
+
+	 }//end process()
+
+
+	 /**
+	  * Determine if this is a multi-line function declaration.
+	  *
+	  * @param PHP_CodeSniffer_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
+	  *                                          in the stack passed in $tokens.
+	  * @param array                $tokens      The stack of tokens that make up
+	  *                                          the file.
+	  *
+	  * @return void
+	  */
+	 public function isMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
+	 {
+		  $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
+		  if ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']) {
+				return true;
+		  }
+
+		  // Closures may use the USE keyword and so be multi-line in this way.
+		  if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
+				$use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']);
+				if ($use !== false) {
+					 // If the opening and closing parenthesis of the use statement
+					 // are also on the same line, this is a single line declaration.
+					 $open  = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1));
+					 $close = $tokens[$open]['parenthesis_closer'];
+					 if ($tokens[$open]['line'] !== $tokens[$close]['line']) {
+						  return true;
+					 }
+				}
+		  }
+
+		  return false;
+
+	 }//end isMultiLineDeclaration()
+
+
+	 /**
+	  * Processes single-line declarations.
+	  *
+	  * Just uses the Generic BSD-Allman brace sniff.
+	  *
+	  * @param PHP_CodeSniffer_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
+	  *                                        the file.
+	  *
+	  * @return void
+	  */
+	 public function processSingleLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens)
+	 {
+		  if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
+				if (class_exists('Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff', true) === false) {
+					 throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff not found');
+				}
+
+				$sniff = new Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff();
+		  } else {
+				if (class_exists('Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff', true) === false) {
+					 throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff not found');
+				}
+
+				$sniff = new Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff();
+		  }
+
+		  $sniff->checkClosures = true;
+		  $sniff->process($phpcsFile, $stackPtr);
+
+	 }//end processSingleLineDeclaration()
+
+
+	 /**
+	  * Processes multi-line declarations.
+	  *
+	  * @param PHP_CodeSniffer_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
+	  *                                        the file.
+	  *
+	  * @return void
+	  */
+	 public function processMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens)
+	 {
+		  // We need to work out how far indented the function
+		  // declaration itself is, so we can work out how far to
+		  // indent parameters.
+		  $functionIndent = 0;
+		  for ($i = ($stackPtr - 1); $i >= 0; $i--) {
+				if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) {
+					 $i++;
+					 break;
+				}
+		  }
+
+		  if ($tokens[$i]['code'] === T_WHITESPACE) {
+				$functionIndent = strlen($tokens[$i]['content']);
+		  }
+
+		  // The closing parenthesis must be on a new line, even
+		  // when checking abstract function definitions.
+		  $closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
+		  $prev         = $phpcsFile->findPrevious(
+				T_WHITESPACE,
+				($closeBracket - 1),
+				null,
+				true
+		  );
+
+		  if ($tokens[$closeBracket]['line'] !== $tokens[$tokens[$closeBracket]['parenthesis_opener']]['line']) {
+				if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) {
+					 $error = 'The closing parenthesis of a multi-line function declaration must be on a new line';
+					 $fix   = $phpcsFile->addFixableError($error, $closeBracket, 'CloseBracketLine');
+					 if ($fix === true) {
+						  $phpcsFile->fixer->addNewlineBefore($closeBracket);
+					 }
+				}
+		  }
+
+		  // If this is a closure and is using a USE statement, the closing
+		  // parenthesis we need to look at from now on is the closing parenthesis
+		  // of the USE statement.
+		  if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
+				$use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']);
+				if ($use !== false) {
+					 $open         = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1));
+					 $closeBracket = $tokens[$open]['parenthesis_closer'];
+
+					 $prev = $phpcsFile->findPrevious(
+						  T_WHITESPACE,
+						  ($closeBracket - 1),
+						  null,
+						  true
+					 );
+
+					 if ($tokens[$closeBracket]['line'] !== $tokens[$tokens[$closeBracket]['parenthesis_opener']]['line']) {
+						  if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) {
+								$error = 'The closing parenthesis of a multi-line use declaration must be on a new line';
+								$fix   = $phpcsFile->addFixableError($error, $closeBracket, 'UseCloseBracketLine');
+								if ($fix === true) {
+									 $phpcsFile->fixer->addNewlineBefore($closeBracket);
+								}
+						  }
+					 }
+				}//end if
+		  }//end if
+
+		  // Each line between the parenthesis should be indented 4 spaces.
+		  $openBracket = $tokens[$stackPtr]['parenthesis_opener'];
+		  $lastLine    = $tokens[$openBracket]['line'];
+		  for ($i = ($openBracket + 1); $i < $closeBracket; $i++) {
+				if ($tokens[$i]['line'] !== $lastLine) {
+					 if ($i === $tokens[$stackPtr]['parenthesis_closer']
+						  || ($tokens[$i]['code'] === T_WHITESPACE
+						  && (($i + 1) === $closeBracket
+						  || ($i + 1) === $tokens[$stackPtr]['parenthesis_closer']))
+					 ) {
+						  // Closing braces need to be indented to the same level
+						  // as the function.
+						  $expectedIndent = $functionIndent;
+					 } else {
+						  $expectedIndent = ($functionIndent + $this->indent);
+					 }
+
+					 // We changed lines, so this should be a whitespace indent token.
+					 if ($tokens[$i]['code'] !== T_WHITESPACE) {
+						  $foundIndent = 0;
+					 } else {
+						  $foundIndent = strlen($tokens[$i]['content']);
+					 }
+
+					 if ($expectedIndent !== $foundIndent) {
+						  $error = 'Multi-line function declaration not indented correctly; expected %s spaces but found %s';
+						  $data  = array(
+										$expectedIndent,
+										$foundIndent,
+									  );
+
+						  $fix = $phpcsFile->addFixableError($error, $i, 'Indent', $data);
+						  if ($fix === true) {
+								$spaces = str_repeat(' ', $expectedIndent);
+								if ($foundIndent === 0) {
+									 $phpcsFile->fixer->addContentBefore($i, $spaces);
+								} else {
+									 $phpcsFile->fixer->replaceToken($i, $spaces);
+								}
+						  }
+					 }
+
+					 $lastLine = $tokens[$i]['line'];
+				}//end if
+
+				if ($tokens[$i]['code'] === T_ARRAY || $tokens[$i]['code'] === T_OPEN_SHORT_ARRAY) {
+					 // Skip arrays as they have their own indentation rules.
+					 if ($tokens[$i]['code'] === T_OPEN_SHORT_ARRAY) {
+						  $i = $tokens[$i]['bracket_closer'];
+					 } else {
+						  $i = $tokens[$i]['parenthesis_closer'];
+					 }
+
+					 $lastLine = $tokens[$i]['line'];
+					 continue;
+				}
+		  }//end for
+
+		  if (isset($tokens[$stackPtr]['scope_opener']) === false) {
+				return;
+		  }
+
+		  // The opening brace needs to be one space away from the closing parenthesis.
+		  $opener = $tokens[$stackPtr]['scope_opener'];
+		  if ($tokens[$opener]['line'] !== $tokens[$closeBracket]['line']) {
+				$error = 'The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line';
+				$fix   = $phpcsFile->addFixableError($error, $opener, 'NewlineBeforeOpenBrace');
+				if ($fix === true) {
+					 $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($opener - 1), $closeBracket, true);
+					 $phpcsFile->fixer->beginChangeset();
+					 $phpcsFile->fixer->addContent($prev, ' {');
+					 $phpcsFile->fixer->replaceToken($opener, '');
+					 $phpcsFile->fixer->endChangeset();
+				}
+		  } else {
+				$prev = $tokens[($opener - 1)];
+				if ($prev['code'] !== T_WHITESPACE) {
+					 $length = 0;
+				} else {
+					 $length = strlen($prev['content']);
+				}
+
+				if ($length !== 1) {
+					 $error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found %s spaces';
+					 $fix   = $phpcsFile->addFixableError($error, ($opener - 1), 'SpaceBeforeOpenBrace', array($length));
+					 if ($fix === true) {
+						  if ($length === 0) {
+								$phpcsFile->fixer->addContentBefore($opener, ' ');
+						  } else {
+								$phpcsFile->fixer->replaceToken(($opener - 1), ' ');
+						  }
+					 }
+
+					 return;
+				}//end if
+		  }//end if
+
+	 }//end processMultiLineDeclaration()
 
 
 }//end class

Spacing +132 added lines, -132 removed lines

@@ -60,39 +60,39 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $tokens = $phpcsFile->getTokens();
 
-        if (isset($tokens[$stackPtr]['parenthesis_opener']) === false
-            || isset($tokens[$stackPtr]['parenthesis_closer']) === false
-            || $tokens[$stackPtr]['parenthesis_opener'] === null
-            || $tokens[$stackPtr]['parenthesis_closer'] === null
+        if ( isset( $tokens[ $stackPtr ][ 'parenthesis_opener' ] ) === false
+            || isset( $tokens[ $stackPtr ][ 'parenthesis_closer' ] ) === false
+            || $tokens[ $stackPtr ][ 'parenthesis_opener' ] === null
+            || $tokens[ $stackPtr ][ 'parenthesis_closer' ] === null
         ) {
             return;
         }
 
-        $openBracket  = $tokens[$stackPtr]['parenthesis_opener'];
-        $closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
+        $openBracket  = $tokens[ $stackPtr ][ 'parenthesis_opener' ];
+        $closeBracket = $tokens[ $stackPtr ][ 'parenthesis_closer' ];
 
         // Must be one space after the FUNCTION keyword.
-        if ($tokens[($stackPtr + 1)]['content'] === $phpcsFile->eolChar) {
+        if ( $tokens[ ( $stackPtr + 1 ) ][ 'content' ] === $phpcsFile->eolChar ) {
             $spaces = 'newline';
-        } else if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) {
-            $spaces = strlen($tokens[($stackPtr + 1)]['content']);
+        } else if ( $tokens[ ( $stackPtr + 1 ) ][ 'code' ] === T_WHITESPACE ) {
+            $spaces = strlen( $tokens[ ( $stackPtr + 1 ) ][ 'content' ] );
         } else {
             $spaces = 0;
         }
 
-        if ($spaces !== 1) {
+        if ( $spaces !== 1 ) {
             $error = 'Expected 1 space after FUNCTION keyword; %s found';
-            $data  = array($spaces);
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterFunction', $data);
-            if ($fix === true) {
-                if ($spaces === 0) {
-                    $phpcsFile->fixer->addContent($stackPtr, ' ');
+            $data  = array( $spaces );
+            $fix   = $phpcsFile->addFixableError( $error, $stackPtr, 'SpaceAfterFunction', $data );
+            if ( $fix === true ) {
+                if ( $spaces === 0 ) {
+                    $phpcsFile->fixer->addContent( $stackPtr, ' ' );
                 } else {
-                    $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' ');
+                    $phpcsFile->fixer->replaceToken( ( $stackPtr + 1 ), ' ' );
                 }
             }
         }
@@ -100,77 +100,77 @@ 
         // Must be one space before the opening parenthesis. For closures, this is
         // enforced by the first check because there is no content between the keywords
         // and the opening parenthesis.
-        if ($tokens[$stackPtr]['code'] === T_FUNCTION) {
-            if ($tokens[($openBracket - 1)]['content'] === $phpcsFile->eolChar) {
+        if ( $tokens[ $stackPtr ][ 'code' ] === T_FUNCTION ) {
+            if ( $tokens[ ( $openBracket - 1 ) ][ 'content' ] === $phpcsFile->eolChar ) {
                 $spaces = 'newline';
-            } else if ($tokens[($openBracket - 1)]['code'] === T_WHITESPACE) {
-                $spaces = strlen($tokens[($openBracket - 1)]['content']);
+            } else if ( $tokens[ ( $openBracket - 1 ) ][ 'code' ] === T_WHITESPACE ) {
+                $spaces = strlen( $tokens[ ( $openBracket - 1 ) ][ 'content' ] );
             } else {
                 $spaces = 0;
             }
 
-            if ($spaces !== 0) {
+            if ( $spaces !== 0 ) {
                 $error = 'Expected 0 spaces before opening parenthesis; %s found';
-                $data  = array($spaces);
-                $fix   = $phpcsFile->addFixableError($error, $openBracket, 'SpaceBeforeOpenParen', $data);
-                if ($fix === true) {
-                    $phpcsFile->fixer->replaceToken(($openBracket - 1), '');
+                $data  = array( $spaces );
+                $fix   = $phpcsFile->addFixableError( $error, $openBracket, 'SpaceBeforeOpenParen', $data );
+                if ( $fix === true ) {
+                    $phpcsFile->fixer->replaceToken( ( $openBracket - 1 ), '' );
                 }
             }
         }//end if
 
         // Must be one space before and after USE keyword for closures.
-        if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
-            $use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']);
-            if ($use !== false) {
-                if ($tokens[($use + 1)]['code'] !== T_WHITESPACE) {
+        if ( $tokens[ $stackPtr ][ 'code' ] === T_CLOSURE ) {
+            $use = $phpcsFile->findNext( T_USE, ( $closeBracket + 1 ), $tokens[ $stackPtr ][ 'scope_opener' ] );
+            if ( $use !== false ) {
+                if ( $tokens[ ( $use + 1 ) ][ 'code' ] !== T_WHITESPACE ) {
                     $length = 0;
-                } else if ($tokens[($use + 1)]['content'] === "\t") {
+                } else if ( $tokens[ ( $use + 1 ) ][ 'content' ] === "\t" ) {
                     $length = '\t';
                 } else {
-                    $length = strlen($tokens[($use + 1)]['content']);
+                    $length = strlen( $tokens[ ( $use + 1 ) ][ 'content' ] );
                 }
 
-                if ($length !== 1) {
+                if ( $length !== 1 ) {
                     $error = 'Expected 1 space after USE keyword; found %s';
-                    $data  = array($length);
-                    $fix   = $phpcsFile->addFixableError($error, $use, 'SpaceAfterUse', $data);
-                    if ($fix === true) {
-                        if ($length === 0) {
-                            $phpcsFile->fixer->addContent($use, ' ');
+                    $data  = array( $length );
+                    $fix   = $phpcsFile->addFixableError( $error, $use, 'SpaceAfterUse', $data );
+                    if ( $fix === true ) {
+                        if ( $length === 0 ) {
+                            $phpcsFile->fixer->addContent( $use, ' ' );
                         } else {
-                            $phpcsFile->fixer->replaceToken(($use + 1), ' ');
+                            $phpcsFile->fixer->replaceToken( ( $use + 1 ), ' ' );
                         }
                     }
                 }
 
-                if ($tokens[($use - 1)]['code'] !== T_WHITESPACE) {
+                if ( $tokens[ ( $use - 1 ) ][ 'code' ] !== T_WHITESPACE ) {
                     $length = 0;
-                } else if ($tokens[($use - 1)]['content'] === "\t") {
+                } else if ( $tokens[ ( $use - 1 ) ][ 'content' ] === "\t" ) {
                     $length = '\t';
                 } else {
-                    $length = strlen($tokens[($use - 1)]['content']);
+                    $length = strlen( $tokens[ ( $use - 1 ) ][ 'content' ] );
                 }
 
-                if ($length !== 1) {
+                if ( $length !== 1 ) {
                     $error = 'Expected 1 space before USE keyword; found %s';
-                    $data  = array($length);
-                    $fix   = $phpcsFile->addFixableError($error, $use, 'SpaceBeforeUse', $data);
-                    if ($fix === true) {
-                        if ($length === 0) {
-                            $phpcsFile->fixer->addContentBefore($use, ' ');
+                    $data  = array( $length );
+                    $fix   = $phpcsFile->addFixableError( $error, $use, 'SpaceBeforeUse', $data );
+                    if ( $fix === true ) {
+                        if ( $length === 0 ) {
+                            $phpcsFile->fixer->addContentBefore( $use, ' ' );
                         } else {
-                            $phpcsFile->fixer->replaceToken(($use - 1), ' ');
+                            $phpcsFile->fixer->replaceToken( ( $use - 1 ), ' ' );
                         }
                     }
                 }
             }//end if
         }//end if
 
-        if ($this->isMultiLineDeclaration($phpcsFile, $stackPtr, $openBracket, $tokens) === true) {
-            $this->processMultiLineDeclaration($phpcsFile, $stackPtr, $tokens);
+        if ( $this->isMultiLineDeclaration( $phpcsFile, $stackPtr, $openBracket, $tokens ) === true ) {
+            $this->processMultiLineDeclaration( $phpcsFile, $stackPtr, $tokens );
         } else {
-            $this->processSingleLineDeclaration($phpcsFile, $stackPtr, $tokens);
+            $this->processSingleLineDeclaration( $phpcsFile, $stackPtr, $tokens );
         }
 
     }//end process()
@@ -189,22 +189,22 @@ 
      *
      * @return void
      */
-    public function isMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
+    public function isMultiLineDeclaration( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens )
     {
-        $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
-        if ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']) {
+        $closeBracket = $tokens[ $openBracket ][ 'parenthesis_closer' ];
+        if ( $tokens[ $openBracket ][ 'line' ] !== $tokens[ $closeBracket ][ 'line' ] ) {
             return true;
         }
 
         // Closures may use the USE keyword and so be multi-line in this way.
-        if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
-            $use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']);
-            if ($use !== false) {
+        if ( $tokens[ $stackPtr ][ 'code' ] === T_CLOSURE ) {
+            $use = $phpcsFile->findNext( T_USE, ( $closeBracket + 1 ), $tokens[ $stackPtr ][ 'scope_opener' ] );
+            if ( $use !== false ) {
                 // If the opening and closing parenthesis of the use statement
                 // are also on the same line, this is a single line declaration.
-                $open  = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1));
-                $close = $tokens[$open]['parenthesis_closer'];
-                if ($tokens[$open]['line'] !== $tokens[$close]['line']) {
+                $open  = $phpcsFile->findNext( T_OPEN_PARENTHESIS, ( $use + 1 ) );
+                $close = $tokens[ $open ][ 'parenthesis_closer' ];
+                if ( $tokens[ $open ][ 'line' ] !== $tokens[ $close ][ 'line' ] ) {
                     return true;
                 }
             }
@@ -228,24 +228,24 @@ 
      *
      * @return void
      */
-    public function processSingleLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens)
+    public function processSingleLineDeclaration( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens )
     {
-        if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
-            if (class_exists('Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff', true) === false) {
-                throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff not found');
+        if ( $tokens[ $stackPtr ][ 'code' ] === T_CLOSURE ) {
+            if ( class_exists( 'Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff', true ) === false ) {
+                throw new PHP_CodeSniffer_Exception( 'Class Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff not found' );
             }
 
             $sniff = new Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff();
         } else {
-            if (class_exists('Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff', true) === false) {
-                throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff not found');
+            if ( class_exists( 'Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff', true ) === false ) {
+                throw new PHP_CodeSniffer_Exception( 'Class Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff not found' );
             }
 
             $sniff = new Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff();
         }
 
         $sniff->checkClosures = true;
-        $sniff->process($phpcsFile, $stackPtr);
+        $sniff->process( $phpcsFile, $stackPtr );
 
     }//end processSingleLineDeclaration()
 
@@ -261,39 +261,39 @@ 
      *
      * @return void
      */
-    public function processMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens)
+    public function processMultiLineDeclaration( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens )
     {
         // We need to work out how far indented the function
         // declaration itself is, so we can work out how far to
         // indent parameters.
         $functionIndent = 0;
-        for ($i = ($stackPtr - 1); $i >= 0; $i--) {
-            if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) {
+        for ( $i = ( $stackPtr - 1 ); $i >= 0; $i-- ) {
+            if ( $tokens[ $i ][ 'line' ] !== $tokens[ $stackPtr ][ 'line' ] ) {
                 $i++;
                 break;
             }
         }
 
-        if ($tokens[$i]['code'] === T_WHITESPACE) {
-            $functionIndent = strlen($tokens[$i]['content']);
+        if ( $tokens[ $i ][ 'code' ] === T_WHITESPACE ) {
+            $functionIndent = strlen( $tokens[ $i ][ 'content' ] );
         }
 
         // The closing parenthesis must be on a new line, even
         // when checking abstract function definitions.
-        $closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
+        $closeBracket = $tokens[ $stackPtr ][ 'parenthesis_closer' ];
         $prev         = $phpcsFile->findPrevious(
             T_WHITESPACE,
-            ($closeBracket - 1),
+            ( $closeBracket - 1 ),
             null,
             true
         );
 
-        if ($tokens[$closeBracket]['line'] !== $tokens[$tokens[$closeBracket]['parenthesis_opener']]['line']) {
-            if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) {
+        if ( $tokens[ $closeBracket ][ 'line' ] !== $tokens[ $tokens[ $closeBracket ][ 'parenthesis_opener' ] ][ 'line' ] ) {
+            if ( $tokens[ $prev ][ 'line' ] === $tokens[ $closeBracket ][ 'line' ] ) {
                 $error = 'The closing parenthesis of a multi-line function declaration must be on a new line';
-                $fix   = $phpcsFile->addFixableError($error, $closeBracket, 'CloseBracketLine');
-                if ($fix === true) {
-                    $phpcsFile->fixer->addNewlineBefore($closeBracket);
+                $fix   = $phpcsFile->addFixableError( $error, $closeBracket, 'CloseBracketLine' );
+                if ( $fix === true ) {
+                    $phpcsFile->fixer->addNewlineBefore( $closeBracket );
                 }
             }
         }
@@ -301,25 +301,25 @@ 
         // If this is a closure and is using a USE statement, the closing
         // parenthesis we need to look at from now on is the closing parenthesis
         // of the USE statement.
-        if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
-            $use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']);
-            if ($use !== false) {
-                $open         = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1));
-                $closeBracket = $tokens[$open]['parenthesis_closer'];
+        if ( $tokens[ $stackPtr ][ 'code' ] === T_CLOSURE ) {
+            $use = $phpcsFile->findNext( T_USE, ( $closeBracket + 1 ), $tokens[ $stackPtr ][ 'scope_opener' ] );
+            if ( $use !== false ) {
+                $open         = $phpcsFile->findNext( T_OPEN_PARENTHESIS, ( $use + 1 ) );
+                $closeBracket = $tokens[ $open ][ 'parenthesis_closer' ];
 
                 $prev = $phpcsFile->findPrevious(
                     T_WHITESPACE,
-                    ($closeBracket - 1),
+                    ( $closeBracket - 1 ),
                     null,
                     true
                 );
 
-                if ($tokens[$closeBracket]['line'] !== $tokens[$tokens[$closeBracket]['parenthesis_opener']]['line']) {
-                    if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) {
+                if ( $tokens[ $closeBracket ][ 'line' ] !== $tokens[ $tokens[ $closeBracket ][ 'parenthesis_opener' ] ][ 'line' ] ) {
+                    if ( $tokens[ $prev ][ 'line' ] === $tokens[ $closeBracket ][ 'line' ] ) {
                         $error = 'The closing parenthesis of a multi-line use declaration must be on a new line';
-                        $fix   = $phpcsFile->addFixableError($error, $closeBracket, 'UseCloseBracketLine');
-                        if ($fix === true) {
-                            $phpcsFile->fixer->addNewlineBefore($closeBracket);
+                        $fix   = $phpcsFile->addFixableError( $error, $closeBracket, 'UseCloseBracketLine' );
+                        if ( $fix === true ) {
+                            $phpcsFile->fixer->addNewlineBefore( $closeBracket );
                         }
                     }
                 }
@@ -327,95 +327,95 @@ 
         }//end if
 
         // Each line between the parenthesis should be indented 4 spaces.
-        $openBracket = $tokens[$stackPtr]['parenthesis_opener'];
-        $lastLine    = $tokens[$openBracket]['line'];
-        for ($i = ($openBracket + 1); $i < $closeBracket; $i++) {
-            if ($tokens[$i]['line'] !== $lastLine) {
-                if ($i === $tokens[$stackPtr]['parenthesis_closer']
-                    || ($tokens[$i]['code'] === T_WHITESPACE
-                    && (($i + 1) === $closeBracket
-                    || ($i + 1) === $tokens[$stackPtr]['parenthesis_closer']))
+        $openBracket = $tokens[ $stackPtr ][ 'parenthesis_opener' ];
+        $lastLine    = $tokens[ $openBracket ][ 'line' ];
+        for ( $i = ( $openBracket + 1 ); $i < $closeBracket; $i++ ) {
+            if ( $tokens[ $i ][ 'line' ] !== $lastLine ) {
+                if ( $i === $tokens[ $stackPtr ][ 'parenthesis_closer' ]
+                    || ( $tokens[ $i ][ 'code' ] === T_WHITESPACE
+                    && ( ( $i + 1 ) === $closeBracket
+                    || ( $i + 1 ) === $tokens[ $stackPtr ][ 'parenthesis_closer' ] ) )
                 ) {
                     // Closing braces need to be indented to the same level
                     // as the function.
                     $expectedIndent = $functionIndent;
                 } else {
-                    $expectedIndent = ($functionIndent + $this->indent);
+                    $expectedIndent = ( $functionIndent + $this->indent );
                 }
 
                 // We changed lines, so this should be a whitespace indent token.
-                if ($tokens[$i]['code'] !== T_WHITESPACE) {
+                if ( $tokens[ $i ][ 'code' ] !== T_WHITESPACE ) {
                     $foundIndent = 0;
                 } else {
-                    $foundIndent = strlen($tokens[$i]['content']);
+                    $foundIndent = strlen( $tokens[ $i ][ 'content' ] );
                 }
 
-                if ($expectedIndent !== $foundIndent) {
+                if ( $expectedIndent !== $foundIndent ) {
                     $error = 'Multi-line function declaration not indented correctly; expected %s spaces but found %s';
                     $data  = array(
                               $expectedIndent,
                               $foundIndent,
                              );
 
-                    $fix = $phpcsFile->addFixableError($error, $i, 'Indent', $data);
-                    if ($fix === true) {
-                        $spaces = str_repeat(' ', $expectedIndent);
-                        if ($foundIndent === 0) {
-                            $phpcsFile->fixer->addContentBefore($i, $spaces);
+                    $fix = $phpcsFile->addFixableError( $error, $i, 'Indent', $data );
+                    if ( $fix === true ) {
+                        $spaces = str_repeat( ' ', $expectedIndent );
+                        if ( $foundIndent === 0 ) {
+                            $phpcsFile->fixer->addContentBefore( $i, $spaces );
                         } else {
-                            $phpcsFile->fixer->replaceToken($i, $spaces);
+                            $phpcsFile->fixer->replaceToken( $i, $spaces );
                         }
                     }
                 }
 
-                $lastLine = $tokens[$i]['line'];
+                $lastLine = $tokens[ $i ][ 'line' ];
             }//end if
 
-            if ($tokens[$i]['code'] === T_ARRAY || $tokens[$i]['code'] === T_OPEN_SHORT_ARRAY) {
+            if ( $tokens[ $i ][ 'code' ] === T_ARRAY || $tokens[ $i ][ 'code' ] === T_OPEN_SHORT_ARRAY ) {
                 // Skip arrays as they have their own indentation rules.
-                if ($tokens[$i]['code'] === T_OPEN_SHORT_ARRAY) {
-                    $i = $tokens[$i]['bracket_closer'];
+                if ( $tokens[ $i ][ 'code' ] === T_OPEN_SHORT_ARRAY ) {
+                    $i = $tokens[ $i ][ 'bracket_closer' ];
                 } else {
-                    $i = $tokens[$i]['parenthesis_closer'];
+                    $i = $tokens[ $i ][ 'parenthesis_closer' ];
                 }
 
-                $lastLine = $tokens[$i]['line'];
+                $lastLine = $tokens[ $i ][ 'line' ];
                 continue;
             }
         }//end for
 
-        if (isset($tokens[$stackPtr]['scope_opener']) === false) {
+        if ( isset( $tokens[ $stackPtr ][ 'scope_opener' ] ) === false ) {
             return;
         }
 
         // The opening brace needs to be one space away from the closing parenthesis.
-        $opener = $tokens[$stackPtr]['scope_opener'];
-        if ($tokens[$opener]['line'] !== $tokens[$closeBracket]['line']) {
+        $opener = $tokens[ $stackPtr ][ 'scope_opener' ];
+        if ( $tokens[ $opener ][ 'line' ] !== $tokens[ $closeBracket ][ 'line' ] ) {
             $error = 'The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line';
-            $fix   = $phpcsFile->addFixableError($error, $opener, 'NewlineBeforeOpenBrace');
-            if ($fix === true) {
-                $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($opener - 1), $closeBracket, true);
+            $fix   = $phpcsFile->addFixableError( $error, $opener, 'NewlineBeforeOpenBrace' );
+            if ( $fix === true ) {
+                $prev = $phpcsFile->findPrevious( PHP_CodeSniffer_Tokens::$emptyTokens, ( $opener - 1 ), $closeBracket, true );
                 $phpcsFile->fixer->beginChangeset();
-                $phpcsFile->fixer->addContent($prev, ' {');
-                $phpcsFile->fixer->replaceToken($opener, '');
+                $phpcsFile->fixer->addContent( $prev, ' {' );
+                $phpcsFile->fixer->replaceToken( $opener, '' );
                 $phpcsFile->fixer->endChangeset();
             }
         } else {
-            $prev = $tokens[($opener - 1)];
-            if ($prev['code'] !== T_WHITESPACE) {
+            $prev = $tokens[ ( $opener - 1 ) ];
+            if ( $prev[ 'code' ] !== T_WHITESPACE ) {
                 $length = 0;
             } else {
-                $length = strlen($prev['content']);
+                $length = strlen( $prev[ 'content' ] );
             }
 
-            if ($length !== 1) {
+            if ( $length !== 1 ) {
                 $error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found %s spaces';
-                $fix   = $phpcsFile->addFixableError($error, ($opener - 1), 'SpaceBeforeOpenBrace', array($length));
-                if ($fix === true) {
-                    if ($length === 0) {
-                        $phpcsFile->fixer->addContentBefore($opener, ' ');
+                $fix   = $phpcsFile->addFixableError( $error, ( $opener - 1 ), 'SpaceBeforeOpenBrace', array( $length ) );
+                if ( $fix === true ) {
+                    if ( $length === 0 ) {
+                        $phpcsFile->fixer->addContentBefore( $opener, ' ' );
                     } else {
-                        $phpcsFile->fixer->replaceToken(($opener - 1), ' ');
+                        $phpcsFile->fixer->replaceToken( ( $opener - 1 ), ' ' );
                     }
                 }
 

Braces +6 added lines, -12 removed lines

@@ -25,8 +25,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class PEAR_Sniffs_Functions_FunctionDeclarationSniff implements PHP_CodeSniffer_Sniff
-{
+class PEAR_Sniffs_Functions_FunctionDeclarationSniff implements PHP_CodeSniffer_Sniff {
 
     /**
      * The number of spaces code should be indented.
@@ -41,8 +40,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return array(
                 T_FUNCTION,
                 T_CLOSURE,
@@ -60,8 +58,7 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $tokens = $phpcsFile->getTokens();
 
         if (isset($tokens[$stackPtr]['parenthesis_opener']) === false
@@ -189,8 +186,7 @@ 
      *
      * @return void
      */
-    public function isMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
-    {
+    public function isMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens) {
         $closeBracket = $tokens[$openBracket]['parenthesis_closer'];
         if ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']) {
             return true;
@@ -228,8 +224,7 @@ 
      *
      * @return void
      */
-    public function processSingleLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens)
-    {
+    public function processSingleLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens) {
         if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
             if (class_exists('Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff', true) === false) {
                 throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff not found');
@@ -261,8 +256,7 @@ 
      *
      * @return void
      */
-    public function processMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens)
-    {
+    public function processMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens) {
         // We need to work out how far indented the function
         // declaration itself is, so we can work out how far to
         // indent parameters.

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/PEAR/Sniffs/NamingConventions/ValidClassNameSniff.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +66 added lines, -66 removed lines

@@ -32,81 +32,81 @@
 {
 
 
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-                T_CLASS,
-                T_INTERFACE,
-               );
+	 /**
+	  * Returns an array of tokens this test wants to listen for.
+	  *
+	  * @return array
+	  */
+	 public function register()
+	 {
+		  return array(
+					 T_CLASS,
+					 T_INTERFACE,
+					);
 
-    }//end register()
+	 }//end register()
 
 
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param PHP_CodeSniffer_File $phpcsFile The current file being processed.
-     * @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 current file being processed.
+	  * @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();
 
-        $className = $phpcsFile->findNext(T_STRING, $stackPtr);
-        $name      = trim($tokens[$className]['content']);
-        $errorData = array(ucfirst($tokens[$stackPtr]['content']));
+		  $className = $phpcsFile->findNext(T_STRING, $stackPtr);
+		  $name      = trim($tokens[$className]['content']);
+		  $errorData = array(ucfirst($tokens[$stackPtr]['content']));
 
-        // Make sure the first letter is a capital.
-        if (preg_match('|^[A-Z]|', $name) === 0) {
-            $error = '%s name must begin with a capital letter';
-            $phpcsFile->addError($error, $stackPtr, 'StartWithCapital', $errorData);
-        }
+		  // Make sure the first letter is a capital.
+		  if (preg_match('|^[A-Z]|', $name) === 0) {
+				$error = '%s name must begin with a capital letter';
+				$phpcsFile->addError($error, $stackPtr, 'StartWithCapital', $errorData);
+		  }
 
-        // Check that each new word starts with a capital as well, but don't
-        // check the first word, as it is checked above.
-        $validName = true;
-        $nameBits  = explode('_', $name);
-        $firstBit  = array_shift($nameBits);
-        foreach ($nameBits as $bit) {
-            if ($bit === '' || $bit{0} !== strtoupper($bit{0})) {
-                $validName = false;
-                break;
-            }
-        }
+		  // Check that each new word starts with a capital as well, but don't
+		  // check the first word, as it is checked above.
+		  $validName = true;
+		  $nameBits  = explode('_', $name);
+		  $firstBit  = array_shift($nameBits);
+		  foreach ($nameBits as $bit) {
+				if ($bit === '' || $bit{0} !== strtoupper($bit{0})) {
+					 $validName = false;
+					 break;
+				}
+		  }
 
-        if ($validName === false) {
-            // Strip underscores because they cause the suggested name
-            // to be incorrect.
-            $nameBits = explode('_', trim($name, '_'));
-            $firstBit = array_shift($nameBits);
-            if ($firstBit === '') {
-                $error = '%s name is not valid';
-                $phpcsFile->addError($error, $stackPtr, 'Invalid', $errorData);
-            } else {
-                $newName = strtoupper($firstBit{0}).substr($firstBit, 1).'_';
-                foreach ($nameBits as $bit) {
-                    if ($bit !== '') {
-                        $newName .= strtoupper($bit{0}).substr($bit, 1).'_';
-                    }
-                }
+		  if ($validName === false) {
+				// Strip underscores because they cause the suggested name
+				// to be incorrect.
+				$nameBits = explode('_', trim($name, '_'));
+				$firstBit = array_shift($nameBits);
+				if ($firstBit === '') {
+					 $error = '%s name is not valid';
+					 $phpcsFile->addError($error, $stackPtr, 'Invalid', $errorData);
+				} else {
+					 $newName = strtoupper($firstBit{0}).substr($firstBit, 1).'_';
+					 foreach ($nameBits as $bit) {
+						  if ($bit !== '') {
+								$newName .= strtoupper($bit{0}).substr($bit, 1).'_';
+						  }
+					 }
 
-                $newName = rtrim($newName, '_');
-                $error   = '%s name is not valid; consider %s instead';
-                $data    = $errorData;
-                $data[]  = $newName;
-                $phpcsFile->addError($error, $stackPtr, 'Invalid', $data);
-            }
-        }//end if
+					 $newName = rtrim($newName, '_');
+					 $error   = '%s name is not valid; consider %s instead';
+					 $data    = $errorData;
+					 $data[]  = $newName;
+					 $phpcsFile->addError($error, $stackPtr, 'Invalid', $data);
+				}
+		  }//end if
 
-    }//end process()
+	 }//end process()
 
 
 }//end class

Spacing +22 added lines, -22 removed lines

@@ -56,53 +56,53 @@
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $tokens = $phpcsFile->getTokens();
 
-        $className = $phpcsFile->findNext(T_STRING, $stackPtr);
-        $name      = trim($tokens[$className]['content']);
-        $errorData = array(ucfirst($tokens[$stackPtr]['content']));
+        $className = $phpcsFile->findNext( T_STRING, $stackPtr );
+        $name      = trim( $tokens[ $className ][ 'content' ] );
+        $errorData = array( ucfirst( $tokens[ $stackPtr ][ 'content' ] ) );
 
         // Make sure the first letter is a capital.
-        if (preg_match('|^[A-Z]|', $name) === 0) {
+        if ( preg_match( '|^[A-Z]|', $name ) === 0 ) {
             $error = '%s name must begin with a capital letter';
-            $phpcsFile->addError($error, $stackPtr, 'StartWithCapital', $errorData);
+            $phpcsFile->addError( $error, $stackPtr, 'StartWithCapital', $errorData );
         }
 
         // Check that each new word starts with a capital as well, but don't
         // check the first word, as it is checked above.
         $validName = true;
-        $nameBits  = explode('_', $name);
-        $firstBit  = array_shift($nameBits);
-        foreach ($nameBits as $bit) {
-            if ($bit === '' || $bit{0} !== strtoupper($bit{0})) {
+        $nameBits  = explode( '_', $name );
+        $firstBit  = array_shift( $nameBits );
+        foreach ( $nameBits as $bit ) {
+            if ( $bit === '' || $bit{0} !== strtoupper( $bit{0}) ) {
                 $validName = false;
                 break;
             }
         }
 
-        if ($validName === false) {
+        if ( $validName === false ) {
             // Strip underscores because they cause the suggested name
             // to be incorrect.
-            $nameBits = explode('_', trim($name, '_'));
-            $firstBit = array_shift($nameBits);
-            if ($firstBit === '') {
+            $nameBits = explode( '_', trim( $name, '_' ) );
+            $firstBit = array_shift( $nameBits );
+            if ( $firstBit === '' ) {
                 $error = '%s name is not valid';
-                $phpcsFile->addError($error, $stackPtr, 'Invalid', $errorData);
+                $phpcsFile->addError( $error, $stackPtr, 'Invalid', $errorData );
             } else {
-                $newName = strtoupper($firstBit{0}).substr($firstBit, 1).'_';
-                foreach ($nameBits as $bit) {
-                    if ($bit !== '') {
-                        $newName .= strtoupper($bit{0}).substr($bit, 1).'_';
+                $newName = strtoupper( $firstBit{0}) . substr( $firstBit, 1 ) . '_';
+                foreach ( $nameBits as $bit ) {
+                    if ( $bit !== '' ) {
+                        $newName .= strtoupper( $bit{0}) . substr( $bit, 1 ) . '_';
                     }
                 }
 
-                $newName = rtrim($newName, '_');
+                $newName = rtrim( $newName, '_' );
                 $error   = '%s name is not valid; consider %s instead';
                 $data    = $errorData;
-                $data[]  = $newName;
-                $phpcsFile->addError($error, $stackPtr, 'Invalid', $data);
+                $data[ ]  = $newName;
+                $phpcsFile->addError( $error, $stackPtr, 'Invalid', $data );
             }
         }//end if
 

Braces +3 added lines, -6 removed lines

@@ -28,8 +28,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class PEAR_Sniffs_NamingConventions_ValidClassNameSniff implements PHP_CodeSniffer_Sniff
-{
+class PEAR_Sniffs_NamingConventions_ValidClassNameSniff implements PHP_CodeSniffer_Sniff {
 
 
     /**
@@ -37,8 +36,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return array(
                 T_CLASS,
                 T_INTERFACE,
@@ -56,8 +54,7 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $tokens = $phpcsFile->getTokens();
 
         $className = $phpcsFile->findNext(T_STRING, $stackPtr);

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/PSR2/Sniffs/ControlStructures/SwitchDeclarationSniff.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +215 added lines, -215 removed lines

@@ -28,221 +28,221 @@
 class PSR2_Sniffs_ControlStructures_SwitchDeclarationSniff implements PHP_CodeSniffer_Sniff
 {
 
-    /**
-     * The number of spaces code should be indented.
-     *
-     * @var int
-     */
-    public $indent = 4;
-
-
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(T_SWITCH);
-
-    }//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();
-
-        // We can't process SWITCH statements unless we know where they start and end.
-        if (isset($tokens[$stackPtr]['scope_opener']) === false
-            || isset($tokens[$stackPtr]['scope_closer']) === false
-        ) {
-            return;
-        }
-
-        $switch        = $tokens[$stackPtr];
-        $nextCase      = $stackPtr;
-        $caseAlignment = ($switch['column'] + $this->indent);
-        $caseCount     = 0;
-        $foundDefault  = false;
-
-        while (($nextCase = $this->_findNextCase($phpcsFile, ($nextCase + 1), $switch['scope_closer'])) !== false) {
-            if ($tokens[$nextCase]['code'] === T_DEFAULT) {
-                $type         = 'default';
-                $foundDefault = true;
-            } else {
-                $type = 'case';
-                $caseCount++;
-            }
-
-            if ($tokens[$nextCase]['content'] !== strtolower($tokens[$nextCase]['content'])) {
-                $expected = strtolower($tokens[$nextCase]['content']);
-                $error    = strtoupper($type).' keyword must be lowercase; expected "%s" but found "%s"';
-                $data     = array(
-                             $expected,
-                             $tokens[$nextCase]['content'],
-                            );
-
-                $fix = $phpcsFile->addFixableError($error, $nextCase, $type.'NotLower', $data);
-                if ($fix === true) {
-                    $phpcsFile->fixer->replaceToken($nextCase, $expected);
-                }
-            }
-
-            if ($type === 'case'
-                && ($tokens[($nextCase + 1)]['code'] !== T_WHITESPACE
-                || $tokens[($nextCase + 1)]['content'] !== ' ')
-            ) {
-                $error = 'CASE keyword must be followed by a single space';
-                $fix   = $phpcsFile->addFixableError($error, $nextCase, 'SpacingAfterCase');
-                if ($fix === true) {
-                    if ($tokens[($nextCase + 1)]['code'] !== T_WHITESPACE) {
-                        $phpcsFile->fixer->addContent($nextCase, ' ');
-                    } else {
-                        $phpcsFile->fixer->replaceToken(($nextCase + 1), ' ');
-                    }
-                }
-            }
-
-            $opener     = $tokens[$nextCase]['scope_opener'];
-            $nextCloser = $tokens[$nextCase]['scope_closer'];
-            if ($tokens[$opener]['code'] === T_COLON) {
-                if ($tokens[($opener - 1)]['code'] === T_WHITESPACE) {
-                    $error = 'There must be no space before the colon in a '.strtoupper($type).' statement';
-                    $fix   = $phpcsFile->addFixableError($error, $nextCase, 'SpaceBeforeColon'.strtoupper($type));
-                    if ($fix === true) {
-                        $phpcsFile->fixer->replaceToken(($opener - 1), '');
-                    }
-                }
-
-                $next = $phpcsFile->findNext(T_WHITESPACE, ($opener + 1), null, true);
-                if ($tokens[$next]['line'] === $tokens[$opener]['line']
-                    && $tokens[$next]['code'] === T_COMMENT
-                ) {
-                    // Skip comments on the same line.
-                    $next = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true);
-                }
-
-                if ($tokens[$next]['line'] !== ($tokens[$opener]['line'] + 1)) {
-                    $error = 'The '.strtoupper($type).' body must start on the line following the statement';
-                    $fix   = $phpcsFile->addFixableError($error, $nextCase, 'BodyOnNextLine'.strtoupper($type));
-                    if ($fix === true) {
-                        if ($tokens[$next]['line'] === $tokens[$opener]['line']) {
-                            $padding = str_repeat(' ', ($caseAlignment + $this->indent - 1));
-                            $phpcsFile->fixer->addContentBefore($next, $phpcsFile->eolChar.$padding);
-                        } else {
-                            $phpcsFile->fixer->beginChangeset();
-                            for ($i = ($opener + 1); $i < $next; $i++) {
-                                if ($tokens[$i]['line'] === $tokens[$next]['line']) {
-                                    break;
-                                }
-
-                                $phpcsFile->fixer->replaceToken($i, '');
-                            }
-
-                            $phpcsFile->fixer->addNewLineBefore($i);
-                            $phpcsFile->fixer->endChangeset();
-                        }
-                    }
-                }//end if
-
-                if ($tokens[$nextCloser]['scope_condition'] === $nextCase) {
-                    // Only need to check some things once, even if the
-                    // closer is shared between multiple case statements, or even
-                    // the default case.
-                    $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($nextCloser - 1), $nextCase, true);
-                    if ($tokens[$prev]['line'] === $tokens[$nextCloser]['line']) {
-                        $error = 'Terminating statement must be on a line by itself';
-                        $fix   = $phpcsFile->addFixableError($error, $nextCloser, 'BreakNotNewLine');
-                        if ($fix === true) {
-                            $phpcsFile->fixer->addNewLine($prev);
-                            $phpcsFile->fixer->replaceToken($nextCloser, trim($tokens[$nextCloser]['content']));
-                        }
-                    } else {
-                        $diff = ($caseAlignment + $this->indent - $tokens[$nextCloser]['column']);
-                        if ($diff !== 0) {
-                            $error = 'Terminating statement must be indented to the same level as the CASE body';
-                            $fix   = $phpcsFile->addFixableError($error, $nextCloser, 'BreakIndent');
-                            if ($fix === true) {
-                                if ($diff > 0) {
-                                    $phpcsFile->fixer->addContentBefore($nextCloser, str_repeat(' ', $diff));
-                                } else {
-                                    $phpcsFile->fixer->substrToken(($nextCloser - 1), 0, $diff);
-                                }
-                            }
-                        }
-                    }//end if
-                }//end if
-            } else {
-                $error = strtoupper($type).' statements must be defined using a colon';
-                $phpcsFile->addError($error, $nextCase, 'WrongOpener'.$type);
-            }//end if
-
-            // We only want cases from here on in.
-            if ($type !== 'case') {
-                continue;
-            }
-
-            $nextCode = $phpcsFile->findNext(
-                T_WHITESPACE,
-                ($tokens[$nextCase]['scope_opener'] + 1),
-                $nextCloser,
-                true
-            );
-
-            if ($tokens[$nextCode]['code'] !== T_CASE && $tokens[$nextCode]['code'] !== T_DEFAULT) {
-                // This case statement has content. If the next case or default comes
-                // before the closer, it means we dont have a terminating statement
-                // and instead need a comment.
-                $nextCode = $this->_findNextCase($phpcsFile, ($tokens[$nextCase]['scope_opener'] + 1), $nextCloser);
-                if ($nextCode !== false) {
-                    $prevCode = $phpcsFile->findPrevious(T_WHITESPACE, ($nextCode - 1), $nextCase, true);
-                    if ($tokens[$prevCode]['code'] !== T_COMMENT) {
-                        $error = 'There must be a comment when fall-through is intentional in a non-empty case body';
-                        $phpcsFile->addError($error, $nextCase, 'TerminatingComment');
-                    }
-                }
-            }
-        }//end while
-
-    }//end process()
-
-
-    /**
-     * Find the next CASE or DEFAULT statement from a point in the file.
-     *
-     * Note that nested switches are ignored.
-     *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
-     * @param int                  $stackPtr  The position to start looking at.
-     * @param int                  $end       The position to stop looking at.
-     *
-     * @return int | bool
-     */
-    private function _findNextCase(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $end)
-    {
-        $tokens = $phpcsFile->getTokens();
-        while (($stackPtr = $phpcsFile->findNext(array(T_CASE, T_DEFAULT, T_SWITCH), $stackPtr, $end)) !== false) {
-            // Skip nested SWITCH statements; they are handled on their own.
-            if ($tokens[$stackPtr]['code'] === T_SWITCH) {
-                $stackPtr = $tokens[$stackPtr]['scope_closer'];
-                continue;
-            }
-
-            break;
-        }
-
-        return $stackPtr;
-
-    }//end _findNextCase()
+	 /**
+	  * The number of spaces code should be indented.
+	  *
+	  * @var int
+	  */
+	 public $indent = 4;
+
+
+	 /**
+	  * Returns an array of tokens this test wants to listen for.
+	  *
+	  * @return array
+	  */
+	 public function register()
+	 {
+		  return array(T_SWITCH);
+
+	 }//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();
+
+		  // We can't process SWITCH statements unless we know where they start and end.
+		  if (isset($tokens[$stackPtr]['scope_opener']) === false
+				|| isset($tokens[$stackPtr]['scope_closer']) === false
+		  ) {
+				return;
+		  }
+
+		  $switch        = $tokens[$stackPtr];
+		  $nextCase      = $stackPtr;
+		  $caseAlignment = ($switch['column'] + $this->indent);
+		  $caseCount     = 0;
+		  $foundDefault  = false;
+
+		  while (($nextCase = $this->_findNextCase($phpcsFile, ($nextCase + 1), $switch['scope_closer'])) !== false) {
+				if ($tokens[$nextCase]['code'] === T_DEFAULT) {
+					 $type         = 'default';
+					 $foundDefault = true;
+				} else {
+					 $type = 'case';
+					 $caseCount++;
+				}
+
+				if ($tokens[$nextCase]['content'] !== strtolower($tokens[$nextCase]['content'])) {
+					 $expected = strtolower($tokens[$nextCase]['content']);
+					 $error    = strtoupper($type).' keyword must be lowercase; expected "%s" but found "%s"';
+					 $data     = array(
+									  $expected,
+									  $tokens[$nextCase]['content'],
+									 );
+
+					 $fix = $phpcsFile->addFixableError($error, $nextCase, $type.'NotLower', $data);
+					 if ($fix === true) {
+						  $phpcsFile->fixer->replaceToken($nextCase, $expected);
+					 }
+				}
+
+				if ($type === 'case'
+					 && ($tokens[($nextCase + 1)]['code'] !== T_WHITESPACE
+					 || $tokens[($nextCase + 1)]['content'] !== ' ')
+				) {
+					 $error = 'CASE keyword must be followed by a single space';
+					 $fix   = $phpcsFile->addFixableError($error, $nextCase, 'SpacingAfterCase');
+					 if ($fix === true) {
+						  if ($tokens[($nextCase + 1)]['code'] !== T_WHITESPACE) {
+								$phpcsFile->fixer->addContent($nextCase, ' ');
+						  } else {
+								$phpcsFile->fixer->replaceToken(($nextCase + 1), ' ');
+						  }
+					 }
+				}
+
+				$opener     = $tokens[$nextCase]['scope_opener'];
+				$nextCloser = $tokens[$nextCase]['scope_closer'];
+				if ($tokens[$opener]['code'] === T_COLON) {
+					 if ($tokens[($opener - 1)]['code'] === T_WHITESPACE) {
+						  $error = 'There must be no space before the colon in a '.strtoupper($type).' statement';
+						  $fix   = $phpcsFile->addFixableError($error, $nextCase, 'SpaceBeforeColon'.strtoupper($type));
+						  if ($fix === true) {
+								$phpcsFile->fixer->replaceToken(($opener - 1), '');
+						  }
+					 }
+
+					 $next = $phpcsFile->findNext(T_WHITESPACE, ($opener + 1), null, true);
+					 if ($tokens[$next]['line'] === $tokens[$opener]['line']
+						  && $tokens[$next]['code'] === T_COMMENT
+					 ) {
+						  // Skip comments on the same line.
+						  $next = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true);
+					 }
+
+					 if ($tokens[$next]['line'] !== ($tokens[$opener]['line'] + 1)) {
+						  $error = 'The '.strtoupper($type).' body must start on the line following the statement';
+						  $fix   = $phpcsFile->addFixableError($error, $nextCase, 'BodyOnNextLine'.strtoupper($type));
+						  if ($fix === true) {
+								if ($tokens[$next]['line'] === $tokens[$opener]['line']) {
+									 $padding = str_repeat(' ', ($caseAlignment + $this->indent - 1));
+									 $phpcsFile->fixer->addContentBefore($next, $phpcsFile->eolChar.$padding);
+								} else {
+									 $phpcsFile->fixer->beginChangeset();
+									 for ($i = ($opener + 1); $i < $next; $i++) {
+										  if ($tokens[$i]['line'] === $tokens[$next]['line']) {
+												break;
+										  }
+
+										  $phpcsFile->fixer->replaceToken($i, '');
+									 }
+
+									 $phpcsFile->fixer->addNewLineBefore($i);
+									 $phpcsFile->fixer->endChangeset();
+								}
+						  }
+					 }//end if
+
+					 if ($tokens[$nextCloser]['scope_condition'] === $nextCase) {
+						  // Only need to check some things once, even if the
+						  // closer is shared between multiple case statements, or even
+						  // the default case.
+						  $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($nextCloser - 1), $nextCase, true);
+						  if ($tokens[$prev]['line'] === $tokens[$nextCloser]['line']) {
+								$error = 'Terminating statement must be on a line by itself';
+								$fix   = $phpcsFile->addFixableError($error, $nextCloser, 'BreakNotNewLine');
+								if ($fix === true) {
+									 $phpcsFile->fixer->addNewLine($prev);
+									 $phpcsFile->fixer->replaceToken($nextCloser, trim($tokens[$nextCloser]['content']));
+								}
+						  } else {
+								$diff = ($caseAlignment + $this->indent - $tokens[$nextCloser]['column']);
+								if ($diff !== 0) {
+									 $error = 'Terminating statement must be indented to the same level as the CASE body';
+									 $fix   = $phpcsFile->addFixableError($error, $nextCloser, 'BreakIndent');
+									 if ($fix === true) {
+										  if ($diff > 0) {
+												$phpcsFile->fixer->addContentBefore($nextCloser, str_repeat(' ', $diff));
+										  } else {
+												$phpcsFile->fixer->substrToken(($nextCloser - 1), 0, $diff);
+										  }
+									 }
+								}
+						  }//end if
+					 }//end if
+				} else {
+					 $error = strtoupper($type).' statements must be defined using a colon';
+					 $phpcsFile->addError($error, $nextCase, 'WrongOpener'.$type);
+				}//end if
+
+				// We only want cases from here on in.
+				if ($type !== 'case') {
+					 continue;
+				}
+
+				$nextCode = $phpcsFile->findNext(
+					 T_WHITESPACE,
+					 ($tokens[$nextCase]['scope_opener'] + 1),
+					 $nextCloser,
+					 true
+				);
+
+				if ($tokens[$nextCode]['code'] !== T_CASE && $tokens[$nextCode]['code'] !== T_DEFAULT) {
+					 // This case statement has content. If the next case or default comes
+					 // before the closer, it means we dont have a terminating statement
+					 // and instead need a comment.
+					 $nextCode = $this->_findNextCase($phpcsFile, ($tokens[$nextCase]['scope_opener'] + 1), $nextCloser);
+					 if ($nextCode !== false) {
+						  $prevCode = $phpcsFile->findPrevious(T_WHITESPACE, ($nextCode - 1), $nextCase, true);
+						  if ($tokens[$prevCode]['code'] !== T_COMMENT) {
+								$error = 'There must be a comment when fall-through is intentional in a non-empty case body';
+								$phpcsFile->addError($error, $nextCase, 'TerminatingComment');
+						  }
+					 }
+				}
+		  }//end while
+
+	 }//end process()
+
+
+	 /**
+	  * Find the next CASE or DEFAULT statement from a point in the file.
+	  *
+	  * Note that nested switches are ignored.
+	  *
+	  * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+	  * @param int                  $stackPtr  The position to start looking at.
+	  * @param int                  $end       The position to stop looking at.
+	  *
+	  * @return int | bool
+	  */
+	 private function _findNextCase(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $end)
+	 {
+		  $tokens = $phpcsFile->getTokens();
+		  while (($stackPtr = $phpcsFile->findNext(array(T_CASE, T_DEFAULT, T_SWITCH), $stackPtr, $end)) !== false) {
+				// Skip nested SWITCH statements; they are handled on their own.
+				if ($tokens[$stackPtr]['code'] === T_SWITCH) {
+					 $stackPtr = $tokens[$stackPtr]['scope_closer'];
+					 continue;
+				}
+
+				break;
+		  }
+
+		  return $stackPtr;
+
+	 }//end _findNextCase()
 
 
 }//end class

Spacing +74 added lines, -74 removed lines

@@ -43,7 +43,7 @@ 
      */
     public function register()
     {
-        return array(T_SWITCH);
+        return array( T_SWITCH );
 
     }//end register()
 
@@ -57,25 +57,25 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $tokens = $phpcsFile->getTokens();
 
         // We can't process SWITCH statements unless we know where they start and end.
-        if (isset($tokens[$stackPtr]['scope_opener']) === false
-            || isset($tokens[$stackPtr]['scope_closer']) === false
+        if ( isset( $tokens[ $stackPtr ][ 'scope_opener' ] ) === false
+            || isset( $tokens[ $stackPtr ][ 'scope_closer' ] ) === false
         ) {
             return;
         }
 
-        $switch        = $tokens[$stackPtr];
+        $switch        = $tokens[ $stackPtr ];
         $nextCase      = $stackPtr;
-        $caseAlignment = ($switch['column'] + $this->indent);
+        $caseAlignment = ( $switch[ 'column' ] + $this->indent );
         $caseCount     = 0;
         $foundDefault  = false;
 
-        while (($nextCase = $this->_findNextCase($phpcsFile, ($nextCase + 1), $switch['scope_closer'])) !== false) {
-            if ($tokens[$nextCase]['code'] === T_DEFAULT) {
+        while ( ( $nextCase = $this->_findNextCase( $phpcsFile, ( $nextCase + 1 ), $switch[ 'scope_closer' ] ) ) !== false ) {
+            if ( $tokens[ $nextCase ][ 'code' ] === T_DEFAULT ) {
                 $type         = 'default';
                 $foundDefault = true;
             } else {
@@ -83,131 +83,131 @@ 
                 $caseCount++;
             }
 
-            if ($tokens[$nextCase]['content'] !== strtolower($tokens[$nextCase]['content'])) {
-                $expected = strtolower($tokens[$nextCase]['content']);
-                $error    = strtoupper($type).' keyword must be lowercase; expected "%s" but found "%s"';
+            if ( $tokens[ $nextCase ][ 'content' ] !== strtolower( $tokens[ $nextCase ][ 'content' ] ) ) {
+                $expected = strtolower( $tokens[ $nextCase ][ 'content' ] );
+                $error    = strtoupper( $type ) . ' keyword must be lowercase; expected "%s" but found "%s"';
                 $data     = array(
                              $expected,
-                             $tokens[$nextCase]['content'],
+                             $tokens[ $nextCase ][ 'content' ],
                             );
 
-                $fix = $phpcsFile->addFixableError($error, $nextCase, $type.'NotLower', $data);
-                if ($fix === true) {
-                    $phpcsFile->fixer->replaceToken($nextCase, $expected);
+                $fix = $phpcsFile->addFixableError( $error, $nextCase, $type . 'NotLower', $data );
+                if ( $fix === true ) {
+                    $phpcsFile->fixer->replaceToken( $nextCase, $expected );
                 }
             }
 
-            if ($type === 'case'
-                && ($tokens[($nextCase + 1)]['code'] !== T_WHITESPACE
-                || $tokens[($nextCase + 1)]['content'] !== ' ')
+            if ( $type === 'case'
+                && ( $tokens[ ( $nextCase + 1 ) ][ 'code' ] !== T_WHITESPACE
+                || $tokens[ ( $nextCase + 1 ) ][ 'content' ] !== ' ' )
             ) {
                 $error = 'CASE keyword must be followed by a single space';
-                $fix   = $phpcsFile->addFixableError($error, $nextCase, 'SpacingAfterCase');
-                if ($fix === true) {
-                    if ($tokens[($nextCase + 1)]['code'] !== T_WHITESPACE) {
-                        $phpcsFile->fixer->addContent($nextCase, ' ');
+                $fix   = $phpcsFile->addFixableError( $error, $nextCase, 'SpacingAfterCase' );
+                if ( $fix === true ) {
+                    if ( $tokens[ ( $nextCase + 1 ) ][ 'code' ] !== T_WHITESPACE ) {
+                        $phpcsFile->fixer->addContent( $nextCase, ' ' );
                     } else {
-                        $phpcsFile->fixer->replaceToken(($nextCase + 1), ' ');
+                        $phpcsFile->fixer->replaceToken( ( $nextCase + 1 ), ' ' );
                     }
                 }
             }
 
-            $opener     = $tokens[$nextCase]['scope_opener'];
-            $nextCloser = $tokens[$nextCase]['scope_closer'];
-            if ($tokens[$opener]['code'] === T_COLON) {
-                if ($tokens[($opener - 1)]['code'] === T_WHITESPACE) {
-                    $error = 'There must be no space before the colon in a '.strtoupper($type).' statement';
-                    $fix   = $phpcsFile->addFixableError($error, $nextCase, 'SpaceBeforeColon'.strtoupper($type));
-                    if ($fix === true) {
-                        $phpcsFile->fixer->replaceToken(($opener - 1), '');
+            $opener     = $tokens[ $nextCase ][ 'scope_opener' ];
+            $nextCloser = $tokens[ $nextCase ][ 'scope_closer' ];
+            if ( $tokens[ $opener ][ 'code' ] === T_COLON ) {
+                if ( $tokens[ ( $opener - 1 ) ][ 'code' ] === T_WHITESPACE ) {
+                    $error = 'There must be no space before the colon in a ' . strtoupper( $type ) . ' statement';
+                    $fix   = $phpcsFile->addFixableError( $error, $nextCase, 'SpaceBeforeColon' . strtoupper( $type ) );
+                    if ( $fix === true ) {
+                        $phpcsFile->fixer->replaceToken( ( $opener - 1 ), '' );
                     }
                 }
 
-                $next = $phpcsFile->findNext(T_WHITESPACE, ($opener + 1), null, true);
-                if ($tokens[$next]['line'] === $tokens[$opener]['line']
-                    && $tokens[$next]['code'] === T_COMMENT
+                $next = $phpcsFile->findNext( T_WHITESPACE, ( $opener + 1 ), null, true );
+                if ( $tokens[ $next ][ 'line' ] === $tokens[ $opener ][ 'line' ]
+                    && $tokens[ $next ][ 'code' ] === T_COMMENT
                 ) {
                     // Skip comments on the same line.
-                    $next = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true);
+                    $next = $phpcsFile->findNext( T_WHITESPACE, ( $next + 1 ), null, true );
                 }
 
-                if ($tokens[$next]['line'] !== ($tokens[$opener]['line'] + 1)) {
-                    $error = 'The '.strtoupper($type).' body must start on the line following the statement';
-                    $fix   = $phpcsFile->addFixableError($error, $nextCase, 'BodyOnNextLine'.strtoupper($type));
-                    if ($fix === true) {
-                        if ($tokens[$next]['line'] === $tokens[$opener]['line']) {
-                            $padding = str_repeat(' ', ($caseAlignment + $this->indent - 1));
-                            $phpcsFile->fixer->addContentBefore($next, $phpcsFile->eolChar.$padding);
+                if ( $tokens[ $next ][ 'line' ] !== ( $tokens[ $opener ][ 'line' ] + 1 ) ) {
+                    $error = 'The ' . strtoupper( $type ) . ' body must start on the line following the statement';
+                    $fix   = $phpcsFile->addFixableError( $error, $nextCase, 'BodyOnNextLine' . strtoupper( $type ) );
+                    if ( $fix === true ) {
+                        if ( $tokens[ $next ][ 'line' ] === $tokens[ $opener ][ 'line' ] ) {
+                            $padding = str_repeat( ' ', ( $caseAlignment + $this->indent - 1 ) );
+                            $phpcsFile->fixer->addContentBefore( $next, $phpcsFile->eolChar . $padding );
                         } else {
                             $phpcsFile->fixer->beginChangeset();
-                            for ($i = ($opener + 1); $i < $next; $i++) {
-                                if ($tokens[$i]['line'] === $tokens[$next]['line']) {
+                            for ( $i = ( $opener + 1 ); $i < $next; $i++ ) {
+                                if ( $tokens[ $i ][ 'line' ] === $tokens[ $next ][ 'line' ] ) {
                                     break;
                                 }
 
-                                $phpcsFile->fixer->replaceToken($i, '');
+                                $phpcsFile->fixer->replaceToken( $i, '' );
                             }
 
-                            $phpcsFile->fixer->addNewLineBefore($i);
+                            $phpcsFile->fixer->addNewLineBefore( $i );
                             $phpcsFile->fixer->endChangeset();
                         }
                     }
                 }//end if
 
-                if ($tokens[$nextCloser]['scope_condition'] === $nextCase) {
+                if ( $tokens[ $nextCloser ][ 'scope_condition' ] === $nextCase ) {
                     // Only need to check some things once, even if the
                     // closer is shared between multiple case statements, or even
                     // the default case.
-                    $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($nextCloser - 1), $nextCase, true);
-                    if ($tokens[$prev]['line'] === $tokens[$nextCloser]['line']) {
+                    $prev = $phpcsFile->findPrevious( T_WHITESPACE, ( $nextCloser - 1 ), $nextCase, true );
+                    if ( $tokens[ $prev ][ 'line' ] === $tokens[ $nextCloser ][ 'line' ] ) {
                         $error = 'Terminating statement must be on a line by itself';
-                        $fix   = $phpcsFile->addFixableError($error, $nextCloser, 'BreakNotNewLine');
-                        if ($fix === true) {
-                            $phpcsFile->fixer->addNewLine($prev);
-                            $phpcsFile->fixer->replaceToken($nextCloser, trim($tokens[$nextCloser]['content']));
+                        $fix   = $phpcsFile->addFixableError( $error, $nextCloser, 'BreakNotNewLine' );
+                        if ( $fix === true ) {
+                            $phpcsFile->fixer->addNewLine( $prev );
+                            $phpcsFile->fixer->replaceToken( $nextCloser, trim( $tokens[ $nextCloser ][ 'content' ] ) );
                         }
                     } else {
-                        $diff = ($caseAlignment + $this->indent - $tokens[$nextCloser]['column']);
-                        if ($diff !== 0) {
+                        $diff = ( $caseAlignment + $this->indent - $tokens[ $nextCloser ][ 'column' ] );
+                        if ( $diff !== 0 ) {
                             $error = 'Terminating statement must be indented to the same level as the CASE body';
-                            $fix   = $phpcsFile->addFixableError($error, $nextCloser, 'BreakIndent');
-                            if ($fix === true) {
-                                if ($diff > 0) {
-                                    $phpcsFile->fixer->addContentBefore($nextCloser, str_repeat(' ', $diff));
+                            $fix   = $phpcsFile->addFixableError( $error, $nextCloser, 'BreakIndent' );
+                            if ( $fix === true ) {
+                                if ( $diff > 0 ) {
+                                    $phpcsFile->fixer->addContentBefore( $nextCloser, str_repeat( ' ', $diff ) );
                                 } else {
-                                    $phpcsFile->fixer->substrToken(($nextCloser - 1), 0, $diff);
+                                    $phpcsFile->fixer->substrToken( ( $nextCloser - 1 ), 0, $diff );
                                 }
                             }
                         }
                     }//end if
                 }//end if
             } else {
-                $error = strtoupper($type).' statements must be defined using a colon';
-                $phpcsFile->addError($error, $nextCase, 'WrongOpener'.$type);
+                $error = strtoupper( $type ) . ' statements must be defined using a colon';
+                $phpcsFile->addError( $error, $nextCase, 'WrongOpener' . $type );
             }//end if
 
             // We only want cases from here on in.
-            if ($type !== 'case') {
+            if ( $type !== 'case' ) {
                 continue;
             }
 
             $nextCode = $phpcsFile->findNext(
                 T_WHITESPACE,
-                ($tokens[$nextCase]['scope_opener'] + 1),
+                ( $tokens[ $nextCase ][ 'scope_opener' ] + 1 ),
                 $nextCloser,
                 true
             );
 
-            if ($tokens[$nextCode]['code'] !== T_CASE && $tokens[$nextCode]['code'] !== T_DEFAULT) {
+            if ( $tokens[ $nextCode ][ 'code' ] !== T_CASE && $tokens[ $nextCode ][ 'code' ] !== T_DEFAULT ) {
                 // This case statement has content. If the next case or default comes
                 // before the closer, it means we dont have a terminating statement
                 // and instead need a comment.
-                $nextCode = $this->_findNextCase($phpcsFile, ($tokens[$nextCase]['scope_opener'] + 1), $nextCloser);
-                if ($nextCode !== false) {
-                    $prevCode = $phpcsFile->findPrevious(T_WHITESPACE, ($nextCode - 1), $nextCase, true);
-                    if ($tokens[$prevCode]['code'] !== T_COMMENT) {
+                $nextCode = $this->_findNextCase( $phpcsFile, ( $tokens[ $nextCase ][ 'scope_opener' ] + 1 ), $nextCloser );
+                if ( $nextCode !== false ) {
+                    $prevCode = $phpcsFile->findPrevious( T_WHITESPACE, ( $nextCode - 1 ), $nextCase, true );
+                    if ( $tokens[ $prevCode ][ 'code' ] !== T_COMMENT ) {
                         $error = 'There must be a comment when fall-through is intentional in a non-empty case body';
-                        $phpcsFile->addError($error, $nextCase, 'TerminatingComment');
+                        $phpcsFile->addError( $error, $nextCase, 'TerminatingComment' );
                     }
                 }
             }
@@ -227,13 +227,13 @@ 
      *
      * @return int | bool
      */
-    private function _findNextCase(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $end)
+    private function _findNextCase( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $end )
     {
         $tokens = $phpcsFile->getTokens();
-        while (($stackPtr = $phpcsFile->findNext(array(T_CASE, T_DEFAULT, T_SWITCH), $stackPtr, $end)) !== false) {
+        while ( ( $stackPtr = $phpcsFile->findNext( array( T_CASE, T_DEFAULT, T_SWITCH ), $stackPtr, $end ) ) !== false ) {
             // Skip nested SWITCH statements; they are handled on their own.
-            if ($tokens[$stackPtr]['code'] === T_SWITCH) {
-                $stackPtr = $tokens[$stackPtr]['scope_closer'];
+            if ( $tokens[ $stackPtr ][ 'code' ] === T_SWITCH ) {
+                $stackPtr = $tokens[ $stackPtr ][ 'scope_closer' ];
                 continue;
             }
 

Braces +4 added lines, -8 removed lines

@@ -25,8 +25,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class PSR2_Sniffs_ControlStructures_SwitchDeclarationSniff implements PHP_CodeSniffer_Sniff
-{
+class PSR2_Sniffs_ControlStructures_SwitchDeclarationSniff implements PHP_CodeSniffer_Sniff {
 
     /**
      * The number of spaces code should be indented.
@@ -41,8 +40,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return array(T_SWITCH);
 
     }//end register()
@@ -57,8 +55,7 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
-    {
+    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
         $tokens = $phpcsFile->getTokens();
 
         // We can't process SWITCH statements unless we know where they start and end.
@@ -227,8 +224,7 @@ 
      *
      * @return int | bool
      */
-    private function _findNextCase(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $end)
-    {
+    private function _findNextCase(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $end) {
         $tokens = $phpcsFile->getTokens();
         while (($stackPtr = $phpcsFile->findNext(array(T_CASE, T_DEFAULT, T_SWITCH), $stackPtr, $end)) !== false) {
             // Skip nested SWITCH statements; they are handled on their own.

vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/PSR2/Sniffs/Files/ClosingTagSniff.php

Doc Comments +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return integer[]
      */
     public function register()
     {
@@ -48,7 +48,7 @@ 
      * @param int                  $stackPtr  The position of the current token in
      *                                        the stack passed in $tokens.
      *
-     * @return void
+     * @return integer
      */
     public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
     {

Indentation +56 added lines, -56 removed lines

@@ -29,72 +29,72 @@
 {
 
 
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(T_OPEN_TAG);
+	 /**
+	  * Returns an array of tokens this test wants to listen for.
+	  *
+	  * @return array
+	  */
+	 public function register()
+	 {
+		  return array(T_OPEN_TAG);
 
-    }//end register()
+	 }//end register()
 
 
-    /**
-     * Processes this sniff, 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 sniff, 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();
 
-        // Make sure this file only contains PHP code.
-        for ($i = 0; $i < $phpcsFile->numTokens; $i++) {
-            if ($tokens[$i]['code'] === T_INLINE_HTML
-                && trim($tokens[$i]['content']) !== ''
-            ) {
-                return $phpcsFile->numTokens;
-            }
-        }
+		  // Make sure this file only contains PHP code.
+		  for ($i = 0; $i < $phpcsFile->numTokens; $i++) {
+				if ($tokens[$i]['code'] === T_INLINE_HTML
+					 && trim($tokens[$i]['content']) !== ''
+				) {
+					 return $phpcsFile->numTokens;
+				}
+		  }
 
-        // Find the last non-empty token.
-        for ($last = ($phpcsFile->numTokens - 1); $last > 0; $last--) {
-            if (trim($tokens[$last]['content']) !== '') {
-                break;
-            }
-        }
+		  // Find the last non-empty token.
+		  for ($last = ($phpcsFile->numTokens - 1); $last > 0; $last--) {
+				if (trim($tokens[$last]['content']) !== '') {
+					 break;
+				}
+		  }
 
-        if ($tokens[$last]['code'] === T_CLOSE_TAG) {
-            $error = 'A closing tag is not permitted at the end of a PHP file';
-            $fix   = $phpcsFile->addFixableError($error, $last, 'NotAllowed');
-            if ($fix === true) {
-                $phpcsFile->fixer->beginChangeset();
-                $phpcsFile->fixer->replaceToken($last, $phpcsFile->eolChar);
-                $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($last - 1), null, true);
-                if ($tokens[$prev]['code'] !== T_SEMICOLON
-                    && $tokens[$prev]['code'] !== T_CLOSE_CURLY_BRACKET
-                ) {
-                    $phpcsFile->fixer->addContent($prev, ';');
-                }
+		  if ($tokens[$last]['code'] === T_CLOSE_TAG) {
+				$error = 'A closing tag is not permitted at the end of a PHP file';
+				$fix   = $phpcsFile->addFixableError($error, $last, 'NotAllowed');
+				if ($fix === true) {
+					 $phpcsFile->fixer->beginChangeset();
+					 $phpcsFile->fixer->replaceToken($last, $phpcsFile->eolChar);
+					 $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($last - 1), null, true);
+					 if ($tokens[$prev]['code'] !== T_SEMICOLON
+						  && $tokens[$prev]['code'] !== T_CLOSE_CURLY_BRACKET
+					 ) {
+						  $phpcsFile->fixer->addContent($prev, ';');
+					 }
 
-                $phpcsFile->fixer->endChangeset();
-            }
+					 $phpcsFile->fixer->endChangeset();
+				}
 
-            $phpcsFile->recordMetric($stackPtr, 'PHP closing tag at end of PHP-only file', 'yes');
-        } else {
-            $phpcsFile->recordMetric($stackPtr, 'PHP closing tag at end of PHP-only file', 'no');
-        }
+				$phpcsFile->recordMetric($stackPtr, 'PHP closing tag at end of PHP-only file', 'yes');
+		  } else {
+				$phpcsFile->recordMetric($stackPtr, 'PHP closing tag at end of PHP-only file', 'no');
+		  }
 
-        // Ignore the rest of the file.
-        return $phpcsFile->numTokens;
+		  // Ignore the rest of the file.
+		  return $phpcsFile->numTokens;
 
-    }//end process()
+	 }//end process()
 
 
 }//end class

Spacing +17 added lines, -17 removed lines

@@ -36,7 +36,7 @@ 
      */
     public function register()
     {
-        return array(T_OPEN_TAG);
+        return array( T_OPEN_TAG );
 
     }//end register()
 
@@ -50,45 +50,45 @@ 
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr )
     {
         $tokens = $phpcsFile->getTokens();
 
         // Make sure this file only contains PHP code.
-        for ($i = 0; $i < $phpcsFile->numTokens; $i++) {
-            if ($tokens[$i]['code'] === T_INLINE_HTML
-                && trim($tokens[$i]['content']) !== ''
+        for ( $i = 0; $i < $phpcsFile->numTokens; $i++ ) {
+            if ( $tokens[ $i ][ 'code' ] === T_INLINE_HTML
+                && trim( $tokens[ $i ][ 'content' ] ) !== ''
             ) {
                 return $phpcsFile->numTokens;
             }
         }
 
         // Find the last non-empty token.
-        for ($last = ($phpcsFile->numTokens - 1); $last > 0; $last--) {
-            if (trim($tokens[$last]['content']) !== '') {
+        for ( $last = ( $phpcsFile->numTokens - 1 ); $last > 0; $last-- ) {
+            if ( trim( $tokens[ $last ][ 'content' ] ) !== '' ) {
                 break;
             }
         }
 
-        if ($tokens[$last]['code'] === T_CLOSE_TAG) {
+        if ( $tokens[ $last ][ 'code' ] === T_CLOSE_TAG ) {
             $error = 'A closing tag is not permitted at the end of a PHP file';
-            $fix   = $phpcsFile->addFixableError($error, $last, 'NotAllowed');
-            if ($fix === true) {
+            $fix   = $phpcsFile->addFixableError( $error, $last, 'NotAllowed' );
+            if ( $fix === true ) {
                 $phpcsFile->fixer->beginChangeset();
-                $phpcsFile->fixer->replaceToken($last, $phpcsFile->eolChar);
-                $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($last - 1), null, true);
-                if ($tokens[$prev]['code'] !== T_SEMICOLON
-                    && $tokens[$prev]['code'] !== T_CLOSE_CURLY_BRACKET
+                $phpcsFile->fixer->replaceToken( $last, $phpcsFile->eolChar );
+                $prev = $phpcsFile->findPrevious( PHP_CodeSniffer_Tokens::$emptyTokens, ( $last - 1 ), null, true );
+                if ( $tokens[ $prev ][ 'code' ] !== T_SEMICOLON
+                    && $tokens[ $prev ][ 'code' ] !== T_CLOSE_CURLY_BRACKET
                 ) {
-                    $phpcsFile->fixer->addContent($prev, ';');
+                    $phpcsFile->fixer->addContent( $prev, ';' );
                 }
 
                 $phpcsFile->fixer->endChangeset();
             }
 
-            $phpcsFile->recordMetric($stackPtr, 'PHP closing tag at end of PHP-only file', 'yes');
+            $phpcsFile->recordMetric( $stackPtr, 'PHP closing tag at end of PHP-only file', 'yes' );
         } else {
-            $phpcsFile->recordMetric($stackPtr, 'PHP closing tag at end of PHP-only file', 'no');
+            $phpcsFile->recordMetric( $stackPtr, 'PHP closing tag at end of PHP-only file', 'no' );
         }
 
         // Ignore the rest of the file.

Braces +3 added lines, -6 removed lines

@@ -25,8 +25,7 @@ 
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class PSR2_Sniffs_Files_ClosingTagSniff implements PHP_CodeSniffer_Sniff
-{
+class PSR2_Sniffs_Files_ClosingTagSniff implements PHP_CodeSniffer_Sniff {
 
 
     /**
@@ -34,8 +33,7 @@ 
      *
      * @return array
      */
-    public function register()
-    {
+    public function register() {
         return array(T_OPEN_TAG);
 
     }//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();
 
         // Make sure this file only contains PHP code.