annotate vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Semantics/EmptyInstallSniff.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\EmptyInstallSniff.
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 use PHP_CodeSniffer\Util\Tokens;
Chris@17 15
Chris@0 16 /**
Chris@0 17 * Throws an error if hook_install() or hook_uninstall() definitions are empty.
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 EmptyInstallSniff 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(), -7));
Chris@0 41 // Only check in *.install files.
Chris@0 42 if ($fileExtension !== 'install') {
Chris@0 43 return;
Chris@0 44 }
Chris@0 45
Chris@0 46 $fileName = substr(basename($phpcsFile->getFilename()), 0, -8);
Chris@0 47 $tokens = $phpcsFile->getTokens();
Chris@0 48 if ($tokens[$stackPtr]['content'] === ($fileName.'_install')
Chris@0 49 || $tokens[$stackPtr]['content'] === ($fileName.'_uninstall')
Chris@0 50 ) {
Chris@0 51 // Check if there is a function body.
Chris@0 52 $bodyPtr = $phpcsFile->findNext(
Chris@17 53 Tokens::$emptyTokens,
Chris@0 54 ($tokens[$functionPtr]['scope_opener'] + 1),
Chris@0 55 $tokens[$functionPtr]['scope_closer'],
Chris@0 56 true
Chris@0 57 );
Chris@0 58 if ($bodyPtr === false) {
Chris@0 59 $error = 'Empty installation hooks are not necessary';
Chris@0 60 $phpcsFile->addError($error, $stackPtr, 'EmptyInstall');
Chris@0 61 }
Chris@0 62 }
Chris@0 63
Chris@0 64 }//end processFunction()
Chris@0 65
Chris@0 66
Chris@0 67 }//end class