public function HookInitCssSniff::processFunction in Coder 8.2

Same name and namespace in other branches

1. 8.3 coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/HookInitCssSniff.php \DrupalPractice\Sniffs\FunctionDefinitions\HookInitCssSniff::processFunction()
2. 8.3.x coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/HookInitCssSniff.php \DrupalPractice\Sniffs\FunctionDefinitions\HookInitCssSniff::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.

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

Return value

void

Overrides FunctionDefinition::processFunction

File

coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/HookInitCssSniff.php, line 39

Class

HookInitCssSniff

Checks that drupal_add_css() is not used in hook_init().

Namespace

DrupalPractice\Sniffs\FunctionDefinitions

Code

public function processFunction(File $phpcsFile, $stackPtr, $functionPtr) {
  $fileExtension = strtolower(substr($phpcsFile
    ->getFilename(), -6));

  // Only check in *.module files.
  if ($fileExtension !== 'module') {
    return;
  }

  // This check only applies to Drupal 7, not Drupal 6.
  if (Project::getCoreVersion($phpcsFile) !== '7.x') {
    return;
  }
  $fileName = substr(basename($phpcsFile
    ->getFilename()), 0, -7);
  $tokens = $phpcsFile
    ->getTokens();
  if ($tokens[$stackPtr]['content'] !== $fileName . '_init' && $tokens[$stackPtr]['content'] !== $fileName . '_page_build') {
    return;
  }

  // Search in the function body for drupal_add_css() calls.
  $string = $phpcsFile
    ->findNext(T_STRING, $tokens[$functionPtr]['scope_opener'], $tokens[$functionPtr]['scope_closer']);
  while ($string !== false) {
    if ($tokens[$string]['content'] === 'drupal_add_css' || $tokens[$string]['content'] === 'drupal_add_js') {
      $opener = $phpcsFile
        ->findNext(Tokens::$emptyTokens, $string + 1, null, true);
      if ($opener !== false && $tokens[$opener]['code'] === T_OPEN_PARENTHESIS) {
        if ($tokens[$stackPtr]['content'] === $fileName . '_init') {
          $warning = 'Do not use %s() in hook_init(), use #attached for CSS and JS in your page/form callback or in hook_page_build() instead';
          $phpcsFile
            ->addWarning($warning, $string, 'AddFunctionFound', array(
            $tokens[$string]['content'],
          ));
        }
        else {
          $warning = 'Do not use %s() in hook_page_build(), use #attached for CSS and JS on the $page render array instead';
          $phpcsFile
            ->addWarning($warning, $string, 'AddFunctionFoundPageBuild', array(
            $tokens[$string]['content'],
          ));
        }
      }
    }
    $string = $phpcsFile
      ->findNext(T_STRING, $string + 1, $tokens[$functionPtr]['scope_closer']);
  }

  //end while
}