Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\Classes\UseLeadingBackslashSniff.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@17: namespace Drupal\Sniffs\Classes;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: use PHP_CodeSniffer\Util\Tokens;
Chris@17: 
Chris@0: /**
Chris@0:  * Use statements to import classes must not begin with "\".
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@17: class UseLeadingBackslashSniff implements Sniff
Chris@0: {
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an array of tokens this test wants to listen for.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function register()
Chris@0:     {
Chris@0:         return array(T_USE);
Chris@0: 
Chris@0:     }//end register()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes this test, when one of its tokens is encountered.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@17:      * @param int                         $stackPtr  The position of the current token in
Chris@17:      *                                               the stack passed in $tokens.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:         // Only check use statements in the global scope.
Chris@0:         if (empty($tokens[$stackPtr]['conditions']) === false) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $startPtr = $phpcsFile->findNext(
Chris@17:             Tokens::$emptyTokens,
Chris@0:             ($stackPtr + 1),
Chris@0:             null,
Chris@0:             true
Chris@0:         );
Chris@0: 
Chris@0:         if ($startPtr !== null && $tokens[$startPtr]['code'] === T_NS_SEPARATOR) {
Chris@0:             $error = 'When importing a class with "use", do not include a leading \\';
Chris@0:             $fix   = $phpcsFile->addFixableError($error, $startPtr, 'SeparatorStart');
Chris@0:             if ($fix === true) {
Chris@0:                 $phpcsFile->fixer->replaceToken($startPtr, '');
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class