public function InterfaceNameSniff::process in Coder 8.3

Same name and namespace in other branches

1. 8.2 coder_sniffer/Drupal/Sniffs/Classes/InterfaceNameSniff.php \Drupal\Sniffs\Classes\InterfaceNameSniff::process()
2. 8.3.x coder_sniffer/Drupal/Sniffs/Classes/InterfaceNameSniff.php \Drupal\Sniffs\Classes\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

File

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