class InterfaceNameSniff in Coder 8.2
Same name and namespace in other branches
- 8.3 coder_sniffer/Drupal/Sniffs/Classes/InterfaceNameSniff.php \Drupal\Sniffs\Classes\InterfaceNameSniff
- 8.3.x coder_sniffer/Drupal/Sniffs/Classes/InterfaceNameSniff.php \Drupal\Sniffs\Classes\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
- 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
*/
public function register() {
return array(
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');
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
InterfaceNameSniff:: |
public | function | Processes this test, when one of its tokens is encountered. | |
InterfaceNameSniff:: |
public | function | Returns an array of tokens this test wants to listen for. |