Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\Functions\FunctionDeclarationSniff.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@17: namespace Drupal\Sniffs\Functions;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@0:  * Ensure that there is only one space after the function keyword and no space
Chris@0:  * before the opening parenthesis.
Chris@0:  *
Chris@0:  * @deprecated in Coder 8.x, will be removed in Coder 9.x.
Chris@0:  * Squiz.Functions.MultiLineFunctionDeclaration is used instead, see ruleset.xml.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@17: class FunctionDeclarationSniff implements Sniff
Chris@0: {
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an array of tokens this test wants to listen for.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function register()
Chris@0:     {
Chris@0:         return array(T_FUNCTION);
Chris@0: 
Chris@0:     }//end register()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes this test, when one of its tokens is encountered.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@17:      * @param int                         $stackPtr  The position of the current token
Chris@17:      *                                               in the stack passed in $tokens.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:         if ($tokens[($stackPtr + 1)]['content'] !== ' ') {
Chris@0:             $error = 'Expected exactly one space after the function keyword';
Chris@0:             $phpcsFile->addError($error, ($stackPtr + 1), 'SpaceAfter');
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($tokens[($stackPtr + 3)]) === true
Chris@0:             && $tokens[($stackPtr + 3)]['code'] === T_WHITESPACE
Chris@0:         ) {
Chris@0:             $error = 'Space before opening parenthesis of function definition prohibited';
Chris@0:             $phpcsFile->addError($error, ($stackPtr + 3), 'SpaceBeforeParenthesis');
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class