class TCheckPlainSniff

Check that "@" and "%" placeholders in t()/watchdog() are not escaped twice with check_plain().

@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

class \Drupal\Sniffs\Semantics\FunctionCall implements \PHP_CodeSniffer\Sniffs\Sniff
- class \DrupalPractice\Sniffs\FunctionCalls\TCheckPlainSniff extends \Drupal\Sniffs\Semantics\FunctionCall

Expanded class hierarchy of TCheckPlainSniff

File

vendor/drupal/coder/coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/TCheckPlainSniff.php, line 23

Namespace

DrupalPractice\Sniffs\FunctionCalls

View source

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

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
FunctionCall::$arguments	protected	property	Internal cache to save the calculated arguments of the function call.
FunctionCall::$closeBracket	protected	property	The token position of the closing bracket of the function call.
FunctionCall::$functionCall	protected	property	The token position of the function call.
FunctionCall::$includeMethodCalls	protected	property	Whether method invocations with the same function name should be processed, too.		1
FunctionCall::$openBracket	protected	property	The token position of the opening bracket of the function call.
FunctionCall::$phpcsFile	protected	property	The currently processed file.
FunctionCall::getArgument	public	function	Returns start and end token for a given argument number.
FunctionCall::isFunctionCall	protected	function	Checks if this is a function call.
FunctionCall::process	public	function	Processes this test, when one of its tokens is encountered.	Overrides Sniff::process	2
FunctionCall::register	public	function	Returns an array of tokens this test wants to listen for.	Overrides Sniff::register
TCheckPlainSniff::processFunctionCall	public	function	Processes this function call.
TCheckPlainSniff::registerFunctionNames	public	function	Returns an array of function names this test wants to listen for.