public function EmptyInstallSniff::processFunction in Coder 8.2

Same name and namespace in other branches

1. 8.3 coder_sniffer/Drupal/Sniffs/Semantics/EmptyInstallSniff.php \Drupal\Sniffs\Semantics\EmptyInstallSniff::processFunction()
2. 8.3.x coder_sniffer/Drupal/Sniffs/Semantics/EmptyInstallSniff.php \Drupal\Sniffs\Semantics\EmptyInstallSniff::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/EmptyInstallSniff.php, line 38

Class

EmptyInstallSniff

Throws an error if hook_install() or hook_uninstall() definitions are empty.

Namespace

Drupal\Sniffs\Semantics

Code

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