diff options
| author | Marc Alexander <admin@m-a-styles.de> | 2015-06-07 22:51:33 +0200 |
|---|---|---|
| committer | Marc Alexander <admin@m-a-styles.de> | 2015-06-07 22:51:33 +0200 |
| commit | 6687b7e9ab543c69c83b386452b53ba03a473539 (patch) | |
| tree | b59ceab8702bed9d4a9d80d550b7d4c03fa27ad4 | |
| parent | 25c4c481d74f2272218fced8506cb7861eec8a75 (diff) | |
| download | forums-6687b7e9ab543c69c83b386452b53ba03a473539.tar forums-6687b7e9ab543c69c83b386452b53ba03a473539.tar.gz forums-6687b7e9ab543c69c83b386452b53ba03a473539.tar.bz2 forums-6687b7e9ab543c69c83b386452b53ba03a473539.tar.xz forums-6687b7e9ab543c69c83b386452b53ba03a473539.zip | |
[ticket/13930] Check for correct spacing between keyword & parenthesis
The codesniffer should check for a correct spacing between keywords like
if or foreach and its opening parenthesis.
PHPBB3-13930
| -rw-r--r-- | build/code_sniffer/phpbb/Sniffs/ControlStructures/OpeningParenthesisSniff.php | 62 | ||||
| -rw-r--r-- | build/code_sniffer/ruleset-php-strict.xml | 3 |
2 files changed, 65 insertions, 0 deletions
diff --git a/build/code_sniffer/phpbb/Sniffs/ControlStructures/OpeningParenthesisSniff.php b/build/code_sniffer/phpbb/Sniffs/ControlStructures/OpeningParenthesisSniff.php new file mode 100644 index 0000000000..955405ce01 --- /dev/null +++ b/build/code_sniffer/phpbb/Sniffs/ControlStructures/OpeningParenthesisSniff.php @@ -0,0 +1,62 @@ +<?php +/** + * + * This file is part of the phpBB Forum Software package. + * + * @copyright (c) phpBB Limited <https://www.phpbb.com> + * @license GNU General Public License, version 2 (GPL-2.0) + * + * For full copyright and license information, please see + * the docs/CREDITS.txt file. + * + */ + +/** + * Checks that there is exactly one space between the keyword and the opening + * parenthesis of a control structures. + */ +class phpbb_Sniffs_ControlStructures_OpeningParenthesisSniff implements PHP_CodeSniffer_Sniff +{ + /** + * Registers the tokens that this sniff wants to listen for. + */ + public function register() + { + return array( + T_IF, + T_FOREACH, + T_WHILE, + T_FOR, + T_SWITCH, + T_ELSEIF, + T_CATCH, + ); + } + + /** + * Processes this test, when one of its tokens is encountered. + * + * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. + * @param int $stackPtr The position of the current token in the + * stack passed in $tokens. + * + * @return void + */ + public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + { + $tokens = $phpcsFile->getTokens(); + + if ($tokens[$stackPtr + 1]['content'] === '(') + { + $error = 'There should be exactly one space between the keyword and opening parenthesis'; + $phpcsFile->addError($error, $stackPtr, 'NoSpaceBeforeOpeningParenthesis'); + return; + } + else if ($tokens[$stackPtr + 1]['content'] !== ' ') + { + $error = 'There should be exactly one space between the keyword and opening parenthesis'; + $phpcsFile->addError($error, $stackPtr, 'IncorrectSpaceBeforeOpeningParenthesis'); + return; + } + } +} diff --git a/build/code_sniffer/ruleset-php-strict.xml b/build/code_sniffer/ruleset-php-strict.xml index 9e2f0664d8..fdc82f2be8 100644 --- a/build/code_sniffer/ruleset-php-strict.xml +++ b/build/code_sniffer/ruleset-php-strict.xml @@ -45,4 +45,7 @@ <!-- There MUST NOT be unused use statements. --> <rule ref="./phpbb/Sniffs/Namespaces/UnusedUseSniff.php" /> + <!-- There MUST be one space between control structure and opening parenthesis --> + <rule ref="./phpbb/Sniffs/ControlStructures/OpeningParenthesisSniff.php" /> + </ruleset> |