Added PhpDoc::isFinal,isReadonly

typhoon-php · Sep 22, 2023 · 8faf375 · 8faf375
1 parent 83932f6
commit 8faf375
Show file tree

Hide file tree

Showing 2 changed files with 84 additions and 0 deletions.
diff --git a/src/PhpDocParser/PhpDoc.php b/src/PhpDocParser/PhpDoc.php
@@ -77,6 +77,28 @@ public function isDeprecated(): bool
         return false;
     }
 
+    public function isFinal(): bool
+    {
+        foreach ($this->tags as $tag) {
+            if ($tag->name === '@final') {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    public function isReadonly(): bool
+    {
+        foreach ($this->tags as $tag) {
+            if (\in_array($tag->name, ['@readonly', '@psalm-readonly', '@phpstan-readonly'], true)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     public function varType(): ?TypeNode
     {
         if ($this->varType !== false) {

diff --git a/tests/unit/PhpDocParser/PhpDocParserTest.php b/tests/unit/PhpDocParser/PhpDocParserTest.php
@@ -48,6 +48,68 @@ public function testIsDeprecatedReturnsTrueIfDeprecated(): void
         self::assertTrue($deprecated);
     }
 
+    public function testIsFinalReturnsFalseIfNoFinalTag(): void
+    {
+        $parser = new PhpDocParser();
+
+        $final = $parser->parsePhpDoc(
+            <<<'PHP'
+                /**
+                 * @example
+                 */
+                PHP,
+        )->isFinal();
+
+        self::assertFalse($final);
+    }
+
+    public function testIsFinalReturnsTrueIfFinal(): void
+    {
+        $parser = new PhpDocParser();
+
+        $final = $parser->parsePhpDoc(
+            <<<'PHP'
+                /**
+                 * @example
+                 * @final
+                 */
+                PHP,
+        )->isFinal();
+
+        self::assertTrue($final);
+    }
+
+    public function testIsReadonlyReturnsFalseIfNoReadonlyTag(): void
+    {
+        $parser = new PhpDocParser();
+
+        $readonly = $parser->parsePhpDoc(
+            <<<'PHP'
+                /**
+                 * @example
+                 */
+                PHP,
+        )->isReadonly();
+
+        self::assertFalse($readonly);
+    }
+
+    public function testIsReadonlyReturnsTrueIfReadonly(): void
+    {
+        $parser = new PhpDocParser();
+
+        $readonly = $parser->parsePhpDoc(
+            <<<'PHP'
+                /**
+                 * @example
+                 * @readonly
+                 */
+                PHP,
+        )->isReadonly();
+
+        self::assertTrue($readonly);
+    }
+
     public function testItReturnsNullVarTypeWhenNoVarTag(): void
     {
         $parser = new PhpDocParser();