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.

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;

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

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;

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
      *

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;

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

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

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)
 	{

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;
             }
         }

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

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)

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;

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