StringPositionSniff Class Reference

Inheritance diagram for StringPositionSniff:

Public Member Functions
	register ()
	process (File $phpcsFile, $stackPtr)

Protected Member Functions
	findIdentical ($leftCurrentPosition, $rightCurrentPosition)
	findFunctionParenthesisCloser ($currentPosition)

Protected Attributes
	$errorMessage = 'Identical operator === is not used for testing the return value of %s function'
	$errorCode = 'ImproperValueTesting'
	$functions
	$tokens = []
	$file
	$leftLimit
	$rightLimit
	$leftRangeTokens
	$rightRangeTokens
	$identical

Detailed Description

Detects misusing of IS_IDENTICAL operators when strpos and stripos functions are used in a condition.

Examples: if (!strpos($haystack, $needle)) {} if (stripos($haystack, $needle) == false) {}

Definition at line 18 of file StringPositionSniff.php.

Member Function Documentation

findFunctionParenthesisCloser()

findFunctionParenthesisCloser (   $currentPosition )

protected

Finds the position of close parenthesis of detected function.

Parameters

int

$currentPosition

Returns

mixed

Definition at line 163 of file StringPositionSniff.php.

    {
        $nextOpenParenthesis = $this->file->findNext(T_OPEN_PARENTHESIS, $currentPosition, $this->rightLimit);
        return $nextOpenParenthesis ? $this->tokens[$nextOpenParenthesis]['parenthesis_closer'] : false;
    }

findIdentical()

findIdentical (   $leftCurrentPosition,   $rightCurrentPosition  )

protected

Recursively finds identical operators in current scope.

Parameters

int	$leftCurrentPosition
int	$rightCurrentPosition

Returns

bool

Definition at line 142 of file StringPositionSniff.php.

    {
        $leftBound = $this->file->findPrevious($this->leftRangeTokens, $leftCurrentPosition, $this->leftLimit - 1);
        $rightBound = $this->file->findNext($this->rightRangeTokens, $rightCurrentPosition, $this->rightLimit + 1);
        $leftToken = $this->tokens[$leftBound];
        $rightToken = $this->tokens[$rightBound];
        if ($leftToken['code'] === T_OPEN_PARENTHESIS && $rightToken['code'] === T_CLOSE_PARENTHESIS) {
            return $this->findIdentical($leftBound - 1, $rightBound + 1);
        } else {
            return (
                in_array($leftToken['code'], $this->identical) || in_array($rightToken['code'], $this->identical)
            ) ?: false;
        }
    }

process()

process	(	File	$phpcsFile,
			$stackPtr
	)

{}

Definition at line 119 of file StringPositionSniff.php.

    {
        $this->tokens = $phpcsFile->getTokens();
        $this->file = $phpcsFile;
        $this->leftLimit = $open = $this->tokens[$stackPtr]['parenthesis_opener'];
        $this->rightLimit = $close = $this->tokens[$stackPtr]['parenthesis_closer'];
        for ($i = ($open + 1); $i < $close; $i++) {
            if (($this->tokens[$i]['code'] === T_STRING && in_array($this->tokens[$i]['content'], $this->functions))
                && (!$this->findIdentical($i - 1, $this->findFunctionParenthesisCloser($i) + 1))
            ) {
                $foundFunctionName = $this->tokens[$i]['content'];
                $phpcsFile->addError($this->errorMessage, $i, $this->errorCode, [$foundFunctionName]);
            }
        }
    }

register()

register

(

)

{}

Definition at line 111 of file StringPositionSniff.php.

    {
        return [T_IF, T_ELSEIF];
    }

Field Documentation

$errorCode

$errorCode = 'ImproperValueTesting'

protected

Definition at line 32 of file StringPositionSniff.php.

$errorMessage

$errorMessage = 'Identical operator === is not used for testing the return value of %s function'

protected

Definition at line 25 of file StringPositionSniff.php.

$file

$file

protected

Definition at line 56 of file StringPositionSniff.php.

$functions

$functions

protected

Initial value:

= [
        'strpos',
        'stripos',
    ]

Definition at line 39 of file StringPositionSniff.php.

$identical

$identical

protected

Initial value:

= [
        T_IS_IDENTICAL,
        T_IS_NOT_IDENTICAL,
    ]

Definition at line 103 of file StringPositionSniff.php.

$leftLimit

$leftLimit

protected

Definition at line 63 of file StringPositionSniff.php.

$leftRangeTokens

$leftRangeTokens

protected

Initial value:

= [
        T_IS_IDENTICAL,
        T_IS_NOT_IDENTICAL,
        T_OPEN_PARENTHESIS,
        T_BOOLEAN_AND,
        T_BOOLEAN_OR,
    ]

Definition at line 77 of file StringPositionSniff.php.

$rightLimit

$rightLimit

protected

Definition at line 70 of file StringPositionSniff.php.

$rightRangeTokens

$rightRangeTokens

protected

Initial value:

= [
        T_IS_IDENTICAL,
        T_IS_NOT_IDENTICAL,
        T_CLOSE_PARENTHESIS,
        T_BOOLEAN_AND,
        T_BOOLEAN_OR,
    ]

Definition at line 90 of file StringPositionSniff.php.

$tokens

$tokens = []

protected

Definition at line 49 of file StringPositionSniff.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/static/framework/Magento/Sniffs/Strings/StringPositionSniff.php