ObjectCalisthenics\Helper\DocBlock\MemberComment::getMemberComment PHP Method

getMemberComment() public static method

public static getMemberComment ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr ) : string
$phpcsFile PHP_CodeSniffer_File
$stackPtr integer
return string
    public static function getMemberComment(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : string
    {
        $docCommentPosition = $phpcsFile->findPrevious(T_DOC_COMMENT_STRING, $stackPtr, $stackPtr - 10);
        if (!$docCommentPosition) {
            return '';
        }
        $docCommentToken = $phpcsFile->getTokens()[$docCommentPosition];
        $docComment = $docCommentToken['content'];
        if (false !== strpos($docComment, 'inheritdoc')) {
            return '';
        }
        return $docComment;
    }

Usage Example

 private static function extractPropertyIfFound(PHP_CodeSniffer_File $phpcsFile, int $stackPtr)
 {
     $tokens = $phpcsFile->getTokens();
     $property = $tokens[$stackPtr];
     // Is it a property or a random variable?
     if (!(count($property['conditions']) === 1 && in_array(reset($property['conditions']), [T_CLASS, T_TRAIT]))) {
         return;
     }
     if ($comment = MemberComment::getMemberComment($phpcsFile, $stackPtr)) {
         self::$propertyList[] = ['type' => $comment];
     }
 }
MemberComment