Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\Semantics\EmptyInstallSniff.
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 Drupal\Sniffs\Semantics\FunctionDefinition;
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Util\Tokens;
Chris@17: 
Chris@0: /**
Chris@0:  * Throws an error if hook_install() or hook_uninstall() definitions are empty.
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 EmptyInstallSniff extends FunctionDefinition
Chris@0: {
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 function processFunction(File $phpcsFile, $stackPtr, $functionPtr)
Chris@0:     {
Chris@0:         $fileExtension = strtolower(substr($phpcsFile->getFilename(), -7));
Chris@0:         // Only check in *.install files.
Chris@0:         if ($fileExtension !== 'install') {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $fileName = substr(basename($phpcsFile->getFilename()), 0, -8);
Chris@0:         $tokens   = $phpcsFile->getTokens();
Chris@0:         if ($tokens[$stackPtr]['content'] === ($fileName.'_install')
Chris@0:             || $tokens[$stackPtr]['content'] === ($fileName.'_uninstall')
Chris@0:         ) {
Chris@0:             // Check if there is a function body.
Chris@0:             $bodyPtr = $phpcsFile->findNext(
Chris@17:                 Tokens::$emptyTokens,
Chris@0:                 ($tokens[$functionPtr]['scope_opener'] + 1),
Chris@0:                 $tokens[$functionPtr]['scope_closer'],
Chris@0:                 true
Chris@0:             );
Chris@0:             if ($bodyPtr === false) {
Chris@0:                 $error = 'Empty installation hooks are not necessary';
Chris@0:                 $phpcsFile->addError($error, $stackPtr, 'EmptyInstall');
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:     }//end processFunction()
Chris@0: 
Chris@0: 
Chris@0: }//end class