class ConstantNameSniff in Coder 8.3.x

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

Hierarchy

• class \Drupal\Sniffs\Semantics\FunctionCall implements \PHP_CodeSniffer\Sniffs\Sniff
  • class \Drupal\Sniffs\Semantics\ConstantNameSniff

File

coder_sniffer/Drupal/Sniffs/Semantics/ConstantNameSniff.php, line 22

Namespace

Drupal\Sniffs\Semantics

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);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConstantNameSniff::processFunctionCall	public	function	Processes this function call.
ConstantNameSniff::registerFunctionNames	public	function	Returns an array of function names this test wants to listen for.
FunctionCall::$arguments	protected	property	Internal cache to save the calculated arguments of the function call.
FunctionCall::$closeBracket	protected	property	The token position of the closing bracket of the function call.
FunctionCall::$functionCall	protected	property	The token position of the function call.
FunctionCall::$includeMethodCalls	protected	property	Whether method invocations with the same function name should be processed, too.	1
FunctionCall::$openBracket	protected	property	The token position of the opening bracket of the function call.
FunctionCall::$phpcsFile	protected	property	The currently processed file.
FunctionCall::getArgument	public	function	Returns start and end token for a given argument number.
FunctionCall::isFunctionCall	protected	function	Checks if this is a function call.
FunctionCall::process	public	function	Processes this test, when one of its tokens is encountered.	2
FunctionCall::register	public	function	Returns an array of tokens this test wants to listen for.