Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 66ae696

Browse files
Allow omitting @param type
1 parent b75949e commit 66ae696

File tree

4 files changed

+118
-5
lines changed

4 files changed

+118
-5
lines changed

‎doc/grammars/phpdoc-param.peg

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
PhpDocParam
22
= AnnotationName Type IsReference? IsVariadic? ParameterName Description?
3+
/ AnnotationName Type? IsReference? IsVariadic? ParameterName Description
34

45
AnnotationName
56
= '@param'

‎src/Ast/PhpDoc/ParamTagValueNode.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class ParamTagValueNode implements PhpDocTagValueNode
1111

1212
use NodeAttributes;
1313

14-
/** @var TypeNode */
14+
/** @var TypeNode|null */
1515
public $type;
1616

1717
/** @var bool */
@@ -26,7 +26,7 @@ class ParamTagValueNode implements PhpDocTagValueNode
2626
/** @var string (may be empty) */
2727
public $description;
2828

29-
public function __construct(TypeNode $type, bool $isVariadic, string $parameterName, string $description, bool $isReference = false)
29+
public function __construct(?TypeNode $type, bool $isVariadic, string $parameterName, string $description, bool $isReference = false)
3030
{
3131
$this->type = $type;
3232
$this->isReference = $isReference;
@@ -38,9 +38,10 @@ public function __construct(TypeNode $type, bool $isVariadic, string $parameterN
3838

3939
public function __toString(): string
4040
{
41+
$type = $this->type !== null ? "{$this->type}" : '';
4142
$reference = $this->isReference ? '&' : '';
4243
$variadic = $this->isVariadic ? '...' : '';
43-
return trim("{$this->type}{$reference}{$variadic}{$this->parameterName}{$this->description}");
44+
return trim("{$type}{$reference}{$variadic}{$this->parameterName}{$this->description}");
4445
}
4546

4647
}

‎src/Parser/PhpDocParser.php

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
use PHPStan\ShouldNotHappenException;
99
use function array_values;
1010
use function count;
11+
use function strlen;
1112
use function trim;
1213

1314
class PhpDocParser
@@ -232,11 +233,20 @@ public function parseTagValue(TokenIterator $tokens, string $tag): Ast\PhpDoc\Ph
232233

233234
private function parseParamTagValue(TokenIterator $tokens): Ast\PhpDoc\ParamTagValueNode
234235
{
235-
$type = $this->typeParser->parse($tokens);
236+
if (
237+
$tokens->isCurrentTokenType(Lexer::TOKEN_REFERENCE)
238+
|| $tokens->isCurrentTokenType(Lexer::TOKEN_VARIADIC)
239+
|| $tokens->isCurrentTokenType(Lexer::TOKEN_VARIABLE)
240+
) {
241+
$type = null;
242+
} else {
243+
$type = $this->typeParser->parse($tokens);
244+
}
245+
236246
$isReference = $tokens->tryConsumeTokenType(Lexer::TOKEN_REFERENCE);
237247
$isVariadic = $tokens->tryConsumeTokenType(Lexer::TOKEN_VARIADIC);
238248
$parameterName = $this->parseRequiredVariableName($tokens);
239-
$description = $this->parseOptionalDescription($tokens);
249+
$description = $type === null ? $this->parseRequiredDescription($tokens) : $this->parseOptionalDescription($tokens);
240250
return new Ast\PhpDoc\ParamTagValueNode($type, $isVariadic, $parameterName, $description, $isReference);
241251
}
242252

@@ -463,6 +473,22 @@ private function parseRequiredVariableName(TokenIterator $tokens): string
463473
return $parameterName;
464474
}
465475

476+
private function parseRequiredDescription(TokenIterator $tokens): string
477+
{
478+
$tokens->pushSavePoint();
479+
480+
$description = $this->parseOptionalDescription($tokens);
481+
482+
if (strlen($description) === 0) {
483+
$tokens->rollback();
484+
485+
$tokens->consumeTokenType(Lexer::TOKEN_OTHER);
486+
}
487+
488+
$tokens->dropSavePoint();
489+
490+
return $description;
491+
}
466492

467493
private function parseOptionalDescription(TokenIterator $tokens, bool $limitStartToken = false): string
468494
{

‎tests/PHPStan/Parser/PhpDocParserTest.php

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,72 @@ public function provideParamTagsData(): Iterator
242242
]),
243243
];
244244

245+
yield [
246+
'OK without type',
247+
'/** @param $foo description */',
248+
new PhpDocNode([
249+
new PhpDocTagNode(
250+
'@param',
251+
new ParamTagValueNode(
252+
null,
253+
false,
254+
'$foo',
255+
'description'
256+
)
257+
),
258+
]),
259+
];
260+
261+
yield [
262+
'OK reference without type',
263+
'/** @param &$foo description */',
264+
new PhpDocNode([
265+
new PhpDocTagNode(
266+
'@param',
267+
new ParamTagValueNode(
268+
null,
269+
false,
270+
'$foo',
271+
'description',
272+
true
273+
)
274+
),
275+
]),
276+
];
277+
278+
yield [
279+
'OK variadic without type',
280+
'/** @param ...$foo description */',
281+
new PhpDocNode([
282+
new PhpDocTagNode(
283+
'@param',
284+
new ParamTagValueNode(
285+
null,
286+
true,
287+
'$foo',
288+
'description'
289+
)
290+
),
291+
]),
292+
];
293+
294+
yield [
295+
'OK reference variadic without type',
296+
'/** @param &...$foo description */',
297+
new PhpDocNode([
298+
new PhpDocTagNode(
299+
'@param',
300+
new ParamTagValueNode(
301+
null,
302+
true,
303+
'$foo',
304+
'description',
305+
true
306+
)
307+
),
308+
]),
309+
];
310+
245311
yield [
246312
'invalid without type, parameter name and description',
247313
'/** @param */',
@@ -393,6 +459,25 @@ public function provideParamTagsData(): Iterator
393459
),
394460
]),
395461
];
462+
463+
yield [
464+
'invalid without type and description',
465+
'/** @param $foo */',
466+
new PhpDocNode([
467+
new PhpDocTagNode(
468+
'@param',
469+
new InvalidTagValueNode(
470+
'$foo',
471+
new ParserException(
472+
'*/',
473+
Lexer::TOKEN_CLOSE_PHPDOC,
474+
16,
475+
Lexer::TOKEN_OTHER
476+
)
477+
)
478+
),
479+
]),
480+
];
396481
}
397482

398483

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /