Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\Semantics\FunctionDefinition.
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\Semantics;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: use PHP_CodeSniffer\Util\Tokens;
Chris@17: 
Chris@0: /**
Chris@0:  * Helper class to sniff for function definitions.
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: abstract class FunctionDefinition 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_STRING);
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:         // Check if this is a function definition.
Chris@0:         $functionPtr = $phpcsFile->findPrevious(
Chris@17:             Tokens::$emptyTokens,
Chris@0:             ($stackPtr - 1),
Chris@0:             null,
Chris@0:             true
Chris@0:         );
Chris@0:         if ($tokens[$functionPtr]['code'] === T_FUNCTION) {
Chris@0:             $this->processFunction($phpcsFile, $stackPtr, $functionPtr);
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Process this function definition.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile   The file being scanned.
Chris@17:      * @param int                         $stackPtr    The position of the function name in the stack.
Chris@17:      *                                                 name in the stack.
Chris@17:      * @param int                         $functionPtr The position of the function keyword in the stack.
Chris@17:      *                                                 keyword in the stack.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     public abstract function processFunction(File $phpcsFile, $stackPtr, $functionPtr);
Chris@0: 
Chris@0: 
Chris@0: }//end class