Chris@0: <?php
Chris@0: /**
Chris@0:  * Verifies that control statements conform to their coding standards.
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\ControlStructures;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@0:  * Checks that "elseif" is used instead of "else if".
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 ElseIfSniff 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_ELSE);
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 the
Chris@17:      *                                               stack passed in $tokens.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0: 
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:         $nextNonWhiteSpace = $phpcsFile->findNext(
Chris@0:             T_WHITESPACE,
Chris@0:             ($stackPtr + 1),
Chris@0:             null,
Chris@0:             true,
Chris@0:             null,
Chris@0:             true
Chris@0:         );
Chris@0: 
Chris@0:         if ($tokens[$nextNonWhiteSpace]['code'] === T_IF) {
Chris@17:             $fix = $phpcsFile->addFixableError('Use "elseif" in place of "else if"', $nextNonWhiteSpace, 'ElseIfDeclaration');
Chris@0:             if ($fix === true) {
Chris@0:                 $phpcsFile->fixer->beginChangeset();
Chris@0:                 $phpcsFile->fixer->replaceToken($stackPtr, 'elseif');
Chris@0:                 for ($i = ($stackPtr + 1); $i < $nextNonWhiteSpace; $i++) {
Chris@0:                     if ($tokens[$i]['code'] === T_WHITESPACE) {
Chris@0:                         $phpcsFile->fixer->replaceToken($i, '');
Chris@0:                     }
Chris@0:                 }
Chris@0: 
Chris@0:                 $phpcsFile->fixer->replaceToken($nextNonWhiteSpace, '');
Chris@0:                 $phpcsFile->fixer->endChangeset();
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class