public function InstallHooksSniff::processFunction in Coder 8.2

Same name and namespace in other branches

1. 8.3 coder_sniffer/Drupal/Sniffs/Semantics/InstallHooksSniff.php \Drupal\Sniffs\Semantics\InstallHooksSniff::processFunction()
2. 8.3.x coder_sniffer/Drupal/Sniffs/Semantics/InstallHooksSniff.php \Drupal\Sniffs\Semantics\InstallHooksSniff::processFunction()

Process this function definition.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

int $stackPtr The position of the function name in the stack.: name in the stack.

int $functionPtr The position of the function keyword in the stack.: keyword in the stack.

Return value

void

Overrides FunctionDefinition::processFunction

File

coder_sniffer/Drupal/Sniffs/Semantics/InstallHooksSniff.php, line 38

Class

InstallHooksSniff

Checks that hook_disable(), hook_enable(), hook_install(), hook_uninstall(), hook_requirements() and hook_schema() are not defined in the module file.

Namespace

Drupal\Sniffs\Semantics

Code

public function processFunction(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);
  }
}