public function Drupal_Sniffs_Semantics_EmptyInstallSniff::processFunction in Coder 7.2
Process this function definition.
Parameters
PHP_CodeSniffer_File $phpcsFile The file being scanned.:
int $stackPtr The position of the function: name in the stack.
int $functionPtr The position of the function: keyword in the stack.
Return value
void
Overrides Drupal_Sniffs_Semantics_FunctionDefinition::processFunction
File
- coder_sniffer/
Drupal/ Sniffs/ Semantics/ EmptyInstallSniff.php, line 34
Class
- Drupal_Sniffs_Semantics_EmptyInstallSniff
- Throws an error if hook_install() or hook_uninstall() definitions are empty.
Code
public function processFunction(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $functionPtr) {
$fileExtension = strtolower(substr($phpcsFile
->getFilename(), -7));
// Only check in *.install files.
if ($fileExtension !== 'install') {
return;
}
$fileName = substr(basename($phpcsFile
->getFilename()), 0, -8);
$tokens = $phpcsFile
->getTokens();
if ($tokens[$stackPtr]['content'] === $fileName . '_install' || $tokens[$stackPtr]['content'] === $fileName . '_uninstall') {
// Check if there is a function body.
$bodyPtr = $phpcsFile
->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, $tokens[$functionPtr]['scope_opener'] + 1, $tokens[$functionPtr]['scope_closer'], true);
if ($bodyPtr === false) {
$error = 'Empty installation hooks are not necessary';
$phpcsFile
->addError($error, $stackPtr, 'EmptyInstall');
}
}
}