Chris@0: <?php
Chris@0: /**
Chris@17:  * \DrupalPractice\Sniffs\FunctionCalls\TCheckPlainSniff
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 DrupalPractice\Sniffs\FunctionCalls;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use Drupal\Sniffs\Semantics\FunctionCall;
Chris@17: 
Chris@0: /**
Chris@0:  * Check that "@" and "%" placeholders in t()/watchdog() are not escaped twice
Chris@0:  * with check_plain().
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 TCheckPlainSniff extends FunctionCall
Chris@0: {
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an array of function names this test wants to listen for.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function registerFunctionNames()
Chris@0:     {
Chris@0:         return array(
Chris@0:                 't',
Chris@0:                 'watchdog',
Chris@0:                );
Chris@0: 
Chris@0:     }//end registerFunctionNames()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes this function call.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile    The file being scanned.
Chris@17:      * @param int                         $stackPtr     The position of the function call in
Chris@17:      *                                                  the stack.
Chris@17:      * @param int                         $openBracket  The position of the opening
Chris@17:      *                                                  parenthesis in the stack.
Chris@17:      * @param int                         $closeBracket The position of the closing
Chris@17:      *                                                  parenthesis in the stack.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public function processFunctionCall(
Chris@17:         File $phpcsFile,
Chris@0:         $stackPtr,
Chris@0:         $openBracket,
Chris@0:         $closeBracket
Chris@0:     ) {
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0:         if ($tokens[$stackPtr]['content'] === 't') {
Chris@0:             $argument = $this->getArgument(2);
Chris@0:         } else {
Chris@0:             // For watchdog() the placeholders are in the third argument.
Chris@0:             $argument = $this->getArgument(3);
Chris@0:         }
Chris@0: 
Chris@0:         if ($argument === false) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         if ($tokens[$argument['start']]['code'] !== T_ARRAY) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $checkPlain = $argument['start'];
Chris@0:         while (($checkPlain = $phpcsFile->findNext(T_STRING, ($checkPlain + 1), $tokens[$argument['start']]['parenthesis_closer'])) !== false) {
Chris@0:             if ($tokens[$checkPlain]['content'] === 'check_plain') {
Chris@0:                 // The check_plain() could be embedded with string concatenation,
Chris@0:                 // which we want to allow.
Chris@0:                 $previous = $phpcsFile->findPrevious(T_WHITESPACE, ($checkPlain - 1), $argument['start'], true);
Chris@0:                 if ($previous === false || $tokens[$previous]['code'] !== T_STRING_CONCAT) {
Chris@0:                     $warning = 'The extra check_plain() is not necessary for placeholders, "@" and "%" will automatically run check_plain()';
Chris@0:                     $phpcsFile->addWarning($warning, $checkPlain, 'CheckPlain');
Chris@0:                 }
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:     }//end processFunctionCall()
Chris@0: 
Chris@0: 
Chris@0: }//end class