function VariableCommentSniff::processMemberVar

Same name in this branch

1. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/Commenting/VariableCommentSniff.php \PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\VariableCommentSniff::processMemberVar()

Called to process class member vars.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

int $stackPtr The position of the current token: in the stack passed in $tokens.

Return value

void

Overrides AbstractVariableSniff::processMemberVar

File

vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Commenting/VariableCommentSniff.php, line 38

Class

VariableCommentSniff

Parses and verifies class property doc comments.

Namespace

Drupal\Sniffs\Commenting

Code

public function processMemberVar(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $ignore = [
        T_PUBLIC => T_PUBLIC,
        T_PRIVATE => T_PRIVATE,
        T_PROTECTED => T_PROTECTED,
        T_VAR => T_VAR,
        T_STATIC => T_STATIC,
        T_READONLY => T_READONLY,
        T_WHITESPACE => T_WHITESPACE,
        T_STRING => T_STRING,
        T_NS_SEPARATOR => T_NS_SEPARATOR,
        T_NAMESPACE => T_NAMESPACE,
        T_NULLABLE => T_NULLABLE,
        T_TYPE_UNION => T_TYPE_UNION,
        T_TYPE_INTERSECTION => T_TYPE_INTERSECTION,
        T_NULL => T_NULL,
        T_TRUE => T_TRUE,
        T_FALSE => T_FALSE,
        T_SELF => T_SELF,
        T_PARENT => T_PARENT,
    ];
    for ($commentEnd = $stackPtr - 1; $commentEnd >= 0; $commentEnd--) {
        if (isset($ignore[$tokens[$commentEnd]['code']]) === true) {
            continue;
        }
        if ($tokens[$commentEnd]['code'] === T_ATTRIBUTE_END && isset($tokens[$commentEnd]['attribute_opener']) === true) {
            $commentEnd = $tokens[$commentEnd]['attribute_opener'];
            continue;
        }
        break;
    }
    if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG && $tokens[$commentEnd]['code'] !== T_COMMENT) {
        $phpcsFile->addError('Missing member variable doc comment', $stackPtr, 'Missing');
        return;
    }
    if ($tokens[$commentEnd]['code'] === T_COMMENT) {
        $fix = $phpcsFile->addFixableError('You must use "/**" style comments for a member variable comment', $stackPtr, 'WrongStyle');
        if ($fix === true) {
            // Convert the comment into a doc comment.
            $phpcsFile->fixer
                ->beginChangeset();
            $comment = '';
            for ($i = $commentEnd; $tokens[$i]['code'] === T_COMMENT; $i--) {
                $comment = ' *' . ltrim($tokens[$i]['content'], '/* ') . $comment;
                $phpcsFile->fixer
                    ->replaceToken($i, '');
            }
            $phpcsFile->fixer
                ->replaceToken($commentEnd, "/**\n" . rtrim($comment, "*/\n") . "\n */\n");
            $phpcsFile->fixer
                ->endChangeset();
        }
        return;
    }
    
    //end if
    $commentStart = $tokens[$commentEnd]['comment_opener'];
    // Ignore variable comments that use inheritdoc, allow both variants.
    $commentContent = $phpcsFile->getTokensAsString($commentStart, $commentEnd - $commentStart);
    if (strpos($commentContent, '{@inheritdoc}') !== false || strpos($commentContent, '{@inheritDoc}') !== false) {
        return;
    }
    $foundVar = null;
    foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
        if ($tokens[$tag]['content'] === '@var') {
            if ($foundVar !== null) {
                $error = 'Only one @var tag is allowed in a member variable comment';
                $phpcsFile->addError($error, $tag, 'DuplicateVar');
            }
            else {
                $foundVar = $tag;
            }
        }
        else {
            if ($tokens[$tag]['content'] === '@see') {
                // Make sure the tag isn't empty.
                $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $tag, $commentEnd);
                if ($string === false || $tokens[$string]['line'] !== $tokens[$tag]['line']) {
                    $error = 'Content missing for @see tag in member variable comment';
                    $phpcsFile->addError($error, $tag, 'EmptySees');
                }
            }
        }
        
        //end if
    }
    
    //end foreach
    // The @var tag is the only one we require.
    if ($foundVar === null) {
        // If there's an inline type argument then you may omit the @var comment.
        // Check if there's a type between the variable name and the comment end.
        if ($phpcsFile->findPrevious([
            T_STRING,
        ], $stackPtr, $commentEnd) !== false) {
            return;
        }
        $error = 'Missing @var tag in member variable comment';
        $phpcsFile->addError($error, $commentEnd, 'MissingVar');
        return;
    }
    $firstTag = $tokens[$commentStart]['comment_tags'][0];
    if ($foundVar !== null && $tokens[$firstTag]['content'] !== '@var') {
        $error = 'The @var tag must be the first tag in a member variable comment';
        $phpcsFile->addError($error, $foundVar, 'VarOrder');
    }
    // Make sure the tag isn't empty and has the correct padding.
    $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $foundVar, $commentEnd);
    if ($string === false || $tokens[$string]['line'] !== $tokens[$foundVar]['line']) {
        $error = 'Content missing for @var tag in member variable comment';
        $phpcsFile->addError($error, $foundVar, 'EmptyVar');
        return;
    }
    $varType = $tokens[$foundVar + 2]['content'];
    // There may be multiple types separated by pipes.
    $suggestedTypes = [];
    foreach (explode('|', $varType) as $type) {
        $suggestedTypes[] = FunctionCommentSniff::suggestType($type);
    }
    $suggestedType = implode('|', $suggestedTypes);
    // Detect and auto-fix the common mistake that the variable name is
    // appended to the type declaration.
    $matches = [];
    if (preg_match('/^([^\\s]+)(\\s+\\$.+)$/', $varType, $matches) === 1) {
        $error = 'Do not append variable name "%s" to the type declaration in a member variable comment';
        $data = [
            trim($matches[2]),
        ];
        $fix = $phpcsFile->addFixableError($error, $foundVar + 2, 'InlineVariableName', $data);
        if ($fix === true) {
            $phpcsFile->fixer
                ->replaceToken($foundVar + 2, $matches[1]);
        }
    }
    else {
        if ($varType !== $suggestedType) {
            $error = 'Expected "%s" but found "%s" for @var tag in member variable comment';
            $data = [
                $suggestedType,
                $varType,
            ];
            $fix = $phpcsFile->addFixableError($error, $foundVar + 2, 'IncorrectVarType', $data);
            if ($fix === true) {
                $phpcsFile->fixer
                    ->replaceToken($foundVar + 2, $suggestedType);
            }
        }
    }
    
    //end if
}