ConstantNameSniff.php in Coder 8.3

Namespace

Drupal\Sniffs\Semantics

File

coder_sniffer/Drupal/Sniffs/Semantics/ConstantNameSniff.php

<?php

/**
 * \Drupal\Sniffs\Semantics\ConstantNameSniff
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
namespace Drupal\Sniffs\Semantics;

use PHP_CodeSniffer\Files\File;

/**
 * Checks that constants introduced with define() in module or install files start
 * with the module's name.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
class ConstantNameSniff extends FunctionCall {

  /**
   * Returns an array of function names this test wants to listen for.
   *
   * @return array<string>
   */
  public function registerFunctionNames() {
    return [
      'define',
    ];
  }

  //end registerFunctionNames()

  /**
   * Processes this function call.
   *
   * @param \PHP_CodeSniffer\Files\File $phpcsFile    The file being scanned.
   * @param int                         $stackPtr     The position of the function call in
   *                                                  the stack.
   * @param int                         $openBracket  The position of the opening
   *                                                  parenthesis in the stack.
   * @param int                         $closeBracket The position of the closing
   *                                                  parenthesis in the stack.
   *
   * @return void
   */
  public function processFunctionCall(File $phpcsFile, $stackPtr, $openBracket, $closeBracket) {
    $nameParts = explode('.', basename($phpcsFile
      ->getFilename()));
    $fileExtension = end($nameParts);

    // Only check in *.module files.
    if ($fileExtension !== 'module' && $fileExtension !== 'install') {
      return;
    }
    $tokens = $phpcsFile
      ->getTokens();
    $argument = $this
      ->getArgument(1);
    if ($tokens[$argument['start']]['code'] !== T_CONSTANT_ENCAPSED_STRING) {

      // Not a string literal, so this is some obscure constant that we ignore.
      return;
    }
    $moduleName = reset($nameParts);
    $expectedStart = strtoupper($moduleName);

    // Remove the quotes around the string litral.
    $constant = substr($tokens[$argument['start']]['content'], 1, -1);
    if (strpos($constant, $expectedStart) !== 0) {
      $warning = 'All constants defined by a module must be prefixed with the module\'s name, expected "%s" but found "%s"';
      $data = [
        $expectedStart . "_{$constant}",
        $constant,
      ];
      $phpcsFile
        ->addWarning($warning, $stackPtr, 'ConstantStart', $data);
    }
  }

}

//end class

Classes

Name	Description
ConstantNameSniff	Checks that constants introduced with define() in module or install files start with the module's name.