EmptyInstallSniff.php in Coder 7.2
File
coder_sniffer/Drupal/Sniffs/Semantics/EmptyInstallSniff.phpView source
<?php
/**
* Drupal_Sniffs_Semantics_EmptyInstallSniff.
*
* PHP version 5
*
* @category PHP
* @package PHP_CodeSniffer
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
/**
* Throws an error if hook_install() or hook_uninstall() definitions are empty.
*
* @category PHP
* @package PHP_CodeSniffer
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
class Drupal_Sniffs_Semantics_EmptyInstallSniff extends Drupal_Sniffs_Semantics_FunctionDefinition {
/**
* Process this function definition.
*
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the function
* name in the stack.
* @param int $functionPtr The position of the function
* keyword in the stack.
*
* @return void
*/
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');
}
}
}
}
//end class
Classes
Name | Description |
---|---|
Drupal_Sniffs_Semantics_EmptyInstallSniff | Throws an error if hook_install() or hook_uninstall() definitions are empty. |