annotate vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Semantics/InstallHooksSniff.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2 /**
Chris@17 3 * \Drupal\Sniffs\Semantics\InstallHooksSniff
Chris@0 4 *
Chris@0 5 * @category PHP
Chris@0 6 * @package PHP_CodeSniffer
Chris@0 7 * @link http://pear.php.net/package/PHP_CodeSniffer
Chris@0 8 */
Chris@0 9
Chris@17 10 namespace Drupal\Sniffs\Semantics;
Chris@17 11
Chris@17 12 use Drupal\Sniffs\Semantics\FunctionDefinition;
Chris@17 13 use PHP_CodeSniffer\Files\File;
Chris@17 14
Chris@0 15 /**
Chris@0 16 * Checks that hook_disable(), hook_enable(), hook_install(), hook_uninstall(),
Chris@0 17 * hook_requirements() and hook_schema() are not defined in the module file.
Chris@0 18 *
Chris@0 19 * @category PHP
Chris@0 20 * @package PHP_CodeSniffer
Chris@0 21 * @link http://pear.php.net/package/PHP_CodeSniffer
Chris@0 22 */
Chris@17 23 class InstallHooksSniff extends FunctionDefinition
Chris@0 24 {
Chris@0 25
Chris@0 26
Chris@0 27 /**
Chris@0 28 * Process this function definition.
Chris@0 29 *
Chris@17 30 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@17 31 * @param int $stackPtr The position of the function name in the stack.
Chris@17 32 * name in the stack.
Chris@17 33 * @param int $functionPtr The position of the function keyword in the stack.
Chris@17 34 * keyword in the stack.
Chris@0 35 *
Chris@0 36 * @return void
Chris@0 37 */
Chris@17 38 public function processFunction(File $phpcsFile, $stackPtr, $functionPtr)
Chris@0 39 {
Chris@0 40 $fileExtension = strtolower(substr($phpcsFile->getFilename(), -6));
Chris@0 41 // Only check in *.module files.
Chris@0 42 if ($fileExtension !== 'module') {
Chris@0 43 return;
Chris@0 44 }
Chris@0 45
Chris@0 46 $tokens = $phpcsFile->getTokens();
Chris@0 47
Chris@0 48 $fileName = substr(basename($phpcsFile->getFilename()), 0, -7);
Chris@0 49 if ($tokens[$stackPtr]['content'] === ($fileName.'_install')
Chris@0 50 || $tokens[$stackPtr]['content'] === ($fileName.'_uninstall')
Chris@0 51 || $tokens[$stackPtr]['content'] === ($fileName.'_requirements')
Chris@0 52 || $tokens[$stackPtr]['content'] === ($fileName.'_schema')
Chris@0 53 || $tokens[$stackPtr]['content'] === ($fileName.'_enable')
Chris@0 54 || $tokens[$stackPtr]['content'] === ($fileName.'_disable')
Chris@0 55 ) {
Chris@0 56 $error = '%s() is an installation hook and must be declared in an install file';
Chris@0 57 $data = array($tokens[$stackPtr]['content']);
Chris@0 58 $phpcsFile->addError($error, $stackPtr, 'InstallHook', $data);
Chris@0 59 }
Chris@0 60
Chris@0 61 }//end processFunction()
Chris@0 62
Chris@0 63
Chris@0 64 }//end class