class CheckPlainSniff

Check that check_plain() is not used on literal strings.

@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\CheckPlainSniff extends \Drupal\Sniffs\Semantics\FunctionCall

Expanded class hierarchy of CheckPlainSniff

File

vendor/drupal/coder/coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/CheckPlainSniff.php, line 22

Namespace

DrupalPractice\Sniffs\FunctionCalls

View source

class CheckPlainSniff extends FunctionCall {
    
    /**
     * Returns an array of function names this test wants to listen for.
     *
     * @return array<string>
     */
    public function registerFunctionNames() {
        return [
            'check_plain',
        ];
    }
    
    //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();
        $argument = $this->getArgument(1);
        if ($argument['start'] === $argument['end'] && $tokens[$argument['start']]['code'] === T_CONSTANT_ENCAPSED_STRING) {
            $warning = 'Do not use check_plain() on string literals, because they cannot contain user provided text';
            $phpcsFile->addWarning($warning, $argument['start'], 'CheckPlainLiteral');
        }
    }
    
    //end processFunctionCall()

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
CheckPlainSniff::processFunctionCall	public	function	Processes this function call.
CheckPlainSniff::registerFunctionNames	public	function	Returns an array of function names this test wants to listen for.
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