class TraitNameSuffixSniff
Hierarchy
- class \PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\TraitNameSuffixSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of TraitNameSuffixSniff
File
-
vendor/
squizlabs/ php_codesniffer/ src/ Standards/ Generic/ Sniffs/ NamingConventions/ TraitNameSuffixSniff.php, line 14
Namespace
PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventionsView source
class TraitNameSuffixSniff implements Sniff {
/**
* Registers the tokens that this sniff wants to listen for.
*
* @return array<int|string>
*/
public function register() {
return [
T_TRAIT,
];
}
//end register()
/**
* Processes this sniff, 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) {
$traitName = $phpcsFile->getDeclarationName($stackPtr);
if ($traitName === null) {
// Live coding or parse error. Bow out.
return;
}
$suffix = substr($traitName, -5);
if (strtolower($suffix) !== 'trait') {
$phpcsFile->addError('Trait names must be suffixed with "Trait"; found "%s"', $stackPtr, 'Missing', [
$traitName,
]);
}
}
//end process()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
TraitNameSuffixSniff::process | public | function | Processes this sniff, when one of its tokens is encountered. | Overrides Sniff::process |
TraitNameSuffixSniff::register | public | function | Registers the tokens that this sniff wants to listen for. | Overrides Sniff::register |