function TraitNameSuffixSniff::process

Processes this sniff, 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/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/NamingConventions/TraitNameSuffixSniff.php, line 39

Class

TraitNameSuffixSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions

Code

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,
        ]);
    }
}