Inspection of "Update test config to allow hhvm failures" - timw4mail/HummingBirdAnimeClient - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (6d735e)

by Timothy

created 2017-02-07 02:02 UTC

Indentation +16 added lines, -16 removed lines patch added patch discarded remove patch

@@ -20,22 +20,22 @@
 block discarded – undo
  * Base trait for api interaction
  */
 trait GuzzleTrait {
-    /**
-     * The Guzzle http client object
-     * @var object
-     */
-    protected $client;
+	/**
+	 * The Guzzle http client object
+	 * @var object
+	 */
+	protected $client;
 
-    /**
-     * Cookie jar object for api requests
-     * @var object
-     */
-    protected $cookieJar;
+	/**
+	 * Cookie jar object for api requests
+	 * @var object
+	 */
+	protected $cookieJar;
 
-    /**
-     * Set up the class properties
-     *
-     * @return void
-     */
-    abstract protected function init();
+	/**
+	 * Set up the class properties
+	 *
+	 * @return void
+	 */
+	abstract protected function init();
 }
\ No newline at end of file

Please login to merge, or discard this patch.

build/CodeIgniter/UnusedSniffs/Files/ClosingLocationCommentSniff.php 1 patch

Indentation +132 added lines, -132 removed lines patch added patch discarded remove patch

@@ -45,138 +45,138 @@
 block discarded – undo
 
 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
 
 ?>

Please login to merge, or discard this patch.

build/CodeIgniter/UnusedSniffs/Files/AbstractClosingCommentSniff.php 1 patch

Indentation +61 added lines, -61 removed lines patch added patch discarded remove patch

@@ -34,71 +34,71 @@
 block discarded – undo
 
 class AbstractClosingCommentSniff implements Sniff
 {
-    /**
-     * As an abstract class, this sniff is not associated to any token.
-     */
-    public function register()
-    {
-      return array();
-    }
+	/**
+	 * As an abstract class, this sniff is not associated to any token.
+	 */
+	public function register()
+	{
+	  return array();
+	}
 
-    /**
-     * As an abstract class, this sniff is not dedicated to process a token.
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-      $error = __CLASS__.'::'.__METHOD__.' is abstract. Please develop this method in a child class.';
-      throw new PHP_CodeSniffer_Exception($error);
-    }
+	/**
+	 * As an abstract class, this sniff is not dedicated to process a token.
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+	  $error = __CLASS__.'::'.__METHOD__.' is abstract. Please develop this method in a child class.';
+	  throw new PHP_CodeSniffer_Exception($error);
+	}
 
-    /**
-     * Returns the comment without its delimiter(s) as well as leading
-     * and traling whitespaces.
-     *
-     * It removes the first #, the two first / (i.e. //) or the first /*
-     * and last \*\/. If a comment starts with /**, then the last * will remain
-     * as well as whitespaces between this star and the comment content.
-     *
-     * @param string $comment Comment containing either comment delimiter(s) and
-     * trailing or leading whitspaces to clean.
-     *
-     * @return string Comment without comment delimiter(s) and whitespaces.
-     */
-    protected static function _getCommentContent ($comment)
-    {
-        if (self::_stringStartsWith($comment, '#')) {
-            $comment = substr($comment, 1);
-        } else if (self::_stringStartsWith($comment, '//')) {
-            $comment = substr($comment, 2);
-        } else if (self::_stringStartsWith($comment, '/*')) {
-            $comment = substr($comment, 2, strlen($comment) - 2 - 2);
-        }
-        $comment = trim($comment);
-        return $comment;
-    }//_getCommentContent()
+	/**
+	 * Returns the comment without its delimiter(s) as well as leading
+	 * and traling whitespaces.
+	 *
+	 * It removes the first #, the two first / (i.e. //) or the first /*
+	 * and last \*\/. If a comment starts with /**, then the last * will remain
+	 * as well as whitespaces between this star and the comment content.
+	 *
+	 * @param string $comment Comment containing either comment delimiter(s) and
+	 * trailing or leading whitspaces to clean.
+	 *
+	 * @return string Comment without comment delimiter(s) and whitespaces.
+	 */
+	protected static function _getCommentContent ($comment)
+	{
+		if (self::_stringStartsWith($comment, '#')) {
+			$comment = substr($comment, 1);
+		} else if (self::_stringStartsWith($comment, '//')) {
+			$comment = substr($comment, 2);
+		} else if (self::_stringStartsWith($comment, '/*')) {
+			$comment = substr($comment, 2, strlen($comment) - 2 - 2);
+		}
+		$comment = trim($comment);
+		return $comment;
+	}//_getCommentContent()
 
 
-    /**
-     * Binary safe string comparison between $needle and
-     * the beginning of $haystack. Returns true if $haystack starts with
-     * $needle, false otherwise.
-     *
-     * @param string $haystack The string to search in.
-     * @param string $needle   The string to search for.
-     *
-     * @return bool true if $haystack starts with $needle, false otherwise.
-     */
-    protected static function _stringStartsWith ($haystack, $needle)
-    {
-        $startsWith = false;
-        if (strlen($needle) <= strlen($haystack)) {
-            $haystackBeginning = substr($haystack, 0, strlen($needle));
-            if (0 === strcmp($haystackBeginning, $needle)) {
-                $startsWith = true;
-            }
-        }
-        return $startsWith;
-    }//_stringStartsWith()
+	/**
+	 * Binary safe string comparison between $needle and
+	 * the beginning of $haystack. Returns true if $haystack starts with
+	 * $needle, false otherwise.
+	 *
+	 * @param string $haystack The string to search in.
+	 * @param string $needle   The string to search for.
+	 *
+	 * @return bool true if $haystack starts with $needle, false otherwise.
+	 */
+	protected static function _stringStartsWith ($haystack, $needle)
+	{
+		$startsWith = false;
+		if (strlen($needle) <= strlen($haystack)) {
+			$haystackBeginning = substr($haystack, 0, strlen($needle));
+			if (0 === strcmp($haystackBeginning, $needle)) {
+				$startsWith = true;
+			}
+		}
+		return $startsWith;
+	}//_stringStartsWith()
 }//end class
 
 ?>

Please login to merge, or discard this patch.

build/CodeIgniter/UnusedSniffs/Files/ClosingFileCommentSniff.php 1 patch

Indentation +59 added lines, -59 removed lines patch added patch discarded remove patch

@@ -39,71 +39,71 @@
 block discarded – undo
 class ClosingFileCommentSniff extends AbstractClosingCommentSniff
 {
 
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-            T_OPEN_TAG,
-        );
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return array(
+			T_OPEN_TAG,
+		);
 
-    }//end register()
+	}//end register()
 
 
-    /**
-     * Processes this 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;
-            }
-        }
+	/**
+	 * 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;
+			}
+		}
 
-        $fullFilename = $phpcsFile->getFilename();
-        $filename = basename($fullFilename);
-        $commentTemplate = "End of file $filename";
+		$fullFilename = $phpcsFile->getFilename();
+		$filename = basename($fullFilename);
+		$commentTemplate = "End of file $filename";
 
-        $tokens = $phpcsFile->getTokens();
-        $currentToken = count($tokens) - 1;
-        $hasClosingFileComment = false;
-        $isNotAWhitespaceOrAComment = false;
-        while ($currentToken >= 0
-            && ! $isNotAWhitespaceOrAComment
-            && ! $hasClosingFileComment
-        ) {
-            $token = $tokens[$currentToken];
-            $tokenCode = $token['code'];
-            if (T_COMMENT === $tokenCode) {
-                $commentString = self::_getCommentContent($token['content']);
-                if (0 === strcmp($commentString, $commentTemplate)) {
-                    $hasClosingFileComment = true;
-                }
-            } else if (T_WHITESPACE === $tokenCode) {
-                // Whitespaces are allowed between the closing file comment,
-                // other comments and end of file
-            } else {
-                $isNotAWhitespaceOrAComment = true;
-            }
-            $currentToken--;
-        }
+		$tokens = $phpcsFile->getTokens();
+		$currentToken = count($tokens) - 1;
+		$hasClosingFileComment = false;
+		$isNotAWhitespaceOrAComment = false;
+		while ($currentToken >= 0
+			&& ! $isNotAWhitespaceOrAComment
+			&& ! $hasClosingFileComment
+		) {
+			$token = $tokens[$currentToken];
+			$tokenCode = $token['code'];
+			if (T_COMMENT === $tokenCode) {
+				$commentString = self::_getCommentContent($token['content']);
+				if (0 === strcmp($commentString, $commentTemplate)) {
+					$hasClosingFileComment = 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 ( ! $hasClosingFileComment) {
-            $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()
+		if ( ! $hasClosingFileComment) {
+			$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()
 }//end class
 
 ?>

Please login to merge, or discard this patch.

build/CodeIgniter/UnusedSniffs/NamingConventions/ConstructorNameSniff.php 1 patch

Indentation +92 added lines, -92 removed lines patch added patch discarded remove patch

@@ -36,101 +36,101 @@
 block discarded – undo
 {
 
 
-    public $php5Constructors = '1';
-
-
-    /**
-     * Constructs the test with the tokens it wishes to listen for.
-     *
-     * @return void
-     */
-    public function __construct()
-    {
-        parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION), true);
-
-    }//end __construct()
-
-
-    /**
-     * 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.
-     * @param int                  $currScope A pointer to the start of the scope.
-     *
-     * @return void
-     */
-    protected function processTokenWithinScope(
-        File $phpcsFile,
-        $stackPtr,
-        $currScope
-    ) {
-        $methodName = $phpcsFile->getDeclarationName($stackPtr);
-        $className  = $phpcsFile->getDeclarationName($currScope);
+	public $php5Constructors = '1';
+
+
+	/**
+	 * Constructs the test with the tokens it wishes to listen for.
+	 *
+	 * @return void
+	 */
+	public function __construct()
+	{
+		parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION), true);
+
+	}//end __construct()
+
+
+	/**
+	 * 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.
+	 * @param int                  $currScope A pointer to the start of the scope.
+	 *
+	 * @return void
+	 */
+	protected function processTokenWithinScope(
+		File $phpcsFile,
+		$stackPtr,
+		$currScope
+	) {
+		$methodName = $phpcsFile->getDeclarationName($stackPtr);
+		$className  = $phpcsFile->getDeclarationName($currScope);
 
 	$isPhp4Constructor = strcasecmp($methodName, $className) === 0;
 	$isPhp5Constructor = strcasecmp($methodName, '__construct') === 0;
-        if ($this->php5Constructors != '0') {
-            if ($isPhp4Constructor) {
-                $error = "PHP4 style constructors are not allowed; use \"__construct\" instead";
-                $phpcsFile->addError($error, $stackPtr);
-            }
-        } else {
-            if ($isPhp5Constructor) {
-                $error = "PHP5 style constructors are not allowed; use \"$className\" instead";
-                $phpcsFile->addError($error, $stackPtr);
-            }
-        }
-        if ( ! $isPhp4Constructor && ! $isPhp5Constructor ) {
-            return;
-        }
-
-        $tokens = $phpcsFile->getTokens();
-
-        $parentClassName = $phpcsFile->findExtendedClassName($currScope);
-        $wrongConstructor = '';
-        // prepares the error message and wrong constructor
-        if ($this->php5Constructors != '0') {
-            $error = 'PHP4 style calls to parent constructors are not allowed.';
-            $error = "$error Please use \"parent::__construct\" instead.";
-            if (false !== $parentClassName) {
-                $wrongConstructor = $parentClassName;
-            }
-            // Else $wrongConstructor will be empty
-            // and the test expression will always be false.
-            // It doesn't check that no parent method should be called
-            // when no parent class is defined.
-        } else {
-            $error = 'PHP5 style calls to parent constructors are not allowed.';
-            if (false !== $parentClassName) {
-                $error = "$error Please use \"parent::$parentClassName\" instead.";
-            }
-            $wrongConstructor = '__construct';
-        }
-
-        // looks for the use of a wrong constructor.
-        $endFunctionIndex = $tokens[$stackPtr]['scope_closer'];
-        $doubleColonIndex = $phpcsFile->findNext(
-            array(T_DOUBLE_COLON),
-            $stackPtr,
-            $endFunctionIndex
-        );
-        while ($doubleColonIndex) {
-            if ($tokens[($doubleColonIndex + 1)]['code'] === T_STRING
-                && $tokens[($doubleColonIndex + 1)]['content'] === $wrongConstructor
-            ) {
-                $phpcsFile->addError($error, ($doubleColonIndex + 1));
-            }
-
-            $doubleColonIndex = $phpcsFile->findNext(
-                array(T_DOUBLE_COLON),
-                $doubleColonIndex + 1,
-                $endFunctionIndex
-            );
-        }
-
-    }//end processTokenWithinScope()
+		if ($this->php5Constructors != '0') {
+			if ($isPhp4Constructor) {
+				$error = "PHP4 style constructors are not allowed; use \"__construct\" instead";
+				$phpcsFile->addError($error, $stackPtr);
+			}
+		} else {
+			if ($isPhp5Constructor) {
+				$error = "PHP5 style constructors are not allowed; use \"$className\" instead";
+				$phpcsFile->addError($error, $stackPtr);
+			}
+		}
+		if ( ! $isPhp4Constructor && ! $isPhp5Constructor ) {
+			return;
+		}
+
+		$tokens = $phpcsFile->getTokens();
+
+		$parentClassName = $phpcsFile->findExtendedClassName($currScope);
+		$wrongConstructor = '';
+		// prepares the error message and wrong constructor
+		if ($this->php5Constructors != '0') {
+			$error = 'PHP4 style calls to parent constructors are not allowed.';
+			$error = "$error Please use \"parent::__construct\" instead.";
+			if (false !== $parentClassName) {
+				$wrongConstructor = $parentClassName;
+			}
+			// Else $wrongConstructor will be empty
+			// and the test expression will always be false.
+			// It doesn't check that no parent method should be called
+			// when no parent class is defined.
+		} else {
+			$error = 'PHP5 style calls to parent constructors are not allowed.';
+			if (false !== $parentClassName) {
+				$error = "$error Please use \"parent::$parentClassName\" instead.";
+			}
+			$wrongConstructor = '__construct';
+		}
+
+		// looks for the use of a wrong constructor.
+		$endFunctionIndex = $tokens[$stackPtr]['scope_closer'];
+		$doubleColonIndex = $phpcsFile->findNext(
+			array(T_DOUBLE_COLON),
+			$stackPtr,
+			$endFunctionIndex
+		);
+		while ($doubleColonIndex) {
+			if ($tokens[($doubleColonIndex + 1)]['code'] === T_STRING
+				&& $tokens[($doubleColonIndex + 1)]['content'] === $wrongConstructor
+			) {
+				$phpcsFile->addError($error, ($doubleColonIndex + 1));
+			}
+
+			$doubleColonIndex = $phpcsFile->findNext(
+				array(T_DOUBLE_COLON),
+				$doubleColonIndex + 1,
+				$endFunctionIndex
+			);
+		}
+
+	}//end processTokenWithinScope()
 
 	protected function processTokenOutsideScope(File $phpcsFile, $stackPtr)
 	{

Please login to merge, or discard this patch.

build/CodeIgniter/UnusedSniffs/NamingConventions/ValidClassNameSniff.php 1 patch

Indentation +37 added lines, -37 removed lines patch added patch discarded remove patch

@@ -39,45 +39,45 @@
 block discarded – undo
 {
 
 
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-            T_CLASS,
-            T_INTERFACE,
-        );
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return array(
+			T_CLASS,
+			T_INTERFACE,
+		);
 
-    }//end register()
+	}//end register()
 
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile The current file being processed.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        // get the class name
-        $className = trim($phpcsFile->getDeclarationName($stackPtr));
-        // compute the expected class name
-        // [^_] means "something different from _", but not "nothing or something different from _"
-        $lcClassNameChunk = preg_replace('/([^_])([A-Z])/', '${1}_${2}', $className);
-        $expectedClassName
-            = strtoupper($className[0]) . strtolower(substr($lcClassNameChunk,1));
-        // ensures that the current class name
-        // and the expected class name are identical
-        if (0 !== strcmp($className, $expectedClassName)) {
-            $error =  'Class names should always have their first letter uppercase. Multiple words should be separated with an underscore, and not CamelCased. Please consider ' . $expectedClassName . ' instead of ' . $className . '.';
-            $phpcsFile->addError($error, $stackPtr);
-        }
-    }//end process()
+	/**
+	 * Processes this test, when one of its tokens is encountered.
+	 *
+	 * @param File $phpcsFile The current file being processed.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+		// get the class name
+		$className = trim($phpcsFile->getDeclarationName($stackPtr));
+		// compute the expected class name
+		// [^_] means "something different from _", but not "nothing or something different from _"
+		$lcClassNameChunk = preg_replace('/([^_])([A-Z])/', '${1}_${2}', $className);
+		$expectedClassName
+			= strtoupper($className[0]) . strtolower(substr($lcClassNameChunk,1));
+		// ensures that the current class name
+		// and the expected class name are identical
+		if (0 !== strcmp($className, $expectedClassName)) {
+			$error =  'Class names should always have their first letter uppercase. Multiple words should be separated with an underscore, and not CamelCased. Please consider ' . $expectedClassName . ' instead of ' . $className . '.';
+			$phpcsFile->addError($error, $stackPtr);
+		}
+	}//end process()
 
 }//end class
 

Please login to merge, or discard this patch.

build/CodeIgniter/UnusedSniffs/NamingConventions/ValidVariableNameSniff.php 1 patch

Indentation +494 added lines, -494 removed lines patch added patch discarded remove patch

@@ -44,519 +44,519 @@
 block discarded – undo
 {
 
 
-    /**
-     * Processes class member variables.
-     *
-     * @param File $phpcsFile The file being scanned.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return void
-     */
-    protected function processMemberVar(File $phpcsFile, $stackPtr)
-    {
-        // get variable name and properties
-        $tokens = $phpcsFile->getTokens();
-        $varTk = $tokens[$stackPtr];
-        $varName = substr($varTk['content'], 1);
-        $varProps = $phpcsFile->getMemberProperties($stackPtr);
-        // check(s)
-        if ( ! $this->checkLowerCase($phpcsFile, $stackPtr, $varName) ) {
-            return;
-        }
-        if ( ! $this->checkVisibilityPrefix($phpcsFile, $stackPtr, $varName, $varProps)) {
-            return;
-        }
-        if ( ! $this->checkLength($phpcsFile, $stackPtr, $varName)) {
-            return;
-        }
+	/**
+	 * Processes class member variables.
+	 *
+	 * @param File $phpcsFile The file being scanned.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	protected function processMemberVar(File $phpcsFile, $stackPtr)
+	{
+		// get variable name and properties
+		$tokens = $phpcsFile->getTokens();
+		$varTk = $tokens[$stackPtr];
+		$varName = substr($varTk['content'], 1);
+		$varProps = $phpcsFile->getMemberProperties($stackPtr);
+		// check(s)
+		if ( ! $this->checkLowerCase($phpcsFile, $stackPtr, $varName) ) {
+			return;
+		}
+		if ( ! $this->checkVisibilityPrefix($phpcsFile, $stackPtr, $varName, $varProps)) {
+			return;
+		}
+		if ( ! $this->checkLength($phpcsFile, $stackPtr, $varName)) {
+			return;
+		}
 
-    }//end processMemberVar()
+	}//end processMemberVar()
 
 
-    /**
-     * Processes normal variables.
-     *
-     * @param File $phpcsFile The file where this token was found.
-     * @param int                  $stackPtr  The position where the token was found.
-     *
-     * @return void
-     */
-    protected function processVariable(File $phpcsFile, $stackPtr)
-    {
-        // get variable name
-        $tokens = $phpcsFile->getTokens();
-        $varTk = $tokens[$stackPtr];
-        $varName = substr($varTk['content'], 1);
-        // skip the current object variable, i.e. $this
-        if (0 === strcmp($varName, 'this')) {
-            return;
-        }
-        // check(s)
-        if ( ! $this->checkLowerCase($phpcsFile, $stackPtr, $varName)) {
-            return;
-        }
-        if ( ! $this->checkLength($phpcsFile, $stackPtr, $varName)) {
-            return;
-        }
+	/**
+	 * Processes normal variables.
+	 *
+	 * @param File $phpcsFile The file where this token was found.
+	 * @param int                  $stackPtr  The position where the token was found.
+	 *
+	 * @return void
+	 */
+	protected function processVariable(File $phpcsFile, $stackPtr)
+	{
+		// get variable name
+		$tokens = $phpcsFile->getTokens();
+		$varTk = $tokens[$stackPtr];
+		$varName = substr($varTk['content'], 1);
+		// skip the current object variable, i.e. $this
+		if (0 === strcmp($varName, 'this')) {
+			return;
+		}
+		// check(s)
+		if ( ! $this->checkLowerCase($phpcsFile, $stackPtr, $varName)) {
+			return;
+		}
+		if ( ! $this->checkLength($phpcsFile, $stackPtr, $varName)) {
+			return;
+		}
 
-    }//end processVariable()
+	}//end processVariable()
 
 
-    /**
-     * Processes variables in double quoted strings.
-     *
-     * @param File $phpcsFile The file where this token was found.
-     * @param int                  $stackPtr  The position where the token was found.
-     *
-     * @return void
-     */
-    protected function processVariableInString(File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-        $stringTk = $tokens[$stackPtr];
-        $stringString = $stringTk['content'];
-        $varAt = self::_getVariablePosition($stringString, 0);
-        while (false !== $varAt) {
-            // get variable name
-            $matches = array();
-            preg_match('/^\$\{?([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)\}?/', substr($stringString, $varAt), $matches);
-            $varName = $matches[1];
-            // check(s)
-            if ( ! $this->checkLowerCase($phpcsFile, $stackPtr, $varName)) {
-                return;
-            }
-            if ( ! $this->checkLength($phpcsFile, $stackPtr, $varName)) {
-                return;
-            }
-            // prepare checking next variable
-            $varAt = self::_getVariablePosition($stringString, $varAt + 1);
-        }
+	/**
+	 * Processes variables in double quoted strings.
+	 *
+	 * @param File $phpcsFile The file where this token was found.
+	 * @param int                  $stackPtr  The position where the token was found.
+	 *
+	 * @return void
+	 */
+	protected function processVariableInString(File $phpcsFile, $stackPtr)
+	{
+		$tokens = $phpcsFile->getTokens();
+		$stringTk = $tokens[$stackPtr];
+		$stringString = $stringTk['content'];
+		$varAt = self::_getVariablePosition($stringString, 0);
+		while (false !== $varAt) {
+			// get variable name
+			$matches = array();
+			preg_match('/^\$\{?([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)\}?/', substr($stringString, $varAt), $matches);
+			$varName = $matches[1];
+			// check(s)
+			if ( ! $this->checkLowerCase($phpcsFile, $stackPtr, $varName)) {
+				return;
+			}
+			if ( ! $this->checkLength($phpcsFile, $stackPtr, $varName)) {
+				return;
+			}
+			// prepare checking next variable
+			$varAt = self::_getVariablePosition($stringString, $varAt + 1);
+		}
 
-    }//end processVariableInString()
+	}//end processVariableInString()
 
 
-    /**
-     * Checks that the variable name is all in lower case, else it add an error
-     * to $phpcsFile. Returns true if variable name is all in lower case, false
-     * otherwise.
-     *
-     * @param File $phpcsFile The current file being processed.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     * @param string               $varName   The name of the variable to
-     *                                        procced without $, { nor }.
-     *
-     * @return bool true if variable name is all in lower case, false otherwise.
-     */
-    protected function checkLowerCase(File $phpcsFile, $stackPtr, $varName)
-    {
-        $isInLowerCase = true;
-        if (0 !== strcmp($varName, strtolower($varName))) {
-            // get the expected variable name
-            $varNameWithUnderscores = preg_replace('/([A-Z])/', '_${1}', $varName);
-            $expectedVarName = strtolower(ltrim($varNameWithUnderscores, '_'));
-            // adapts the error message to the error case
-            if (strlen($varNameWithUnderscores) > strlen($varName)) {
-                $error = 'Variables should not use CamelCasing or start with a Capital.';
-            } else {
-                $error = 'Variables should be entirely lowercased.';
-            }
-            $error = $error . 'Please consider "' . $expectedVarName
-                . '" instead of "' . $varName . '".';
-            // adds the error and changes return value
-            $phpcsFile->addError($error, $stackPtr);
-            $isInLowerCase = false;
-        }
-        return $isInLowerCase;
-    }//end checkLowerCase()
+	/**
+	 * Checks that the variable name is all in lower case, else it add an error
+	 * to $phpcsFile. Returns true if variable name is all in lower case, false
+	 * otherwise.
+	 *
+	 * @param File $phpcsFile The current file being processed.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 * @param string               $varName   The name of the variable to
+	 *                                        procced without $, { nor }.
+	 *
+	 * @return bool true if variable name is all in lower case, false otherwise.
+	 */
+	protected function checkLowerCase(File $phpcsFile, $stackPtr, $varName)
+	{
+		$isInLowerCase = true;
+		if (0 !== strcmp($varName, strtolower($varName))) {
+			// get the expected variable name
+			$varNameWithUnderscores = preg_replace('/([A-Z])/', '_${1}', $varName);
+			$expectedVarName = strtolower(ltrim($varNameWithUnderscores, '_'));
+			// adapts the error message to the error case
+			if (strlen($varNameWithUnderscores) > strlen($varName)) {
+				$error = 'Variables should not use CamelCasing or start with a Capital.';
+			} else {
+				$error = 'Variables should be entirely lowercased.';
+			}
+			$error = $error . 'Please consider "' . $expectedVarName
+				. '" instead of "' . $varName . '".';
+			// adds the error and changes return value
+			$phpcsFile->addError($error, $stackPtr);
+			$isInLowerCase = false;
+		}
+		return $isInLowerCase;
+	}//end checkLowerCase()
 
-    /**
-     * Checks that an underscore is used at the beginning of a variable only if
-     * it is about a private variable. If it isn't a private variable, then it
-     * must not be prefixed with an underscore. Returns true if $varName is
-     * properly prefixed according to the variable visibility provided in
-     * $varProps, false otherwise.
-     *
-     * @param File $phpcsFile The current file being processed.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     * @param string               $varName   The name of the variable to
-     *                                        procced without $, { nor }.
-     * @param array                $varProps  Member variable properties like
-     *                                        its visibility.
-     *
-     * @return bool true if variable name is prefixed with an underscore only
-     * when it is about a private variable, false otherwise.
-     */
-    protected function checkVisibilityPrefix(File $phpcsFile, $stackPtr, $varName, $varProps)
-    {
-        $isVisibilityPrefixRight = true;
-        $scope = $varProps['scope'];
-        // If it's a private variable, it must have an underscore on the front.
-        if ($scope === 'private' && $varName{0} !== '_') {
-            $error = "Private variable name \"$varName\" must be prefixed with an underscore";
-            $phpcsFile->addError($error, $stackPtr);
-            $isVisibilityPrefixRight = false;
-        } else if ($scope !== 'private' && $varName{0} === '_') {
-            // If it's not a private variable,
-            // then it must not start with an underscore.
-            if (isset ($scopeSpecified) && true === $scopeSpecified) {
-                $error = "Public variable name \"$varName\" must not be prefixed with an underscore";
-            } else {
-                $error = ucfirst($scope) . " variable name \"$varName\" must not be prefixed with an underscore";
-            }
-            $phpcsFile->addError($error, $stackPtr);
-            $isVisibilityPrefixRight = false;
-        }
-        return $isVisibilityPrefixRight;
-    }//end checkVisibilityPrefix()
+	/**
+	 * Checks that an underscore is used at the beginning of a variable only if
+	 * it is about a private variable. If it isn't a private variable, then it
+	 * must not be prefixed with an underscore. Returns true if $varName is
+	 * properly prefixed according to the variable visibility provided in
+	 * $varProps, false otherwise.
+	 *
+	 * @param File $phpcsFile The current file being processed.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 * @param string               $varName   The name of the variable to
+	 *                                        procced without $, { nor }.
+	 * @param array                $varProps  Member variable properties like
+	 *                                        its visibility.
+	 *
+	 * @return bool true if variable name is prefixed with an underscore only
+	 * when it is about a private variable, false otherwise.
+	 */
+	protected function checkVisibilityPrefix(File $phpcsFile, $stackPtr, $varName, $varProps)
+	{
+		$isVisibilityPrefixRight = true;
+		$scope = $varProps['scope'];
+		// If it's a private variable, it must have an underscore on the front.
+		if ($scope === 'private' && $varName{0} !== '_') {
+			$error = "Private variable name \"$varName\" must be prefixed with an underscore";
+			$phpcsFile->addError($error, $stackPtr);
+			$isVisibilityPrefixRight = false;
+		} else if ($scope !== 'private' && $varName{0} === '_') {
+			// If it's not a private variable,
+			// then it must not start with an underscore.
+			if (isset ($scopeSpecified) && true === $scopeSpecified) {
+				$error = "Public variable name \"$varName\" must not be prefixed with an underscore";
+			} else {
+				$error = ucfirst($scope) . " variable name \"$varName\" must not be prefixed with an underscore";
+			}
+			$phpcsFile->addError($error, $stackPtr);
+			$isVisibilityPrefixRight = false;
+		}
+		return $isVisibilityPrefixRight;
+	}//end checkVisibilityPrefix()
 
-    /**
-     * Checks that variable name length is not too short. Returns true, if it
-     * meets minimum length requirement, false otherwise.
-     *
-     * A variable name is too short if it is shorter than the minimal
-     * length and it isn't in the list of allowed short names nor declared in a
-     * for loop (in which it would be nested).
-     * The minimal length is defined in the function. It is 3 chars now.
-     * The list of allowed short names is defined in the function.
-     * It is case-sensitive. It contains only 'ci' now.
-     *
-     * @param File $phpcsFile The current file being processed.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     * @param string               $varName   The name of the variable to
-     *                                        procced without $, { nor }.
-     *
-     * @return bool false if variable name $varName is shorter than the minimal
-     * length and it isn't in the list of allowed short names nor declared in a
-     * for loop (in which it would be nested), otherwise true.
-     */
-    protected function checkLength(File $phpcsFile, $stackPtr, $varName)
-    {
-        $minLength = 3;
-        $allowedShortName = array('ci');
+	/**
+	 * Checks that variable name length is not too short. Returns true, if it
+	 * meets minimum length requirement, false otherwise.
+	 *
+	 * A variable name is too short if it is shorter than the minimal
+	 * length and it isn't in the list of allowed short names nor declared in a
+	 * for loop (in which it would be nested).
+	 * The minimal length is defined in the function. It is 3 chars now.
+	 * The list of allowed short names is defined in the function.
+	 * It is case-sensitive. It contains only 'ci' now.
+	 *
+	 * @param File $phpcsFile The current file being processed.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 * @param string               $varName   The name of the variable to
+	 *                                        procced without $, { nor }.
+	 *
+	 * @return bool false if variable name $varName is shorter than the minimal
+	 * length and it isn't in the list of allowed short names nor declared in a
+	 * for loop (in which it would be nested), otherwise true.
+	 */
+	protected function checkLength(File $phpcsFile, $stackPtr, $varName)
+	{
+		$minLength = 3;
+		$allowedShortName = array('ci');
 
-        $isLengthRight = true;
-        // cleans variable name
-        $varName = ltrim($varName, '_');
-        if (strlen($varName) <= $minLength) {
-            // skips adding an error, if it is a specific variable name
-            if (in_array($varName, $allowedShortName)) {
-                return $isLengthRight;
-            }
-            // skips adding an error, if the variable is in a for loop
-            if (false !== self::_isInForLoop($phpcsFile, $stackPtr, $varName)) {
-                return $isLengthRight;
-            }
-            // adds the error message finally
-            $error = 'Very short'
-                . (
-                    $minLength > 0 ?
-                    ' (i.e. less than ' . ($minLength + 1) . ' chars)'
-                    : ''
-                )
-                . ', non-word variables like "' . $varName
-                . '" should only be used as iterators in for() loops.';
-            $phpcsFile->addError($error, $stackPtr);
-            $isLengthRight = false;
-        }
-        return $isLengthRight;
-    }//end checkLength()
+		$isLengthRight = true;
+		// cleans variable name
+		$varName = ltrim($varName, '_');
+		if (strlen($varName) <= $minLength) {
+			// skips adding an error, if it is a specific variable name
+			if (in_array($varName, $allowedShortName)) {
+				return $isLengthRight;
+			}
+			// skips adding an error, if the variable is in a for loop
+			if (false !== self::_isInForLoop($phpcsFile, $stackPtr, $varName)) {
+				return $isLengthRight;
+			}
+			// adds the error message finally
+			$error = 'Very short'
+				. (
+					$minLength > 0 ?
+					' (i.e. less than ' . ($minLength + 1) . ' chars)'
+					: ''
+				)
+				. ', non-word variables like "' . $varName
+				. '" should only be used as iterators in for() loops.';
+			$phpcsFile->addError($error, $stackPtr);
+			$isLengthRight = false;
+		}
+		return $isLengthRight;
+	}//end checkLength()
 
-    /**
-     * Returns the position of closest previous T_FOR, if token associated with
-     * $stackPtr in $phpcsFile is in a for loop, otherwise false.
-     *
-     * @param File $phpcsFile The current file being processed.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     * @param string               $varName   The name of the variable to
-     *                                        procced without $, { nor }.
-     *
-     * @return int|bool Position of T_FOR if token associated with $stackPtr in
-     *                  $phpcsFile is in the head of a for loop, otherwise false.
-     */
-    private static function _isInForLoop(File $phpcsFile, $stackPtr, $varName)
-    {
-        $keepLookingFromPtr = $stackPtr;
-        while (false !== $keepLookingFromPtr) {
-            // looks if it is in (head or body) of a for loop
-            $forPtr = self::_isInForLoopHead($phpcsFile, $keepLookingFromPtr);
-            if (false === $forPtr) {
-                $forPtr = self::_isInForLoopBody($phpcsFile, $keepLookingFromPtr);
-            }
-            // checks if it is declared in here and prepares next step
-            if (false !== $forPtr) {
-                if (false !== self::_isDeclaredInForLoop($phpcsFile, $forPtr, $varName)) {
-                    return $forPtr;
-                }
-                $keepLookingFromPtr = $forPtr;
-            } else {
-                $keepLookingFromPtr = false;
-            }
-        }
-        return false;
-    }//end _isInForLoop()
+	/**
+	 * Returns the position of closest previous T_FOR, if token associated with
+	 * $stackPtr in $phpcsFile is in a for loop, otherwise false.
+	 *
+	 * @param File $phpcsFile The current file being processed.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 * @param string               $varName   The name of the variable to
+	 *                                        procced without $, { nor }.
+	 *
+	 * @return int|bool Position of T_FOR if token associated with $stackPtr in
+	 *                  $phpcsFile is in the head of a for loop, otherwise false.
+	 */
+	private static function _isInForLoop(File $phpcsFile, $stackPtr, $varName)
+	{
+		$keepLookingFromPtr = $stackPtr;
+		while (false !== $keepLookingFromPtr) {
+			// looks if it is in (head or body) of a for loop
+			$forPtr = self::_isInForLoopHead($phpcsFile, $keepLookingFromPtr);
+			if (false === $forPtr) {
+				$forPtr = self::_isInForLoopBody($phpcsFile, $keepLookingFromPtr);
+			}
+			// checks if it is declared in here and prepares next step
+			if (false !== $forPtr) {
+				if (false !== self::_isDeclaredInForLoop($phpcsFile, $forPtr, $varName)) {
+					return $forPtr;
+				}
+				$keepLookingFromPtr = $forPtr;
+			} else {
+				$keepLookingFromPtr = false;
+			}
+		}
+		return false;
+	}//end _isInForLoop()
 
-    /**
-     * Returns the position of closest previous T_FOR, if token associated with
-     * $stackPtr in $phpcsFile is in the head of a for loop, otherwise false.
-     * The head is the code placed between parenthesis next to the key word
-     * 'for' : for (<loop_head>) {<loop_body>}.
-     *
-     * @param File $phpcsFile The current file being processed.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return int|bool Position of T_FOR if token associated with $stackPtr in
-     *                  $phpcsFile is in the head of a for loop, otherwise false.
-     */
-    private static function _isInForLoopHead(File $phpcsFile, $stackPtr)
-    {
-        $isInForLoop = false;
-        $tokens = $phpcsFile->getTokens();
-        $currentTk = $tokens[$stackPtr];
-        if (array_key_exists('nested_parenthesis', $currentTk)) {
-            $nestedParenthesis = $currentTk['nested_parenthesis'];
-            foreach ( $nestedParenthesis as $openParPtr => $closeParPtr) {
-                $nonWhitspacePtr = $phpcsFile->findPrevious(
-                    array(T_WHITESPACE),
-                    $openParPtr - 1,
-                    null,
-                    true,
-                    null,
-                    true
-                );
-                if (false !== $nonWhitspacePtr) {
-                    $isFor = T_FOR === $tokens[$nonWhitspacePtr]['code'];
-                    if ($isFor) {
-                        $isInForLoop = $nonWhitspacePtr;
-                        break;
-                    }
-                }
-            }
-        }
-        return $isInForLoop;
-    }//end _isInForLoopHead()
+	/**
+	 * Returns the position of closest previous T_FOR, if token associated with
+	 * $stackPtr in $phpcsFile is in the head of a for loop, otherwise false.
+	 * The head is the code placed between parenthesis next to the key word
+	 * 'for' : for (<loop_head>) {<loop_body>}.
+	 *
+	 * @param File $phpcsFile The current file being processed.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 *
+	 * @return int|bool Position of T_FOR if token associated with $stackPtr in
+	 *                  $phpcsFile is in the head of a for loop, otherwise false.
+	 */
+	private static function _isInForLoopHead(File $phpcsFile, $stackPtr)
+	{
+		$isInForLoop = false;
+		$tokens = $phpcsFile->getTokens();
+		$currentTk = $tokens[$stackPtr];
+		if (array_key_exists('nested_parenthesis', $currentTk)) {
+			$nestedParenthesis = $currentTk['nested_parenthesis'];
+			foreach ( $nestedParenthesis as $openParPtr => $closeParPtr) {
+				$nonWhitspacePtr = $phpcsFile->findPrevious(
+					array(T_WHITESPACE),
+					$openParPtr - 1,
+					null,
+					true,
+					null,
+					true
+				);
+				if (false !== $nonWhitspacePtr) {
+					$isFor = T_FOR === $tokens[$nonWhitspacePtr]['code'];
+					if ($isFor) {
+						$isInForLoop = $nonWhitspacePtr;
+						break;
+					}
+				}
+			}
+		}
+		return $isInForLoop;
+	}//end _isInForLoopHead()
 
-    /**
-     * Returns the position of closest previous T_FOR, if token associated with
-     * $stackPtr in $phpcsFile is in the body of a for loop, otherwise false.
-     * The body are the instructions placed after parenthesis of a 'for'
-     * declaration, enclosed with curly brackets usually.
-     * 'for' : for (<loop_head>) {<loop_body>}.
-     *
-     * @param File $phpcsFile The current file being processed.
-     * @param int                  $stackPtr  The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return int|bool Position of T_FOR if token associated with $stackPtr in
-     *                  $phpcsFile is in the body of a for loop, otherwise false.
-     */
-    private static function _isInForLoopBody(File $phpcsFile, $stackPtr)
-    {
-        $isInForLoop = false;
-        $tokens = $phpcsFile->getTokens();
-        // get englobing hierarchy
-        $parentPtrAndCode = $tokens[$stackPtr]['conditions'];
-        krsort($parentPtrAndCode);
+	/**
+	 * Returns the position of closest previous T_FOR, if token associated with
+	 * $stackPtr in $phpcsFile is in the body of a for loop, otherwise false.
+	 * The body are the instructions placed after parenthesis of a 'for'
+	 * declaration, enclosed with curly brackets usually.
+	 * 'for' : for (<loop_head>) {<loop_body>}.
+	 *
+	 * @param File $phpcsFile The current file being processed.
+	 * @param int                  $stackPtr  The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 *
+	 * @return int|bool Position of T_FOR if token associated with $stackPtr in
+	 *                  $phpcsFile is in the body of a for loop, otherwise false.
+	 */
+	private static function _isInForLoopBody(File $phpcsFile, $stackPtr)
+	{
+		$isInForLoop = false;
+		$tokens = $phpcsFile->getTokens();
+		// get englobing hierarchy
+		$parentPtrAndCode = $tokens[$stackPtr]['conditions'];
+		krsort($parentPtrAndCode);
 
-        // looks for a for loop having a body not enclosed with curly brackets,
-        // which involves that its body contains only one instruction.
-        if (is_array($parentPtrAndCode) && ! empty($parentPtrAndCode)) {
-            $parentCode = reset($parentPtrAndCode);
-            $parentPtr = key($parentPtrAndCode);
-            $openBracketPtr = $tokens[$parentPtr]['scope_opener'];
-        } else {
-            $parentCode = 0;
-            $parentPtr = 0;
-            $openBracketPtr = 0;
-        }
-        $openResearchScopePtr = $stackPtr;
-        // recursive search, since a for statement may englobe other inline
-        // control statement or may be near to function calls, etc...
-        while (false !== $openResearchScopePtr) {
-            $closeParPtr = $phpcsFile->findPrevious(
-                array(T_CLOSE_PARENTHESIS),
-                $openResearchScopePtr,
-                null,
-                false,
-                null,
-                true
-            );
-            // is there a closing parenthesis with a control statement before
-            // the previous instruction ?
-            if (false !== $closeParPtr) {
-                // is there no opening curly bracket specific to
-                // set of instructions, between the closing parenthesis
-                // and the current token ?
-                if ($openBracketPtr < $closeParPtr) {
-                    // starts the search from the token before the closing
-                    // parenthesis, if it isn't a for statement
-                    $openResearchScopePtr = $closeParPtr - 1;
-                    // is this parenthesis associated with a for statement ?
-                    $closeParenthesisTk = $tokens[$closeParPtr];
-                    if (array_key_exists('parenthesis_owner', $closeParenthesisTk)) {
-                        $mayBeForPtr = $closeParenthesisTk['parenthesis_owner'];
-                        $mayBeForTk = $tokens[$mayBeForPtr];
-                        if (T_FOR === $mayBeForTk['code']) {
-                            return $mayBeForPtr;
-                        }
-                    }
-                } else {
-                    // if it is about a for loop, don't go further
-                    // and detect it after one more loop execution, do it now
-                    if (T_FOR === $parentCode) {
-                        return $parentPtr;
-                    }
-                    // starts the search from the token before the one
-                    // englobing the current statement
-                    $openResearchScopePtr = $parentPtr - 1;
-                    // re-initialize variables about the englobing structure
-                    if (is_array($parentPtrAndCode)) {
-                        $parentCode = next($parentPtrAndCode);
-                        $parentPtr = key($parentPtrAndCode);
-                        $openBracketPtr = $tokens[$parentPtr]['scope_opener'];
-                    }
-                }
-            } else {
-                $openResearchScopePtr = false;
-            }
-        }
-        // looks for a for loop having a body enclosed with curly brackets
-        foreach ($parentPtrAndCode as $parentPtr => $parentCode) {
-            if (T_FOR === $parentCode) {
-                return $parentPtr;
-            }
-        }
-        return false;
-    }//end _isInForLoopBody()
+		// looks for a for loop having a body not enclosed with curly brackets,
+		// which involves that its body contains only one instruction.
+		if (is_array($parentPtrAndCode) && ! empty($parentPtrAndCode)) {
+			$parentCode = reset($parentPtrAndCode);
+			$parentPtr = key($parentPtrAndCode);
+			$openBracketPtr = $tokens[$parentPtr]['scope_opener'];
+		} else {
+			$parentCode = 0;
+			$parentPtr = 0;
+			$openBracketPtr = 0;
+		}
+		$openResearchScopePtr = $stackPtr;
+		// recursive search, since a for statement may englobe other inline
+		// control statement or may be near to function calls, etc...
+		while (false !== $openResearchScopePtr) {
+			$closeParPtr = $phpcsFile->findPrevious(
+				array(T_CLOSE_PARENTHESIS),
+				$openResearchScopePtr,
+				null,
+				false,
+				null,
+				true
+			);
+			// is there a closing parenthesis with a control statement before
+			// the previous instruction ?
+			if (false !== $closeParPtr) {
+				// is there no opening curly bracket specific to
+				// set of instructions, between the closing parenthesis
+				// and the current token ?
+				if ($openBracketPtr < $closeParPtr) {
+					// starts the search from the token before the closing
+					// parenthesis, if it isn't a for statement
+					$openResearchScopePtr = $closeParPtr - 1;
+					// is this parenthesis associated with a for statement ?
+					$closeParenthesisTk = $tokens[$closeParPtr];
+					if (array_key_exists('parenthesis_owner', $closeParenthesisTk)) {
+						$mayBeForPtr = $closeParenthesisTk['parenthesis_owner'];
+						$mayBeForTk = $tokens[$mayBeForPtr];
+						if (T_FOR === $mayBeForTk['code']) {
+							return $mayBeForPtr;
+						}
+					}
+				} else {
+					// if it is about a for loop, don't go further
+					// and detect it after one more loop execution, do it now
+					if (T_FOR === $parentCode) {
+						return $parentPtr;
+					}
+					// starts the search from the token before the one
+					// englobing the current statement
+					$openResearchScopePtr = $parentPtr - 1;
+					// re-initialize variables about the englobing structure
+					if (is_array($parentPtrAndCode)) {
+						$parentCode = next($parentPtrAndCode);
+						$parentPtr = key($parentPtrAndCode);
+						$openBracketPtr = $tokens[$parentPtr]['scope_opener'];
+					}
+				}
+			} else {
+				$openResearchScopePtr = false;
+			}
+		}
+		// looks for a for loop having a body enclosed with curly brackets
+		foreach ($parentPtrAndCode as $parentPtr => $parentCode) {
+			if (T_FOR === $parentCode) {
+				return $parentPtr;
+			}
+		}
+		return false;
+	}//end _isInForLoopBody()
 
-    /**
-     * Returns true if a variable declared in the head of the for loop pointed
-     * by $forPtr in file $phpcsFile has the name $varName.
-     *
-     * @param File $phpcsFile The current file being processed.
-     * @param int                  $forPtr    The position of the 'for' token
-     *                                        in the stack passed in $tokens.
-     * @param string               $varName   The name of the variable to
-     *                                        procced without $, { nor }.
-     *
-     * @return int|bool true if a variable declared in the head of the for loop
-     * pointed by $forPtr in file $phpcsFile has the name $varName.
-     */
-    private static function _isDeclaredInForLoop(File $phpcsFile, $forPtr, $varName)
-    {
-        $isDeclaredInFor = false;
-        $tokens = $phpcsFile->getTokens();
-        $forVarPtrs = self::_getVarDeclaredInFor($phpcsFile, $forPtr);
-        foreach ($forVarPtrs as $forVarPtr) {
-            $forVarTk = $tokens[$forVarPtr];
-            // get variable name
-            $matches = array();
-            preg_match('/^\$\{?([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)\}?/', $forVarTk['content'], $matches);
-            $forVarName = $matches[1];
-            if (0 === strcmp($forVarName, $varName)) {
-                $isDeclaredInFor = $forVarPtr;
-                break;
-            }
-        }
-        return $isDeclaredInFor;
-    }//end _isDeclaredInForLoop()
+	/**
+	 * Returns true if a variable declared in the head of the for loop pointed
+	 * by $forPtr in file $phpcsFile has the name $varName.
+	 *
+	 * @param File $phpcsFile The current file being processed.
+	 * @param int                  $forPtr    The position of the 'for' token
+	 *                                        in the stack passed in $tokens.
+	 * @param string               $varName   The name of the variable to
+	 *                                        procced without $, { nor }.
+	 *
+	 * @return int|bool true if a variable declared in the head of the for loop
+	 * pointed by $forPtr in file $phpcsFile has the name $varName.
+	 */
+	private static function _isDeclaredInForLoop(File $phpcsFile, $forPtr, $varName)
+	{
+		$isDeclaredInFor = false;
+		$tokens = $phpcsFile->getTokens();
+		$forVarPtrs = self::_getVarDeclaredInFor($phpcsFile, $forPtr);
+		foreach ($forVarPtrs as $forVarPtr) {
+			$forVarTk = $tokens[$forVarPtr];
+			// get variable name
+			$matches = array();
+			preg_match('/^\$\{?([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)\}?/', $forVarTk['content'], $matches);
+			$forVarName = $matches[1];
+			if (0 === strcmp($forVarName, $varName)) {
+				$isDeclaredInFor = $forVarPtr;
+				break;
+			}
+		}
+		return $isDeclaredInFor;
+	}//end _isDeclaredInForLoop()
 
-    /**
-     * Returns list of pointers to variables declared in for loop associated to
-     * $forPtr in file $phpcsFile.
-     *
-     * All pointers in the result list are pointing to token with code
-     * T_VARIABLE. An exception is raised, if $forPtr doesn't point a token with
-     * code T_FOR.
-     *
-     * @param File $phpcsFile The current file being processed.
-     * @param int                  $forPtr    The position of the current token
-     *                                        in the stack passed in $tokens.
-     *
-     * @return array List of pointers to variables declared in for loop $forPtr.
-     */
-    private static function _getVarDeclaredInFor(File $phpcsFile, $forPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-        $forTk = $tokens[$forPtr];
-        if (T_FOR !== $forTk['code']) {
-            throw new PHP_CodeSniffer_Exception('$forPtr must be of type T_FOR');
-        }
-        $openParPtr = $forTk['parenthesis_opener'];
-        $openParenthesisTk = $tokens[$openParPtr];
-        $endOfDeclPtr = $phpcsFile->findNext(array(T_SEMICOLON), $openParPtr);
-        $forVarPtrs = array();
-        $varPtr = $phpcsFile->findNext(
-            array(T_VARIABLE),
-            $openParPtr + 1,
-            $endOfDeclPtr
-        );
-        while (false !== $varPtr) {
-            $forVarPtrs [] = $varPtr;
-            $varPtr = $phpcsFile->findNext(
-                array(T_VARIABLE),
-                $varPtr + 1,
-                $endOfDeclPtr
-            );
-        }
-        return $forVarPtrs;
-    }//end _getVarDeclaredInFor()
+	/**
+	 * Returns list of pointers to variables declared in for loop associated to
+	 * $forPtr in file $phpcsFile.
+	 *
+	 * All pointers in the result list are pointing to token with code
+	 * T_VARIABLE. An exception is raised, if $forPtr doesn't point a token with
+	 * code T_FOR.
+	 *
+	 * @param File $phpcsFile The current file being processed.
+	 * @param int                  $forPtr    The position of the current token
+	 *                                        in the stack passed in $tokens.
+	 *
+	 * @return array List of pointers to variables declared in for loop $forPtr.
+	 */
+	private static function _getVarDeclaredInFor(File $phpcsFile, $forPtr)
+	{
+		$tokens = $phpcsFile->getTokens();
+		$forTk = $tokens[$forPtr];
+		if (T_FOR !== $forTk['code']) {
+			throw new PHP_CodeSniffer_Exception('$forPtr must be of type T_FOR');
+		}
+		$openParPtr = $forTk['parenthesis_opener'];
+		$openParenthesisTk = $tokens[$openParPtr];
+		$endOfDeclPtr = $phpcsFile->findNext(array(T_SEMICOLON), $openParPtr);
+		$forVarPtrs = array();
+		$varPtr = $phpcsFile->findNext(
+			array(T_VARIABLE),
+			$openParPtr + 1,
+			$endOfDeclPtr
+		);
+		while (false !== $varPtr) {
+			$forVarPtrs [] = $varPtr;
+			$varPtr = $phpcsFile->findNext(
+				array(T_VARIABLE),
+				$varPtr + 1,
+				$endOfDeclPtr
+			);
+		}
+		return $forVarPtrs;
+	}//end _getVarDeclaredInFor()
 
-    /**
-     * Returns the position of first occurrence of a PHP variable starting with
-     * $ in $haystack from $offset.
-     *
-     * @param string $haystack The string to search in.
-     * @param int    $offset   The optional offset parameter allows you to
-     *                         specify which character in haystack to start
-     *                         searching. The returned position is still
-     *                         relative to the beginning of haystack.
-     *
-     * @return mixed The position as an integer
-     *               or the boolean false, if no variable is found.
-     */
-    private static function _getVariablePosition($haystack, $offset = 0)
-    {
-        $var_starts_at = strpos($haystack, '$', $offset);
-        $is_a_var = false;
-        while (false !== $var_starts_at && ! $is_a_var) {
-            // makes sure that $ is used for a variable and not as a symbol,
-            // if $ is protected with the escape char, then it is a symbol.
-            if (0 !== strcmp($haystack[$var_starts_at - 1], '\\')) {
-                if (0 === strcmp($haystack[$var_starts_at + 1], '{')) {
-                    // there is an opening brace in the right place
-                    // so it looks for the closing brace in the right place
-                    $hsChunk2 = substr($haystack, $var_starts_at + 2);
-                    if (1 === preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*\}/', $hsChunk2)) {
-                        $is_a_var = true;
-                    }
-                } else {
-                    $hsChunk1 = substr($haystack, $var_starts_at + 1);
-                    if (1 === preg_match('/^[a-zA-Z_\x7f-\xff]/', $hsChunk1)) {
-                        // $ is used for a variable and not as a symbol,
-                        // since what follows $ matchs the definition of
-                        // a variable label for PHP.
-                        $is_a_var = true;
-                    }
-                }
-            }
-            // update $var_starts_at for the next variable
-            // only if no variable was found, since it is returned otherwise.
-            if ( ! $is_a_var) {
-                $var_starts_at = strpos($haystack, '$', $var_starts_at + 1);
-            }
-        }
-        if ($is_a_var) {
-            return $var_starts_at;
-        } else {
-            return false;
-        }
-    }//end _getVariablePosition()
+	/**
+	 * Returns the position of first occurrence of a PHP variable starting with
+	 * $ in $haystack from $offset.
+	 *
+	 * @param string $haystack The string to search in.
+	 * @param int    $offset   The optional offset parameter allows you to
+	 *                         specify which character in haystack to start
+	 *                         searching. The returned position is still
+	 *                         relative to the beginning of haystack.
+	 *
+	 * @return mixed The position as an integer
+	 *               or the boolean false, if no variable is found.
+	 */
+	private static function _getVariablePosition($haystack, $offset = 0)
+	{
+		$var_starts_at = strpos($haystack, '$', $offset);
+		$is_a_var = false;
+		while (false !== $var_starts_at && ! $is_a_var) {
+			// makes sure that $ is used for a variable and not as a symbol,
+			// if $ is protected with the escape char, then it is a symbol.
+			if (0 !== strcmp($haystack[$var_starts_at - 1], '\\')) {
+				if (0 === strcmp($haystack[$var_starts_at + 1], '{')) {
+					// there is an opening brace in the right place
+					// so it looks for the closing brace in the right place
+					$hsChunk2 = substr($haystack, $var_starts_at + 2);
+					if (1 === preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*\}/', $hsChunk2)) {
+						$is_a_var = true;
+					}
+				} else {
+					$hsChunk1 = substr($haystack, $var_starts_at + 1);
+					if (1 === preg_match('/^[a-zA-Z_\x7f-\xff]/', $hsChunk1)) {
+						// $ is used for a variable and not as a symbol,
+						// since what follows $ matchs the definition of
+						// a variable label for PHP.
+						$is_a_var = true;
+					}
+				}
+			}
+			// update $var_starts_at for the next variable
+			// only if no variable was found, since it is returned otherwise.
+			if ( ! $is_a_var) {
+				$var_starts_at = strpos($haystack, '$', $var_starts_at + 1);
+			}
+		}
+		if ($is_a_var) {
+			return $var_starts_at;
+		} else {
+			return false;
+		}
+	}//end _getVariablePosition()
 }//end class
 
 ?>

Please login to merge, or discard this patch.

build/CodeIgniter/UnusedSniffs/NamingConventions/ValidMethodNameSniff.php 1 patch

Indentation +115 added lines, -115 removed lines patch added patch discarded remove patch

@@ -40,121 +40,121 @@
 block discarded – undo
 
 class ValidMethodNameSniff extends AbstractScopeSniff
 {
-    /**
-     * A list of all PHP magic methods.
-     *
-     * @var array
-     */
-    protected static $magicMethods = array(
-                               'construct',
-                               'destruct',
-                               'call',
-                               'callStatic',
-                               'get',
-                               'set',
-                               'isset',
-                               'unset',
-                               'sleep',
-                               'wakeup',
-                               'toString',
-                               'set_state',
-                               'clone',
-                              );
-
-    /**
-     * Defines which token(s) in which scope(s) will be proceed.
-     */
-    public function __construct()
-    {
-        parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION), true);
-
-    }//end __construct()
-
-
-    /**
-     * Processes the tokens within the scope.
-     *
-     * @param File $phpcsFile The file being processed.
-     * @param int                  $stackPtr  The position where this token was
-     *                                        found.
-     * @param int                  $currScope The position of the current scope.
-     *
-     * @return void
-     */
-    protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope)
-    {
-        $methodName = $phpcsFile->getDeclarationName($stackPtr);
-        if ($methodName === null) {
-            // Ignore closures.
-            return;
-        }
-
-        $className  = $phpcsFile->getDeclarationName($currScope);
-
-        // Is this a magic method i.e. is prefixed with "__".
-        if (0 === strcmp(substr($methodName, 0, 2), '__')) {
-            $magicPart = substr($methodName, 2);
-            if (in_array($magicPart, self::$magicMethods) === false) {
-                 $error = "Method name \"$className::$methodName\" is invalid; only PHP magic methods should be prefixed with a double underscore";
-                 $phpcsFile->addError($error, $stackPtr);
-            }
-
-            return;
-        }
-
-        // PHP4 constructors are allowed to break our rules.
-        if ($methodName === $className) {
-            return;
-        }
-
-        // PHP4 destructors are allowed to break our rules.
-        if ($methodName === '_'.$className) {
-            return;
-        }
-
-        if (0 !== strcmp($methodName, strtolower($methodName))) {
-            $uscrdMethodName = preg_replace('/([A-Z])/', '_${1}', $methodName);
-            $expectedMethodName = strtolower($uscrdMethodName);
-            $error = "Class methods should be entirely lowercased. Please consider \"$expectedMethodName\" instead of \"$methodName\".";
-            $phpcsFile->addError($error, $stackPtr);
-            return;
-        }
-
-        $methodProps    = $phpcsFile->getMethodProperties($stackPtr);
-        $scope          = $methodProps['scope'];
-        $scopeSpecified = $methodProps['scope_specified'];
-
-        // If it's a private method, it must have an underscore on the front.
-        if ($scope === 'private' && $methodName{0} !== '_') {
-            $error = "Private method name \"$className::$methodName\" must be prefixed with an underscore";
-            $phpcsFile->addError($error, $stackPtr);
-            return;
-        }
-
-        // If it's not a private method, it must not have an underscore on the front.
-        if ($scope !== 'private' && $methodName{0} === '_') {
-            if (true === $scopeSpecified) {
-                $error = "Public method name \"$className::$methodName\" must not be prefixed with an underscore";
-            } else {
-                $error = ucfirst($scope)." method name \"$className::$methodName\" must not be prefixed with an underscore";
-            }
-            $phpcsFile->addError($error, $stackPtr);
-            return;
-        }
-
-        // If name is too verbose,
-        // then either an error or a warning is displayed.
-        $error_limit = 50;
-        $warning_limit = 35;
-        if (strlen($methodName) > $error_limit) {
-            $error = "Overly long and verbose names are prohibited. Please find a name shorter than $error_limit chars.";
-            $phpcsFile->addError($error, $stackPtr);
-            return;
-        } else if (strlen($methodName) > $warning_limit) {
-            $warning = "Try to avoid overly long and verbose names in finding a name shorter than $warning_limit chars.";
-            $phpcsFile->addWarning($warning, $stackPtr);
-        }
-    }//end processTokenWithinScope()
+	/**
+	 * A list of all PHP magic methods.
+	 *
+	 * @var array
+	 */
+	protected static $magicMethods = array(
+							   'construct',
+							   'destruct',
+							   'call',
+							   'callStatic',
+							   'get',
+							   'set',
+							   'isset',
+							   'unset',
+							   'sleep',
+							   'wakeup',
+							   'toString',
+							   'set_state',
+							   'clone',
+							  );
+
+	/**
+	 * Defines which token(s) in which scope(s) will be proceed.
+	 */
+	public function __construct()
+	{
+		parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION), true);
+
+	}//end __construct()
+
+
+	/**
+	 * Processes the tokens within the scope.
+	 *
+	 * @param File $phpcsFile The file being processed.
+	 * @param int                  $stackPtr  The position where this token was
+	 *                                        found.
+	 * @param int                  $currScope The position of the current scope.
+	 *
+	 * @return void
+	 */
+	protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope)
+	{
+		$methodName = $phpcsFile->getDeclarationName($stackPtr);
+		if ($methodName === null) {
+			// Ignore closures.
+			return;
+		}
+
+		$className  = $phpcsFile->getDeclarationName($currScope);
+
+		// Is this a magic method i.e. is prefixed with "__".
+		if (0 === strcmp(substr($methodName, 0, 2), '__')) {
+			$magicPart = substr($methodName, 2);
+			if (in_array($magicPart, self::$magicMethods) === false) {
+				 $error = "Method name \"$className::$methodName\" is invalid; only PHP magic methods should be prefixed with a double underscore";
+				 $phpcsFile->addError($error, $stackPtr);
+			}
+
+			return;
+		}
+
+		// PHP4 constructors are allowed to break our rules.
+		if ($methodName === $className) {
+			return;
+		}
+
+		// PHP4 destructors are allowed to break our rules.
+		if ($methodName === '_'.$className) {
+			return;
+		}
+
+		if (0 !== strcmp($methodName, strtolower($methodName))) {
+			$uscrdMethodName = preg_replace('/([A-Z])/', '_${1}', $methodName);
+			$expectedMethodName = strtolower($uscrdMethodName);
+			$error = "Class methods should be entirely lowercased. Please consider \"$expectedMethodName\" instead of \"$methodName\".";
+			$phpcsFile->addError($error, $stackPtr);
+			return;
+		}
+
+		$methodProps    = $phpcsFile->getMethodProperties($stackPtr);
+		$scope          = $methodProps['scope'];
+		$scopeSpecified = $methodProps['scope_specified'];
+
+		// If it's a private method, it must have an underscore on the front.
+		if ($scope === 'private' && $methodName{0} !== '_') {
+			$error = "Private method name \"$className::$methodName\" must be prefixed with an underscore";
+			$phpcsFile->addError($error, $stackPtr);
+			return;
+		}
+
+		// If it's not a private method, it must not have an underscore on the front.
+		if ($scope !== 'private' && $methodName{0} === '_') {
+			if (true === $scopeSpecified) {
+				$error = "Public method name \"$className::$methodName\" must not be prefixed with an underscore";
+			} else {
+				$error = ucfirst($scope)." method name \"$className::$methodName\" must not be prefixed with an underscore";
+			}
+			$phpcsFile->addError($error, $stackPtr);
+			return;
+		}
+
+		// If name is too verbose,
+		// then either an error or a warning is displayed.
+		$error_limit = 50;
+		$warning_limit = 35;
+		if (strlen($methodName) > $error_limit) {
+			$error = "Overly long and verbose names are prohibited. Please find a name shorter than $error_limit chars.";
+			$phpcsFile->addError($error, $stackPtr);
+			return;
+		} else if (strlen($methodName) > $warning_limit) {
+			$warning = "Try to avoid overly long and verbose names in finding a name shorter than $warning_limit chars.";
+			$phpcsFile->addWarning($warning, $stackPtr);
+		}
+	}//end processTokenWithinScope()
 
 }//end class
 

Please login to merge, or discard this patch.

build/CodeIgniter/UnusedSniffs/NamingConventions/ValidFileNameSniff.php 1 patch

Indentation +44 added lines, -44 removed lines patch added patch discarded remove patch

@@ -32,53 +32,53 @@
 block discarded – undo
 
 class ValidFileNameSniff implements Sniff
 {
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(
-            T_CLASS,
-            T_INTERFACE,
-        );
-    }//end register()
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return array(
+			T_CLASS,
+			T_INTERFACE,
+		);
+	}//end register()
 
 
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile The file being scanned.
-     * @param int                  $stackPtr  The position of the current token in the
-     *                                        stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-        // computes the expected filename based on the name of the class or interface that it contains.
-        $decNamePtr = $phpcsFile->findNext(T_STRING, $stackPtr);
-        $decName = $tokens[$decNamePtr]['content'];
-        $expectedFileName = strtolower($decName);
-        // extracts filename without extension from its path.
-        $fullPath = $phpcsFile->getFilename();
-        $fileNameAndExt = basename($fullPath);
-        $fileName = substr($fileNameAndExt, 0, strrpos($fileNameAndExt, '.'));
+	/**
+	 * Processes this test, when one of its tokens is encountered.
+	 *
+	 * @param File $phpcsFile The file being scanned.
+	 * @param int                  $stackPtr  The position of the current token in the
+	 *                                        stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+		$tokens = $phpcsFile->getTokens();
+		// computes the expected filename based on the name of the class or interface that it contains.
+		$decNamePtr = $phpcsFile->findNext(T_STRING, $stackPtr);
+		$decName = $tokens[$decNamePtr]['content'];
+		$expectedFileName = strtolower($decName);
+		// extracts filename without extension from its path.
+		$fullPath = $phpcsFile->getFilename();
+		$fileNameAndExt = basename($fullPath);
+		$fileName = substr($fileNameAndExt, 0, strrpos($fileNameAndExt, '.'));
 
-        if ($expectedFileName !== $fileName) {
-            $errorTemplate = 'Filename "%s" doesn\'t match the name of the %s that it contains "%s" in lower case. "%s" was expected.';
-            $errorMessage = sprintf(
-                $errorTemplate,
-                $fileName,
-                strtolower($tokens[$stackPtr]['content']), // class or interface
-                $decName,
-                $expectedFileName
-            );
-            $phpcsFile->addError($errorMessage, 0);
-        }
-    }//end process()
+		if ($expectedFileName !== $fileName) {
+			$errorTemplate = 'Filename "%s" doesn\'t match the name of the %s that it contains "%s" in lower case. "%s" was expected.';
+			$errorMessage = sprintf(
+				$errorTemplate,
+				$fileName,
+				strtolower($tokens[$stackPtr]['content']), // class or interface
+				$decName,
+				$expectedFileName
+			);
+			$phpcsFile->addError($errorMessage, 0);
+		}
+	}//end process()
 }//end class
 
 ?>

Please login to merge, or discard this patch.

		@@ -20,22 +20,22 @@
		block discarded – undo
20	20	* Base trait for api interaction
21	21	*/
22	22	trait GuzzleTrait {
23		- /**
24		- * The Guzzle http client object
25		- * @var object
26		- */
27		- protected $client;
	23	+ /**
	24	+ * The Guzzle http client object
	25	+ * @var object
	26	+ */
	27	+ protected $client;
28	28
29		- /**
30		- * Cookie jar object for api requests
31		- * @var object
32		- */
33		- protected $cookieJar;
	29	+ /**
	30	+ * Cookie jar object for api requests
	31	+ * @var object
	32	+ */
	33	+ protected $cookieJar;
34	34
35		- /**
36		- * Set up the class properties
37		- *
38		- * @return void
39		- */
40		- abstract protected function init();
	35	+ /**
	36	+ * Set up the class properties
	37	+ *
	38	+ * @return void
	39	+ */
	40	+ abstract protected function init();
41	41	}
42	42	\ No newline at end of file

		@@ -45,138 +45,138 @@
		block discarded – undo
45	45
46	46	class ClosingLocationCommentSniff extends AbstractClosingCommentSniff
47	47	{
48		- public $applicationRoot = '/application/';
49		-
50		- /**
51		- * Returns an array of tokens this test wants to listen for.
52		- *
53		- * @return array
54		- */
55		- public function register()
56		- {
57		- return array(
58		- T_OPEN_TAG
59		- );
60		-
61		- }//end register()
62		-
63		-
64		- /**
65		- * Processes this test, when one of its tokens is encountered.
66		- *
67		- * @param File $phpcsFile The current file being scanned.
68		- * @param int $stackPtr The position of the current token
69		- * in the stack passed in $tokens.
70		- *
71		- * @return void
72		- */
73		- public function process(File $phpcsFile, $stackPtr)
74		- {
75		- // We are only interested if this is the first open tag.
76		- if ($stackPtr !== 0) {
77		- if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
78		- return;
79		- }
80		- }
81		-
82		- $filePath = $phpcsFile->getFilename();
83		- $tokens = $phpcsFile->getTokens();
84		- // removes the application root from the beginning of the file path
85		- $locationPath = self::_getLocationPath($filePath, $this->_getAppRoot());
86		- // add an error, if application root doesn't exist in current file path
87		- if (false === $locationPath) {
88		- $error = 'Unable to find "' . $this->_getAppRoot() . '" in file path "' . $filePath . '". Please set your project\'s application root.';
89		- $phpcsFile->addError($error, count($tokens) - 1);
90		- return;
91		- }
92		- // generates the expected comment
93		- $commentTemplate = "Location: $locationPath";
94		-
95		- $currentToken = count($tokens) - 1;
96		- $hasClosingLocationComment = false;
97		- $isNotAWhitespaceOrAComment = false;
98		- while ($currentToken >= 0
99		- && ! $isNotAWhitespaceOrAComment
100		- && ! $hasClosingLocationComment
101		- ) {
102		- $token = $tokens[$currentToken];
103		- $tokenCode = $token['code'];
104		- if (T_COMMENT === $tokenCode) {
105		- $commentString = self::_getCommentContent($token['content']);
106		- if (0 === strcmp($commentString, $commentTemplate)) {
107		- $hasClosingLocationComment = true;
108		- }
109		- } else if (T_WHITESPACE === $tokenCode) {
110		- // Whitespaces are allowed between the closing file comment,
111		- //other comments and end of file
112		- } else {
113		- $isNotAWhitespaceOrAComment = true;
114		- }
115		- $currentToken--;
116		- }
117		-
118		- if ( ! $hasClosingLocationComment) {
119		- $error = 'No comment block marks the end of file instead of the closing PHP tag. Please add a comment block containing only "' . $commentTemplate . '".';
120		- $phpcsFile->addError($error, $currentToken);
121		- }
122		- }//end process()
123		-
124		-
125		- /**
126		- * Returns the relative path from $appRoot to $filePath, or false if
127		- * $appRoot cannot be found in $filePath, because $appRoot is not a parent
128		- * of $filePath.
129		- *
130		- * @param string $filePath Full path to the file being proceed.
131		- * @param string $appRoot Partial or full path to the CodeIgniter
132		- * application root of the file being proceed. It must not contain the
133		- * full path to the application root, but at least the name of the
134		- * application root. Parent directory of the application root are allowed
135		- * but not mandatory.
136		- *
137		- * @return string\|bool The relative path from $appRoot to $filePath, or
138		- * false if $appRoot cannot be found in $filePath.
139		- */
140		- private static function _getLocationPath ($filePath, $appRoot)
141		- {
142		- // removes the path to application root
143		- // from the beginning of the file path
144		- $appRootAt = strpos($filePath, $appRoot);
145		- if (false === $appRootAt) {
146		- return false;
147		- }
148		- $localPath = substr($filePath, $appRootAt + strlen($appRoot));
149		- // ensures the location path to be a relative path starting with "./".
150		- if ( ! self::_stringStartsWith($localPath, './')) {
151		- $localPath = './' . $localPath;
152		- } else if ( ! self::_stringStartsWith($localPath, '.')
153		- && self::_stringStartsWith($localPath, '/')
154		- ) {
155		- $localPath = '.' . $localPath;
156		- }
157		- return $localPath;
158		- }//end _getLocationPath()
159		-
160		-
161		- /**
162		- * Returns the application root that should be used first.
163		- *
164		- * There are several ways to configure the application root.
165		- * In order of priority :
166		- * - Configuration variable ci_application_root.
167		- * - Rule property applicationRoot.
168		- * - Default value '/application/'
169		- *
170		- * @return string Path to your project application root.
171		- */
172		- private function _getAppRoot()
173		- {
174		- $appRoot = Common::getConfigData('ci_application_root');
175		- if (null === $appRoot) {
176		- $appRoot = $this->applicationRoot;
177		- }
178		- return $appRoot;
179		- }//end _getAppRoot()
	48	+ public $applicationRoot = '/application/';
	49	+
	50	+ /**
	51	+ * Returns an array of tokens this test wants to listen for.
	52	+ *
	53	+ * @return array
	54	+ */
	55	+ public function register()
	56	+ {
	57	+ return array(
	58	+ T_OPEN_TAG
	59	+ );
	60	+
	61	+ }//end register()
	62	+
	63	+
	64	+ /**
	65	+ * Processes this test, when one of its tokens is encountered.
	66	+ *
	67	+ * @param File $phpcsFile The current file being scanned.
	68	+ * @param int $stackPtr The position of the current token
	69	+ * in the stack passed in $tokens.
	70	+ *
	71	+ * @return void
	72	+ */
	73	+ public function process(File $phpcsFile, $stackPtr)
	74	+ {
	75	+ // We are only interested if this is the first open tag.
	76	+ if ($stackPtr !== 0) {
	77	+ if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
	78	+ return;
	79	+ }
	80	+ }
	81	+
	82	+ $filePath = $phpcsFile->getFilename();
	83	+ $tokens = $phpcsFile->getTokens();
	84	+ // removes the application root from the beginning of the file path
	85	+ $locationPath = self::_getLocationPath($filePath, $this->_getAppRoot());
	86	+ // add an error, if application root doesn't exist in current file path
	87	+ if (false === $locationPath) {
	88	+ $error = 'Unable to find "' . $this->_getAppRoot() . '" in file path "' . $filePath . '". Please set your project\'s application root.';
	89	+ $phpcsFile->addError($error, count($tokens) - 1);
	90	+ return;
	91	+ }
	92	+ // generates the expected comment
	93	+ $commentTemplate = "Location: $locationPath";
	94	+
	95	+ $currentToken = count($tokens) - 1;
	96	+ $hasClosingLocationComment = false;
	97	+ $isNotAWhitespaceOrAComment = false;
	98	+ while ($currentToken >= 0
	99	+ && ! $isNotAWhitespaceOrAComment
	100	+ && ! $hasClosingLocationComment
	101	+ ) {
	102	+ $token = $tokens[$currentToken];
	103	+ $tokenCode = $token['code'];
	104	+ if (T_COMMENT === $tokenCode) {
	105	+ $commentString = self::_getCommentContent($token['content']);
	106	+ if (0 === strcmp($commentString, $commentTemplate)) {
	107	+ $hasClosingLocationComment = true;
	108	+ }
	109	+ } else if (T_WHITESPACE === $tokenCode) {
	110	+ // Whitespaces are allowed between the closing file comment,
	111	+ //other comments and end of file
	112	+ } else {
	113	+ $isNotAWhitespaceOrAComment = true;
	114	+ }
	115	+ $currentToken--;
	116	+ }
	117	+
	118	+ if ( ! $hasClosingLocationComment) {
	119	+ $error = 'No comment block marks the end of file instead of the closing PHP tag. Please add a comment block containing only "' . $commentTemplate . '".';
	120	+ $phpcsFile->addError($error, $currentToken);
	121	+ }
	122	+ }//end process()
	123	+
	124	+
	125	+ /**
	126	+ * Returns the relative path from $appRoot to $filePath, or false if
	127	+ * $appRoot cannot be found in $filePath, because $appRoot is not a parent
	128	+ * of $filePath.
	129	+ *
	130	+ * @param string $filePath Full path to the file being proceed.
	131	+ * @param string $appRoot Partial or full path to the CodeIgniter
	132	+ * application root of the file being proceed. It must not contain the
	133	+ * full path to the application root, but at least the name of the
	134	+ * application root. Parent directory of the application root are allowed
	135	+ * but not mandatory.
	136	+ *
	137	+ * @return string\|bool The relative path from $appRoot to $filePath, or
	138	+ * false if $appRoot cannot be found in $filePath.
	139	+ */
	140	+ private static function _getLocationPath ($filePath, $appRoot)
	141	+ {
	142	+ // removes the path to application root
	143	+ // from the beginning of the file path
	144	+ $appRootAt = strpos($filePath, $appRoot);
	145	+ if (false === $appRootAt) {
	146	+ return false;
	147	+ }
	148	+ $localPath = substr($filePath, $appRootAt + strlen($appRoot));
	149	+ // ensures the location path to be a relative path starting with "./".
	150	+ if ( ! self::_stringStartsWith($localPath, './')) {
	151	+ $localPath = './' . $localPath;
	152	+ } else if ( ! self::_stringStartsWith($localPath, '.')
	153	+ && self::_stringStartsWith($localPath, '/')
	154	+ ) {
	155	+ $localPath = '.' . $localPath;
	156	+ }
	157	+ return $localPath;
	158	+ }//end _getLocationPath()
	159	+
	160	+
	161	+ /**
	162	+ * Returns the application root that should be used first.
	163	+ *
	164	+ * There are several ways to configure the application root.
	165	+ * In order of priority :
	166	+ * - Configuration variable ci_application_root.
	167	+ * - Rule property applicationRoot.
	168	+ * - Default value '/application/'
	169	+ *
	170	+ * @return string Path to your project application root.
	171	+ */
	172	+ private function _getAppRoot()
	173	+ {
	174	+ $appRoot = Common::getConfigData('ci_application_root');
	175	+ if (null === $appRoot) {
	176	+ $appRoot = $this->applicationRoot;
	177	+ }
	178	+ return $appRoot;
	179	+ }//end _getAppRoot()
180	180	}//end class
181	181
182	182	?>

		@@ -34,71 +34,71 @@
		block discarded – undo
34	34
35	35	class AbstractClosingCommentSniff implements Sniff
36	36	{
37		- /**
38		- * As an abstract class, this sniff is not associated to any token.
39		- */
40		- public function register()
41		- {
42		- return array();
43		- }
	37	+ /**
	38	+ * As an abstract class, this sniff is not associated to any token.
	39	+ */
	40	+ public function register()
	41	+ {
	42	+ return array();
	43	+ }
44	44
45		- /**
46		- * As an abstract class, this sniff is not dedicated to process a token.
47		- */
48		- public function process(File $phpcsFile, $stackPtr)
49		- {
50		- $error = __CLASS__.'::'.__METHOD__.' is abstract. Please develop this method in a child class.';
51		- throw new PHP_CodeSniffer_Exception($error);
52		- }
	45	+ /**
	46	+ * As an abstract class, this sniff is not dedicated to process a token.
	47	+ */
	48	+ public function process(File $phpcsFile, $stackPtr)
	49	+ {
	50	+ $error = __CLASS__.'::'.__METHOD__.' is abstract. Please develop this method in a child class.';
	51	+ throw new PHP_CodeSniffer_Exception($error);
	52	+ }
53	53
54		- /**
55		- * Returns the comment without its delimiter(s) as well as leading
56		- * and traling whitespaces.
57		- *
58		- * It removes the first #, the two first / (i.e. //) or the first /*
59		- * and last \\/. If a comment starts with /, then the last will remain
60		- * as well as whitespaces between this star and the comment content.
61		- *
62		- * @param string $comment Comment containing either comment delimiter(s) and
63		- * trailing or leading whitspaces to clean.
64		- *
65		- * @return string Comment without comment delimiter(s) and whitespaces.
66		- */
67		- protected static function _getCommentContent ($comment)
68		- {
69		- if (self::_stringStartsWith($comment, '#')) {
70		- $comment = substr($comment, 1);
71		- } else if (self::_stringStartsWith($comment, '//')) {
72		- $comment = substr($comment, 2);
73		- } else if (self::_stringStartsWith($comment, '/*')) {
74		- $comment = substr($comment, 2, strlen($comment) - 2 - 2);
75		- }
76		- $comment = trim($comment);
77		- return $comment;
78		- }//_getCommentContent()
	54	+ /**
	55	+ * Returns the comment without its delimiter(s) as well as leading
	56	+ * and traling whitespaces.
	57	+ *
	58	+ * It removes the first #, the two first / (i.e. //) or the first /*
	59	+ * and last \\/. If a comment starts with /, then the last will remain
	60	+ * as well as whitespaces between this star and the comment content.
	61	+ *
	62	+ * @param string $comment Comment containing either comment delimiter(s) and
	63	+ * trailing or leading whitspaces to clean.
	64	+ *
	65	+ * @return string Comment without comment delimiter(s) and whitespaces.
	66	+ */
	67	+ protected static function _getCommentContent ($comment)
	68	+ {
	69	+ if (self::_stringStartsWith($comment, '#')) {
	70	+ $comment = substr($comment, 1);
	71	+ } else if (self::_stringStartsWith($comment, '//')) {
	72	+ $comment = substr($comment, 2);
	73	+ } else if (self::_stringStartsWith($comment, '/*')) {
	74	+ $comment = substr($comment, 2, strlen($comment) - 2 - 2);
	75	+ }
	76	+ $comment = trim($comment);
	77	+ return $comment;
	78	+ }//_getCommentContent()
79	79
80	80
81		- /**
82		- * Binary safe string comparison between $needle and
83		- * the beginning of $haystack. Returns true if $haystack starts with
84		- * $needle, false otherwise.
85		- *
86		- * @param string $haystack The string to search in.
87		- * @param string $needle The string to search for.
88		- *
89		- * @return bool true if $haystack starts with $needle, false otherwise.
90		- */
91		- protected static function _stringStartsWith ($haystack, $needle)
92		- {
93		- $startsWith = false;
94		- if (strlen($needle) <= strlen($haystack)) {
95		- $haystackBeginning = substr($haystack, 0, strlen($needle));
96		- if (0 === strcmp($haystackBeginning, $needle)) {
97		- $startsWith = true;
98		- }
99		- }
100		- return $startsWith;
101		- }//_stringStartsWith()
	81	+ /**
	82	+ * Binary safe string comparison between $needle and
	83	+ * the beginning of $haystack. Returns true if $haystack starts with
	84	+ * $needle, false otherwise.
	85	+ *
	86	+ * @param string $haystack The string to search in.
	87	+ * @param string $needle The string to search for.
	88	+ *
	89	+ * @return bool true if $haystack starts with $needle, false otherwise.
	90	+ */
	91	+ protected static function _stringStartsWith ($haystack, $needle)
	92	+ {
	93	+ $startsWith = false;
	94	+ if (strlen($needle) <= strlen($haystack)) {
	95	+ $haystackBeginning = substr($haystack, 0, strlen($needle));
	96	+ if (0 === strcmp($haystackBeginning, $needle)) {
	97	+ $startsWith = true;
	98	+ }
	99	+ }
	100	+ return $startsWith;
	101	+ }//_stringStartsWith()
102	102	}//end class
103	103
104	104	?>

		@@ -39,71 +39,71 @@
		block discarded – undo
39	39	class ClosingFileCommentSniff extends AbstractClosingCommentSniff
40	40	{
41	41
42		- /**
43		- * Returns an array of tokens this test wants to listen for.
44		- *
45		- * @return array
46		- */
47		- public function register()
48		- {
49		- return array(
50		- T_OPEN_TAG,
51		- );
	42	+ /**
	43	+ * Returns an array of tokens this test wants to listen for.
	44	+ *
	45	+ * @return array
	46	+ */
	47	+ public function register()
	48	+ {
	49	+ return array(
	50	+ T_OPEN_TAG,
	51	+ );
52	52
53		- }//end register()
	53	+ }//end register()
54	54
55	55
56		- /**
57		- * Processes this test, when one of its tokens is encountered.
58		- *
59		- * @param File $phpcsFile The current file being scanned.
60		- * @param int $stackPtr The position of the current token
61		- * in the stack passed in $tokens.
62		- *
63		- * @return void
64		- */
65		- public function process(File $phpcsFile, $stackPtr)
66		- {
67		- // We are only interested if this is the first open tag.
68		- if ($stackPtr !== 0) {
69		- if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
70		- return;
71		- }
72		- }
	56	+ /**
	57	+ * Processes this test, when one of its tokens is encountered.
	58	+ *
	59	+ * @param File $phpcsFile The current file being scanned.
	60	+ * @param int $stackPtr The position of the current token
	61	+ * in the stack passed in $tokens.
	62	+ *
	63	+ * @return void
	64	+ */
	65	+ public function process(File $phpcsFile, $stackPtr)
	66	+ {
	67	+ // We are only interested if this is the first open tag.
	68	+ if ($stackPtr !== 0) {
	69	+ if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
	70	+ return;
	71	+ }
	72	+ }
73	73
74		- $fullFilename = $phpcsFile->getFilename();
75		- $filename = basename($fullFilename);
76		- $commentTemplate = "End of file $filename";
	74	+ $fullFilename = $phpcsFile->getFilename();
	75	+ $filename = basename($fullFilename);
	76	+ $commentTemplate = "End of file $filename";
77	77
78		- $tokens = $phpcsFile->getTokens();
79		- $currentToken = count($tokens) - 1;
80		- $hasClosingFileComment = false;
81		- $isNotAWhitespaceOrAComment = false;
82		- while ($currentToken >= 0
83		- && ! $isNotAWhitespaceOrAComment
84		- && ! $hasClosingFileComment
85		- ) {
86		- $token = $tokens[$currentToken];
87		- $tokenCode = $token['code'];
88		- if (T_COMMENT === $tokenCode) {
89		- $commentString = self::_getCommentContent($token['content']);
90		- if (0 === strcmp($commentString, $commentTemplate)) {
91		- $hasClosingFileComment = true;
92		- }
93		- } else if (T_WHITESPACE === $tokenCode) {
94		- // Whitespaces are allowed between the closing file comment,
95		- // other comments and end of file
96		- } else {
97		- $isNotAWhitespaceOrAComment = true;
98		- }
99		- $currentToken--;
100		- }
	78	+ $tokens = $phpcsFile->getTokens();
	79	+ $currentToken = count($tokens) - 1;
	80	+ $hasClosingFileComment = false;
	81	+ $isNotAWhitespaceOrAComment = false;
	82	+ while ($currentToken >= 0
	83	+ && ! $isNotAWhitespaceOrAComment
	84	+ && ! $hasClosingFileComment
	85	+ ) {
	86	+ $token = $tokens[$currentToken];
	87	+ $tokenCode = $token['code'];
	88	+ if (T_COMMENT === $tokenCode) {
	89	+ $commentString = self::_getCommentContent($token['content']);
	90	+ if (0 === strcmp($commentString, $commentTemplate)) {
	91	+ $hasClosingFileComment = true;
	92	+ }
	93	+ } else if (T_WHITESPACE === $tokenCode) {
	94	+ // Whitespaces are allowed between the closing file comment,
	95	+ // other comments and end of file
	96	+ } else {
	97	+ $isNotAWhitespaceOrAComment = true;
	98	+ }
	99	+ $currentToken--;
	100	+ }
101	101
102		- if ( ! $hasClosingFileComment) {
103		- $error = 'No comment block marks the end of file instead of the closing PHP tag. Please add a comment block containing only "' . $commentTemplate . '".';
104		- $phpcsFile->addError($error, $currentToken);
105		- }
106		- }//end process()
	102	+ if ( ! $hasClosingFileComment) {
	103	+ $error = 'No comment block marks the end of file instead of the closing PHP tag. Please add a comment block containing only "' . $commentTemplate . '".';
	104	+ $phpcsFile->addError($error, $currentToken);
	105	+ }
	106	+ }//end process()
107	107	}//end class
108	108
109	109	?>

		@@ -36,101 +36,101 @@
		block discarded – undo
36	36	{
37	37
38	38
39		- public $php5Constructors = '1';
40		-
41		-
42		- /**
43		- * Constructs the test with the tokens it wishes to listen for.
44		- *
45		- * @return void
46		- */
47		- public function __construct()
48		- {
49		- parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION), true);
50		-
51		- }//end __construct()
52		-
53		-
54		- /**
55		- * Processes this test when one of its tokens is encountered.
56		- *
57		- * @param File $phpcsFile The current file being scanned.
58		- * @param int $stackPtr The position of the current token
59		- * in the stack passed in $tokens.
60		- * @param int $currScope A pointer to the start of the scope.
61		- *
62		- * @return void
63		- */
64		- protected function processTokenWithinScope(
65		- File $phpcsFile,
66		- $stackPtr,
67		- $currScope
68		- ) {
69		- $methodName = $phpcsFile->getDeclarationName($stackPtr);
70		- $className = $phpcsFile->getDeclarationName($currScope);
	39	+ public $php5Constructors = '1';
	40	+
	41	+
	42	+ /**
	43	+ * Constructs the test with the tokens it wishes to listen for.
	44	+ *
	45	+ * @return void
	46	+ */
	47	+ public function __construct()
	48	+ {
	49	+ parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION), true);
	50	+
	51	+ }//end __construct()
	52	+
	53	+
	54	+ /**
	55	+ * Processes this test when one of its tokens is encountered.
	56	+ *
	57	+ * @param File $phpcsFile The current file being scanned.
	58	+ * @param int $stackPtr The position of the current token
	59	+ * in the stack passed in $tokens.
	60	+ * @param int $currScope A pointer to the start of the scope.
	61	+ *
	62	+ * @return void
	63	+ */
	64	+ protected function processTokenWithinScope(
	65	+ File $phpcsFile,
	66	+ $stackPtr,
	67	+ $currScope
	68	+ ) {
	69	+ $methodName = $phpcsFile->getDeclarationName($stackPtr);
	70	+ $className = $phpcsFile->getDeclarationName($currScope);
71	71
72	72	$isPhp4Constructor = strcasecmp($methodName, $className) === 0;
73	73	$isPhp5Constructor = strcasecmp($methodName, '__construct') === 0;
74		- if ($this->php5Constructors != '0') {
75		- if ($isPhp4Constructor) {
76		- $error = "PHP4 style constructors are not allowed; use \"__construct\" instead";
77		- $phpcsFile->addError($error, $stackPtr);
78		- }
79		- } else {
80		- if ($isPhp5Constructor) {
81		- $error = "PHP5 style constructors are not allowed; use \"$className\" instead";
82		- $phpcsFile->addError($error, $stackPtr);
83		- }
84		- }
85		- if ( ! $isPhp4Constructor && ! $isPhp5Constructor ) {
86		- return;
87		- }
88		-
89		- $tokens = $phpcsFile->getTokens();
90		-
91		- $parentClassName = $phpcsFile->findExtendedClassName($currScope);
92		- $wrongConstructor = '';
93		- // prepares the error message and wrong constructor
94		- if ($this->php5Constructors != '0') {
95		- $error = 'PHP4 style calls to parent constructors are not allowed.';
96		- $error = "$error Please use \"parent::__construct\" instead.";
97		- if (false !== $parentClassName) {
98		- $wrongConstructor = $parentClassName;
99		- }
100		- // Else $wrongConstructor will be empty
101		- // and the test expression will always be false.
102		- // It doesn't check that no parent method should be called
103		- // when no parent class is defined.
104		- } else {
105		- $error = 'PHP5 style calls to parent constructors are not allowed.';
106		- if (false !== $parentClassName) {
107		- $error = "$error Please use \"parent::$parentClassName\" instead.";
108		- }
109		- $wrongConstructor = '__construct';
110		- }
111		-
112		- // looks for the use of a wrong constructor.
113		- $endFunctionIndex = $tokens[$stackPtr]['scope_closer'];
114		- $doubleColonIndex = $phpcsFile->findNext(
115		- array(T_DOUBLE_COLON),
116		- $stackPtr,
117		- $endFunctionIndex
118		- );
119		- while ($doubleColonIndex) {
120		- if ($tokens[($doubleColonIndex + 1)]['code'] === T_STRING
121		- && $tokens[($doubleColonIndex + 1)]['content'] === $wrongConstructor
122		- ) {
123		- $phpcsFile->addError($error, ($doubleColonIndex + 1));
124		- }
125		-
126		- $doubleColonIndex = $phpcsFile->findNext(
127		- array(T_DOUBLE_COLON),
128		- $doubleColonIndex + 1,
129		- $endFunctionIndex
130		- );
131		- }
132		-
133		- }//end processTokenWithinScope()
	74	+ if ($this->php5Constructors != '0') {
	75	+ if ($isPhp4Constructor) {
	76	+ $error = "PHP4 style constructors are not allowed; use \"__construct\" instead";
	77	+ $phpcsFile->addError($error, $stackPtr);
	78	+ }
	79	+ } else {
	80	+ if ($isPhp5Constructor) {
	81	+ $error = "PHP5 style constructors are not allowed; use \"$className\" instead";
	82	+ $phpcsFile->addError($error, $stackPtr);
	83	+ }
	84	+ }
	85	+ if ( ! $isPhp4Constructor && ! $isPhp5Constructor ) {
	86	+ return;
	87	+ }
	88	+
	89	+ $tokens = $phpcsFile->getTokens();
	90	+
	91	+ $parentClassName = $phpcsFile->findExtendedClassName($currScope);
	92	+ $wrongConstructor = '';
	93	+ // prepares the error message and wrong constructor
	94	+ if ($this->php5Constructors != '0') {
	95	+ $error = 'PHP4 style calls to parent constructors are not allowed.';
	96	+ $error = "$error Please use \"parent::__construct\" instead.";
	97	+ if (false !== $parentClassName) {
	98	+ $wrongConstructor = $parentClassName;
	99	+ }
	100	+ // Else $wrongConstructor will be empty
	101	+ // and the test expression will always be false.
	102	+ // It doesn't check that no parent method should be called
	103	+ // when no parent class is defined.
	104	+ } else {
	105	+ $error = 'PHP5 style calls to parent constructors are not allowed.';
	106	+ if (false !== $parentClassName) {
	107	+ $error = "$error Please use \"parent::$parentClassName\" instead.";
	108	+ }
	109	+ $wrongConstructor = '__construct';
	110	+ }
	111	+
	112	+ // looks for the use of a wrong constructor.
	113	+ $endFunctionIndex = $tokens[$stackPtr]['scope_closer'];
	114	+ $doubleColonIndex = $phpcsFile->findNext(
	115	+ array(T_DOUBLE_COLON),
	116	+ $stackPtr,
	117	+ $endFunctionIndex
	118	+ );
	119	+ while ($doubleColonIndex) {
	120	+ if ($tokens[($doubleColonIndex + 1)]['code'] === T_STRING
	121	+ && $tokens[($doubleColonIndex + 1)]['content'] === $wrongConstructor
	122	+ ) {
	123	+ $phpcsFile->addError($error, ($doubleColonIndex + 1));
	124	+ }
	125	+
	126	+ $doubleColonIndex = $phpcsFile->findNext(
	127	+ array(T_DOUBLE_COLON),
	128	+ $doubleColonIndex + 1,
	129	+ $endFunctionIndex
	130	+ );
	131	+ }
	132	+
	133	+ }//end processTokenWithinScope()
134	134
135	135	protected function processTokenOutsideScope(File $phpcsFile, $stackPtr)
136	136	{

		@@ -39,45 +39,45 @@
		block discarded – undo
39	39	{
40	40
41	41
42		- /**
43		- * Returns an array of tokens this test wants to listen for.
44		- *
45		- * @return array
46		- */
47		- public function register()
48		- {
49		- return array(
50		- T_CLASS,
51		- T_INTERFACE,
52		- );
	42	+ /**
	43	+ * Returns an array of tokens this test wants to listen for.
	44	+ *
	45	+ * @return array
	46	+ */
	47	+ public function register()
	48	+ {
	49	+ return array(
	50	+ T_CLASS,
	51	+ T_INTERFACE,
	52	+ );
53	53
54		- }//end register()
	54	+ }//end register()
55	55
56		- /**
57		- * Processes this test, when one of its tokens is encountered.
58		- *
59		- * @param File $phpcsFile The current file being processed.
60		- * @param int $stackPtr The position of the current token
61		- * in the stack passed in $tokens.
62		- *
63		- * @return void
64		- */
65		- public function process(File $phpcsFile, $stackPtr)
66		- {
67		- // get the class name
68		- $className = trim($phpcsFile->getDeclarationName($stackPtr));
69		- // compute the expected class name
70		- // [^_] means "something different from _", but not "nothing or something different from _"
71		- $lcClassNameChunk = preg_replace('/([^_])([A-Z])/', '${1}_${2}', $className);
72		- $expectedClassName
73		- = strtoupper($className[0]) . strtolower(substr($lcClassNameChunk,1));
74		- // ensures that the current class name
75		- // and the expected class name are identical
76		- if (0 !== strcmp($className, $expectedClassName)) {
77		- $error = 'Class names should always have their first letter uppercase. Multiple words should be separated with an underscore, and not CamelCased. Please consider ' . $expectedClassName . ' instead of ' . $className . '.';
78		- $phpcsFile->addError($error, $stackPtr);
79		- }
80		- }//end process()
	56	+ /**
	57	+ * Processes this test, when one of its tokens is encountered.
	58	+ *
	59	+ * @param File $phpcsFile The current file being processed.
	60	+ * @param int $stackPtr The position of the current token
	61	+ * in the stack passed in $tokens.
	62	+ *
	63	+ * @return void
	64	+ */
	65	+ public function process(File $phpcsFile, $stackPtr)
	66	+ {
	67	+ // get the class name
	68	+ $className = trim($phpcsFile->getDeclarationName($stackPtr));
	69	+ // compute the expected class name
	70	+ // [^_] means "something different from _", but not "nothing or something different from _"
	71	+ $lcClassNameChunk = preg_replace('/([^_])([A-Z])/', '${1}_${2}', $className);
	72	+ $expectedClassName
	73	+ = strtoupper($className[0]) . strtolower(substr($lcClassNameChunk,1));
	74	+ // ensures that the current class name
	75	+ // and the expected class name are identical
	76	+ if (0 !== strcmp($className, $expectedClassName)) {
	77	+ $error = 'Class names should always have their first letter uppercase. Multiple words should be separated with an underscore, and not CamelCased. Please consider ' . $expectedClassName . ' instead of ' . $className . '.';
	78	+ $phpcsFile->addError($error, $stackPtr);
	79	+ }
	80	+ }//end process()
81	81
82	82	}//end class
83	83

		@@ -40,121 +40,121 @@
		block discarded – undo
40	40
41	41	class ValidMethodNameSniff extends AbstractScopeSniff
42	42	{
43		- /**
44		- * A list of all PHP magic methods.
45		- *
46		- * @var array
47		- */
48		- protected static $magicMethods = array(
49		- 'construct',
50		- 'destruct',
51		- 'call',
52		- 'callStatic',
53		- 'get',
54		- 'set',
55		- 'isset',
56		- 'unset',
57		- 'sleep',
58		- 'wakeup',
59		- 'toString',
60		- 'set_state',
61		- 'clone',
62		- );
63		-
64		- /**
65		- * Defines which token(s) in which scope(s) will be proceed.
66		- */
67		- public function __construct()
68		- {
69		- parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION), true);
70		-
71		- }//end __construct()
72		-
73		-
74		- /**
75		- * Processes the tokens within the scope.
76		- *
77		- * @param File $phpcsFile The file being processed.
78		- * @param int $stackPtr The position where this token was
79		- * found.
80		- * @param int $currScope The position of the current scope.
81		- *
82		- * @return void
83		- */
84		- protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope)
85		- {
86		- $methodName = $phpcsFile->getDeclarationName($stackPtr);
87		- if ($methodName === null) {
88		- // Ignore closures.
89		- return;
90		- }
91		-
92		- $className = $phpcsFile->getDeclarationName($currScope);
93		-
94		- // Is this a magic method i.e. is prefixed with "__".
95		- if (0 === strcmp(substr($methodName, 0, 2), '__')) {
96		- $magicPart = substr($methodName, 2);
97		- if (in_array($magicPart, self::$magicMethods) === false) {
98		- $error = "Method name \"$className::$methodName\" is invalid; only PHP magic methods should be prefixed with a double underscore";
99		- $phpcsFile->addError($error, $stackPtr);
100		- }
101		-
102		- return;
103		- }
104		-
105		- // PHP4 constructors are allowed to break our rules.
106		- if ($methodName === $className) {
107		- return;
108		- }
109		-
110		- // PHP4 destructors are allowed to break our rules.
111		- if ($methodName === '_'.$className) {
112		- return;
113		- }
114		-
115		- if (0 !== strcmp($methodName, strtolower($methodName))) {
116		- $uscrdMethodName = preg_replace('/([A-Z])/', '_${1}', $methodName);
117		- $expectedMethodName = strtolower($uscrdMethodName);
118		- $error = "Class methods should be entirely lowercased. Please consider \"$expectedMethodName\" instead of \"$methodName\".";
119		- $phpcsFile->addError($error, $stackPtr);
120		- return;
121		- }
122		-
123		- $methodProps = $phpcsFile->getMethodProperties($stackPtr);
124		- $scope = $methodProps['scope'];
125		- $scopeSpecified = $methodProps['scope_specified'];
126		-
127		- // If it's a private method, it must have an underscore on the front.
128		- if ($scope === 'private' && $methodName{0} !== '_') {
129		- $error = "Private method name \"$className::$methodName\" must be prefixed with an underscore";
130		- $phpcsFile->addError($error, $stackPtr);
131		- return;
132		- }
133		-
134		- // If it's not a private method, it must not have an underscore on the front.
135		- if ($scope !== 'private' && $methodName{0} === '_') {
136		- if (true === $scopeSpecified) {
137		- $error = "Public method name \"$className::$methodName\" must not be prefixed with an underscore";
138		- } else {
139		- $error = ucfirst($scope)." method name \"$className::$methodName\" must not be prefixed with an underscore";
140		- }
141		- $phpcsFile->addError($error, $stackPtr);
142		- return;
143		- }
144		-
145		- // If name is too verbose,
146		- // then either an error or a warning is displayed.
147		- $error_limit = 50;
148		- $warning_limit = 35;
149		- if (strlen($methodName) > $error_limit) {
150		- $error = "Overly long and verbose names are prohibited. Please find a name shorter than $error_limit chars.";
151		- $phpcsFile->addError($error, $stackPtr);
152		- return;
153		- } else if (strlen($methodName) > $warning_limit) {
154		- $warning = "Try to avoid overly long and verbose names in finding a name shorter than $warning_limit chars.";
155		- $phpcsFile->addWarning($warning, $stackPtr);
156		- }
157		- }//end processTokenWithinScope()
	43	+ /**
	44	+ * A list of all PHP magic methods.
	45	+ *
	46	+ * @var array
	47	+ */
	48	+ protected static $magicMethods = array(
	49	+ 'construct',
	50	+ 'destruct',
	51	+ 'call',
	52	+ 'callStatic',
	53	+ 'get',
	54	+ 'set',
	55	+ 'isset',
	56	+ 'unset',
	57	+ 'sleep',
	58	+ 'wakeup',
	59	+ 'toString',
	60	+ 'set_state',
	61	+ 'clone',
	62	+ );
	63	+
	64	+ /**
	65	+ * Defines which token(s) in which scope(s) will be proceed.
	66	+ */
	67	+ public function __construct()
	68	+ {
	69	+ parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION), true);
	70	+
	71	+ }//end __construct()
	72	+
	73	+
	74	+ /**
	75	+ * Processes the tokens within the scope.
	76	+ *
	77	+ * @param File $phpcsFile The file being processed.
	78	+ * @param int $stackPtr The position where this token was
	79	+ * found.
	80	+ * @param int $currScope The position of the current scope.
	81	+ *
	82	+ * @return void
	83	+ */
	84	+ protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope)
	85	+ {
	86	+ $methodName = $phpcsFile->getDeclarationName($stackPtr);
	87	+ if ($methodName === null) {
	88	+ // Ignore closures.
	89	+ return;
	90	+ }
	91	+
	92	+ $className = $phpcsFile->getDeclarationName($currScope);
	93	+
	94	+ // Is this a magic method i.e. is prefixed with "__".
	95	+ if (0 === strcmp(substr($methodName, 0, 2), '__')) {
	96	+ $magicPart = substr($methodName, 2);
	97	+ if (in_array($magicPart, self::$magicMethods) === false) {
	98	+ $error = "Method name \"$className::$methodName\" is invalid; only PHP magic methods should be prefixed with a double underscore";
	99	+ $phpcsFile->addError($error, $stackPtr);
	100	+ }
	101	+
	102	+ return;
	103	+ }
	104	+
	105	+ // PHP4 constructors are allowed to break our rules.
	106	+ if ($methodName === $className) {
	107	+ return;
	108	+ }
	109	+
	110	+ // PHP4 destructors are allowed to break our rules.
	111	+ if ($methodName === '_'.$className) {
	112	+ return;
	113	+ }
	114	+
	115	+ if (0 !== strcmp($methodName, strtolower($methodName))) {
	116	+ $uscrdMethodName = preg_replace('/([A-Z])/', '_${1}', $methodName);
	117	+ $expectedMethodName = strtolower($uscrdMethodName);
	118	+ $error = "Class methods should be entirely lowercased. Please consider \"$expectedMethodName\" instead of \"$methodName\".";
	119	+ $phpcsFile->addError($error, $stackPtr);
	120	+ return;
	121	+ }
	122	+
	123	+ $methodProps = $phpcsFile->getMethodProperties($stackPtr);
	124	+ $scope = $methodProps['scope'];
	125	+ $scopeSpecified = $methodProps['scope_specified'];
	126	+
	127	+ // If it's a private method, it must have an underscore on the front.
	128	+ if ($scope === 'private' && $methodName{0} !== '_') {
	129	+ $error = "Private method name \"$className::$methodName\" must be prefixed with an underscore";
	130	+ $phpcsFile->addError($error, $stackPtr);
	131	+ return;
	132	+ }
	133	+
	134	+ // If it's not a private method, it must not have an underscore on the front.
	135	+ if ($scope !== 'private' && $methodName{0} === '_') {
	136	+ if (true === $scopeSpecified) {
	137	+ $error = "Public method name \"$className::$methodName\" must not be prefixed with an underscore";
	138	+ } else {
	139	+ $error = ucfirst($scope)." method name \"$className::$methodName\" must not be prefixed with an underscore";
	140	+ }
	141	+ $phpcsFile->addError($error, $stackPtr);
	142	+ return;
	143	+ }
	144	+
	145	+ // If name is too verbose,
	146	+ // then either an error or a warning is displayed.
	147	+ $error_limit = 50;
	148	+ $warning_limit = 35;
	149	+ if (strlen($methodName) > $error_limit) {
	150	+ $error = "Overly long and verbose names are prohibited. Please find a name shorter than $error_limit chars.";
	151	+ $phpcsFile->addError($error, $stackPtr);
	152	+ return;
	153	+ } else if (strlen($methodName) > $warning_limit) {
	154	+ $warning = "Try to avoid overly long and verbose names in finding a name shorter than $warning_limit chars.";
	155	+ $phpcsFile->addWarning($warning, $stackPtr);
	156	+ }
	157	+ }//end processTokenWithinScope()
158	158
159	159	}//end class
160	160

		@@ -32,53 +32,53 @@
		block discarded – undo
32	32
33	33	class ValidFileNameSniff implements Sniff
34	34	{
35		- /**
36		- * Returns an array of tokens this test wants to listen for.
37		- *
38		- * @return array
39		- */
40		- public function register()
41		- {
42		- return array(
43		- T_CLASS,
44		- T_INTERFACE,
45		- );
46		- }//end register()
	35	+ /**
	36	+ * Returns an array of tokens this test wants to listen for.
	37	+ *
	38	+ * @return array
	39	+ */
	40	+ public function register()
	41	+ {
	42	+ return array(
	43	+ T_CLASS,
	44	+ T_INTERFACE,
	45	+ );
	46	+ }//end register()
47	47
48	48
49		- /**
50		- * Processes this test, when one of its tokens is encountered.
51		- *
52		- * @param File $phpcsFile The file being scanned.
53		- * @param int $stackPtr The position of the current token in the
54		- * stack passed in $tokens.
55		- *
56		- * @return void
57		- */
58		- public function process(File $phpcsFile, $stackPtr)
59		- {
60		- $tokens = $phpcsFile->getTokens();
61		- // computes the expected filename based on the name of the class or interface that it contains.
62		- $decNamePtr = $phpcsFile->findNext(T_STRING, $stackPtr);
63		- $decName = $tokens[$decNamePtr]['content'];
64		- $expectedFileName = strtolower($decName);
65		- // extracts filename without extension from its path.
66		- $fullPath = $phpcsFile->getFilename();
67		- $fileNameAndExt = basename($fullPath);
68		- $fileName = substr($fileNameAndExt, 0, strrpos($fileNameAndExt, '.'));
	49	+ /**
	50	+ * Processes this test, when one of its tokens is encountered.
	51	+ *
	52	+ * @param File $phpcsFile The file being scanned.
	53	+ * @param int $stackPtr The position of the current token in the
	54	+ * stack passed in $tokens.
	55	+ *
	56	+ * @return void
	57	+ */
	58	+ public function process(File $phpcsFile, $stackPtr)
	59	+ {
	60	+ $tokens = $phpcsFile->getTokens();
	61	+ // computes the expected filename based on the name of the class or interface that it contains.
	62	+ $decNamePtr = $phpcsFile->findNext(T_STRING, $stackPtr);
	63	+ $decName = $tokens[$decNamePtr]['content'];
	64	+ $expectedFileName = strtolower($decName);
	65	+ // extracts filename without extension from its path.
	66	+ $fullPath = $phpcsFile->getFilename();
	67	+ $fileNameAndExt = basename($fullPath);
	68	+ $fileName = substr($fileNameAndExt, 0, strrpos($fileNameAndExt, '.'));
69	69
70		- if ($expectedFileName !== $fileName) {
71		- $errorTemplate = 'Filename "%s" doesn\'t match the name of the %s that it contains "%s" in lower case. "%s" was expected.';
72		- $errorMessage = sprintf(
73		- $errorTemplate,
74		- $fileName,
75		- strtolower($tokens[$stackPtr]['content']), // class or interface
76		- $decName,
77		- $expectedFileName
78		- );
79		- $phpcsFile->addError($errorMessage, 0);
80		- }
81		- }//end process()
	70	+ if ($expectedFileName !== $fileName) {
	71	+ $errorTemplate = 'Filename "%s" doesn\'t match the name of the %s that it contains "%s" in lower case. "%s" was expected.';
	72	+ $errorMessage = sprintf(
	73	+ $errorTemplate,
	74	+ $fileName,
	75	+ strtolower($tokens[$stackPtr]['content']), // class or interface
	76	+ $decName,
	77	+ $expectedFileName
	78	+ );
	79	+ $phpcsFile->addError($errorMessage, 0);
	80	+ }
	81	+ }//end process()
82	82	}//end class
83	83
84	84	?>

timw4mail / HummingBirdAnimeClient

Branch — develop (6d735e)

Category

Indentation +16 added lines, -16 removed lines patch added patch discarded remove patch

Indentation +132 added lines, -132 removed lines patch added patch discarded remove patch

Indentation +61 added lines, -61 removed lines patch added patch discarded remove patch

Indentation +59 added lines, -59 removed lines patch added patch discarded remove patch

Indentation +92 added lines, -92 removed lines patch added patch discarded remove patch

Indentation +37 added lines, -37 removed lines patch added patch discarded remove patch

Indentation +494 added lines, -494 removed lines patch added patch discarded remove patch

Indentation +115 added lines, -115 removed lines patch added patch discarded remove patch

Indentation +44 added lines, -44 removed lines patch added patch discarded remove patch