VariableCommentSniff Class Reference

Inheritance diagram for VariableCommentSniff:

Public Member Functions
	processMemberVar (File $phpcsFile, $stackPtr)

Protected Member Functions
	processVariable (File $phpcsFile, $stackPtr)
	processVariableInString (File $phpcsFile, $stackPtr)

Detailed Description

Definition at line 16 of file VariableCommentSniff.php.

Member Function Documentation

processMemberVar()

processMemberVar	(	File	$phpcsFile,
			$stackPtr
	)

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.

Returns

void

Definition at line 29 of file VariableCommentSniff.php.

    {
        $tokens = $phpcsFile->getTokens();
        $ignore = array(
                   T_PUBLIC,
                   T_PRIVATE,
                   T_PROTECTED,
                   T_VAR,
                   T_STATIC,
                   T_WHITESPACE,
                  );

        $commentEnd = $phpcsFile->findPrevious($ignore, ($stackPtr - 1), null, true);
        if ($commentEnd === false
            || ($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) {
            $phpcsFile->addError('You must use "/**" style comments for a member variable comment', $stackPtr, 'WrongStyle');
            return;
        }

        $commentStart = $tokens[$commentEnd]['comment_opener'];

        $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');
                }
            } else {
                $error = '%s tag is not allowed in member variable comment';
                $data  = array($tokens[$tag]['content']);
                $phpcsFile->addWarning($error, $tag, 'TagNotAllowed', $data);
            }//end if
        }//end foreach

        // The @var tag is the only one we require.
        if ($foundVar === null) {
            $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'];
        $suggestedType = Common::suggestType($varType);
        if ($varType !== $suggestedType) {
            $error = 'Expected "%s" but found "%s" for @var tag in member variable comment';
            $data  = array(
                      $suggestedType,
                      $varType,
                     );

            $fix = $phpcsFile->addFixableError($error, ($foundVar + 2), 'IncorrectVarType', $data);
            if ($fix === true) {
                $phpcsFile->fixer->replaceToken(($foundVar + 2), $suggestedType);
            }
        }

    }//end processMemberVar()

processVariable()

processVariable ( File  $phpcsFile,   $stackPtr  )

protected

Called to process a normal variable.

Not required for this sniff.

Parameters

\PHP_CodeSniffer\Files\File	$phpcsFile	The PHP_CodeSniffer file where this token was found.
int	$stackPtr	The position where the double quoted string was found.

Returns

void

Definition at line 130 of file VariableCommentSniff.php.

    {

    }//end processVariable()

processVariableInString()

processVariableInString ( File  $phpcsFile,   $stackPtr  )

protected

Called to process variables found in double quoted strings.

Not required for this sniff.

Parameters

\PHP_CodeSniffer\Files\File	$phpcsFile	The PHP_CodeSniffer file where this token was found.
int	$stackPtr	The position where the double quoted string was found.

Returns

void

Definition at line 147 of file VariableCommentSniff.php.

    {

    }//end processVariableInString()

---

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

• vendor/magento/magento2-functional-testing-framework/dev/tests/static/Magento/Sniffs/Commenting/VariableCommentSniff.php