class Drupal_Sniffs_Semantics_InstallHooksSniff in Coder 7.2
Checks that hook_disable(), hook_enable(), hook_install(), hook_uninstall(), hook_requirements() and hook_schema() are not defined in the module file.
@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer
Hierarchy
- class \Drupal_Sniffs_Semantics_FunctionDefinition implements \PHP_CodeSniffer_Sniff
Expanded class hierarchy of Drupal_Sniffs_Semantics_InstallHooksSniff
File
- coder_sniffer/
Drupal/ Sniffs/ Semantics/ InstallHooksSniff.php, line 20
View source
class Drupal_Sniffs_Semantics_InstallHooksSniff 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(), -6));
// Only check in *.module files.
if ($fileExtension !== 'module') {
return;
}
$tokens = $phpcsFile
->getTokens();
$fileName = substr(basename($phpcsFile
->getFilename()), 0, -7);
if ($tokens[$stackPtr]['content'] === $fileName . '_install' || $tokens[$stackPtr]['content'] === $fileName . '_uninstall' || $tokens[$stackPtr]['content'] === $fileName . '_requirements' || $tokens[$stackPtr]['content'] === $fileName . '_schema' || $tokens[$stackPtr]['content'] === $fileName . '_enable' || $tokens[$stackPtr]['content'] === $fileName . '_disable') {
$error = '%s() is an installation hook and must be declared in an install file';
$data = array(
$tokens[$stackPtr]['content'],
);
$phpcsFile
->addError($error, $stackPtr, 'InstallHook', $data);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Drupal_Sniffs_Semantics_FunctionDefinition:: |
public | function | Processes this test, when one of its tokens is encountered. | |
Drupal_Sniffs_Semantics_FunctionDefinition:: |
public | function | Returns an array of tokens this test wants to listen for. | |
Drupal_Sniffs_Semantics_InstallHooksSniff:: |
public | function |
Process this function definition. Overrides Drupal_Sniffs_Semantics_FunctionDefinition:: |