Skip to content

Commit b23fbb1

Browse files
JanTvrdikJanTvrdik
committed
PhpDocParser: support phpstan and psalm prefixes
1 parent b3040ad commit b23fbb1

File tree

2 files changed

+53
-25
lines changed

2 files changed

+53
-25
lines changed

‎src/Ast/PhpDoc/PhpDocNode.php‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ public function getTagsByName(string $tagName): array
4545
/**
4646
* @return VarTagValueNode[]
4747
*/
48-
public function getVarTagValues(): array
48+
public function getVarTagValues(string $tagName = '@var'): array
4949
{
5050
return array_column(
51-
array_filter($this->getTagsByName('@var'), static function (PhpDocTagNode $tag): bool {
51+
array_filter($this->getTagsByName($tagName), static function (PhpDocTagNode $tag): bool {
5252
return $tag->value instanceof VarTagValueNode;
5353
}),
5454
'value'
@@ -59,10 +59,10 @@ public function getVarTagValues(): array
5959
/**
6060
* @return ParamTagValueNode[]
6161
*/
62-
public function getParamTagValues(): array
62+
public function getParamTagValues(string $tagName = '@param'): array
6363
{
6464
return array_column(
65-
array_filter($this->getTagsByName('@param'), static function (PhpDocTagNode $tag): bool {
65+
array_filter($this->getTagsByName($tagName), static function (PhpDocTagNode $tag): bool {
6666
return $tag->value instanceof ParamTagValueNode;
6767
}),
6868
'value'
@@ -73,10 +73,10 @@ public function getParamTagValues(): array
7373
/**
7474
* @return TemplateTagValueNode[]
7575
*/
76-
public function getTemplateTagValues(): array
76+
public function getTemplateTagValues(string $tagName = '@template'): array
7777
{
7878
return array_column(
79-
array_filter($this->getTagsByName('@template'), static function (PhpDocTagNode $tag): bool {
79+
array_filter($this->getTagsByName($tagName), static function (PhpDocTagNode $tag): bool {
8080
return $tag->value instanceof TemplateTagValueNode;
8181
}),
8282
'value'
@@ -87,10 +87,10 @@ public function getTemplateTagValues(): array
8787
/**
8888
* @return ExtendsTagValueNode[]
8989
*/
90-
public function getExtendsTagValues(): array
90+
public function getExtendsTagValues(string $tagName = '@extends'): array
9191
{
9292
return array_column(
93-
array_filter($this->getTagsByName('@extends'), static function (PhpDocTagNode $tag): bool {
93+
array_filter($this->getTagsByName($tagName), static function (PhpDocTagNode $tag): bool {
9494
return $tag->value instanceof ExtendsTagValueNode;
9595
}),
9696
'value'
@@ -101,10 +101,10 @@ public function getExtendsTagValues(): array
101101
/**
102102
* @return ImplementsTagValueNode[]
103103
*/
104-
public function getImplementsTagValues(): array
104+
public function getImplementsTagValues(string $tagName = '@implements'): array
105105
{
106106
return array_column(
107-
array_filter($this->getTagsByName('@implements'), static function (PhpDocTagNode $tag): bool {
107+
array_filter($this->getTagsByName($tagName), static function (PhpDocTagNode $tag): bool {
108108
return $tag->value instanceof ImplementsTagValueNode;
109109
}),
110110
'value'
@@ -115,10 +115,10 @@ public function getImplementsTagValues(): array
115115
/**
116116
* @return UsesTagValueNode[]
117117
*/
118-
public function getUsesTagValues(): array
118+
public function getUsesTagValues(string $tagName = '@uses'): array
119119
{
120120
return array_column(
121-
array_filter($this->getTagsByName('@uses'), static function (PhpDocTagNode $tag): bool {
121+
array_filter($this->getTagsByName($tagName), static function (PhpDocTagNode $tag): bool {
122122
return $tag->value instanceof UsesTagValueNode;
123123
}),
124124
'value'
@@ -129,10 +129,10 @@ public function getUsesTagValues(): array
129129
/**
130130
* @return ReturnTagValueNode[]
131131
*/
132-
public function getReturnTagValues(): array
132+
public function getReturnTagValues(string $tagName = '@return'): array
133133
{
134134
return array_column(
135-
array_filter($this->getTagsByName('@return'), static function (PhpDocTagNode $tag): bool {
135+
array_filter($this->getTagsByName($tagName), static function (PhpDocTagNode $tag): bool {
136136
return $tag->value instanceof ReturnTagValueNode;
137137
}),
138138
'value'
@@ -143,10 +143,10 @@ public function getReturnTagValues(): array
143143
/**
144144
* @return ThrowsTagValueNode[]
145145
*/
146-
public function getThrowsTagValues(): array
146+
public function getThrowsTagValues(string $tagName = '@throws'): array
147147
{
148148
return array_column(
149-
array_filter($this->getTagsByName('@throws'), static function (PhpDocTagNode $tag): bool {
149+
array_filter($this->getTagsByName($tagName), static function (PhpDocTagNode $tag): bool {
150150
return $tag->value instanceof ThrowsTagValueNode;
151151
}),
152152
'value'
@@ -171,10 +171,10 @@ public function getDeprecatedTagValues(): array
171171
/**
172172
* @return PropertyTagValueNode[]
173173
*/
174-
public function getPropertyTagValues(): array
174+
public function getPropertyTagValues(string $tagName = '@property'): array
175175
{
176176
return array_column(
177-
array_filter($this->getTagsByName('@property'), static function (PhpDocTagNode $tag): bool {
177+
array_filter($this->getTagsByName($tagName), static function (PhpDocTagNode $tag): bool {
178178
return $tag->value instanceof PropertyTagValueNode;
179179
}),
180180
'value'
@@ -185,10 +185,10 @@ public function getPropertyTagValues(): array
185185
/**
186186
* @return PropertyTagValueNode[]
187187
*/
188-
public function getPropertyReadTagValues(): array
188+
public function getPropertyReadTagValues(string $tagName = '@property-read'): array
189189
{
190190
return array_column(
191-
array_filter($this->getTagsByName('@property-read'), static function (PhpDocTagNode $tag): bool {
191+
array_filter($this->getTagsByName($tagName), static function (PhpDocTagNode $tag): bool {
192192
return $tag->value instanceof PropertyTagValueNode;
193193
}),
194194
'value'
@@ -199,10 +199,10 @@ public function getPropertyReadTagValues(): array
199199
/**
200200
* @return PropertyTagValueNode[]
201201
*/
202-
public function getPropertyWriteTagValues(): array
202+
public function getPropertyWriteTagValues(string $tagName = '@property-write'): array
203203
{
204204
return array_column(
205-
array_filter($this->getTagsByName('@property-write'), static function (PhpDocTagNode $tag): bool {
205+
array_filter($this->getTagsByName($tagName), static function (PhpDocTagNode $tag): bool {
206206
return $tag->value instanceof PropertyTagValueNode;
207207
}),
208208
'value'
@@ -213,10 +213,10 @@ public function getPropertyWriteTagValues(): array
213213
/**
214214
* @return MethodTagValueNode[]
215215
*/
216-
public function getMethodTagValues(): array
216+
public function getMethodTagValues(string $tagName = '@method'): array
217217
{
218218
return array_column(
219-
array_filter($this->getTagsByName('@method'), static function (PhpDocTagNode $tag): bool {
219+
array_filter($this->getTagsByName($tagName), static function (PhpDocTagNode $tag): bool {
220220
return $tag->value instanceof MethodTagValueNode;
221221
}),
222222
'value'

‎src/Parser/PhpDocParser.php‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,14 +115,20 @@ public function parseTagValue(TokenIterator $tokens, string $tag): Ast\PhpDoc\Ph
115115

116116
switch ($tag) {
117117
case '@param':
118+
case '@phpstan-param':
119+
case '@psalm-param':
118120
$tagValue = $this->parseParamTagValue($tokens);
119121
break;
120122

121123
case '@var':
124+
case '@phpstan-var':
125+
case '@psalm-var':
122126
$tagValue = $this->parseVarTagValue($tokens);
123127
break;
124128

125129
case '@return':
130+
case '@phpstan-return':
131+
case '@psalm-return':
126132
$tagValue = $this->parseReturnTagValue($tokens);
127133
break;
128134

@@ -137,21 +143,43 @@ public function parseTagValue(TokenIterator $tokens, string $tag): Ast\PhpDoc\Ph
137143
case '@property':
138144
case '@property-read':
139145
case '@property-write':
146+
case '@phpstan-property':
147+
case '@phpstan-property-read':
148+
case '@phpstan-property-write':
149+
case '@psalm-property':
150+
case '@psalm-property-read':
151+
case '@psalm-property-write':
140152
$tagValue = $this->parsePropertyTagValue($tokens);
141153
break;
142154

143155
case '@method':
156+
case '@phpstan-method':
157+
case '@psalm-method':
144158
$tagValue = $this->parseMethodTagValue($tokens);
145159
break;
146160

147161
case '@template':
162+
case '@phpstan-template':
163+
case '@psalm-template':
148164
$tagValue = $this->parseTemplateTagValue($tokens);
149165
break;
150166

151167
case '@extends':
168+
case '@phpstan-extends':
169+
case '@template-extends':
170+
$tagValue = $this->parseExtendsTagValue('@extends', $tokens);
171+
break;
172+
152173
case '@implements':
174+
case '@phpstan-implements':
175+
case '@template-implements':
176+
$tagValue = $this->parseExtendsTagValue('@implements', $tokens);
177+
break;
178+
153179
case '@uses':
154-
$tagValue = $this->parseExtendsTagValue($tag, $tokens);
180+
case '@phpstan-uses':
181+
case '@template-use':
182+
$tagValue = $this->parseExtendsTagValue('@uses', $tokens);
155183
break;
156184

157185
default:

0 commit comments

Comments
 (0)