Chris@0: <?php
Chris@0: /**
Chris@0:  * 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@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@0: abstract class Drupal_Sniffs_Semantics_FunctionDefinition implements PHP_CodeSniffer_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@0:      * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
Chris@0:      * @param int                  $stackPtr  The position of the current token
Chris@0:      *                                        in the stack passed in $tokens.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public function process(PHP_CodeSniffer_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@0:             PHP_CodeSniffer_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@0:      * @param PHP_CodeSniffer_File $phpcsFile   The file being scanned.
Chris@0:      * @param int                  $stackPtr    The position of the function name in the stack.
Chris@0:      *                                           name in the stack.
Chris@0:      * @param int                  $functionPtr The position of the function keyword in the stack.
Chris@0:      *                                           keyword in the stack.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public abstract function processFunction(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $functionPtr);
Chris@0: 
Chris@0: 
Chris@0: }//end class