function DisallowReferenceSniff::process

* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint *

Parameters

int $referencePointer:

Overrides Sniff::process

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/DisallowReferenceSniff.php, line 42

Class

DisallowReferenceSniff

Namespace

SlevomatCodingStandard\Sniffs\PHP

Code

public function process(File $phpcsFile, $referencePointer) : void {
    $tokens = $phpcsFile->getTokens();
    $previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $referencePointer - 1);
    if (in_array($tokens[$previousPointer]['code'], TokenHelper::$functionTokenCodes, true)) {
        $phpcsFile->addError('Returning reference is disallowed.', $referencePointer, self::CODE_DISALLOWED_RETURNING_REFERENCE);
        return;
    }
    $previousParenthesisOpenerPointer = TokenHelper::findPrevious($phpcsFile, T_OPEN_PARENTHESIS, $referencePointer - 1);
    if ($previousParenthesisOpenerPointer !== null && $tokens[$previousParenthesisOpenerPointer]['parenthesis_closer'] > $referencePointer) {
        if (array_key_exists('parenthesis_owner', $tokens[$previousParenthesisOpenerPointer])) {
            $parenthesisOwnerPointer = $tokens[$previousParenthesisOpenerPointer]['parenthesis_owner'];
            if (in_array($tokens[$parenthesisOwnerPointer]['code'], TokenHelper::$functionTokenCodes, true)) {
                $phpcsFile->addError('Passing by reference is disallowed.', $referencePointer, self::CODE_DISALLOWED_PASSING_BY_REFERENCE);
                return;
            }
        }
        $pointerBeforeParenthesisOpener = TokenHelper::findPreviousEffective($phpcsFile, $previousParenthesisOpenerPointer - 1);
        if ($pointerBeforeParenthesisOpener !== null && $tokens[$pointerBeforeParenthesisOpener]['code'] === T_USE) {
            $phpcsFile->addError('Inheriting variable by reference is disallowed.', $referencePointer, self::CODE_DISALLOWED_INHERITING_VARIABLE_BY_REFERENCE);
            return;
        }
    }
    
    /** @var int $variableStartPointer */
    $variableStartPointer = TokenHelper::findNextEffective($phpcsFile, $referencePointer + 1);
    $variableEndPointer = IdentificatorHelper::findEndPointer($phpcsFile, $variableStartPointer);
    if ($variableEndPointer === null) {
        return;
    }
    $previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $referencePointer - 1);
    if (!in_array($tokens[$previousPointer]['code'], [
        T_EQUAL,
        T_DOUBLE_ARROW,
        T_OPEN_SHORT_ARRAY,
        T_COMMA,
        T_AS,
    ], true)) {
        return;
    }
    $phpcsFile->addError('Assigning by reference is disallowed.', $referencePointer, self::CODE_DISALLOWED_ASSIGNING_BY_REFERENCE);
}