Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\Semantics\InstallHooksSniff
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: 
Chris@0: /**
Chris@0:  * Checks that hook_disable(), hook_enable(), hook_install(), hook_uninstall(),
Chris@0:  * hook_requirements() and hook_schema() are not defined in the module file.
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 InstallHooksSniff 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(), -6));
Chris@0:         // Only check in *.module files.
Chris@0:         if ($fileExtension !== 'module') {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:         $fileName = substr(basename($phpcsFile->getFilename()), 0, -7);
Chris@0:         if ($tokens[$stackPtr]['content'] === ($fileName.'_install')
Chris@0:             || $tokens[$stackPtr]['content'] === ($fileName.'_uninstall')
Chris@0:             || $tokens[$stackPtr]['content'] === ($fileName.'_requirements')
Chris@0:             || $tokens[$stackPtr]['content'] === ($fileName.'_schema')
Chris@0:             || $tokens[$stackPtr]['content'] === ($fileName.'_enable')
Chris@0:             || $tokens[$stackPtr]['content'] === ($fileName.'_disable')
Chris@0:         ) {
Chris@0:             $error = '%s() is an installation hook and must be declared in an install file';
Chris@0:             $data  = array($tokens[$stackPtr]['content']);
Chris@0:             $phpcsFile->addError($error, $stackPtr, 'InstallHook', $data);
Chris@0:         }
Chris@0: 
Chris@0:     }//end processFunction()
Chris@0: 
Chris@0: 
Chris@0: }//end class