class InterfaceNameSniff
Checks that interface names end with "Interface".
@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer
Hierarchy
- class \Drupal\Sniffs\Classes\InterfaceNameSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of InterfaceNameSniff
File
-
vendor/
drupal/ coder/ coder_sniffer/ Drupal/ Sniffs/ Classes/ InterfaceNameSniff.php, line 22
Namespace
Drupal\Sniffs\ClassesView source
class InterfaceNameSniff implements Sniff {
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array<int|string>
*/
public function register() {
return [
T_INTERFACE,
];
}
//end register()
/**
* Processes this test, when one of its tokens is encountered.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token in
* the stack passed in $tokens.
*
* @return void
*/
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');
}
}
//end process()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
InterfaceNameSniff::process | public | function | Processes this test, when one of its tokens is encountered. | Overrides Sniff::process |
InterfaceNameSniff::register | public | function | Returns an array of tokens this test wants to listen for. | Overrides Sniff::register |