timw4mail / HummingBirdAnimeClient

build/CodeIgniter/Sniffs/Commenting/InlineCommentSniff.php

Doc Comments +3 added lines, -3 removed lines

@@ -41,7 +41,7 @@ 
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return integer[]
      */
     public function register()
     {
@@ -118,7 +118,7 @@ 
      * @param File $phpcsFile The current file being scanned.
      * @param int                  $stackPtr  Pointer to the first comment line.
      *
-     * @return type array Pointers to tokens making up the comment block.
+     * @return integer[] array Pointers to tokens making up the comment block.
      */
     private function _getCommentBlock(File $phpcsFile, $stackPtr)
     {
@@ -145,7 +145,7 @@ 
      * Add errors to $phpcsFile, if $commentLines isn't enclosed with blank lines.
      *
      * @param File $phpcsFile    The current file being scanned.
-     * @param array                $commentLines Lines of the comment block being checked.
+     * @param integer[]                $commentLines Lines of the comment block being checked.
      *
      * @return bool TRUE if $commentLines is enclosed with at least a blank line
      * before and after, FALSE otherwise.

Indentation +149 added lines, -149 removed lines

@@ -32,155 +32,155 @@
 
 class InlineCommentSniff implements Sniff
 {
-    /**
-     * @var int Limit defining long comments.
-     * Long comments count $longCommentLimit or more lines.
-     */
-    public $longCommentLimit = 5;
-
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-            T_COMMENT
-        );
-    }//end register()
-
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile The current file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-
-        // keep testing only if it's about the first comment of the block
-        $previousCommentPtr = $phpcsFile->findPrevious($tokens[$stackPtr]['code'], $stackPtr - 1);
-        if ($tokens[$previousCommentPtr]['line'] !== $tokens[$stackPtr]['line'] - 1) {
-            if (TRUE !== $this->_checkCommentStyle($phpcsFile, $stackPtr)) {
-                return;
-            }
-
-            $commentLines = $this->_getCommentBlock($phpcsFile, $stackPtr);
-
-            if (count($commentLines) >= $this->longCommentLimit) {
-                $this->_checkBlankLinesAroundLongComment($phpcsFile, $commentLines);
-            }
-        }
-    }//end process()
-
-
-    /**
-     * Add error to $phpcsFile, if comment pointed by $stackPtr doesn't start
-     * with '//'.
-     *
-     * @param File $phpcsFile The current file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        that has to be a comment.
-     *
-     * @return bool TRUE if the content of the token pointed by $stackPtr starts
-     *              with //, FALSE if an error was added to $phpcsFile.
-     */
-    private function _checkCommentStyle(File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-        if ($tokens[$stackPtr]['content']{0} === '#') {
-            $error  = 'Perl-style comments are not allowed; use "// Comment" or DocBlock comments instead';
-            $phpcsFile->addError($error, $stackPtr, 'WrongStyle');
-            return FALSE;
-        } else if (substr($tokens[$stackPtr]['content'], 0, 2) === '/*'
-            || $tokens[$stackPtr]['content']{0} === '*'
-        ) {
-            $error  = 'Multi lines comments are not allowed; use "// Comment" DocBlock comments instead';
-            $phpcsFile->addError($error, $stackPtr, 'WrongStyle');
-            return FALSE;
-        } else if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//') {
-            $error  = 'Use single line or DocBlock comments within code';
-            $phpcsFile->addError($error, $stackPtr, 'WrongStyle');
-            return FALSE;
-        }
-        return TRUE;
-    }//_checkCommentStyle()
-
-
-    /**
-     * Gather into an array all comment lines to which $stackPtr belongs.
-     *
-     * @param File $phpcsFile The current file being scanned.
-     * @param int                  $stackPtr  Pointer to the first comment line.
-     *
-     * @return type array Pointers to tokens making up the comment block.
-     */
-    private function _getCommentBlock(File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-        $commentLines = array($stackPtr);
-        $nextComment  = $stackPtr;
-        $lastLine     = $tokens[$stackPtr]['line'];
-
-        while (($nextComment = $phpcsFile->findNext($tokens[$stackPtr]['code'], ($nextComment + 1), null, false)) !== false) {
-            if (($tokens[$nextComment]['line'] - 1) !== $lastLine) {
-                // Not part of the block.
-                break;
-            }
-
-            $lastLine       = $tokens[$nextComment]['line'];
-            $commentLines[] = $nextComment;
-        }
-
-        return $commentLines;
-    }//_getCommentBlock()
-
-
-    /**
-     * Add errors to $phpcsFile, if $commentLines isn't enclosed with blank lines.
-     *
-     * @param File $phpcsFile    The current file being scanned.
-     * @param array                $commentLines Lines of the comment block being checked.
-     *
-     * @return bool TRUE if $commentLines is enclosed with at least a blank line
-     * before and after, FALSE otherwise.
-     */
-    private function _checkBlankLinesAroundLongComment(File $phpcsFile, array $commentLines)
-    {
-        $hasBlankLinesAround = TRUE;
-        $tokens = $phpcsFile->getTokens();
-
-        // check blank line before the long comment
-        $firstCommentPtr = reset($commentLines);
-        $firstPreviousSpacePtr = $firstCommentPtr - 1;
-        while (T_WHITESPACE === $tokens[$firstPreviousSpacePtr]['code'] && $firstPreviousSpacePtr > 0) {
-            $firstPreviousSpacePtr--;
-        }
-        if ($tokens[$firstPreviousSpacePtr]['line'] >= $tokens[$firstCommentPtr]['line'] - 1) {
-            $error  = "Please add a blank line before comments counting more than {$this->longCommentLimit} lines.";
-            $phpcsFile->addError($error, $firstCommentPtr, 'LongCommentWithoutSpacing');
-            $hasBlankLinesAround = FALSE;
-        }
-
-        // check blank line after the long comment
-        $lastCommentPtr = end($commentLines);
-        $lastNextSpacePtr = $lastCommentPtr + 1;
-        while (T_WHITESPACE === $tokens[$lastNextSpacePtr]['code'] && $lastNextSpacePtr < count($tokens)) {
-            $lastNextSpacePtr++;
-        }
-        if ($tokens[$lastNextSpacePtr]['line'] <= $tokens[$lastCommentPtr]['line'] + 1) {
-            $error  = "Please add a blank line after comments counting more than {$this->longCommentLimit} lines.";
-            $phpcsFile->addError($error, $lastCommentPtr, 'LongCommentWithoutSpacing');
-            $hasBlankLinesAround = FALSE;
-        }
-
-        return $hasBlankLinesAround;
-    }//end _checkBlanksAroundLongComment()
+	/**
+	 * @var int Limit defining long comments.
+	 * Long comments count $longCommentLimit or more lines.
+	 */
+	public $longCommentLimit = 5;
+
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return array(
+			T_COMMENT
+		);
+	}//end register()
+
+	/**
+	 * Processes this test, when one of its tokens is encountered.
+	 *
+	 * @param File $phpcsFile The current file being scanned.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+		$tokens = $phpcsFile->getTokens();
+
+		// keep testing only if it's about the first comment of the block
+		$previousCommentPtr = $phpcsFile->findPrevious($tokens[$stackPtr]['code'], $stackPtr - 1);
+		if ($tokens[$previousCommentPtr]['line'] !== $tokens[$stackPtr]['line'] - 1) {
+			if (TRUE !== $this->_checkCommentStyle($phpcsFile, $stackPtr)) {
+				return;
+			}
+
+			$commentLines = $this->_getCommentBlock($phpcsFile, $stackPtr);
+
+			if (count($commentLines) >= $this->longCommentLimit) {
+				$this->_checkBlankLinesAroundLongComment($phpcsFile, $commentLines);
+			}
+		}
+	}//end process()
+
+
+	/**
+	 * Add error to $phpcsFile, if comment pointed by $stackPtr doesn't start
+	 * with '//'.
+	 *
+	 * @param File $phpcsFile The current file being scanned.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        that has to be a comment.
+	 *
+	 * @return bool TRUE if the content of the token pointed by $stackPtr starts
+	 *              with //, FALSE if an error was added to $phpcsFile.
+	 */
+	private function _checkCommentStyle(File $phpcsFile, $stackPtr)
+	{
+		$tokens = $phpcsFile->getTokens();
+		if ($tokens[$stackPtr]['content']{0} === '#') {
+			$error  = 'Perl-style comments are not allowed; use "// Comment" or DocBlock comments instead';
+			$phpcsFile->addError($error, $stackPtr, 'WrongStyle');
+			return FALSE;
+		} else if (substr($tokens[$stackPtr]['content'], 0, 2) === '/*'
+			|| $tokens[$stackPtr]['content']{0} === '*'
+		) {
+			$error  = 'Multi lines comments are not allowed; use "// Comment" DocBlock comments instead';
+			$phpcsFile->addError($error, $stackPtr, 'WrongStyle');
+			return FALSE;
+		} else if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//') {
+			$error  = 'Use single line or DocBlock comments within code';
+			$phpcsFile->addError($error, $stackPtr, 'WrongStyle');
+			return FALSE;
+		}
+		return TRUE;
+	}//_checkCommentStyle()
+
+
+	/**
+	 * Gather into an array all comment lines to which $stackPtr belongs.
+	 *
+	 * @param File $phpcsFile The current file being scanned.
+	 * @param int                  $stackPtr  Pointer to the first comment line.
+	 *
+	 * @return type array Pointers to tokens making up the comment block.
+	 */
+	private function _getCommentBlock(File $phpcsFile, $stackPtr)
+	{
+		$tokens = $phpcsFile->getTokens();
+		$commentLines = array($stackPtr);
+		$nextComment  = $stackPtr;
+		$lastLine     = $tokens[$stackPtr]['line'];
+
+		while (($nextComment = $phpcsFile->findNext($tokens[$stackPtr]['code'], ($nextComment + 1), null, false)) !== false) {
+			if (($tokens[$nextComment]['line'] - 1) !== $lastLine) {
+				// Not part of the block.
+				break;
+			}
+
+			$lastLine       = $tokens[$nextComment]['line'];
+			$commentLines[] = $nextComment;
+		}
+
+		return $commentLines;
+	}//_getCommentBlock()
+
+
+	/**
+	 * Add errors to $phpcsFile, if $commentLines isn't enclosed with blank lines.
+	 *
+	 * @param File $phpcsFile    The current file being scanned.
+	 * @param array                $commentLines Lines of the comment block being checked.
+	 *
+	 * @return bool TRUE if $commentLines is enclosed with at least a blank line
+	 * before and after, FALSE otherwise.
+	 */
+	private function _checkBlankLinesAroundLongComment(File $phpcsFile, array $commentLines)
+	{
+		$hasBlankLinesAround = TRUE;
+		$tokens = $phpcsFile->getTokens();
+
+		// check blank line before the long comment
+		$firstCommentPtr = reset($commentLines);
+		$firstPreviousSpacePtr = $firstCommentPtr - 1;
+		while (T_WHITESPACE === $tokens[$firstPreviousSpacePtr]['code'] && $firstPreviousSpacePtr > 0) {
+			$firstPreviousSpacePtr--;
+		}
+		if ($tokens[$firstPreviousSpacePtr]['line'] >= $tokens[$firstCommentPtr]['line'] - 1) {
+			$error  = "Please add a blank line before comments counting more than {$this->longCommentLimit} lines.";
+			$phpcsFile->addError($error, $firstCommentPtr, 'LongCommentWithoutSpacing');
+			$hasBlankLinesAround = FALSE;
+		}
+
+		// check blank line after the long comment
+		$lastCommentPtr = end($commentLines);
+		$lastNextSpacePtr = $lastCommentPtr + 1;
+		while (T_WHITESPACE === $tokens[$lastNextSpacePtr]['code'] && $lastNextSpacePtr < count($tokens)) {
+			$lastNextSpacePtr++;
+		}
+		if ($tokens[$lastNextSpacePtr]['line'] <= $tokens[$lastCommentPtr]['line'] + 1) {
+			$error  = "Please add a blank line after comments counting more than {$this->longCommentLimit} lines.";
+			$phpcsFile->addError($error, $lastCommentPtr, 'LongCommentWithoutSpacing');
+			$hasBlankLinesAround = FALSE;
+		}
+
+		return $hasBlankLinesAround;
+	}//end _checkBlanksAroundLongComment()
 
 }//end class
 

Spacing +5 added lines, -5 removed lines

@@ -94,17 +94,17 @@ 
     {
         $tokens = $phpcsFile->getTokens();
         if ($tokens[$stackPtr]['content']{0} === '#') {
-            $error  = 'Perl-style comments are not allowed; use "// Comment" or DocBlock comments instead';
+            $error = 'Perl-style comments are not allowed; use "// Comment" or DocBlock comments instead';
             $phpcsFile->addError($error, $stackPtr, 'WrongStyle');
             return FALSE;
         } else if (substr($tokens[$stackPtr]['content'], 0, 2) === '/*'
             || $tokens[$stackPtr]['content']{0} === '*'
         ) {
-            $error  = 'Multi lines comments are not allowed; use "// Comment" DocBlock comments instead';
+            $error = 'Multi lines comments are not allowed; use "// Comment" DocBlock comments instead';
             $phpcsFile->addError($error, $stackPtr, 'WrongStyle');
             return FALSE;
         } else if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//') {
-            $error  = 'Use single line or DocBlock comments within code';
+            $error = 'Use single line or DocBlock comments within code';
             $phpcsFile->addError($error, $stackPtr, 'WrongStyle');
             return FALSE;
         }
@@ -162,7 +162,7 @@ 
             $firstPreviousSpacePtr--;
         }
         if ($tokens[$firstPreviousSpacePtr]['line'] >= $tokens[$firstCommentPtr]['line'] - 1) {
-            $error  = "Please add a blank line before comments counting more than {$this->longCommentLimit} lines.";
+            $error = "Please add a blank line before comments counting more than {$this->longCommentLimit} lines.";
             $phpcsFile->addError($error, $firstCommentPtr, 'LongCommentWithoutSpacing');
             $hasBlankLinesAround = FALSE;
         }
@@ -174,7 +174,7 @@ 
             $lastNextSpacePtr++;
         }
         if ($tokens[$lastNextSpacePtr]['line'] <= $tokens[$lastCommentPtr]['line'] + 1) {
-            $error  = "Please add a blank line after comments counting more than {$this->longCommentLimit} lines.";
+            $error = "Please add a blank line after comments counting more than {$this->longCommentLimit} lines.";
             $phpcsFile->addError($error, $lastCommentPtr, 'LongCommentWithoutSpacing');
             $hasBlankLinesAround = FALSE;
         }

Braces +26 added lines, -14 removed lines

@@ -30,8 +30,7 @@ 
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Files\File;
 
-class InlineCommentSniff implements Sniff
-{
+class InlineCommentSniff implements Sniff {
     /**
      * @var int Limit defining long comments.
      * Long comments count $longCommentLimit or more lines.
@@ -65,14 +64,17 @@ 
 
         // keep testing only if it's about the first comment of the block
         $previousCommentPtr = $phpcsFile->findPrevious($tokens[$stackPtr]['code'], $stackPtr - 1);
-        if ($tokens[$previousCommentPtr]['line'] !== $tokens[$stackPtr]['line'] - 1) {
-            if (TRUE !== $this->_checkCommentStyle($phpcsFile, $stackPtr)) {
+        if ($tokens[$previousCommentPtr]['line'] !== $tokens[$stackPtr]['line'] - 1)
+        {
+            if (TRUE !== $this->_checkCommentStyle($phpcsFile, $stackPtr))
+            {
                 return;
             }
 
             $commentLines = $this->_getCommentBlock($phpcsFile, $stackPtr);
 
-            if (count($commentLines) >= $this->longCommentLimit) {
+            if (count($commentLines) >= $this->longCommentLimit)
+            {
                 $this->_checkBlankLinesAroundLongComment($phpcsFile, $commentLines);
             }
         }
@@ -93,17 +95,21 @@ 
     private function _checkCommentStyle(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
-        if ($tokens[$stackPtr]['content']{0} === '#') {
+        if ($tokens[$stackPtr]['content']{0} === '#')
+        {
             $error  = 'Perl-style comments are not allowed; use "// Comment" or DocBlock comments instead';
             $phpcsFile->addError($error, $stackPtr, 'WrongStyle');
             return FALSE;
-        } else if (substr($tokens[$stackPtr]['content'], 0, 2) === '/*'
+        }
+        else if (substr($tokens[$stackPtr]['content'], 0, 2) === '/*'
             || $tokens[$stackPtr]['content']{0} === '*'
         ) {
             $error  = 'Multi lines comments are not allowed; use "// Comment" DocBlock comments instead';
             $phpcsFile->addError($error, $stackPtr, 'WrongStyle');
             return FALSE;
-        } else if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//') {
+        }
+        else if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//')
+        {
             $error  = 'Use single line or DocBlock comments within code';
             $phpcsFile->addError($error, $stackPtr, 'WrongStyle');
             return FALSE;
@@ -127,8 +133,10 @@ 
         $nextComment  = $stackPtr;
         $lastLine     = $tokens[$stackPtr]['line'];
 
-        while (($nextComment = $phpcsFile->findNext($tokens[$stackPtr]['code'], ($nextComment + 1), null, false)) !== false) {
-            if (($tokens[$nextComment]['line'] - 1) !== $lastLine) {
+        while (($nextComment = $phpcsFile->findNext($tokens[$stackPtr]['code'], ($nextComment + 1), null, false)) !== false)
+        {
+            if (($tokens[$nextComment]['line'] - 1) !== $lastLine)
+            {
                 // Not part of the block.
                 break;
             }
@@ -158,10 +166,12 @@ 
         // check blank line before the long comment
         $firstCommentPtr = reset($commentLines);
         $firstPreviousSpacePtr = $firstCommentPtr - 1;
-        while (T_WHITESPACE === $tokens[$firstPreviousSpacePtr]['code'] && $firstPreviousSpacePtr > 0) {
+        while (T_WHITESPACE === $tokens[$firstPreviousSpacePtr]['code'] && $firstPreviousSpacePtr > 0)
+        {
             $firstPreviousSpacePtr--;
         }
-        if ($tokens[$firstPreviousSpacePtr]['line'] >= $tokens[$firstCommentPtr]['line'] - 1) {
+        if ($tokens[$firstPreviousSpacePtr]['line'] >= $tokens[$firstCommentPtr]['line'] - 1)
+        {
             $error  = "Please add a blank line before comments counting more than {$this->longCommentLimit} lines.";
             $phpcsFile->addError($error, $firstCommentPtr, 'LongCommentWithoutSpacing');
             $hasBlankLinesAround = FALSE;
@@ -170,10 +180,12 @@ 
         // check blank line after the long comment
         $lastCommentPtr = end($commentLines);
         $lastNextSpacePtr = $lastCommentPtr + 1;
-        while (T_WHITESPACE === $tokens[$lastNextSpacePtr]['code'] && $lastNextSpacePtr < count($tokens)) {
+        while (T_WHITESPACE === $tokens[$lastNextSpacePtr]['code'] && $lastNextSpacePtr < count($tokens))
+        {
             $lastNextSpacePtr++;
         }
-        if ($tokens[$lastNextSpacePtr]['line'] <= $tokens[$lastCommentPtr]['line'] + 1) {
+        if ($tokens[$lastNextSpacePtr]['line'] <= $tokens[$lastCommentPtr]['line'] + 1)
+        {
             $error  = "Please add a blank line after comments counting more than {$this->longCommentLimit} lines.";
             $phpcsFile->addError($error, $lastCommentPtr, 'LongCommentWithoutSpacing');
             $hasBlankLinesAround = FALSE;

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -127,7 +127,7 @@
         $nextComment  = $stackPtr;
         $lastLine     = $tokens[$stackPtr]['line'];
 
-        while (($nextComment = $phpcsFile->findNext($tokens[$stackPtr]['code'], ($nextComment + 1), null, false)) !== false) {
+        while (($nextComment = $phpcsFile->findNext($tokens[$stackPtr]['code'], ($nextComment + 1), NULL, FALSE)) !== FALSE) {
             if (($tokens[$nextComment]['line'] - 1) !== $lastLine) {
                 // Not part of the block.
                 break;

build/CodeIgniter/Sniffs/Files/ByteOrderMarkSniff.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 +60 added lines, -60 removed lines

@@ -32,67 +32,67 @@
 
 class ByteOrderMarkSniff implements Sniff
 {
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array( T_OPEN_TAG );
-    }//end register()
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return array( T_OPEN_TAG );
+	}//end register()
 
-    /**
-     * List of supported BOM definitions.
-     *
-     * Use encoding names as keys and hex BOM representations as values.
-     *
-     * @return array
-     */
-    protected function getBomDefinitions()
-    {
-        return array(
-            'UTF-8'       => 'efbbbf',
-            'UTF-16 (BE)' => 'feff',
-            'UTF-16 (LE)' => 'fffe',
-            'UTF-32 (BE)' => '0000feff',
-            'UTF-32 (LE)' => 'fffe0000'
-        );
-    }//end getBomDefinitions()
+	/**
+	 * List of supported BOM definitions.
+	 *
+	 * Use encoding names as keys and hex BOM representations as values.
+	 *
+	 * @return array
+	 */
+	protected function getBomDefinitions()
+	{
+		return array(
+			'UTF-8'       => 'efbbbf',
+			'UTF-16 (BE)' => 'feff',
+			'UTF-16 (LE)' => 'fffe',
+			'UTF-32 (BE)' => '0000feff',
+			'UTF-32 (LE)' => 'fffe0000'
+		);
+	}//end getBomDefinitions()
 
-    /**
-     * Process tokens.
-     *
-     * Actually, only proceed when we're at index 0, this should be the only case
-     * that will contain BOM. Then check if BOM definition matches what
-     * we've found as file's inline HTML. Inline HTML could be longer than just BOM
-     * so make sure you test as much as needed.
-     *
-     * @param File $phpcsFile The current file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr )
-    {
-        // We are only interested if this is the first open tag.
-        if ($stackPtr !== 0) {
-            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
-                return;
-            }
-        }
+	/**
+	 * Process tokens.
+	 *
+	 * Actually, only proceed when we're at index 0, this should be the only case
+	 * that will contain BOM. Then check if BOM definition matches what
+	 * we've found as file's inline HTML. Inline HTML could be longer than just BOM
+	 * so make sure you test as much as needed.
+	 *
+	 * @param File $phpcsFile The current file being scanned.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(File $phpcsFile, $stackPtr )
+	{
+		// We are only interested if this is the first open tag.
+		if ($stackPtr !== 0) {
+			if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
+				return;
+			}
+		}
 
-        $tokens = $phpcsFile->getTokens();
-        $fileStartString = $tokens[0]['content'];
-        foreach ($this->getBomDefinitions() as $bomName => $expectedBomHex) {
-            $bomByteLength = strlen($expectedBomHex) / 2;
-            $fileStartHex = bin2hex(substr($fileStartString, 0, $bomByteLength));
-            if ($fileStartHex === $expectedBomHex) {
-                $error = "File contains a $bomName byte order mark (BOM).";
-                $phpcsFile->addError($error, $stackPtr);
-                break;
-            }
-        }
-    }//end process()
+		$tokens = $phpcsFile->getTokens();
+		$fileStartString = $tokens[0]['content'];
+		foreach ($this->getBomDefinitions() as $bomName => $expectedBomHex) {
+			$bomByteLength = strlen($expectedBomHex) / 2;
+			$fileStartHex = bin2hex(substr($fileStartString, 0, $bomByteLength));
+			if ($fileStartHex === $expectedBomHex) {
+				$error = "File contains a $bomName byte order mark (BOM).";
+				$phpcsFile->addError($error, $stackPtr);
+				break;
+			}
+		}
+	}//end process()
 }

Spacing +2 added lines, -2 removed lines

@@ -39,7 +39,7 @@ 
      */
     public function register()
     {
-        return array( T_OPEN_TAG );
+        return array(T_OPEN_TAG);
     }//end register()
 
     /**
@@ -74,7 +74,7 @@ 
      *
      * @return void
      */
-    public function process(File $phpcsFile, $stackPtr )
+    public function process(File $phpcsFile, $stackPtr)
     {
         // We are only interested if this is the first open tag.
         if ($stackPtr !== 0) {

Braces +9 added lines, -6 removed lines

@@ -30,8 +30,7 @@ 
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Files\File;
 
-class ByteOrderMarkSniff implements Sniff
-{
+class ByteOrderMarkSniff implements Sniff {
     /**
      * Returns an array of tokens this test wants to listen for.
      *
@@ -77,18 +76,22 @@ 
     public function process(File $phpcsFile, $stackPtr )
     {
         // We are only interested if this is the first open tag.
-        if ($stackPtr !== 0) {
-            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
+        if ($stackPtr !== 0)
+        {
+            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false)
+            {
                 return;
             }
         }
 
         $tokens = $phpcsFile->getTokens();
         $fileStartString = $tokens[0]['content'];
-        foreach ($this->getBomDefinitions() as $bomName => $expectedBomHex) {
+        foreach ($this->getBomDefinitions() as $bomName => $expectedBomHex)
+        {
             $bomByteLength = strlen($expectedBomHex) / 2;
             $fileStartHex = bin2hex(substr($fileStartString, 0, $bomByteLength));
-            if ($fileStartHex === $expectedBomHex) {
+            if ($fileStartHex === $expectedBomHex)
+            {
                 $error = "File contains a $bomName byte order mark (BOM).";
                 $phpcsFile->addError($error, $stackPtr);
                 break;

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -78,7 +78,7 @@
     {
         // We are only interested if this is the first open tag.
         if ($stackPtr !== 0) {
-            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
+            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== FALSE) {
                 return;
             }
         }

build/CodeIgniter/Sniffs/Files/Utf8EncodingSniff.php

Doc Comments +2 added lines, -1 removed lines

@@ -36,7 +36,7 @@ 
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return integer[]
      */
     public function register()
     {
@@ -174,6 +174,7 @@ 
      *
      * @param string $str String to split.
 	 * @param int $len number of characters per chunk
+	 * @param string $glue
      *
      * @return array string array after splitting
      *

Indentation +132 added lines, -132 removed lines

@@ -33,74 +33,74 @@ 
 class Utf8EncodingSniff implements Sniff
 {
 
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-            T_OPEN_TAG
-        );
-
-    }//end register()
-
-
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile The current file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        // We are only interested if this is the first open tag.
-        if ($stackPtr !== 0) {
-            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
-                return;
-            }
-        }
-
-        $file_path = $phpcsFile->getFilename();
-        $file_name = basename($file_path);
-        $file_content = file_get_contents($file_path);
-        if (false === mb_check_encoding($file_content, 'UTF-8')) {
-            $error = 'File "' . $file_name . '" should be saved with Unicode (UTF-8) encoding.';
-            $phpcsFile->addError($error, 0);
-        }
-        if ( ! self::_checkUtf8W3c($file_content)) {
-            $error = 'File "' . $file_name . '" should be saved with Unicode (UTF-8) encoding, but it did not successfully pass the W3C test.';
-            $phpcsFile->addError($error, 0);
-        }
-        if ( ! self::_checkUtf8Rfc3629($file_content)) {
-            $error = 'File "' . $file_name . '" should be saved with Unicode (UTF-8) encoding, but it did not meet RFC3629 requirements.';
-            $phpcsFile->addError($error, 0);
-        }
-    }//end process()
-
-
-    /**
-     * Checks that the string $content contains only valid UTF-8 chars
-     * using W3C's method.
-     * Returns true if $content contains only UTF-8 chars, false otherwise.
-     *
-     * @param string $content String to check.
-     *
-     * @return bool true if $content contains only UTF-8 chars, false otherwise.
-     *
-     * @see http://w3.org/International/questions/qa-forms-utf-8.html
-     */
-    private static function _checkUtf8W3c($content)
-    {
-        $content_chunks=self::mb_chunk_split($content, 4096, '');
-    	foreach($content_chunks as $content_chunk)
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return array(
+			T_OPEN_TAG
+		);
+
+	}//end register()
+
+
+	/**
+	 * Processes this test, when one of its tokens is encountered.
+	 *
+	 * @param File $phpcsFile The current file being scanned.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+		// We are only interested if this is the first open tag.
+		if ($stackPtr !== 0) {
+			if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
+				return;
+			}
+		}
+
+		$file_path = $phpcsFile->getFilename();
+		$file_name = basename($file_path);
+		$file_content = file_get_contents($file_path);
+		if (false === mb_check_encoding($file_content, 'UTF-8')) {
+			$error = 'File "' . $file_name . '" should be saved with Unicode (UTF-8) encoding.';
+			$phpcsFile->addError($error, 0);
+		}
+		if ( ! self::_checkUtf8W3c($file_content)) {
+			$error = 'File "' . $file_name . '" should be saved with Unicode (UTF-8) encoding, but it did not successfully pass the W3C test.';
+			$phpcsFile->addError($error, 0);
+		}
+		if ( ! self::_checkUtf8Rfc3629($file_content)) {
+			$error = 'File "' . $file_name . '" should be saved with Unicode (UTF-8) encoding, but it did not meet RFC3629 requirements.';
+			$phpcsFile->addError($error, 0);
+		}
+	}//end process()
+
+
+	/**
+	 * Checks that the string $content contains only valid UTF-8 chars
+	 * using W3C's method.
+	 * Returns true if $content contains only UTF-8 chars, false otherwise.
+	 *
+	 * @param string $content String to check.
+	 *
+	 * @return bool true if $content contains only UTF-8 chars, false otherwise.
+	 *
+	 * @see http://w3.org/International/questions/qa-forms-utf-8.html
+	 */
+	private static function _checkUtf8W3c($content)
+	{
+		$content_chunks=self::mb_chunk_split($content, 4096, '');
+		foreach($content_chunks as $content_chunk)
 		{
 			$preg_result= preg_match(
-            '%^(?:
+			'%^(?:
                   [\x09\x0A\x0D\x20-\x7E]            # ASCII
                 | [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
                 |  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
@@ -110,7 +110,7 @@ 
                 | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
                 |  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
             )*$%xs',
-            $content_chunk
+			$content_chunk
 			);
 			if($preg_result!==1)
 			{
@@ -119,66 +119,66 @@ 
 
 		}
 		return true;
-    }//end _checkUtf8W3c()
-
-    /**
-     * Checks that the string $content contains only valid UTF-8 chars
-     * using the method described in RFC 3629.
-     * Returns true if $content contains only UTF-8 chars, false otherwise.
-     *
-     * @param string $content String to check.
-     *
-     * @return bool true if $content contains only UTF-8 chars, false otherwise.
-     *
-     * @see http://www.php.net/manual/en/function.mb-detect-encoding.php#85294
-     */
-    private static function _checkUtf8Rfc3629($content)
-    {
-        $len = strlen($content);
-        for ($i = 0; $i < $len; $i++) {
-            $c = ord($content[$i]);
-            if ($c > 128) {
-                if (($c >= 254)) {
-                    return false;
-                } elseif ($c >= 252) {
-                    $bits=6;
-                } elseif ($c >= 248) {
-                    $bits=5;
-                } elseif ($c >= 240) {
-                    $bytes = 4;
-                } elseif ($c >= 224) {
-                    $bytes = 3;
-                } elseif ($c >= 192) {
-                    $bytes = 2;
-                } else {
-                    return false;
-                } if (($i + $bytes) > $len) {
-                    return false;
-                } while ($bytes > 1) {
-                    $i++;
-                    $b = ord($content[$i]);
-                    if ($b < 128 || $b > 191) {
-                        return false;
-                    }
-                    $bytes--;
-                }
-            }
-        }
-        return true;
-    }//_checkUtf8Rfc3629()
+	}//end _checkUtf8W3c()
+
+	/**
+	 * Checks that the string $content contains only valid UTF-8 chars
+	 * using the method described in RFC 3629.
+	 * Returns true if $content contains only UTF-8 chars, false otherwise.
+	 *
+	 * @param string $content String to check.
+	 *
+	 * @return bool true if $content contains only UTF-8 chars, false otherwise.
+	 *
+	 * @see http://www.php.net/manual/en/function.mb-detect-encoding.php#85294
+	 */
+	private static function _checkUtf8Rfc3629($content)
+	{
+		$len = strlen($content);
+		for ($i = 0; $i < $len; $i++) {
+			$c = ord($content[$i]);
+			if ($c > 128) {
+				if (($c >= 254)) {
+					return false;
+				} elseif ($c >= 252) {
+					$bits=6;
+				} elseif ($c >= 248) {
+					$bits=5;
+				} elseif ($c >= 240) {
+					$bytes = 4;
+				} elseif ($c >= 224) {
+					$bytes = 3;
+				} elseif ($c >= 192) {
+					$bytes = 2;
+				} else {
+					return false;
+				} if (($i + $bytes) > $len) {
+					return false;
+				} while ($bytes > 1) {
+					$i++;
+					$b = ord($content[$i]);
+					if ($b < 128 || $b > 191) {
+						return false;
+					}
+					$bytes--;
+				}
+			}
+		}
+		return true;
+	}//_checkUtf8Rfc3629()
 
 	 /**
-     * Splits a string to chunks of given size
-	 * This helps to avoid segmentation fault errors when large text is given
-     * Returns array of strings after splitting
-     *
-     * @param string $str String to split.
-	 * @param int $len number of characters per chunk
-     *
-     * @return array string array after splitting
-     *
-     * @see http://php.net/manual/en/function.chunk-split.php
-     */
+	  * Splits a string to chunks of given size
+	  * This helps to avoid segmentation fault errors when large text is given
+	  * Returns array of strings after splitting
+	  *
+	  * @param string $str String to split.
+	  * @param int $len number of characters per chunk
+	  *
+	  * @return array string array after splitting
+	  *
+	  * @see http://php.net/manual/en/function.chunk-split.php
+	  */
 	private static function mb_chunk_split($str, $len, $glue)
 	{
 		if (empty($str)) return false;
@@ -196,14 +196,14 @@ 
 		return $new;
 	}//mb_chunk_split
 	/**
-     * Supporting function for mb_chunk_split
-     *
-     * @param string $str
+	 * Supporting function for mb_chunk_split
+	 *
+	 * @param string $str
+	 *
+	 * @return array
 	 *
-     * @return array
-     *
-     * @see http://php.net/manual/en/function.chunk-split.php
-     */
+	 * @see http://php.net/manual/en/function.chunk-split.php
+	 */
 	private static function mbStringToArray ($str)
 	{
 		if (empty($str)) return false;

Spacing +10 added lines, -10 removed lines

@@ -96,10 +96,10 @@ 
      */
     private static function _checkUtf8W3c($content)
     {
-        $content_chunks=self::mb_chunk_split($content, 4096, '');
-    	foreach($content_chunks as $content_chunk)
+        $content_chunks = self::mb_chunk_split($content, 4096, '');
+    	foreach ($content_chunks as $content_chunk)
 		{
-			$preg_result= preg_match(
+			$preg_result = preg_match(
             '%^(?:
                   [\x09\x0A\x0D\x20-\x7E]            # ASCII
                 | [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
@@ -112,7 +112,7 @@ 
             )*$%xs',
             $content_chunk
 			);
-			if($preg_result!==1)
+			if ($preg_result !== 1)
 			{
 				return false;
 			}
@@ -141,9 +141,9 @@ 
                 if (($c >= 254)) {
                     return false;
                 } elseif ($c >= 252) {
-                    $bits=6;
+                    $bits = 6;
                 } elseif ($c >= 248) {
-                    $bits=5;
+                    $bits = 5;
                 } elseif ($c >= 240) {
                     $bytes = 4;
                 } elseif ($c >= 224) {
@@ -182,14 +182,14 @@ 
 	private static function mb_chunk_split($str, $len, $glue)
 	{
 		if (empty($str)) return false;
-		$array = self::mbStringToArray ($str);
+		$array = self::mbStringToArray($str);
 		$n = -1;
 		$new = Array();
 		foreach ($array as $char) {
 			$n++;
-			if ($n < $len) $new []= $char;
+			if ($n < $len) $new [] = $char;
 			elseif ($n == $len) {
-				$new []= $glue . $char;
+				$new [] = $glue . $char;
 				$n = 0;
 			}
 		}
@@ -204,7 +204,7 @@ 
      *
      * @see http://php.net/manual/en/function.chunk-split.php
      */
-	private static function mbStringToArray ($str)
+	private static function mbStringToArray($str)
 	{
 		if (empty($str)) return false;
 		$len = mb_strlen($str);

Braces +48 added lines, -23 removed lines

@@ -30,8 +30,7 @@ 
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Files\File;
 
-class Utf8EncodingSniff implements Sniff
-{
+class Utf8EncodingSniff implements Sniff {
 
     /**
      * Returns an array of tokens this test wants to listen for.
@@ -59,8 +58,10 @@ 
     public function process(File $phpcsFile, $stackPtr)
     {
         // We are only interested if this is the first open tag.
-        if ($stackPtr !== 0) {
-            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
+        if ($stackPtr !== 0)
+        {
+            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false)
+            {
                 return;
             }
         }
@@ -68,15 +69,18 @@ 
         $file_path = $phpcsFile->getFilename();
         $file_name = basename($file_path);
         $file_content = file_get_contents($file_path);
-        if (false === mb_check_encoding($file_content, 'UTF-8')) {
+        if (false === mb_check_encoding($file_content, 'UTF-8'))
+        {
             $error = 'File "' . $file_name . '" should be saved with Unicode (UTF-8) encoding.';
             $phpcsFile->addError($error, 0);
         }
-        if ( ! self::_checkUtf8W3c($file_content)) {
+        if ( ! self::_checkUtf8W3c($file_content))
+        {
             $error = 'File "' . $file_name . '" should be saved with Unicode (UTF-8) encoding, but it did not successfully pass the W3C test.';
             $phpcsFile->addError($error, 0);
         }
-        if ( ! self::_checkUtf8Rfc3629($file_content)) {
+        if ( ! self::_checkUtf8Rfc3629($file_content))
+        {
             $error = 'File "' . $file_name . '" should be saved with Unicode (UTF-8) encoding, but it did not meet RFC3629 requirements.';
             $phpcsFile->addError($error, 0);
         }
@@ -98,7 +102,7 @@ 
     {
         $content_chunks=self::mb_chunk_split($content, 4096, '');
     	foreach($content_chunks as $content_chunk)
-		{
+    	{
 			$preg_result= preg_match(
             '%^(?:
                   [\x09\x0A\x0D\x20-\x7E]            # ASCII
@@ -135,29 +139,47 @@ 
     private static function _checkUtf8Rfc3629($content)
     {
         $len = strlen($content);
-        for ($i = 0; $i < $len; $i++) {
+        for ($i = 0; $i < $len; $i++)
+        {
             $c = ord($content[$i]);
-            if ($c > 128) {
-                if (($c >= 254)) {
+            if ($c > 128)
+            {
+                if (($c >= 254))
+                {
                     return false;
-                } elseif ($c >= 252) {
+                }
+                elseif ($c >= 252)
+                {
                     $bits=6;
-                } elseif ($c >= 248) {
+                }
+                elseif ($c >= 248)
+                {
                     $bits=5;
-                } elseif ($c >= 240) {
+                }
+                elseif ($c >= 240)
+                {
                     $bytes = 4;
-                } elseif ($c >= 224) {
+                }
+                elseif ($c >= 224)
+                {
                     $bytes = 3;
-                } elseif ($c >= 192) {
+                }
+                elseif ($c >= 192)
+                {
                     $bytes = 2;
-                } else {
+                }
+                else
+                {
                     return false;
-                } if (($i + $bytes) > $len) {
+                } if (($i + $bytes) > $len)
+                {
                     return false;
-                } while ($bytes > 1) {
+                } while ($bytes > 1)
+                {
                     $i++;
                     $b = ord($content[$i]);
-                    if ($b < 128 || $b > 191) {
+                    if ($b < 128 || $b > 191)
+                    {
                         return false;
                     }
                     $bytes--;
@@ -185,10 +207,12 @@ 
 		$array = self::mbStringToArray ($str);
 		$n = -1;
 		$new = Array();
-		foreach ($array as $char) {
+		foreach ($array as $char)
+		{
 			$n++;
 			if ($n < $len) $new []= $char;
-			elseif ($n == $len) {
+			elseif ($n == $len)
+			{
 				$new []= $glue . $char;
 				$n = 0;
 			}
@@ -209,7 +233,8 @@ 
 		if (empty($str)) return false;
 		$len = mb_strlen($str);
 		$array = array();
-		for ($i = 0; $i < $len; $i++) {
+		for ($i = 0; $i < $len; $i++)
+		{
 			$array[] = mb_substr($str, $i, 1);
 		}
 		return $array;

Upper-Lower-Casing +12 added lines, -12 removed lines

@@ -60,7 +60,7 @@ 
     {
         // We are only interested if this is the first open tag.
         if ($stackPtr !== 0) {
-            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
+            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== FALSE) {
                 return;
             }
         }
@@ -68,7 +68,7 @@ 
         $file_path = $phpcsFile->getFilename();
         $file_name = basename($file_path);
         $file_content = file_get_contents($file_path);
-        if (false === mb_check_encoding($file_content, 'UTF-8')) {
+        if (FALSE === mb_check_encoding($file_content, 'UTF-8')) {
             $error = 'File "' . $file_name . '" should be saved with Unicode (UTF-8) encoding.';
             $phpcsFile->addError($error, 0);
         }
@@ -114,11 +114,11 @@ 
 			);
 			if($preg_result!==1)
 			{
-				return false;
+				return FALSE;
 			}
 
 		}
-		return true;
+		return TRUE;
     }//end _checkUtf8W3c()
 
     /**
@@ -139,7 +139,7 @@ 
             $c = ord($content[$i]);
             if ($c > 128) {
                 if (($c >= 254)) {
-                    return false;
+                    return FALSE;
                 } elseif ($c >= 252) {
                     $bits=6;
                 } elseif ($c >= 248) {
@@ -151,20 +151,20 @@ 
                 } elseif ($c >= 192) {
                     $bytes = 2;
                 } else {
-                    return false;
+                    return FALSE;
                 } if (($i + $bytes) > $len) {
-                    return false;
+                    return FALSE;
                 } while ($bytes > 1) {
                     $i++;
                     $b = ord($content[$i]);
                     if ($b < 128 || $b > 191) {
-                        return false;
+                        return FALSE;
                     }
                     $bytes--;
                 }
             }
         }
-        return true;
+        return TRUE;
     }//_checkUtf8Rfc3629()
 
 	 /**
@@ -181,10 +181,10 @@ 
      */
 	private static function mb_chunk_split($str, $len, $glue)
 	{
-		if (empty($str)) return false;
+		if (empty($str)) return FALSE;
 		$array = self::mbStringToArray ($str);
 		$n = -1;
-		$new = Array();
+		$new = array();
 		foreach ($array as $char) {
 			$n++;
 			if ($n < $len) $new []= $char;
@@ -206,7 +206,7 @@ 
      */
 	private static function mbStringToArray ($str)
 	{
-		if (empty($str)) return false;
+		if (empty($str)) return FALSE;
 		$len = mb_strlen($str);
 		$array = array();
 		for ($i = 0; $i < $len; $i++) {

build/CodeIgniter/Sniffs/Operators/LogicalOperatorAndSniff.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +34 added lines, -34 removed lines

@@ -33,47 +33,47 @@
 class LogicalOperatorAndSniff implements Sniff
 {
 	/**
-     * Returns an array of tokens this test wants to listen for: symbolic and literal operators and.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-            T_LOGICAL_AND,
-        );
+	 * Returns an array of tokens this test wants to listen for: symbolic and literal operators and.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return array(
+			T_LOGICAL_AND,
+		);
 
-    }//end register()
+	}//end register()
 
 
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile The current file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
+	/**
+	 * Processes this test, when one of its tokens is encountered.
+	 *
+	 * @param File $phpcsFile The current file being scanned.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+		$tokens = $phpcsFile->getTokens();
 
-        $operator_token = $tokens[$stackPtr];
-        $operator_string = $operator_token['content'];
-        $operator_code = $operator_token['code'];
+		$operator_token = $tokens[$stackPtr];
+		$operator_string = $operator_token['content'];
+		$operator_code = $operator_token['code'];
 
-        if ($operator_string !== strtoupper($operator_string)) {
-            $error_message = 'Logical operator should be in upper case;'
-                . ' use "' . strtoupper($operator_string)
-                . '" instead of "' . $operator_string . '"';
-            $phpcsFile->addError($error_message, $stackPtr, 'LowercaseLogicalOperator');
-        }
+		if ($operator_string !== strtoupper($operator_string)) {
+			$error_message = 'Logical operator should be in upper case;'
+				. ' use "' . strtoupper($operator_string)
+				. '" instead of "' . $operator_string . '"';
+			$phpcsFile->addError($error_message, $stackPtr, 'LowercaseLogicalOperator');
+		}
 
-        $warning_message = 'The symbolic form "&&" is preferred over the literal form "AND"';
-        $phpcsFile->addWarning($warning_message, $stackPtr, 'UseOfLiteralAndOperator');
+		$warning_message = 'The symbolic form "&&" is preferred over the literal form "AND"';
+		$phpcsFile->addWarning($warning_message, $stackPtr, 'UseOfLiteralAndOperator');
 
-    }//end process()
+	}//end process()
 
 
 }//end class

Braces +3 added lines, -3 removed lines

@@ -30,8 +30,7 @@ 
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Files\File;
 
-class LogicalOperatorAndSniff implements Sniff
-{
+class LogicalOperatorAndSniff implements Sniff {
 	/**
      * Returns an array of tokens this test wants to listen for: symbolic and literal operators and.
      *
@@ -63,7 +62,8 @@ 
         $operator_string = $operator_token['content'];
         $operator_code = $operator_token['code'];
 
-        if ($operator_string !== strtoupper($operator_string)) {
+        if ($operator_string !== strtoupper($operator_string))
+        {
             $error_message = 'Logical operator should be in upper case;'
                 . ' use "' . strtoupper($operator_string)
                 . '" instead of "' . $operator_string . '"';

build/CodeIgniter/Sniffs/Operators/UppercaseLogicalOperatorOrSniff.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +40 added lines, -40 removed lines

@@ -32,51 +32,51 @@
 
 class UppercaseLogicalOperatorOrSniff implements Sniff
 {
-    /**
-     * Returns an array of tokens this test wants to listen for: literal and symbolic operators or.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-            T_BOOLEAN_OR,
-            T_LOGICAL_OR,
-        );
+	/**
+	 * Returns an array of tokens this test wants to listen for: literal and symbolic operators or.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return array(
+			T_BOOLEAN_OR,
+			T_LOGICAL_OR,
+		);
 
-    }//end register()
+	}//end register()
 
 
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile The current file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
+	/**
+	 * Processes this test, when one of its tokens is encountered.
+	 *
+	 * @param File $phpcsFile The current file being scanned.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+		$tokens = $phpcsFile->getTokens();
 
-        $operator_token = $tokens[$stackPtr];
-        $operator_string = $operator_token['content'];
-        $operator_code = $operator_token['code'];
+		$operator_token = $tokens[$stackPtr];
+		$operator_string = $operator_token['content'];
+		$operator_code = $operator_token['code'];
 
-        if ($operator_code == T_BOOLEAN_OR) {
-            $error_message = 'Logical operator "' . $operator_string
-                . '" is prohibited; use "OR" instead';
-            $phpcsFile->addError($error_message, $stackPtr, 'UseOf||InsteadOfOR');
-        }
-        // it is literal, if it is not symbolic
-        else if ($operator_string !== strtoupper($operator_string)) {
-            $error_message = 'Logical operator should be in upper case;'
-                . ' use "' . strtoupper($operator_string)
-                . '" instead of "' . $operator_string . '"';
-            $phpcsFile->addError($error_message, $stackPtr, 'UseOfLowercaseOr');
-        }
-    }//end process()
+		if ($operator_code == T_BOOLEAN_OR) {
+			$error_message = 'Logical operator "' . $operator_string
+				. '" is prohibited; use "OR" instead';
+			$phpcsFile->addError($error_message, $stackPtr, 'UseOf||InsteadOfOR');
+		}
+		// it is literal, if it is not symbolic
+		else if ($operator_string !== strtoupper($operator_string)) {
+			$error_message = 'Logical operator should be in upper case;'
+				. ' use "' . strtoupper($operator_string)
+				. '" instead of "' . $operator_string . '"';
+			$phpcsFile->addError($error_message, $stackPtr, 'UseOfLowercaseOr');
+		}
+	}//end process()
 
 
 }//end class

Braces +5 added lines, -4 removed lines

@@ -30,8 +30,7 @@ 
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Files\File;
 
-class UppercaseLogicalOperatorOrSniff implements Sniff
-{
+class UppercaseLogicalOperatorOrSniff implements Sniff {
     /**
      * Returns an array of tokens this test wants to listen for: literal and symbolic operators or.
      *
@@ -64,13 +63,15 @@ 
         $operator_string = $operator_token['content'];
         $operator_code = $operator_token['code'];
 
-        if ($operator_code == T_BOOLEAN_OR) {
+        if ($operator_code == T_BOOLEAN_OR)
+        {
             $error_message = 'Logical operator "' . $operator_string
                 . '" is prohibited; use "OR" instead';
             $phpcsFile->addError($error_message, $stackPtr, 'UseOf||InsteadOfOR');
         }
         // it is literal, if it is not symbolic
-        else if ($operator_string !== strtoupper($operator_string)) {
+        else if ($operator_string !== strtoupper($operator_string))
+        {
             $error_message = 'Logical operator should be in upper case;'
                 . ' use "' . strtoupper($operator_string)
                 . '" instead of "' . $operator_string . '"';

build/CodeIgniter/Sniffs/Strings/DoubleQuoteUsageSniff.php

Doc Comments +2 added lines, -2 removed lines

@@ -87,7 +87,7 @@ 
 	 * @param string               $dblQtString The double-quoted string content,
 	 *                                          i.e. without quotes.
 	 *
-	 * @return void
+	 * @return boolean
 	 */
 	protected function processDoubleQuotedString (File $phpcsFile, $stackPtr, $dblQtString)
 	{
@@ -134,7 +134,7 @@ 
 	 * @param string               $sglQtString The single-quoted string content,
 	 *                                          i.e. without quotes.
 	 *
-	 * @return void
+	 * @return boolean
 	 */
 	protected function processSingleQuotedString (File $phpcsFile, $stackPtr, $sglQtString)
 	{

Indentation +123 added lines, -123 removed lines

@@ -327,137 +327,137 @@
  */
 class DoubleQuoteUsageSniff extends VariableUsageSniff
 {
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-            T_DOUBLE_QUOTED_STRING,
-            T_CONSTANT_ENCAPSED_STRING,
-        );
-    }//end register()
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return array(
+			T_DOUBLE_QUOTED_STRING,
+			T_CONSTANT_ENCAPSED_STRING,
+		);
+	}//end register()
 
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile The current file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        // no variable are in the string from here
-        $tokens = $phpcsFile->getTokens();
-        $qtString = $tokens[$stackPtr]['content'];
-        // makes sure that it is about a double quote string,
-        // since variables are not parsed out of double quoted string
-        $open_qt_str = substr($qtString, 0, 1);
+	/**
+	 * Processes this test, when one of its tokens is encountered.
+	 *
+	 * @param File $phpcsFile The current file being scanned.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+		// no variable are in the string from here
+		$tokens = $phpcsFile->getTokens();
+		$qtString = $tokens[$stackPtr]['content'];
+		// makes sure that it is about a double quote string,
+		// since variables are not parsed out of double quoted string
+		$open_qt_str = substr($qtString, 0, 1);
 
-        // clean the enclosing quotes
-        $qtString = substr($qtString, 1, strlen($qtString) - 1 - 1);
+		// clean the enclosing quotes
+		$qtString = substr($qtString, 1, strlen($qtString) - 1 - 1);
 
-        if (0 === strcmp($open_qt_str, '"')) {
-            $this->processDoubleQuotedString($phpcsFile, $stackPtr, $qtString);
-        } else if (0 === strcmp($open_qt_str, "'")) {
-            $this->processSingleQuotedString($phpcsFile, $stackPtr, $qtString);
-        }
-    }//end process()
+		if (0 === strcmp($open_qt_str, '"')) {
+			$this->processDoubleQuotedString($phpcsFile, $stackPtr, $qtString);
+		} else if (0 === strcmp($open_qt_str, "'")) {
+			$this->processSingleQuotedString($phpcsFile, $stackPtr, $qtString);
+		}
+	}//end process()
 
 
-    /**
-     * Processes this test, when the token encountered is a double-quoted string.
-     *
-     * @param File $phpcsFile The current file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     * @param string               $qtString  The double-quoted string content,
-     *                                        i.e. without quotes.
-     *
-     * @return void
-     */
-    protected function processDoubleQuotedString (File $phpcsFile, $stackPtr, $qtString)
-    {
-        // so there should be at least a single quote or a special char
-        // if there are the 2 kinds of quote and no special char, then add a warning
-        $has_variable = parent::processDoubleQuotedString($phpcsFile, $stackPtr, '"'.$qtString.'"');
-        $has_specific_sequence = $this->_hasSpecificSequence($qtString);
-        $dbl_qt_at = strpos($qtString, '"');
-        $smpl_qt_at = strpos($qtString, "'");
-        if (false === $has_variable && false === $has_specific_sequence
-            && false === $smpl_qt_at
-        ) {
-            $error = 'Single-quoted strings should be used unless it contains variables, special chars like \n or single quotes.';
-            $phpcsFile->addError($error, $stackPtr);
-        } else if (false !== $smpl_qt_at && false !== $dbl_qt_at
-            && false === $has_variable && false === $has_specific_sequence
-        ) {
-            $warning = 'It is encouraged to use a single-quoted string, since it doesn\'t contain any variable nor special char though it mixes single and double quotes.';
-            $phpcsFile->addWarning($warning, $stackPtr);
-        }
-    }//end processDoubleQuotedString()
+	/**
+	 * Processes this test, when the token encountered is a double-quoted string.
+	 *
+	 * @param File $phpcsFile The current file being scanned.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 * @param string               $qtString  The double-quoted string content,
+	 *                                        i.e. without quotes.
+	 *
+	 * @return void
+	 */
+	protected function processDoubleQuotedString (File $phpcsFile, $stackPtr, $qtString)
+	{
+		// so there should be at least a single quote or a special char
+		// if there are the 2 kinds of quote and no special char, then add a warning
+		$has_variable = parent::processDoubleQuotedString($phpcsFile, $stackPtr, '"'.$qtString.'"');
+		$has_specific_sequence = $this->_hasSpecificSequence($qtString);
+		$dbl_qt_at = strpos($qtString, '"');
+		$smpl_qt_at = strpos($qtString, "'");
+		if (false === $has_variable && false === $has_specific_sequence
+			&& false === $smpl_qt_at
+		) {
+			$error = 'Single-quoted strings should be used unless it contains variables, special chars like \n or single quotes.';
+			$phpcsFile->addError($error, $stackPtr);
+		} else if (false !== $smpl_qt_at && false !== $dbl_qt_at
+			&& false === $has_variable && false === $has_specific_sequence
+		) {
+			$warning = 'It is encouraged to use a single-quoted string, since it doesn\'t contain any variable nor special char though it mixes single and double quotes.';
+			$phpcsFile->addWarning($warning, $stackPtr);
+		}
+	}//end processDoubleQuotedString()
 
 
-    /**
-     * Processes this test, when the token encountered is a single-quoted string.
-     *
-     * @param File $phpcsFile The current file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     * @param string               $qtString  The single-quoted string content,
-     *                                        i.e. without quotes.
-     *
-     * @return void
-     */
-    protected function processSingleQuotedString (File $phpcsFile, $stackPtr, $qtString)
-    {
-        // if there is single quotes without additional double quotes,
-        // then user is allowed to use double quote to avoid having to
-        // escape single quotes. Don't add the warning, if an error was
-        // already added, because a variable was found in a single-quoted
-        // string.
-        $has_variable = parent::processSingleQuotedString($phpcsFile, $stackPtr, "'".$qtString."'");
-        $dbl_qt_at = strpos($qtString, '"');
-        $smpl_qt_at = strpos($qtString, "'");
-        if (false === $has_variable && false !== $smpl_qt_at && false === $dbl_qt_at) {
-            $warning = 'You may also use double-quoted strings if the string contains single quotes, so you do not have to use escape characters.';
-            $phpcsFile->addWarning($warning, $stackPtr);
-        }
-    }//end processSingleQuotedString()
+	/**
+	 * Processes this test, when the token encountered is a single-quoted string.
+	 *
+	 * @param File $phpcsFile The current file being scanned.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 * @param string               $qtString  The single-quoted string content,
+	 *                                        i.e. without quotes.
+	 *
+	 * @return void
+	 */
+	protected function processSingleQuotedString (File $phpcsFile, $stackPtr, $qtString)
+	{
+		// if there is single quotes without additional double quotes,
+		// then user is allowed to use double quote to avoid having to
+		// escape single quotes. Don't add the warning, if an error was
+		// already added, because a variable was found in a single-quoted
+		// string.
+		$has_variable = parent::processSingleQuotedString($phpcsFile, $stackPtr, "'".$qtString."'");
+		$dbl_qt_at = strpos($qtString, '"');
+		$smpl_qt_at = strpos($qtString, "'");
+		if (false === $has_variable && false !== $smpl_qt_at && false === $dbl_qt_at) {
+			$warning = 'You may also use double-quoted strings if the string contains single quotes, so you do not have to use escape characters.';
+			$phpcsFile->addWarning($warning, $stackPtr);
+		}
+	}//end processSingleQuotedString()
 
-    /**
-     * Return TRUE, if a sequence of chars that is parsed in a specific way
-     * in double-quoted strings is found, FALSE otherwise.
-     *
-     * @param string $string String in which sequence of special chars will
-     * be researched.
-     *
-     * @return TRUE, if a sequence of chars that is parsed in a specific way
-     * in double-quoted strings is found, FALSE otherwise.
-     *
-     * @link http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.double
-     */
-    private function _hasSpecificSequence($string)
-    {
-        $hasSpecificSequence = FALSE;
-        $specialMeaningStrs = array('\n', '\r', '\t', '\v', '\f');
-        foreach ($specialMeaningStrs as $splStr) {
-            if (FALSE !== strpos($string, $splStr)) {
-                $hasSpecificSequence = TRUE;
-            }
-        }
-        $specialMeaningPtrns = array('\[0-7]{1,3}', '\x[0-9A-Fa-f]{1,2}');
-        foreach ($specialMeaningPtrns as $splPtrn) {
-            if (1 === preg_match("/{$splPtrn}/", $string)) {
-                $hasSpecificSequence = TRUE;
-            }
-        }
-        return $hasSpecificSequence;
-    }//end _hasSpecificSequence()
+	/**
+	 * Return TRUE, if a sequence of chars that is parsed in a specific way
+	 * in double-quoted strings is found, FALSE otherwise.
+	 *
+	 * @param string $string String in which sequence of special chars will
+	 * be researched.
+	 *
+	 * @return TRUE, if a sequence of chars that is parsed in a specific way
+	 * in double-quoted strings is found, FALSE otherwise.
+	 *
+	 * @link http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.double
+	 */
+	private function _hasSpecificSequence($string)
+	{
+		$hasSpecificSequence = FALSE;
+		$specialMeaningStrs = array('\n', '\r', '\t', '\v', '\f');
+		foreach ($specialMeaningStrs as $splStr) {
+			if (FALSE !== strpos($string, $splStr)) {
+				$hasSpecificSequence = TRUE;
+			}
+		}
+		$specialMeaningPtrns = array('\[0-7]{1,3}', '\x[0-9A-Fa-f]{1,2}');
+		foreach ($specialMeaningPtrns as $splPtrn) {
+			if (1 === preg_match("/{$splPtrn}/", $string)) {
+				$hasSpecificSequence = TRUE;
+			}
+		}
+		return $hasSpecificSequence;
+	}//end _hasSpecificSequence()
 
 }//end class
 

Spacing +24 added lines, -24 removed lines

@@ -89,10 +89,10 @@ 
 	 *
 	 * @return void
 	 */
-	protected function processDoubleQuotedString (File $phpcsFile, $stackPtr, $dblQtString)
+	protected function processDoubleQuotedString(File $phpcsFile, $stackPtr, $dblQtString)
 	{
 		$variableFound = FALSE;
-		$strTokens = token_get_all('<?php '.$dblQtString);
+		$strTokens = token_get_all('<?php ' . $dblQtString);
 		$strPtr = 1; // skip php opening tag added by ourselves
 		$requireDblQuotes = FALSE;
 		while ($strPtr < count($strTokens)) {
@@ -136,10 +136,10 @@ 
 	 *
 	 * @return void
 	 */
-	protected function processSingleQuotedString (File $phpcsFile, $stackPtr, $sglQtString)
+	protected function processSingleQuotedString(File $phpcsFile, $stackPtr, $sglQtString)
 	{
 		$variableFound = FALSE;
-		$strTokens = token_get_all('<?php '.$sglQtString);
+		$strTokens = token_get_all('<?php ' . $sglQtString);
 		$strPtr = 1; // skip php opening tag added by ourselves
 		while ($strPtr < count($strTokens)) {
 			$strToken = $strTokens[$strPtr];
@@ -171,17 +171,17 @@ 
 	 * @return array The attribute name associated to index 'var', an array with
 	 * indexes 'obj' and 'attr' or an array with indexes 'arr' and 'idx'.
 	 */
-	private function _parseVariable ($strTokens, &$strPtr)
+	private function _parseVariable($strTokens, &$strPtr)
 	{
 		if ( ! in_array($strTokens[$strPtr][0], array(T_VARIABLE, T_STRING_VARNAME))) {
-			throw new Exception ('Expected variable name.');
+			throw new Exception('Expected variable name.');
 		}
 		$var = $strTokens[$strPtr][1];
 		$strPtr++;
 		$startStrPtr = $strPtr;
 		try {
 			$attr = $this->_parseObjectAttribute($strTokens, $strPtr);
-			return array ('obj' => $var, 'attr' => $attr);
+			return array('obj' => $var, 'attr' => $attr);
 		} catch (Exception $err) {
 			if ($strPtr !== $startStrPtr) {
 				throw $err;
@@ -189,13 +189,13 @@ 
 		}
 		try {
 			$idx = $this->_parseArrayIndexes($strTokens, $strPtr);
-			return array ('arr' => $var, 'idx' => $idx);
+			return array('arr' => $var, 'idx' => $idx);
 		} catch (Exception $err) {
 			if ($strPtr !== $startStrPtr) {
 				throw $err;
 			}
 		}
-		return array ('var' => $var);
+		return array('var' => $var);
 	}//end _parseVariable()
 
 
@@ -215,21 +215,21 @@ 
 	 * @return mixed The attribute name as a string, an array with indexes
 	 * 'obj' and 'attr' or an array with indexes 'arr' and 'idx'.
 	 */
-	private function _parseObjectAttribute ($strTokens, &$strPtr)
+	private function _parseObjectAttribute($strTokens, &$strPtr)
 	{
 		if (T_OBJECT_OPERATOR !== $strTokens[$strPtr][0]) {
-			throw new Exception ('Expected ->.');
+			throw new Exception('Expected ->.');
 		}
 		$strPtr++;
 		if (T_STRING !== $strTokens[$strPtr][0]) {
-			throw new Exception ('Expected an object attribute.');
+			throw new Exception('Expected an object attribute.');
 		}
 		$attr = $strTokens[$strPtr][1];
 		$strPtr++;
 		$startStrPtr = $strPtr;
 		try {
 			$sub_attr = $this->_parseObjectAttribute($strTokens, $strPtr);
-			return array ('obj' => $attr, 'attr' => $sub_attr);
+			return array('obj' => $attr, 'attr' => $sub_attr);
 		} catch (Exception $err) {
 			if ($strPtr !== $startStrPtr) {
 				throw $err;
@@ -237,7 +237,7 @@ 
 		}
 		try {
 			$idx = $this->_parseArrayIndexes($strTokens, $strPtr);
-			return array ('arr' => $attr, 'idx' => $idx);
+			return array('arr' => $attr, 'idx' => $idx);
 		} catch (Exception $err) {
 			if ($strPtr !== $startStrPtr) {
 				throw $err;
@@ -260,7 +260,7 @@ 
 	 *
 	 * @return array Indexes in the same order as in the string.
 	 */
-	private function _parseArrayIndexes ($strTokens, &$strPtr)
+	private function _parseArrayIndexes($strTokens, &$strPtr)
 	{
 		$indexes = array($this->_parseArrayIndex($strTokens, $strPtr));
 		try {
@@ -290,19 +290,19 @@ 
 	 *
 	 * @return string Index between the 2 square brackets
 	 */
-	private function _parseArrayIndex ($strTokens, &$strPtr)
+	private function _parseArrayIndex($strTokens, &$strPtr)
 	{
 		if ('[' !== $strTokens[$strPtr]) {
-			throw new Exception ('Expected [.');
+			throw new Exception('Expected [.');
 		}
 		$strPtr++;
-		if (! in_array($strTokens[$strPtr][0], array(T_CONSTANT_ENCAPSED_STRING, T_LNUMBER))) {
-			throw new Exception ('Expected an array index.');
+		if ( ! in_array($strTokens[$strPtr][0], array(T_CONSTANT_ENCAPSED_STRING, T_LNUMBER))) {
+			throw new Exception('Expected an array index.');
 		}
 		$index = $strTokens[$strPtr][1];
 		$strPtr++;
 		if (']' !== $strTokens[$strPtr]) {
-			throw new Exception ('Expected ].');
+			throw new Exception('Expected ].');
 		}
 		$strPtr++;
 		return $index;
@@ -380,11 +380,11 @@ 
      *
      * @return void
      */
-    protected function processDoubleQuotedString (File $phpcsFile, $stackPtr, $qtString)
+    protected function processDoubleQuotedString(File $phpcsFile, $stackPtr, $qtString)
     {
         // so there should be at least a single quote or a special char
         // if there are the 2 kinds of quote and no special char, then add a warning
-        $has_variable = parent::processDoubleQuotedString($phpcsFile, $stackPtr, '"'.$qtString.'"');
+        $has_variable = parent::processDoubleQuotedString($phpcsFile, $stackPtr, '"' . $qtString . '"');
         $has_specific_sequence = $this->_hasSpecificSequence($qtString);
         $dbl_qt_at = strpos($qtString, '"');
         $smpl_qt_at = strpos($qtString, "'");
@@ -413,14 +413,14 @@ 
      *
      * @return void
      */
-    protected function processSingleQuotedString (File $phpcsFile, $stackPtr, $qtString)
+    protected function processSingleQuotedString(File $phpcsFile, $stackPtr, $qtString)
     {
         // if there is single quotes without additional double quotes,
         // then user is allowed to use double quote to avoid having to
         // escape single quotes. Don't add the warning, if an error was
         // already added, because a variable was found in a single-quoted
         // string.
-        $has_variable = parent::processSingleQuotedString($phpcsFile, $stackPtr, "'".$qtString."'");
+        $has_variable = parent::processSingleQuotedString($phpcsFile, $stackPtr, "'" . $qtString . "'");
         $dbl_qt_at = strpos($qtString, '"');
         $smpl_qt_at = strpos($qtString, "'");
         if (false === $has_variable && false !== $smpl_qt_at && false === $dbl_qt_at) {

Braces +95 added lines, -46 removed lines

@@ -35,8 +35,7 @@ 
  * @license   http://thomas.ernest.fr/developement/php_cs/licence GNU General Public License
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class VariableUsageSniff implements Sniff
-{
+class VariableUsageSniff implements Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
@@ -70,9 +69,12 @@ 
 		// makes sure that it is about a double quote string,
 		// since variables are not parsed out of double quoted string
 		$openDblQtStr = substr($string, 0, 1);
-		if (0 === strcmp($openDblQtStr, '"')) {
+		if (0 === strcmp($openDblQtStr, '"'))
+		{
 			$this->processDoubleQuotedString($phpcsFile, $stackPtr, $string);
-		} else if (0 === strcmp($openDblQtStr, "'")) {
+		}
+		else if (0 === strcmp($openDblQtStr, "'"))
+		{
 			$this->processSingleQuotedString($phpcsFile, $stackPtr, $string);
 		}
 	}//end process()
@@ -95,25 +97,34 @@ 
 		$strTokens = token_get_all('<?php '.$dblQtString);
 		$strPtr = 1; // skip php opening tag added by ourselves
 		$requireDblQuotes = FALSE;
-		while ($strPtr < count($strTokens)) {
+		while ($strPtr < count($strTokens))
+		{
 			$strToken = $strTokens[$strPtr];
-			if (is_array($strToken)) {
-				if (in_array($strToken[0], array(T_DOLLAR_OPEN_CURLY_BRACES, T_CURLY_OPEN))) {
+			if (is_array($strToken))
+			{
+				if (in_array($strToken[0], array(T_DOLLAR_OPEN_CURLY_BRACES, T_CURLY_OPEN)))
+				{
 					$strPtr++;
-					try {
+					try
+					{
 						$this->_parseVariable($strTokens, $strPtr);
-					} catch (Exception $err) {
+					}
+					catch (Exception $err)
+					{
 						$error = 'There is no variable, object nor array between curly braces. Please use the escape char for $ or {.';
 						$phpcsFile->addError($error, $stackPtr);
 					}
 					$variableFound = TRUE;
-					if ('}' !== $strTokens[$strPtr]) {
+					if ('}' !== $strTokens[$strPtr])
+					{
 						$error = 'There is no matching closing curly brace.';
 						$phpcsFile->addError($error, $stackPtr);
 					}
 					// don't move forward, since it will be done in the main loop
 					// $strPtr++;
-				} else if (T_VARIABLE === $strToken[0]) {
+				}
+				else if (T_VARIABLE === $strToken[0])
+				{
 					$variableFound = TRUE;
 					$error = "Variable {$strToken[1]} in double-quoted strings should be enclosed with curly braces. Please consider {{$strToken[1]}}";
 					$phpcsFile->addError($error, $stackPtr);
@@ -141,10 +152,13 @@ 
 		$variableFound = FALSE;
 		$strTokens = token_get_all('<?php '.$sglQtString);
 		$strPtr = 1; // skip php opening tag added by ourselves
-		while ($strPtr < count($strTokens)) {
+		while ($strPtr < count($strTokens))
+		{
 			$strToken = $strTokens[$strPtr];
-			if (is_array($strToken)) {
-				if (T_VARIABLE === $strToken[0]) {
+			if (is_array($strToken))
+			{
+				if (T_VARIABLE === $strToken[0])
+				{
 					$error = "Variables like {$strToken[1]} should be in double-quoted strings only.";
 					$phpcsFile->addError($error, $stackPtr);
 				}
@@ -173,25 +187,34 @@ 
 	 */
 	private function _parseVariable ($strTokens, &$strPtr)
 	{
-		if ( ! in_array($strTokens[$strPtr][0], array(T_VARIABLE, T_STRING_VARNAME))) {
+		if ( ! in_array($strTokens[$strPtr][0], array(T_VARIABLE, T_STRING_VARNAME)))
+		{
 			throw new Exception ('Expected variable name.');
 		}
 		$var = $strTokens[$strPtr][1];
 		$strPtr++;
 		$startStrPtr = $strPtr;
-		try {
+		try
+		{
 			$attr = $this->_parseObjectAttribute($strTokens, $strPtr);
 			return array ('obj' => $var, 'attr' => $attr);
-		} catch (Exception $err) {
-			if ($strPtr !== $startStrPtr) {
+		}
+		catch (Exception $err)
+		{
+			if ($strPtr !== $startStrPtr)
+			{
 				throw $err;
 			}
 		}
-		try {
+		try
+		{
 			$idx = $this->_parseArrayIndexes($strTokens, $strPtr);
 			return array ('arr' => $var, 'idx' => $idx);
-		} catch (Exception $err) {
-			if ($strPtr !== $startStrPtr) {
+		}
+		catch (Exception $err)
+		{
+			if ($strPtr !== $startStrPtr)
+			{
 				throw $err;
 			}
 		}
@@ -217,29 +240,39 @@ 
 	 */
 	private function _parseObjectAttribute ($strTokens, &$strPtr)
 	{
-		if (T_OBJECT_OPERATOR !== $strTokens[$strPtr][0]) {
+		if (T_OBJECT_OPERATOR !== $strTokens[$strPtr][0])
+		{
 			throw new Exception ('Expected ->.');
 		}
 		$strPtr++;
-		if (T_STRING !== $strTokens[$strPtr][0]) {
+		if (T_STRING !== $strTokens[$strPtr][0])
+		{
 			throw new Exception ('Expected an object attribute.');
 		}
 		$attr = $strTokens[$strPtr][1];
 		$strPtr++;
 		$startStrPtr = $strPtr;
-		try {
+		try
+		{
 			$sub_attr = $this->_parseObjectAttribute($strTokens, $strPtr);
 			return array ('obj' => $attr, 'attr' => $sub_attr);
-		} catch (Exception $err) {
-			if ($strPtr !== $startStrPtr) {
+		}
+		catch (Exception $err)
+		{
+			if ($strPtr !== $startStrPtr)
+			{
 				throw $err;
 			}
 		}
-		try {
+		try
+		{
 			$idx = $this->_parseArrayIndexes($strTokens, $strPtr);
 			return array ('arr' => $attr, 'idx' => $idx);
-		} catch (Exception $err) {
-			if ($strPtr !== $startStrPtr) {
+		}
+		catch (Exception $err)
+		{
+			if ($strPtr !== $startStrPtr)
+			{
 				throw $err;
 			}
 		}
@@ -263,13 +296,18 @@ 
 	private function _parseArrayIndexes ($strTokens, &$strPtr)
 	{
 		$indexes = array($this->_parseArrayIndex($strTokens, $strPtr));
-		try {
-			while (1) {
+		try
+		{
+			while (1)
+			{
 				$startStrPtr = $strPtr;
 				$indexes [] = $this->_parseArrayIndex($strTokens, $strPtr);
 			}
-		} catch (Exception $err) {
-			if (0 !== ($strPtr - $startStrPtr)) {
+		}
+		catch (Exception $err)
+		{
+			if (0 !== ($strPtr - $startStrPtr))
+			{
 				throw $err;
 			}
 			return $indexes;
@@ -292,16 +330,19 @@ 
 	 */
 	private function _parseArrayIndex ($strTokens, &$strPtr)
 	{
-		if ('[' !== $strTokens[$strPtr]) {
+		if ('[' !== $strTokens[$strPtr])
+		{
 			throw new Exception ('Expected [.');
 		}
 		$strPtr++;
-		if (! in_array($strTokens[$strPtr][0], array(T_CONSTANT_ENCAPSED_STRING, T_LNUMBER))) {
+		if (! in_array($strTokens[$strPtr][0], array(T_CONSTANT_ENCAPSED_STRING, T_LNUMBER)))
+		{
 			throw new Exception ('Expected an array index.');
 		}
 		$index = $strTokens[$strPtr][1];
 		$strPtr++;
-		if (']' !== $strTokens[$strPtr]) {
+		if (']' !== $strTokens[$strPtr])
+		{
 			throw new Exception ('Expected ].');
 		}
 		$strPtr++;
@@ -325,8 +366,7 @@ 
  * @license   http://thomas.ernest.fr/developement/php_cs/licence GNU General Public License
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
-class DoubleQuoteUsageSniff extends VariableUsageSniff
-{
+class DoubleQuoteUsageSniff extends VariableUsageSniff {
     /**
      * Returns an array of tokens this test wants to listen for.
      *
@@ -361,9 +401,12 @@ 
         // clean the enclosing quotes
         $qtString = substr($qtString, 1, strlen($qtString) - 1 - 1);
 
-        if (0 === strcmp($open_qt_str, '"')) {
+        if (0 === strcmp($open_qt_str, '"'))
+        {
             $this->processDoubleQuotedString($phpcsFile, $stackPtr, $qtString);
-        } else if (0 === strcmp($open_qt_str, "'")) {
+        }
+        else if (0 === strcmp($open_qt_str, "'"))
+        {
             $this->processSingleQuotedString($phpcsFile, $stackPtr, $qtString);
         }
     }//end process()
@@ -393,7 +436,8 @@ 
         ) {
             $error = 'Single-quoted strings should be used unless it contains variables, special chars like \n or single quotes.';
             $phpcsFile->addError($error, $stackPtr);
-        } else if (false !== $smpl_qt_at && false !== $dbl_qt_at
+        }
+        else if (false !== $smpl_qt_at && false !== $dbl_qt_at
             && false === $has_variable && false === $has_specific_sequence
         ) {
             $warning = 'It is encouraged to use a single-quoted string, since it doesn\'t contain any variable nor special char though it mixes single and double quotes.';
@@ -423,7 +467,8 @@ 
         $has_variable = parent::processSingleQuotedString($phpcsFile, $stackPtr, "'".$qtString."'");
         $dbl_qt_at = strpos($qtString, '"');
         $smpl_qt_at = strpos($qtString, "'");
-        if (false === $has_variable && false !== $smpl_qt_at && false === $dbl_qt_at) {
+        if (false === $has_variable && false !== $smpl_qt_at && false === $dbl_qt_at)
+        {
             $warning = 'You may also use double-quoted strings if the string contains single quotes, so you do not have to use escape characters.';
             $phpcsFile->addWarning($warning, $stackPtr);
         }
@@ -445,14 +490,18 @@ 
     {
         $hasSpecificSequence = FALSE;
         $specialMeaningStrs = array('\n', '\r', '\t', '\v', '\f');
-        foreach ($specialMeaningStrs as $splStr) {
-            if (FALSE !== strpos($string, $splStr)) {
+        foreach ($specialMeaningStrs as $splStr)
+        {
+            if (FALSE !== strpos($string, $splStr))
+            {
                 $hasSpecificSequence = TRUE;
             }
         }
         $specialMeaningPtrns = array('\[0-7]{1,3}', '\x[0-9A-Fa-f]{1,2}');
-        foreach ($specialMeaningPtrns as $splPtrn) {
-            if (1 === preg_match("/{$splPtrn}/", $string)) {
+        foreach ($specialMeaningPtrns as $splPtrn)
+        {
+            if (1 === preg_match("/{$splPtrn}/", $string))
+            {
                 $hasSpecificSequence = TRUE;
             }
         }

Upper-Lower-Casing +6 added lines, -6 removed lines

@@ -115,7 +115,7 @@ 
 					// $strPtr++;
 				} else if (T_VARIABLE === $strToken[0]) {
 					$variableFound = TRUE;
-					$error = "Variable {$strToken[1]} in double-quoted strings should be enclosed with curly braces. Please consider {{$strToken[1]}}";
+					$error = "variable {$strToken[1]} in double-quoted strings should be enclosed with curly braces. Please consider {{$strToken[1]}}";
 					$phpcsFile->addError($error, $stackPtr);
 				}
 			}
@@ -388,13 +388,13 @@ 
         $has_specific_sequence = $this->_hasSpecificSequence($qtString);
         $dbl_qt_at = strpos($qtString, '"');
         $smpl_qt_at = strpos($qtString, "'");
-        if (false === $has_variable && false === $has_specific_sequence
-            && false === $smpl_qt_at
+        if (FALSE === $has_variable && FALSE === $has_specific_sequence
+            && FALSE === $smpl_qt_at
         ) {
             $error = 'Single-quoted strings should be used unless it contains variables, special chars like \n or single quotes.';
             $phpcsFile->addError($error, $stackPtr);
-        } else if (false !== $smpl_qt_at && false !== $dbl_qt_at
-            && false === $has_variable && false === $has_specific_sequence
+        } else if (FALSE !== $smpl_qt_at && FALSE !== $dbl_qt_at
+            && FALSE === $has_variable && FALSE === $has_specific_sequence
         ) {
             $warning = 'It is encouraged to use a single-quoted string, since it doesn\'t contain any variable nor special char though it mixes single and double quotes.';
             $phpcsFile->addWarning($warning, $stackPtr);
@@ -423,7 +423,7 @@ 
         $has_variable = parent::processSingleQuotedString($phpcsFile, $stackPtr, "'".$qtString."'");
         $dbl_qt_at = strpos($qtString, '"');
         $smpl_qt_at = strpos($qtString, "'");
-        if (false === $has_variable && false !== $smpl_qt_at && false === $dbl_qt_at) {
+        if (FALSE === $has_variable && FALSE !== $smpl_qt_at && FALSE === $dbl_qt_at) {
             $warning = 'You may also use double-quoted strings if the string contains single quotes, so you do not have to use escape characters.';
             $phpcsFile->addWarning($warning, $stackPtr);
         }

build/CodeIgniter/Sniffs/WhiteSpace/LogicalNotSpacingSniff.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +31 added lines, -31 removed lines

@@ -33,41 +33,41 @@
 class LogicalNotSpacingSniff implements Sniff
 {
 
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-            T_BOOLEAN_NOT,
-        );
-    }//end register()
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return array(
+			T_BOOLEAN_NOT,
+		);
+	}//end register()
 
 
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile The current file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
+	/**
+	 * Processes this test, when one of its tokens is encountered.
+	 *
+	 * @param File $phpcsFile The current file being scanned.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+		$tokens = $phpcsFile->getTokens();
 
-        $operator_token = $tokens[$stackPtr];
+		$operator_token = $tokens[$stackPtr];
 
-        $previous_token = $tokens[$stackPtr - 1];
-        $next_token = $tokens[$stackPtr + 1];
-        if (T_WHITESPACE !== $previous_token['code'] || T_WHITESPACE !== $next_token['code']) {
-            $error = 'Logical operator ! should always be preceded and followed with a whitespace.';
-            $phpcsFile->addError($error, $stackPtr);
-        }
-    }//end process()
+		$previous_token = $tokens[$stackPtr - 1];
+		$next_token = $tokens[$stackPtr + 1];
+		if (T_WHITESPACE !== $previous_token['code'] || T_WHITESPACE !== $next_token['code']) {
+			$error = 'Logical operator ! should always be preceded and followed with a whitespace.';
+			$phpcsFile->addError($error, $stackPtr);
+		}
+	}//end process()
 
 
 }//end class

Braces +3 added lines, -3 removed lines

@@ -30,8 +30,7 @@ 
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Files\File;
 
-class LogicalNotSpacingSniff implements Sniff
-{
+class LogicalNotSpacingSniff implements Sniff {
 
     /**
      * Returns an array of tokens this test wants to listen for.
@@ -63,7 +62,8 @@ 
 
         $previous_token = $tokens[$stackPtr - 1];
         $next_token = $tokens[$stackPtr + 1];
-        if (T_WHITESPACE !== $previous_token['code'] || T_WHITESPACE !== $next_token['code']) {
+        if (T_WHITESPACE !== $previous_token['code'] || T_WHITESPACE !== $next_token['code'])
+        {
             $error = 'Logical operator ! should always be preceded and followed with a whitespace.';
             $phpcsFile->addError($error, $stackPtr);
         }

build/CodeIgniter/UnusedSniffs/Files/ClosingLocationCommentSniff.php

Doc Comments +2 added lines, -2 removed lines

@@ -50,7 +50,7 @@ 
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return integer[]
      */
     public function register()
     {
@@ -134,7 +134,7 @@ 
      * application root. Parent directory of the application root are allowed
      * but not mandatory.
      *
-     * @return string|bool The relative path from $appRoot to $filePath, or
+     * @return false|string The relative path from $appRoot to $filePath, or
      * false if $appRoot cannot be found in $filePath.
      */
     private static function _getLocationPath ($filePath, $appRoot)

Indentation +132 added lines, -132 removed lines

@@ -45,138 +45,138 @@
 
 class ClosingLocationCommentSniff extends AbstractClosingCommentSniff
 {
-    public $applicationRoot = '/application/';
-
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-            T_OPEN_TAG
-        );
-
-    }//end register()
-
-
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile The current file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        // We are only interested if this is the first open tag.
-        if ($stackPtr !== 0) {
-            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
-                return;
-            }
-        }
-
-        $filePath = $phpcsFile->getFilename();
-        $tokens = $phpcsFile->getTokens();
-        // removes the application root from the beginning of the file path
-        $locationPath = self::_getLocationPath($filePath, $this->_getAppRoot());
-        // add an error, if application root doesn't exist in current file path
-        if (false === $locationPath) {
-            $error = 'Unable to find "' . $this->_getAppRoot() . '" in file path "' . $filePath . '". Please set your project\'s application root.';
-            $phpcsFile->addError($error, count($tokens) - 1);
-            return;
-        }
-        // generates the expected comment
-        $commentTemplate = "Location: $locationPath";
-
-        $currentToken = count($tokens) - 1;
-        $hasClosingLocationComment = false;
-        $isNotAWhitespaceOrAComment = false;
-        while ($currentToken >= 0
-            && ! $isNotAWhitespaceOrAComment
-            && ! $hasClosingLocationComment
-        ) {
-            $token = $tokens[$currentToken];
-            $tokenCode = $token['code'];
-            if (T_COMMENT === $tokenCode) {
-                $commentString = self::_getCommentContent($token['content']);
-                if (0 === strcmp($commentString, $commentTemplate)) {
-                    $hasClosingLocationComment = true;
-                }
-            } else if (T_WHITESPACE === $tokenCode) {
-                // Whitespaces are allowed between the closing file comment,
-                //other comments and end of file
-            } else {
-                $isNotAWhitespaceOrAComment = true;
-            }
-            $currentToken--;
-        }
-
-        if ( ! $hasClosingLocationComment) {
-            $error = 'No comment block marks the end of file instead of the closing PHP tag. Please add a comment block containing only "' . $commentTemplate . '".';
-            $phpcsFile->addError($error, $currentToken);
-        }
-    }//end process()
-
-
-    /**
-     * Returns the relative path from $appRoot to $filePath, or false if
-     * $appRoot cannot be found in $filePath, because $appRoot is not a parent
-     * of $filePath.
-     *
-     * @param string $filePath Full path to the file being proceed.
-     * @param string $appRoot  Partial or full path to the CodeIgniter
-     * application root of the file being proceed. It must not contain the
-     * full path to the application root, but at least the name of the
-     * application root. Parent directory of the application root are allowed
-     * but not mandatory.
-     *
-     * @return string|bool The relative path from $appRoot to $filePath, or
-     * false if $appRoot cannot be found in $filePath.
-     */
-    private static function _getLocationPath ($filePath, $appRoot)
-    {
-        // removes the path to application root
-        // from the beginning of the file path
-        $appRootAt = strpos($filePath, $appRoot);
-        if (false === $appRootAt) {
-            return false;
-        }
-        $localPath = substr($filePath, $appRootAt + strlen($appRoot));
-        // ensures the location path to be a relative path starting with "./".
-        if ( ! self::_stringStartsWith($localPath, './')) {
-            $localPath = './' . $localPath;
-        } else if ( ! self::_stringStartsWith($localPath, '.')
-            && self::_stringStartsWith($localPath, '/')
-        ) {
-            $localPath = '.' . $localPath;
-        }
-        return $localPath;
-    }//end _getLocationPath()
-
-
-    /**
-     * Returns the application root that should be used first.
-     *
-     * There are several ways to configure the application root.
-     * In order of priority :
-     *   - Configuration variable ci_application_root.
-     *   - Rule property applicationRoot.
-     *   - Default value '/application/'
-     *
-     * @return string Path to your project application root.
-     */
-    private function _getAppRoot()
-    {
-        $appRoot = Common::getConfigData('ci_application_root');
-        if (null === $appRoot) {
-            $appRoot = $this->applicationRoot;
-        }
-        return $appRoot;
-    }//end _getAppRoot()
+	public $applicationRoot = '/application/';
+
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return array(
+			T_OPEN_TAG
+		);
+
+	}//end register()
+
+
+	/**
+	 * Processes this test, when one of its tokens is encountered.
+	 *
+	 * @param File $phpcsFile The current file being scanned.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+		// We are only interested if this is the first open tag.
+		if ($stackPtr !== 0) {
+			if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
+				return;
+			}
+		}
+
+		$filePath = $phpcsFile->getFilename();
+		$tokens = $phpcsFile->getTokens();
+		// removes the application root from the beginning of the file path
+		$locationPath = self::_getLocationPath($filePath, $this->_getAppRoot());
+		// add an error, if application root doesn't exist in current file path
+		if (false === $locationPath) {
+			$error = 'Unable to find "' . $this->_getAppRoot() . '" in file path "' . $filePath . '". Please set your project\'s application root.';
+			$phpcsFile->addError($error, count($tokens) - 1);
+			return;
+		}
+		// generates the expected comment
+		$commentTemplate = "Location: $locationPath";
+
+		$currentToken = count($tokens) - 1;
+		$hasClosingLocationComment = false;
+		$isNotAWhitespaceOrAComment = false;
+		while ($currentToken >= 0
+			&& ! $isNotAWhitespaceOrAComment
+			&& ! $hasClosingLocationComment
+		) {
+			$token = $tokens[$currentToken];
+			$tokenCode = $token['code'];
+			if (T_COMMENT === $tokenCode) {
+				$commentString = self::_getCommentContent($token['content']);
+				if (0 === strcmp($commentString, $commentTemplate)) {
+					$hasClosingLocationComment = true;
+				}
+			} else if (T_WHITESPACE === $tokenCode) {
+				// Whitespaces are allowed between the closing file comment,
+				//other comments and end of file
+			} else {
+				$isNotAWhitespaceOrAComment = true;
+			}
+			$currentToken--;
+		}
+
+		if ( ! $hasClosingLocationComment) {
+			$error = 'No comment block marks the end of file instead of the closing PHP tag. Please add a comment block containing only "' . $commentTemplate . '".';
+			$phpcsFile->addError($error, $currentToken);
+		}
+	}//end process()
+
+
+	/**
+	 * Returns the relative path from $appRoot to $filePath, or false if
+	 * $appRoot cannot be found in $filePath, because $appRoot is not a parent
+	 * of $filePath.
+	 *
+	 * @param string $filePath Full path to the file being proceed.
+	 * @param string $appRoot  Partial or full path to the CodeIgniter
+	 * application root of the file being proceed. It must not contain the
+	 * full path to the application root, but at least the name of the
+	 * application root. Parent directory of the application root are allowed
+	 * but not mandatory.
+	 *
+	 * @return string|bool The relative path from $appRoot to $filePath, or
+	 * false if $appRoot cannot be found in $filePath.
+	 */
+	private static function _getLocationPath ($filePath, $appRoot)
+	{
+		// removes the path to application root
+		// from the beginning of the file path
+		$appRootAt = strpos($filePath, $appRoot);
+		if (false === $appRootAt) {
+			return false;
+		}
+		$localPath = substr($filePath, $appRootAt + strlen($appRoot));
+		// ensures the location path to be a relative path starting with "./".
+		if ( ! self::_stringStartsWith($localPath, './')) {
+			$localPath = './' . $localPath;
+		} else if ( ! self::_stringStartsWith($localPath, '.')
+			&& self::_stringStartsWith($localPath, '/')
+		) {
+			$localPath = '.' . $localPath;
+		}
+		return $localPath;
+	}//end _getLocationPath()
+
+
+	/**
+	 * Returns the application root that should be used first.
+	 *
+	 * There are several ways to configure the application root.
+	 * In order of priority :
+	 *   - Configuration variable ci_application_root.
+	 *   - Rule property applicationRoot.
+	 *   - Default value '/application/'
+	 *
+	 * @return string Path to your project application root.
+	 */
+	private function _getAppRoot()
+	{
+		$appRoot = Common::getConfigData('ci_application_root');
+		if (null === $appRoot) {
+			$appRoot = $this->applicationRoot;
+		}
+		return $appRoot;
+	}//end _getAppRoot()
 }//end class
 
 ?>

Spacing +1 added lines, -1 removed lines

@@ -137,7 +137,7 @@
      * @return string|bool The relative path from $appRoot to $filePath, or
      * false if $appRoot cannot be found in $filePath.
      */
-    private static function _getLocationPath ($filePath, $appRoot)
+    private static function _getLocationPath($filePath, $appRoot)
     {
         // removes the path to application root
         // from the beginning of the file path

Braces +27 added lines, -14 removed lines

@@ -43,8 +43,7 @@ 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Util\Common;
 
-class ClosingLocationCommentSniff extends AbstractClosingCommentSniff
-{
+class ClosingLocationCommentSniff extends AbstractClosingCommentSniff {
     public $applicationRoot = '/application/';
 
     /**
@@ -73,8 +72,10 @@ 
     public function process(File $phpcsFile, $stackPtr)
     {
         // We are only interested if this is the first open tag.
-        if ($stackPtr !== 0) {
-            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
+        if ($stackPtr !== 0)
+        {
+            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false)
+            {
                 return;
             }
         }
@@ -84,7 +85,8 @@ 
         // removes the application root from the beginning of the file path
         $locationPath = self::_getLocationPath($filePath, $this->_getAppRoot());
         // add an error, if application root doesn't exist in current file path
-        if (false === $locationPath) {
+        if (false === $locationPath)
+        {
             $error = 'Unable to find "' . $this->_getAppRoot() . '" in file path "' . $filePath . '". Please set your project\'s application root.';
             $phpcsFile->addError($error, count($tokens) - 1);
             return;
@@ -101,21 +103,28 @@ 
         ) {
             $token = $tokens[$currentToken];
             $tokenCode = $token['code'];
-            if (T_COMMENT === $tokenCode) {
+            if (T_COMMENT === $tokenCode)
+            {
                 $commentString = self::_getCommentContent($token['content']);
-                if (0 === strcmp($commentString, $commentTemplate)) {
+                if (0 === strcmp($commentString, $commentTemplate))
+                {
                     $hasClosingLocationComment = true;
                 }
-            } else if (T_WHITESPACE === $tokenCode) {
+            }
+            else if (T_WHITESPACE === $tokenCode)
+            {
                 // Whitespaces are allowed between the closing file comment,
                 //other comments and end of file
-            } else {
+            }
+            else
+            {
                 $isNotAWhitespaceOrAComment = true;
             }
             $currentToken--;
         }
 
-        if ( ! $hasClosingLocationComment) {
+        if ( ! $hasClosingLocationComment)
+        {
             $error = 'No comment block marks the end of file instead of the closing PHP tag. Please add a comment block containing only "' . $commentTemplate . '".';
             $phpcsFile->addError($error, $currentToken);
         }
@@ -142,14 +151,17 @@ 
         // removes the path to application root
         // from the beginning of the file path
         $appRootAt = strpos($filePath, $appRoot);
-        if (false === $appRootAt) {
+        if (false === $appRootAt)
+        {
             return false;
         }
         $localPath = substr($filePath, $appRootAt + strlen($appRoot));
         // ensures the location path to be a relative path starting with "./".
-        if ( ! self::_stringStartsWith($localPath, './')) {
+        if ( ! self::_stringStartsWith($localPath, './'))
+        {
             $localPath = './' . $localPath;
-        } else if ( ! self::_stringStartsWith($localPath, '.')
+        }
+        else if ( ! self::_stringStartsWith($localPath, '.')
             && self::_stringStartsWith($localPath, '/')
         ) {
             $localPath = '.' . $localPath;
@@ -172,7 +184,8 @@ 
     private function _getAppRoot()
     {
         $appRoot = Common::getConfigData('ci_application_root');
-        if (null === $appRoot) {
+        if (null === $appRoot)
+        {
             $appRoot = $this->applicationRoot;
         }
         return $appRoot;

Upper-Lower-Casing +9 added lines, -9 removed lines

@@ -74,7 +74,7 @@ 
     {
         // We are only interested if this is the first open tag.
         if ($stackPtr !== 0) {
-            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
+            if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== FALSE) {
                 return;
             }
         }
@@ -84,7 +84,7 @@ 
         // removes the application root from the beginning of the file path
         $locationPath = self::_getLocationPath($filePath, $this->_getAppRoot());
         // add an error, if application root doesn't exist in current file path
-        if (false === $locationPath) {
+        if (FALSE === $locationPath) {
             $error = 'Unable to find "' . $this->_getAppRoot() . '" in file path "' . $filePath . '". Please set your project\'s application root.';
             $phpcsFile->addError($error, count($tokens) - 1);
             return;
@@ -93,8 +93,8 @@ 
         $commentTemplate = "Location: $locationPath";
 
         $currentToken = count($tokens) - 1;
-        $hasClosingLocationComment = false;
-        $isNotAWhitespaceOrAComment = false;
+        $hasClosingLocationComment = FALSE;
+        $isNotAWhitespaceOrAComment = FALSE;
         while ($currentToken >= 0
             && ! $isNotAWhitespaceOrAComment
             && ! $hasClosingLocationComment
@@ -104,13 +104,13 @@ 
             if (T_COMMENT === $tokenCode) {
                 $commentString = self::_getCommentContent($token['content']);
                 if (0 === strcmp($commentString, $commentTemplate)) {
-                    $hasClosingLocationComment = true;
+                    $hasClosingLocationComment = TRUE;
                 }
             } else if (T_WHITESPACE === $tokenCode) {
                 // Whitespaces are allowed between the closing file comment,
                 //other comments and end of file
             } else {
-                $isNotAWhitespaceOrAComment = true;
+                $isNotAWhitespaceOrAComment = TRUE;
             }
             $currentToken--;
         }
@@ -142,8 +142,8 @@ 
         // removes the path to application root
         // from the beginning of the file path
         $appRootAt = strpos($filePath, $appRoot);
-        if (false === $appRootAt) {
-            return false;
+        if (FALSE === $appRootAt) {
+            return FALSE;
         }
         $localPath = substr($filePath, $appRootAt + strlen($appRoot));
         // ensures the location path to be a relative path starting with "./".
@@ -172,7 +172,7 @@ 
     private function _getAppRoot()
     {
         $appRoot = Common::getConfigData('ci_application_root');
-        if (null === $appRoot) {
+        if (NULL === $appRoot) {
             $appRoot = $this->applicationRoot;
         }
         return $appRoot;

RoboFile.php

Doc Comments +5 added lines, -1 removed lines

@@ -2,6 +2,10 @@ 
 if ( ! function_exists('glob_recursive'))
 {
 	// Does not support flag GLOB_BRACE
+
+	/**
+	 * @param string $pattern
+	 */
 	function glob_recursive($pattern, $flags = 0)
 	{
 		$files = glob($pattern, $flags);
@@ -320,7 +324,7 @@ 
 	 * Shortcut for joining an array of command arguments
 	 * and then running it
 	 *
-	 * @param array $cmd_parts - command arguments
+	 * @param string[] $cmd_parts - command arguments
 	 * @param string $join_on - what to join the command arguments with
 	 */
 	protected function _run(array $cmd_parts, $join_on = ' ')

Spacing +8 added lines, -8 removed lines

@@ -6,9 +6,9 @@ 
 	{
 		$files = glob($pattern, $flags);
 
-		foreach (glob(dirname($pattern).'/*', GLOB_ONLYDIR|GLOB_NOSORT) as $dir)
+		foreach (glob(dirname($pattern) . '/*', GLOB_ONLYDIR | GLOB_NOSORT) as $dir)
 		{
-			$files = array_merge($files, glob_recursive($dir.'/'.basename($pattern), $flags));
+			$files = array_merge($files, glob_recursive($dir . '/' . basename($pattern), $flags));
 		}
 
 		return $files;
@@ -80,13 +80,13 @@ 
 			'build/humbug.json',
 			'build/humbug-log.txt',
 		];
-		array_map(function ($file) {
+		array_map(function($file) {
 			@unlink($file);
 		}, $cleanFiles);
 
 		// So the task doesn't complain,
 		// make any 'missing' dirs to cleanup
-		array_map(function ($dir) {
+		array_map(function($dir) {
 			if ( ! is_dir($dir))
 			{
 				`mkdir -p {$dir}`;
@@ -130,7 +130,7 @@ 
 
 		$chunks = array_chunk($files, 6);
 
-		foreach($chunks as $chunk)
+		foreach ($chunks as $chunk)
 		{
 			$this->parallelLint($chunk);
 		}
@@ -241,10 +241,10 @@ 
 			->monitor('composer.json', function() {
 				$this->taskComposerUpdate()->run();
 			})
-			->monitor('src', function () {
+			->monitor('src', function() {
 				$this->taskExec('test')->run();
 			})
-			->monitor('tests', function () {
+			->monitor('tests', function() {
 				$this->taskExec('test')->run();
 			})
 			->run();
@@ -295,7 +295,7 @@ 
 			->timeout(5)
 			->printed(FALSE);
 
-		foreach($chunk as $file)
+		foreach ($chunk as $file)
 		{
 			$task = $task->process("php -l {$file}");
 		}

Upper-Lower-Casing +2 added lines, -2 removed lines

@@ -104,7 +104,7 @@ 
 	{
 		$this->taskPhpUnit()
 			->configFile('build/phpunit.xml')
-			->printed(true)
+			->printed(TRUE)
 			->run();
 	}
 
@@ -228,7 +228,7 @@ 
 		$this->lint();
 		$this->taskPHPUnit()
 			->configFile('phpunit.xml')
-			->printed(true)
+			->printed(TRUE)
 			->run();
 	}