Add name support into the property (-read|-write) annotations

Author: Kirill Nesmeyanov

src/DocBlock/Tag/PropertyReadTag.php

@@ -8,12 +8,26 @@
 use TypeLang\PhpDocParser\DocBlock\Description;
 
 /**
- * TODO Add support of property name parsing: {@link https://docs.phpdoc.org/3.0/guide/references/phpdoc/tags/property.html#property-property-read-property-write}
+ * @link https://docs.phpdoc.org/3.0/guide/references/phpdoc/tags/property.html#property-property-read-property-write
  */
-final class PropertyReadTag extends TypedTag
+final class PropertyReadTag extends TypedTag implements VariableNameProviderInterface
 {
-    public function __construct(TypeStatement $type, Description|string|null $description = null)
-    {
+    /**
+     * @param non-empty-string $variable
+     */
+    public function __construct(
+        private readonly string $variable,
+        TypeStatement $type,
+        Description|string|null $description = null
+    ) {
         parent::__construct('property-read', $type, $description);
     }
+
+    /**
+     * @return non-empty-string
+     */
+    public function getVarName(): string
+    {
+        return $this->variable;
+    }
 }

src/DocBlock/Tag/PropertyTag.php

@@ -8,12 +8,26 @@
 use TypeLang\PhpDocParser\DocBlock\Description;
 
 /**
- * TODO Add support of property name parsing: {@link https://docs.phpdoc.org/3.0/guide/references/phpdoc/tags/property.html#property-property-read-property-write}
+ * @link https://docs.phpdoc.org/3.0/guide/references/phpdoc/tags/property.html#property-property-read-property-write
  */
-final class PropertyTag extends TypedTag
+final class PropertyTag extends TypedTag implements VariableNameProviderInterface
 {
-    public function __construct(TypeStatement $type, Description|string|null $description = null)
-    {
+    /**
+     * @param non-empty-string $variable
+     */
+    public function __construct(
+        private readonly string $variable,
+        TypeStatement $type,
+        Description|string|null $description = null
+    ) {
         parent::__construct('property', $type, $description);
     }
+
+    /**
+     * @return non-empty-string
+     */
+    public function getVarName(): string
+    {
+        return $this->variable;
+    }
 }

src/DocBlock/Tag/PropertyWriteTag.php

@@ -8,12 +8,26 @@
 use TypeLang\PhpDocParser\DocBlock\Description;
 
 /**
- * TODO Add support of property name parsing: {@link https://docs.phpdoc.org/3.0/guide/references/phpdoc/tags/property.html#property-property-read-property-write}
+ * @link https://docs.phpdoc.org/3.0/guide/references/phpdoc/tags/property.html#property-property-read-property-write
  */
-final class PropertyWriteTag extends TypedTag
+final class PropertyWriteTag extends TypedTag implements VariableNameProviderInterface
 {
-    public function __construct(TypeStatement $type, Description|string|null $description = null)
-    {
+    /**
+     * @param non-empty-string $variable
+     */
+    public function __construct(
+        private readonly string $variable,
+        TypeStatement $type,
+        Description|string|null $description = null
+    ) {
         parent::__construct('property-write', $type, $description);
     }
+
+    /**
+     * @return non-empty-string
+     */
+    public function getVarName(): string
+    {
+        return $this->variable;
+    }
 }

src/DocBlockFactory.php

@@ -97,9 +97,9 @@ public static function getStandardTags(
         yield 'var' => new CommonTypedTagFactory(VarTag::class, $parser, $descriptions);
         yield 'global' => new CommonTypedTagWithNameFactory(GlobalTag::class, $parser, $descriptions);
         yield 'param' => new CommonTypedTagWithNameFactory(ParamTag::class, $parser, $descriptions);
-        yield 'property' => new CommonTypedTagFactory(PropertyTag::class, $parser, $descriptions);
-        yield 'property-read' => new CommonTypedTagFactory(PropertyReadTag::class, $parser, $descriptions);
-        yield 'property-write' => new CommonTypedTagFactory(PropertyWriteTag::class, $parser, $descriptions);
+        yield 'property' => new CommonTypedTagWithNameFactory(PropertyTag::class, $parser, $descriptions);
+        yield 'property-read' => new CommonTypedTagWithNameFactory(PropertyReadTag::class, $parser, $descriptions);
+        yield 'property-write' => new CommonTypedTagWithNameFactory(PropertyWriteTag::class, $parser, $descriptions);
         yield ['return', 'returns'] => new CommonTypedTagFactory(ReturnTag::class, $parser, $descriptions);
         yield ['throw', 'throws'] => new CommonTypedTagFactory(ThrowsTag::class, $parser, $descriptions);