Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. InterfaceNameSniff.php

function InterfaceNameSniff::process

Processes this test, when one of its tokens is encountered.

Parameters

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

int $stackPtr The position of the current token in: the stack passed in $tokens.

Return value

void

Overrides Sniff::process

File

vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Classes/InterfaceNameSniff.php, line 47

Class

InterfaceNameSniff
Checks that interface names end with "Interface".

Namespace

Drupal\Sniffs\Classes

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $namePtr = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
    $name = $tokens[$namePtr]['content'];
    if (substr($name, -9) !== 'Interface') {
        $warn = 'Interface names should always have the suffix "Interface"';
        $phpcsFile->addWarning($warn, $namePtr, 'InterfaceSuffix');
    }
}
RSS feed
Powered by Drupal