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
 

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()
 }

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;

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

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

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
 

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

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
 
 ?>

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 = ' ')