annotate vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Classes/InterfaceNameSniff.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2 /**
Chris@17 3 * \Drupal\Sniffs\Classes\InterfaceNameSniff.
Chris@0 4 *
Chris@0 5 * @category PHP
Chris@0 6 * @package PHP_CodeSniffer
Chris@0 7 * @link http://pear.php.net/package/PHP_CodeSniffer
Chris@0 8 */
Chris@0 9
Chris@17 10 namespace Drupal\Sniffs\Classes;
Chris@17 11
Chris@17 12 use PHP_CodeSniffer\Files\File;
Chris@17 13 use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17 14
Chris@0 15 /**
Chris@0 16 * Checks that interface names end with "Interface".
Chris@0 17 *
Chris@0 18 * @category PHP
Chris@0 19 * @package PHP_CodeSniffer
Chris@0 20 * @link http://pear.php.net/package/PHP_CodeSniffer
Chris@0 21 */
Chris@17 22 class InterfaceNameSniff implements Sniff
Chris@0 23 {
Chris@0 24
Chris@0 25
Chris@0 26 /**
Chris@0 27 * Returns an array of tokens this test wants to listen for.
Chris@0 28 *
Chris@0 29 * @return array
Chris@0 30 */
Chris@0 31 public function register()
Chris@0 32 {
Chris@0 33 return array(T_INTERFACE);
Chris@0 34
Chris@0 35 }//end register()
Chris@0 36
Chris@0 37
Chris@0 38 /**
Chris@0 39 * Processes this test, when one of its tokens is encountered.
Chris@0 40 *
Chris@17 41 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@17 42 * @param int $stackPtr The position of the current token in
Chris@17 43 * the stack passed in $tokens.
Chris@0 44 *
Chris@0 45 * @return void
Chris@0 46 */
Chris@17 47 public function process(File $phpcsFile, $stackPtr)
Chris@0 48 {
Chris@0 49 $tokens = $phpcsFile->getTokens();
Chris@0 50 $namePtr = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
Chris@0 51 $name = $tokens[$namePtr]['content'];
Chris@0 52 if (substr($name, -9) !== 'Interface') {
Chris@0 53 $warn = 'Interface names should always have the suffix "Interface"';
Chris@0 54 $phpcsFile->addWarning($warn, $namePtr, 'InterfaceSuffix');
Chris@0 55 }
Chris@0 56
Chris@0 57 }//end process()
Chris@0 58
Chris@0 59
Chris@0 60 }//end class