Added DocCommentHelper::getDocComment()

Author: kukulich

SlevomatCodingStandard/Helpers/DocCommentHelper.php

@@ -10,6 +10,21 @@ public static function hasDocComment(\PHP_CodeSniffer\Files\File $codeSnifferFil
 		return self::findDocCommentOpenToken($codeSnifferFile, $pointer) !== null;
 	}
 
+	/**
+	 * @param \PHP_CodeSniffer\Files\File $codeSnifferFile
+	 * @param int $pointer
+	 * @return string|null
+	 */
+	public static function getDocComment(\PHP_CodeSniffer\Files\File $codeSnifferFile, int $pointer)
+	{
+		$docCommentOpenToken = self::findDocCommentOpenToken($codeSnifferFile, $pointer);
+		if ($docCommentOpenToken === null) {
+			return null;
+		}
+
+		return trim(TokenHelper::getContent($codeSnifferFile, $docCommentOpenToken + 1, $codeSnifferFile->getTokens()[$docCommentOpenToken]['comment_closer'] - 1));
+	}
+
 	public static function hasDocCommentDescription(\PHP_CodeSniffer\Files\File $codeSnifferFile, int $pointer): bool
 	{
 		$docCommentOpenToken = self::findDocCommentOpenToken($codeSnifferFile, $pointer);

SlevomatCodingStandard/Sniffs/Commenting/InlineDocCommentDeclarationSniff.php

@@ -4,7 +4,6 @@
 
 use SlevomatCodingStandard\Helpers\DocCommentHelper;
 use SlevomatCodingStandard\Helpers\PropertyHelper;
-use SlevomatCodingStandard\Helpers\TokenHelper;
 
 class InlineDocCommentDeclarationSniff implements \PHP_CodeSniffer\Sniffs\Sniff
 {
@@ -39,7 +38,7 @@ public function process(\PHP_CodeSniffer\Files\File $phpcsFile, $variablePointer
 
 		$tokens = $phpcsFile->getTokens();
 
-		$docCommentContent = trim(TokenHelper::getContent($phpcsFile, $docCommentOpenPointer + 1, $tokens[$docCommentOpenPointer]['comment_closer'] - 1));
+		$docCommentContent = DocCommentHelper::getDocComment($phpcsFile, $variablePointer);
 
 		if (strpos($docCommentContent, '@var') !== 0) {
 			return;

tests/Helpers/DocCommentHelperTest.php

@@ -14,6 +14,12 @@ public function testClassHasDocComment()
 		$this->assertTrue(DocCommentHelper::hasDocComment($this->getTestedCodeSnifferFile(), $this->findClassPointerByName($this->getTestedCodeSnifferFile(), 'WithDocComment')));
 	}
 
+	public function testClassGetDocComment()
+	{
+		$this->assertSame("* Class WithDocComment\n *\n * @see https://www.slevomat.cz", DocCommentHelper::getDocComment($this->getTestedCodeSnifferFile(), $this->findClassPointerByName($this->getTestedCodeSnifferFile(), 'WithDocCommentAndDescription')));
+		$this->assertNull(DocCommentHelper::getDocComment($this->getTestedCodeSnifferFile(), $this->findClassPointerByName($this->getTestedCodeSnifferFile(), 'WithoutDocComment')));
+	}
+
 	public function testClassHasNoDocComment()
 	{
 		$this->assertFalse(DocCommentHelper::hasDocComment($this->getTestedCodeSnifferFile(), $this->findClassPointerByName($this->getTestedCodeSnifferFile(), 'WithoutDocComment')));