*/
- public $nodes = [];
+ public array $nodes = [];
public function enterNode(Node $node)
{
diff --git a/tests/PHPStan/Parser/PhpDocParserTest.php b/tests/PHPStan/Parser/PhpDocParserTest.php
index 0d533f70..abe69b8e 100644
--- a/tests/PHPStan/Parser/PhpDocParserTest.php
+++ b/tests/PHPStan/Parser/PhpDocParserTest.php
@@ -2,6 +2,7 @@
namespace PHPStan\PhpDocParser\Parser;
+use Doctrine\Common\Annotations\DocParser;
use Iterator;
use PHPStan\PhpDocParser\Ast\Attribute;
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprArrayItemNode;
@@ -9,12 +10,18 @@
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprIntegerNode;
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprStringNode;
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstFetchNode;
+use PHPStan\PhpDocParser\Ast\ConstExpr\DoctrineConstExprStringNode;
use PHPStan\PhpDocParser\Ast\Node;
use PHPStan\PhpDocParser\Ast\NodeTraverser;
use PHPStan\PhpDocParser\Ast\PhpDoc\AssertTagMethodValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\AssertTagPropertyValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\AssertTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\DeprecatedTagValueNode;
+use PHPStan\PhpDocParser\Ast\PhpDoc\Doctrine\DoctrineAnnotation;
+use PHPStan\PhpDocParser\Ast\PhpDoc\Doctrine\DoctrineArgument;
+use PHPStan\PhpDocParser\Ast\PhpDoc\Doctrine\DoctrineArray;
+use PHPStan\PhpDocParser\Ast\PhpDoc\Doctrine\DoctrineArrayItem;
+use PHPStan\PhpDocParser\Ast\PhpDoc\Doctrine\DoctrineTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\ExtendsTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\GenericTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\ImplementsTagValueNode;
@@ -22,12 +29,18 @@
use PHPStan\PhpDocParser\Ast\PhpDoc\MethodTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\MethodTagValueParameterNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\MixinTagValueNode;
+use PHPStan\PhpDocParser\Ast\PhpDoc\ParamClosureThisTagValueNode;
+use PHPStan\PhpDocParser\Ast\PhpDoc\ParamImmediatelyInvokedCallableTagValueNode;
+use PHPStan\PhpDocParser\Ast\PhpDoc\ParamLaterInvokedCallableTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\ParamOutTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTextNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\PropertyTagValueNode;
+use PHPStan\PhpDocParser\Ast\PhpDoc\PureUnlessCallableIsImpureTagValueNode;
+use PHPStan\PhpDocParser\Ast\PhpDoc\RequireExtendsTagValueNode;
+use PHPStan\PhpDocParser\Ast\PhpDoc\RequireImplementsTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\SelfOutTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\TemplateTagValueNode;
@@ -47,40 +60,36 @@
use PHPStan\PhpDocParser\Ast\Type\ConstTypeNode;
use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
+use PHPStan\PhpDocParser\Ast\Type\IntersectionTypeNode;
use PHPStan\PhpDocParser\Ast\Type\InvalidTypeNode;
use PHPStan\PhpDocParser\Ast\Type\NullableTypeNode;
+use PHPStan\PhpDocParser\Ast\Type\ObjectShapeItemNode;
+use PHPStan\PhpDocParser\Ast\Type\ObjectShapeNode;
use PHPStan\PhpDocParser\Ast\Type\OffsetAccessTypeNode;
use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
use PHPStan\PhpDocParser\Lexer\Lexer;
+use PHPStan\PhpDocParser\ParserConfig;
use PHPUnit\Framework\TestCase;
use function count;
use function sprintf;
+use const DIRECTORY_SEPARATOR;
use const PHP_EOL;
class PhpDocParserTest extends TestCase
{
- /** @var Lexer */
- private $lexer;
+ private Lexer $lexer;
- /** @var PhpDocParser */
- private $phpDocParser;
-
- /** @var PhpDocParser */
- private $phpDocParserWithRequiredWhitespaceBeforeDescription;
-
- /** @var PhpDocParser */
- private $phpDocParserWithPreserveTypeAliasesWithInvalidTypes;
+ private PhpDocParser $phpDocParser;
protected function setUp(): void
{
parent::setUp();
- $this->lexer = new Lexer();
- $constExprParser = new ConstExprParser();
- $typeParser = new TypeParser($constExprParser);
- $this->phpDocParser = new PhpDocParser($typeParser, $constExprParser);
- $this->phpDocParserWithRequiredWhitespaceBeforeDescription = new PhpDocParser($typeParser, $constExprParser, true);
- $this->phpDocParserWithPreserveTypeAliasesWithInvalidTypes = new PhpDocParser($typeParser, $constExprParser, true, true);
+ $config = new ParserConfig([]);
+ $this->lexer = new Lexer($config);
+ $constExprParser = new ConstExprParser($config);
+ $typeParser = new TypeParser($config, $constExprParser);
+ $this->phpDocParser = new PhpDocParser($config, $typeParser, $constExprParser);
}
@@ -88,11 +97,17 @@ protected function setUp(): void
* @dataProvider provideTagsWithNumbers
* @dataProvider provideSpecializedTags
* @dataProvider provideParamTagsData
+ * @dataProvider provideParamImmediatelyInvokedCallableTagsData
+ * @dataProvider provideParamLaterInvokedCallableTagsData
* @dataProvider provideTypelessParamTagsData
+ * @dataProvider provideParamClosureThisTagsData
+ * @dataProvider providePureUnlessCallableIsImpureTagsData
* @dataProvider provideVarTagsData
* @dataProvider provideReturnTagsData
* @dataProvider provideThrowsTagsData
* @dataProvider provideMixinTagsData
+ * @dataProvider provideRequireExtendsTagsData
+ * @dataProvider provideRequireImplementsTagsData
* @dataProvider provideDeprecatedTagsData
* @dataProvider providePropertyTagsData
* @dataProvider provideMethodTagsData
@@ -108,34 +123,22 @@ protected function setUp(): void
* @dataProvider provideTagsWithBackslash
* @dataProvider provideSelfOutTagsData
* @dataProvider provideParamOutTagsData
+ * @dataProvider provideDoctrineData
+ * @dataProvider provideDoctrineWithoutDoctrineCheckData
+ * @dataProvider provideCommentLikeDescriptions
+ * @dataProvider provideInlineTags
*/
public function testParse(
string $label,
string $input,
- PhpDocNode $expectedPhpDocNode,
- ?PhpDocNode $withRequiredWhitespaceBeforeDescriptionExpectedPhpDocNode = null,
- ?PhpDocNode $withPreserveTypeAliasesWithInvalidTypesExpectedPhpDocNode = null
+ PhpDocNode $expectedPhpDocNode
): void
{
$this->executeTestParse(
$this->phpDocParser,
$label,
$input,
- $expectedPhpDocNode
- );
-
- $this->executeTestParse(
- $this->phpDocParserWithRequiredWhitespaceBeforeDescription,
- $label,
- $input,
- $withRequiredWhitespaceBeforeDescriptionExpectedPhpDocNode ?? $expectedPhpDocNode
- );
-
- $this->executeTestParse(
- $this->phpDocParserWithPreserveTypeAliasesWithInvalidTypes,
- $label,
- $input,
- $withPreserveTypeAliasesWithInvalidTypesExpectedPhpDocNode ?? $withRequiredWhitespaceBeforeDescriptionExpectedPhpDocNode ?? $expectedPhpDocNode
+ $expectedPhpDocNode,
);
}
@@ -146,8 +149,8 @@ private function executeTestParse(PhpDocParser $phpDocParser, string $label, str
$actualPhpDocNode = $phpDocParser->parse($tokens);
$this->assertEquals($expectedPhpDocNode, $actualPhpDocNode, $label);
- $this->assertSame((string) $expectedPhpDocNode, (string) $actualPhpDocNode);
- $this->assertSame(Lexer::TOKEN_END, $tokens->currentTokenType());
+ $this->assertSame((string) $expectedPhpDocNode, (string) $actualPhpDocNode, $label);
+ $this->assertSame(Lexer::TOKEN_END, $tokens->currentTokenType(), $label);
}
@@ -163,8 +166,9 @@ public function provideParamTagsData(): Iterator
new IdentifierTypeNode('Foo'),
false,
'$foo',
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -179,8 +183,9 @@ public function provideParamTagsData(): Iterator
new IdentifierTypeNode('Foo'),
false,
'$foo',
- 'optional description'
- )
+ 'optional description',
+ false,
+ ),
),
]),
];
@@ -195,8 +200,9 @@ public function provideParamTagsData(): Iterator
new IdentifierTypeNode('Foo'),
true,
'$foo',
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -211,8 +217,9 @@ public function provideParamTagsData(): Iterator
new IdentifierTypeNode('Foo'),
true,
'$foo',
- 'optional description'
- )
+ 'optional description',
+ false,
+ ),
),
]),
];
@@ -228,8 +235,8 @@ public function provideParamTagsData(): Iterator
false,
'$foo',
'',
- true
- )
+ true,
+ ),
),
]),
];
@@ -245,8 +252,8 @@ public function provideParamTagsData(): Iterator
false,
'$foo',
'optional description',
- true
- )
+ true,
+ ),
),
]),
];
@@ -262,8 +269,8 @@ public function provideParamTagsData(): Iterator
true,
'$foo',
'',
- true
- )
+ true,
+ ),
),
]),
];
@@ -279,8 +286,8 @@ public function provideParamTagsData(): Iterator
true,
'$foo',
'optional description',
- true
- )
+ true,
+ ),
),
]),
];
@@ -295,8 +302,9 @@ public function provideParamTagsData(): Iterator
new ConstTypeNode(new ConstFetchNode('self', '*')),
false,
'$foo',
- 'optional description'
- )
+ 'optional description',
+ false,
+ ),
),
]),
];
@@ -315,9 +323,9 @@ public function provideParamTagsData(): Iterator
11,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -336,9 +344,9 @@ public function provideParamTagsData(): Iterator
11,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -357,9 +365,9 @@ public function provideParamTagsData(): Iterator
16,
Lexer::TOKEN_CLOSE_PARENTHESES,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -378,9 +386,9 @@ public function provideParamTagsData(): Iterator
16,
Lexer::TOKEN_CLOSE_PARENTHESES,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -399,9 +407,9 @@ public function provideParamTagsData(): Iterator
19,
Lexer::TOKEN_CLOSE_ANGLE_BRACKET,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -420,9 +428,9 @@ public function provideParamTagsData(): Iterator
16,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -441,9 +449,9 @@ public function provideParamTagsData(): Iterator
15,
Lexer::TOKEN_VARIABLE,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -464,9 +472,9 @@ public function provideParamTagsData(): Iterator
21,
Lexer::TOKEN_VARIABLE,
null,
- 2
- )
- )
+ 2,
+ ),
+ ),
),
]),
];
@@ -485,9 +493,9 @@ public function provideParamTagsData(): Iterator
15,
Lexer::TOKEN_VARIABLE,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -512,8 +520,9 @@ public function provideParamTagsData(): Iterator
false,
'$parameters',
'{' . PHP_EOL .
- ' Optional. Parameters for filtering the list of user assignments. Default empty array.'
- )
+ ' Optional. Parameters for filtering the list of user assignments. Default empty array.',
+ false,
+ ),
),
new PhpDocTextNode(''),
new PhpDocTagNode('@type', new GenericTagValueNode('bool $is_active Pass `true` to only return active user assignments and `false` to' . PHP_EOL .
@@ -536,8 +545,9 @@ public function provideTypelessParamTagsData(): Iterator
new TypelessParamTagValueNode(
false,
'$foo',
- 'description'
- )
+ 'description',
+ false,
+ ),
),
]),
];
@@ -552,8 +562,8 @@ public function provideTypelessParamTagsData(): Iterator
false,
'$foo',
'description',
- true
- )
+ true,
+ ),
),
]),
];
@@ -567,8 +577,9 @@ public function provideTypelessParamTagsData(): Iterator
new TypelessParamTagValueNode(
true,
'$foo',
- 'description'
- )
+ 'description',
+ false,
+ ),
),
]),
];
@@ -583,8 +594,8 @@ public function provideTypelessParamTagsData(): Iterator
true,
'$foo',
'description',
- true
- )
+ true,
+ ),
),
]),
];
@@ -599,8 +610,149 @@ public function provideTypelessParamTagsData(): Iterator
false,
'$foo',
'',
- false
- )
+ false,
+ ),
+ ),
+ ]),
+ ];
+ }
+
+ public function provideParamImmediatelyInvokedCallableTagsData(): Iterator
+ {
+ yield [
+ 'OK',
+ '/** @param-immediately-invoked-callable $foo */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@param-immediately-invoked-callable',
+ new ParamImmediatelyInvokedCallableTagValueNode(
+ '$foo',
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with description',
+ '/** @param-immediately-invoked-callable $foo test two three */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@param-immediately-invoked-callable',
+ new ParamImmediatelyInvokedCallableTagValueNode(
+ '$foo',
+ 'test two three',
+ ),
+ ),
+ ]),
+ ];
+ }
+
+ public function provideParamLaterInvokedCallableTagsData(): Iterator
+ {
+ yield [
+ 'OK',
+ '/** @param-later-invoked-callable $foo */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@param-later-invoked-callable',
+ new ParamLaterInvokedCallableTagValueNode(
+ '$foo',
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with description',
+ '/** @param-later-invoked-callable $foo test two three */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@param-later-invoked-callable',
+ new ParamLaterInvokedCallableTagValueNode(
+ '$foo',
+ 'test two three',
+ ),
+ ),
+ ]),
+ ];
+ }
+
+ public function provideParamClosureThisTagsData(): Iterator
+ {
+ yield [
+ 'OK',
+ '/** @param-closure-this Foo $a */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@param-closure-this',
+ new ParamClosureThisTagValueNode(
+ new IdentifierTypeNode('Foo'),
+ '$a',
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with prefix',
+ '/** @phpstan-param-closure-this Foo $a */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@phpstan-param-closure-this',
+ new ParamClosureThisTagValueNode(
+ new IdentifierTypeNode('Foo'),
+ '$a',
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with description',
+ '/** @param-closure-this Foo $a test */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@param-closure-this',
+ new ParamClosureThisTagValueNode(
+ new IdentifierTypeNode('Foo'),
+ '$a',
+ 'test',
+ ),
+ ),
+ ]),
+ ];
+ }
+
+ public function providePureUnlessCallableIsImpureTagsData(): Iterator
+ {
+ yield [
+ 'OK',
+ '/** @pure-unless-callable-is-impure $foo */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@pure-unless-callable-is-impure',
+ new PureUnlessCallableIsImpureTagValueNode(
+ '$foo',
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with description',
+ '/** @pure-unless-callable-is-impure $foo test two three */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@pure-unless-callable-is-impure',
+ new PureUnlessCallableIsImpureTagValueNode(
+ '$foo',
+ 'test two three',
+ ),
),
]),
];
@@ -617,8 +769,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'',
- ''
- )
+ '',
+ ),
),
]),
];
@@ -632,8 +784,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'$foo',
- ''
- )
+ '',
+ ),
),
]),
];
@@ -647,8 +799,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'$foo',
- ''
- )
+ '',
+ ),
),
]),
];
@@ -662,8 +814,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'',
- 'optional description'
- )
+ 'optional description',
+ ),
),
]),
];
@@ -676,11 +828,11 @@ public function provideVarTagsData(): Iterator
'@var',
new VarTagValueNode(
new ArrayTypeNode(
- new IdentifierTypeNode('callable')
+ new IdentifierTypeNode('callable'),
),
'',
- 'function (Configurator $sender, DI\Compiler $compiler); Occurs after the compiler is created'
- )
+ 'function (Configurator $sender, DI\Compiler $compiler); Occurs after the compiler is created',
+ ),
),
]),
];
@@ -694,8 +846,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'',
- '@inject'
- )
+ '@inject',
+ ),
),
]),
];
@@ -709,8 +861,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'',
- '(Bar)'
- )
+ '(Bar)',
+ ),
),
]),
];
@@ -724,8 +876,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'$foo',
- 'optional description'
- )
+ 'optional description',
+ ),
),
]),
];
@@ -739,8 +891,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'$this',
- ''
- )
+ '',
+ ),
),
]),
];
@@ -754,8 +906,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'$this',
- ''
- )
+ '',
+ ),
),
]),
];
@@ -769,8 +921,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'$this',
- 'Testing'
- )
+ 'Testing',
+ ),
),
]),
];
@@ -784,8 +936,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'$this',
- 'Testing'
- )
+ 'Testing',
+ ),
),
]),
];
@@ -799,18 +951,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'$foo',
- '#desc'
- )
- ),
- ]),
- new PhpDocNode([
- new PhpDocTagNode(
- '@var',
- new VarTagValueNode(
- new IdentifierTypeNode('Foo'),
- '$foo',
- '#desc'
- )
+ '#desc',
+ ),
),
]),
];
@@ -824,8 +966,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new ConstTypeNode(new ConstFetchNode('self', '*')),
'$foo',
- 'optional description'
- )
+ 'optional description',
+ ),
),
]),
];
@@ -839,8 +981,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'$var',
- ''
- )
+ '',
+ ),
),
]),
];
@@ -854,8 +996,8 @@ public function provideVarTagsData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('Foo'),
'',
- ''
- )
+ '',
+ ),
),
]),
];
@@ -874,9 +1016,9 @@ public function provideVarTagsData(): Iterator
9,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -895,9 +1037,9 @@ public function provideVarTagsData(): Iterator
9,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -916,9 +1058,9 @@ public function provideVarTagsData(): Iterator
14,
Lexer::TOKEN_CLOSE_PARENTHESES,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -937,9 +1079,9 @@ public function provideVarTagsData(): Iterator
14,
Lexer::TOKEN_CLOSE_PARENTHESES,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -958,9 +1100,9 @@ public function provideVarTagsData(): Iterator
17,
Lexer::TOKEN_CLOSE_ANGLE_BRACKET,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -979,9 +1121,9 @@ public function provideVarTagsData(): Iterator
14,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -989,23 +1131,6 @@ public function provideVarTagsData(): Iterator
yield [
'invalid object shape',
'/** @psalm-type PARTSTRUCTURE_PARAM = objecttt{attribute:string, value?:string} */',
- new PhpDocNode([
- new PhpDocTagNode(
- '@psalm-type',
- new InvalidTagValueNode(
- 'Unexpected token "{", expected \'*/\' at offset 46 on line 1',
- new ParserException(
- '{',
- Lexer::TOKEN_OPEN_CURLY_BRACKET,
- 46,
- Lexer::TOKEN_CLOSE_PHPDOC,
- null,
- 1
- )
- )
- ),
- ]),
- null,
new PhpDocNode([
new PhpDocTagNode(
'@psalm-type',
@@ -1018,10 +1143,10 @@ public function provideVarTagsData(): Iterator
46,
Lexer::TOKEN_PHPDOC_EOL,
null,
- 1
- )
- )
- )
+ 1,
+ ),
+ ),
+ ),
),
]),
];
@@ -1039,8 +1164,8 @@ public function providePropertyTagsData(): Iterator
new PropertyTagValueNode(
new IdentifierTypeNode('Foo'),
'$foo',
- ''
- )
+ '',
+ ),
),
]),
];
@@ -1054,8 +1179,8 @@ public function providePropertyTagsData(): Iterator
new PropertyTagValueNode(
new IdentifierTypeNode('Foo'),
'$foo',
- 'optional description'
- )
+ 'optional description',
+ ),
),
]),
];
@@ -1074,9 +1199,9 @@ public function providePropertyTagsData(): Iterator
14,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1095,9 +1220,9 @@ public function providePropertyTagsData(): Iterator
14,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1116,9 +1241,9 @@ public function providePropertyTagsData(): Iterator
19,
Lexer::TOKEN_CLOSE_PARENTHESES,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1137,9 +1262,9 @@ public function providePropertyTagsData(): Iterator
19,
Lexer::TOKEN_CLOSE_PARENTHESES,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1158,9 +1283,9 @@ public function providePropertyTagsData(): Iterator
22,
Lexer::TOKEN_CLOSE_ANGLE_BRACKET,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1179,9 +1304,9 @@ public function providePropertyTagsData(): Iterator
19,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1200,9 +1325,9 @@ public function providePropertyTagsData(): Iterator
18,
Lexer::TOKEN_VARIABLE,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1221,9 +1346,9 @@ public function providePropertyTagsData(): Iterator
18,
Lexer::TOKEN_VARIABLE,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1240,8 +1365,8 @@ public function provideReturnTagsData(): Iterator
'@return',
new ReturnTagValueNode(
new IdentifierTypeNode('Foo'),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -1254,8 +1379,8 @@ public function provideReturnTagsData(): Iterator
'@return',
new ReturnTagValueNode(
new IdentifierTypeNode('Foo'),
- 'optional description'
- )
+ 'optional description',
+ ),
),
]),
];
@@ -1268,8 +1393,8 @@ public function provideReturnTagsData(): Iterator
'@return',
new ReturnTagValueNode(
new IdentifierTypeNode('Foo'),
- '[Bar]'
- )
+ '[Bar]',
+ ),
),
]),
];
@@ -1283,10 +1408,24 @@ public function provideReturnTagsData(): Iterator
new ReturnTagValueNode(
new OffsetAccessTypeNode(
new IdentifierTypeNode('Foo'),
- new IdentifierTypeNode('Bar')
+ new IdentifierTypeNode('Bar'),
),
- ''
- )
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with HTML description',
+ '/** @return MongoCollection Returns a collection object representing the new collection.
*/',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@return',
+ new ReturnTagValueNode(
+ new IdentifierTypeNode('MongoCollection'),
+ 'Returns a collection object representing the new collection.
',
+ ),
),
]),
];
@@ -1305,9 +1444,9 @@ public function provideReturnTagsData(): Iterator
12,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1326,9 +1465,9 @@ public function provideReturnTagsData(): Iterator
12,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1347,9 +1486,9 @@ public function provideReturnTagsData(): Iterator
18,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1368,9 +1507,9 @@ public function provideReturnTagsData(): Iterator
18,
Lexer::TOKEN_OTHER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1389,9 +1528,9 @@ public function provideReturnTagsData(): Iterator
18,
Lexer::TOKEN_OTHER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1410,9 +1549,9 @@ public function provideReturnTagsData(): Iterator
24,
Lexer::TOKEN_CLOSE_ANGLE_BRACKET,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1433,11 +1572,11 @@ public function provideReturnTagsData(): Iterator
],
[
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
]),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -1450,8 +1589,8 @@ public function provideReturnTagsData(): Iterator
'@return',
new ReturnTagValueNode(
new ConstTypeNode(new ConstFetchNode('self', '*')),
- 'example description'
- )
+ 'example description',
+ ),
),
]),
];
@@ -1468,10 +1607,10 @@ public function provideReturnTagsData(): Iterator
new IdentifierTypeNode('Bar'),
new IdentifierTypeNode('never'),
new IdentifierTypeNode('int'),
- false
+ false,
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -1488,10 +1627,10 @@ public function provideReturnTagsData(): Iterator
new IdentifierTypeNode('Bar'),
new IdentifierTypeNode('never'),
new IdentifierTypeNode('int'),
- true
+ true,
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -1514,12 +1653,12 @@ public function provideReturnTagsData(): Iterator
new ConstTypeNode(new ConstFetchNode('self', 'TYPE_INT')),
new IdentifierTypeNode('int'),
new IdentifierTypeNode('bool'),
- false
+ false,
),
- false
+ false,
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -1532,8 +1671,8 @@ public function provideReturnTagsData(): Iterator
'@return',
new ReturnTagValueNode(
new IdentifierTypeNode('Foo'),
- 'is not Bar ? never : int'
- )
+ 'is not Bar ? never : int',
+ ),
),
]),
];
@@ -1550,10 +1689,10 @@ public function provideReturnTagsData(): Iterator
new IdentifierTypeNode('Bar'),
new IdentifierTypeNode('never'),
new IdentifierTypeNode('int'),
- false
+ false,
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -1570,10 +1709,10 @@ public function provideReturnTagsData(): Iterator
new IdentifierTypeNode('Bar'),
new IdentifierTypeNode('never'),
new IdentifierTypeNode('int'),
- true
+ true,
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -1596,12 +1735,12 @@ public function provideReturnTagsData(): Iterator
new ConstTypeNode(new ConstFetchNode('self', 'TYPE_INT')),
new IdentifierTypeNode('int'),
new IdentifierTypeNode('bool'),
- false
+ false,
),
- false
+ false,
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -1620,9 +1759,9 @@ public function provideReturnTagsData(): Iterator
12,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1642,20 +1781,21 @@ public function provideReturnTagsData(): Iterator
false,
true,
'$u',
- false
+ false,
),
new CallableTypeParameterNode(
new IdentifierTypeNode('string'),
false,
false,
'',
- false
+ false,
),
],
- new IdentifierTypeNode('string')
+ new IdentifierTypeNode('string'),
+ [],
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -1663,15 +1803,6 @@ public function provideReturnTagsData(): Iterator
yield [
'invalid variadic callable',
'/** @return \Closure(...int, string): string */',
- new PhpDocNode([
- new PhpDocTagNode(
- '@return',
- new ReturnTagValueNode(
- new IdentifierTypeNode('\Closure'),
- '(...int, string): string'
- )
- ),
- ]),
new PhpDocNode([
new PhpDocTagNode(
'@return',
@@ -1683,9 +1814,72 @@ public function provideReturnTagsData(): Iterator
20,
Lexer::TOKEN_HORIZONTAL_WS,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'valid CallableTypeNode without space after "callable"',
+ '/** @return callable(int, string): void */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@return',
+ new ReturnTagValueNode(
+ new CallableTypeNode(new IdentifierTypeNode('callable'), [
+ new CallableTypeParameterNode(new IdentifierTypeNode('int'), false, false, '', false),
+ new CallableTypeParameterNode(new IdentifierTypeNode('string'), false, false, '', false),
+ ], new IdentifierTypeNode('void'), []),
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'valid CallableTypeNode with space after "callable"',
+ '/** @return callable (int, string): void */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@return',
+ new ReturnTagValueNode(
+ new CallableTypeNode(new IdentifierTypeNode('callable'), [
+ new CallableTypeParameterNode(new IdentifierTypeNode('int'), false, false, '', false),
+ new CallableTypeParameterNode(new IdentifierTypeNode('string'), false, false, '', false),
+ ], new IdentifierTypeNode('void'), []),
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'valid IdentifierTypeNode with space after "callable" turns the rest to description',
+ '/** @return callable (int, string) */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@return',
+ new ReturnTagValueNode(new IdentifierTypeNode('callable'), '(int, string)'),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'invalid CallableTypeNode without space after "callable"',
+ '/** @return callable(int, string) */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@return',
+ new InvalidTagValueNode('callable(int, string)', new ParserException(
+ '(',
+ 4,
+ 20,
+ 27,
+ null,
+ 1,
+ )),
),
]),
];
@@ -1702,8 +1896,8 @@ public function provideThrowsTagsData(): Iterator
'@throws',
new ThrowsTagValueNode(
new IdentifierTypeNode('Foo'),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -1716,8 +1910,8 @@ public function provideThrowsTagsData(): Iterator
'@throws',
new ThrowsTagValueNode(
new IdentifierTypeNode('Foo'),
- 'optional description'
- )
+ 'optional description',
+ ),
),
]),
];
@@ -1730,8 +1924,8 @@ public function provideThrowsTagsData(): Iterator
'@throws',
new ThrowsTagValueNode(
new IdentifierTypeNode('Foo'),
- '[Bar]'
- )
+ '[Bar]',
+ ),
),
]),
];
@@ -1750,9 +1944,9 @@ public function provideThrowsTagsData(): Iterator
12,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1771,9 +1965,9 @@ public function provideThrowsTagsData(): Iterator
18,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1789,8 +1983,8 @@ public function provideMixinTagsData(): Iterator
'@mixin',
new MixinTagValueNode(
new IdentifierTypeNode('Foo'),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -1803,8 +1997,8 @@ public function provideMixinTagsData(): Iterator
'@mixin',
new MixinTagValueNode(
new IdentifierTypeNode('Foo'),
- 'optional description'
- )
+ 'optional description',
+ ),
),
]),
];
@@ -1817,8 +2011,8 @@ public function provideMixinTagsData(): Iterator
'@mixin',
new MixinTagValueNode(
new IdentifierTypeNode('Foo'),
- '[Bar]'
- )
+ '[Bar]',
+ ),
),
]),
];
@@ -1837,9 +2031,9 @@ public function provideMixinTagsData(): Iterator
11,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1858,9 +2052,9 @@ public function provideMixinTagsData(): Iterator
17,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -1877,8 +2071,140 @@ public function provideMixinTagsData(): Iterator
], [
GenericTypeNode::VARIANCE_INVARIANT,
]),
- ''
- )
+ '',
+ ),
+ ),
+ ]),
+ ];
+ }
+
+ public function provideRequireExtendsTagsData(): Iterator
+ {
+ yield [
+ 'OK without description',
+ '/** @phpstan-require-extends Foo */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@phpstan-require-extends',
+ new RequireExtendsTagValueNode(
+ new IdentifierTypeNode('Foo'),
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with description',
+ '/** @phpstan-require-extends Foo optional description */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@phpstan-require-extends',
+ new RequireExtendsTagValueNode(
+ new IdentifierTypeNode('Foo'),
+ 'optional description',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with psalm-prefix description',
+ '/** @psalm-require-extends Foo optional description */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@psalm-require-extends',
+ new RequireExtendsTagValueNode(
+ new IdentifierTypeNode('Foo'),
+ 'optional description',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'invalid without type and description',
+ '/** @phpstan-require-extends */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@phpstan-require-extends',
+ new InvalidTagValueNode(
+ '',
+ new ParserException(
+ '*/',
+ Lexer::TOKEN_CLOSE_PHPDOC,
+ 29,
+ Lexer::TOKEN_IDENTIFIER,
+ null,
+ 1,
+ ),
+ ),
+ ),
+ ]),
+ ];
+ }
+
+ public function provideRequireImplementsTagsData(): Iterator
+ {
+ yield [
+ 'OK without description',
+ '/** @phpstan-require-implements Foo */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@phpstan-require-implements',
+ new RequireImplementsTagValueNode(
+ new IdentifierTypeNode('Foo'),
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with description',
+ '/** @phpstan-require-implements Foo optional description */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@phpstan-require-implements',
+ new RequireImplementsTagValueNode(
+ new IdentifierTypeNode('Foo'),
+ 'optional description',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with psalm-prefix description',
+ '/** @psalm-require-implements Foo optional description */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@psalm-require-implements',
+ new RequireImplementsTagValueNode(
+ new IdentifierTypeNode('Foo'),
+ 'optional description',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'invalid without type and description',
+ '/** @phpstan-require-implements */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@phpstan-require-implements',
+ new InvalidTagValueNode(
+ '',
+ new ParserException(
+ '*/',
+ Lexer::TOKEN_CLOSE_PHPDOC,
+ 32,
+ Lexer::TOKEN_IDENTIFIER,
+ null,
+ 1,
+ ),
+ ),
),
]),
];
@@ -1892,7 +2218,7 @@ public function provideDeprecatedTagsData(): Iterator
new PhpDocNode([
new PhpDocTagNode(
'@deprecated',
- new DeprecatedTagValueNode('')
+ new DeprecatedTagValueNode(''),
),
]),
];
@@ -1903,7 +2229,7 @@ public function provideDeprecatedTagsData(): Iterator
new PhpDocNode([
new PhpDocTagNode(
'@deprecated',
- new DeprecatedTagValueNode('text string')
+ new DeprecatedTagValueNode('text string'),
),
]),
];
@@ -1916,12 +2242,12 @@ public function provideDeprecatedTagsData(): Iterator
new PhpDocNode([
new PhpDocTagNode(
'@deprecated',
- new DeprecatedTagValueNode('text first')
+ new DeprecatedTagValueNode('text first'),
),
new PhpDocTextNode(''),
new PhpDocTagNode(
'@deprecated',
- new DeprecatedTagValueNode('text second')
+ new DeprecatedTagValueNode('text second'),
),
]),
];
@@ -1934,11 +2260,11 @@ public function provideDeprecatedTagsData(): Iterator
new PhpDocNode([
new PhpDocTagNode(
'@deprecated',
- new DeprecatedTagValueNode('text first')
+ new DeprecatedTagValueNode('text first'),
),
new PhpDocTagNode(
'@deprecated',
- new DeprecatedTagValueNode('text second')
+ new DeprecatedTagValueNode('text second'),
),
]),
];
@@ -1955,7 +2281,7 @@ public function provideDeprecatedTagsData(): Iterator
new DeprecatedTagValueNode('in Drupal 8.6.0 and will be removed before Drupal 9.0.0. In
Drupal 9 there will be no way to set the status and in Drupal 8 this
ability has been removed because mb_*() functions are supplied using
- Symfony\'s polyfill.')
+ Symfony\'s polyfill.'),
),
]),
];
@@ -1976,7 +2302,7 @@ public function provideDeprecatedTagsData(): Iterator
new PhpDocTextNode(''),
new PhpDocTagNode(
'@author',
- new GenericTagValueNode('Foo Baz ')
+ new GenericTagValueNode('Foo Baz '),
),
new PhpDocTextNode(''),
new PhpDocTagNode(
@@ -1984,7 +2310,7 @@ public function provideDeprecatedTagsData(): Iterator
new DeprecatedTagValueNode('in Drupal 8.6.0 and will be removed before Drupal 9.0.0. In
Drupal 9 there will be no way to set the status and in Drupal 8 this
ability has been removed because mb_*() functions are supplied using
- Symfony\'s polyfill.')
+ Symfony\'s polyfill.'),
),
]),
];
@@ -2003,8 +2329,9 @@ public function provideMethodTagsData(): Iterator
null,
'foo',
[],
- ''
- )
+ '',
+ [],
+ ),
),
]),
];
@@ -2020,8 +2347,9 @@ public function provideMethodTagsData(): Iterator
new IdentifierTypeNode('Foo'),
'foo',
[],
- ''
- )
+ '',
+ [],
+ ),
),
]),
];
@@ -2037,8 +2365,9 @@ public function provideMethodTagsData(): Iterator
new IdentifierTypeNode('static'),
'foo',
[],
- ''
- )
+ '',
+ [],
+ ),
),
]),
];
@@ -2054,8 +2383,9 @@ public function provideMethodTagsData(): Iterator
new IdentifierTypeNode('Foo'),
'foo',
[],
- ''
- )
+ '',
+ [],
+ ),
),
]),
];
@@ -2071,8 +2401,9 @@ public function provideMethodTagsData(): Iterator
new IdentifierTypeNode('static'),
'foo',
[],
- ''
- )
+ '',
+ [],
+ ),
),
]),
];
@@ -2088,8 +2419,9 @@ public function provideMethodTagsData(): Iterator
new IdentifierTypeNode('Foo'),
'foo',
[],
- 'optional description'
- )
+ 'optional description',
+ [],
+ ),
),
]),
];
@@ -2110,11 +2442,12 @@ public function provideMethodTagsData(): Iterator
false,
false,
'$a',
- null
+ null,
),
],
- ''
- )
+ '',
+ [],
+ ),
),
]),
];
@@ -2135,11 +2468,12 @@ public function provideMethodTagsData(): Iterator
false,
false,
'$a',
- null
+ null,
),
],
- ''
- )
+ '',
+ [],
+ ),
),
]),
];
@@ -2160,11 +2494,12 @@ public function provideMethodTagsData(): Iterator
true,
false,
'$a',
- null
+ null,
),
],
- ''
- )
+ '',
+ [],
+ ),
),
]),
];
@@ -2185,11 +2520,12 @@ public function provideMethodTagsData(): Iterator
false,
true,
'$a',
- null
+ null,
),
],
- ''
- )
+ '',
+ [],
+ ),
),
]),
];
@@ -2210,11 +2546,12 @@ public function provideMethodTagsData(): Iterator
true,
true,
'$a',
- null
+ null,
),
],
- ''
- )
+ '',
+ [],
+ ),
),
]),
];
@@ -2235,11 +2572,12 @@ public function provideMethodTagsData(): Iterator
false,
false,
'$a',
- new ConstExprIntegerNode('123')
+ new ConstExprIntegerNode('123'),
),
],
- ''
- )
+ '',
+ [],
+ ),
),
]),
];
@@ -2260,11 +2598,12 @@ public function provideMethodTagsData(): Iterator
true,
true,
'$a',
- new ConstExprIntegerNode('123')
+ new ConstExprIntegerNode('123'),
),
],
- ''
- )
+ '',
+ [],
+ ),
),
]),
];
@@ -2285,25 +2624,26 @@ public function provideMethodTagsData(): Iterator
false,
false,
'$a',
- null
+ null,
),
new MethodTagValueParameterNode(
null,
false,
false,
'$b',
- null
+ null,
),
new MethodTagValueParameterNode(
null,
false,
false,
'$c',
- null
+ null,
),
],
- ''
- )
+ '',
+ [],
+ ),
),
]),
];
@@ -2322,9 +2662,9 @@ public function provideMethodTagsData(): Iterator
16,
Lexer::TOKEN_OPEN_PARENTHESES,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -2343,9 +2683,9 @@ public function provideMethodTagsData(): Iterator
23,
Lexer::TOKEN_OPEN_PARENTHESES,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -2364,9 +2704,9 @@ public function provideMethodTagsData(): Iterator
17,
Lexer::TOKEN_VARIABLE,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -2392,7 +2732,7 @@ public function provideMethodTagsData(): Iterator
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
false,
false,
@@ -2400,13 +2740,13 @@ public function provideMethodTagsData(): Iterator
new ConstExprArrayNode([
new ConstExprArrayItemNode(
null,
- new ConstExprStringNode('\'a\'')
+ new ConstExprStringNode('a', ConstExprStringNode::SINGLE_QUOTED),
),
new ConstExprArrayItemNode(
null,
- new ConstExprStringNode('\'b\'')
+ new ConstExprStringNode('b', ConstExprStringNode::SINGLE_QUOTED),
),
- ])
+ ]),
),
],
'',
@@ -2415,10 +2755,10 @@ public function provideMethodTagsData(): Iterator
'T',
null,
'',
- new IdentifierTypeNode('string')
+ new IdentifierTypeNode('string'),
),
- ]
- )
+ ],
+ ),
),
]),
];
@@ -2439,21 +2779,21 @@ public function provideMethodTagsData(): Iterator
false,
false,
'$t1',
- null
+ null,
),
new MethodTagValueParameterNode(
new IdentifierTypeNode('T2'),
false,
false,
'$t2',
- null
+ null,
),
new MethodTagValueParameterNode(
new IdentifierTypeNode('T3'),
false,
false,
'$t3',
- null
+ null,
),
],
'',
@@ -2461,8 +2801,29 @@ public function provideMethodTagsData(): Iterator
new TemplateTagValueNode('T1', null, ''),
new TemplateTagValueNode('T2', new IdentifierTypeNode('Bar'), ''),
new TemplateTagValueNode('T3', new IdentifierTypeNode('Baz'), ''),
- ]
- )
+ ],
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK non-static with return type that starts with static type',
+ '/** @method static|null foo() */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@method',
+ new MethodTagValueNode(
+ false,
+ new UnionTypeNode([
+ new IdentifierTypeNode('static'),
+ new IdentifierTypeNode('null'),
+ ]),
+ 'foo',
+ [],
+ '',
+ [],
+ ),
),
]),
];
@@ -2482,7 +2843,7 @@ public function provideSingleLinePhpDocData(): Iterator
'/** /**/',
new PhpDocNode([
new PhpDocTextNode(
- '/*'
+ '/*',
),
]),
];
@@ -2492,7 +2853,7 @@ public function provideSingleLinePhpDocData(): Iterator
'/** text */',
new PhpDocNode([
new PhpDocTextNode(
- 'text'
+ 'text',
),
]),
];
@@ -2502,7 +2863,7 @@ public function provideSingleLinePhpDocData(): Iterator
'/** text @foo bar */',
new PhpDocNode([
new PhpDocTextNode(
- 'text @foo bar'
+ 'text @foo bar',
),
]),
];
@@ -2513,7 +2874,7 @@ public function provideSingleLinePhpDocData(): Iterator
new PhpDocNode([
new PhpDocTagNode(
'@foo',
- new GenericTagValueNode('')
+ new GenericTagValueNode(''),
),
]),
];
@@ -2524,7 +2885,7 @@ public function provideSingleLinePhpDocData(): Iterator
new PhpDocNode([
new PhpDocTagNode(
'@foo',
- new GenericTagValueNode('lorem ipsum')
+ new GenericTagValueNode('lorem ipsum'),
),
]),
];
@@ -2535,7 +2896,11 @@ public function provideSingleLinePhpDocData(): Iterator
new PhpDocNode([
new PhpDocTagNode(
'@foo',
- new GenericTagValueNode('lorem @bar ipsum')
+ new GenericTagValueNode('lorem'),
+ ),
+ new PhpDocTagNode(
+ '@bar',
+ new GenericTagValueNode('ipsum'),
),
]),
];
@@ -2547,8 +2912,8 @@ public function provideSingleLinePhpDocData(): Iterator
new PhpDocTagNode(
'@varFoo',
new GenericTagValueNode(
- '$foo'
- )
+ '$foo',
+ ),
),
]),
];
@@ -2563,11 +2928,9 @@ public function provideSingleLinePhpDocData(): Iterator
new PhpDocNode([
new PhpDocTagNode(
'@example',
- new GenericTagValueNode('')
- ),
- new PhpDocTextNode(
- 'entity_managers:' . PHP_EOL .
- ' default:'
+ new GenericTagValueNode(PHP_EOL .
+ ' entity_managers:' . PHP_EOL .
+ ' default:'),
),
]),
];
@@ -2584,11 +2947,12 @@ public function provideSingleLinePhpDocData(): Iterator
[
new CallableTypeParameterNode(new IdentifierTypeNode('int'), false, false, '', false),
],
- new IdentifierTypeNode('void')
+ new IdentifierTypeNode('void'),
+ [],
),
'',
- ''
- )
+ '',
+ ),
),
]),
];
@@ -2602,8 +2966,8 @@ public function provideSingleLinePhpDocData(): Iterator
new VarTagValueNode(
new IdentifierTypeNode('callable'),
'',
- '(int)'
- )
+ '(int)',
+ ),
),
]),
];
@@ -2611,16 +2975,6 @@ public function provideSingleLinePhpDocData(): Iterator
yield [
'callable with incomplete signature without return type',
'/** @var callable(int) */',
- new PhpDocNode([
- new PhpDocTagNode(
- '@var',
- new VarTagValueNode(
- new IdentifierTypeNode('callable'),
- '',
- '(int)'
- )
- ),
- ]),
new PhpDocNode([
new PhpDocTagNode(
'@var',
@@ -2632,20 +2986,20 @@ public function provideSingleLinePhpDocData(): Iterator
17,
Lexer::TOKEN_HORIZONTAL_WS,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
}
/**
- * @return array
+ * @return iterable>
*/
- public function provideMultiLinePhpDocData(): array
+ public function provideMultiLinePhpDocData(): iterable
{
- return [
+ yield from [
[
'multi-line with two tags',
'/**
@@ -2659,8 +3013,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('Foo'),
false,
'$foo',
- '1st multi world description'
- )
+ '1st multi world description',
+ false,
+ ),
),
new PhpDocTagNode(
'@param',
@@ -2668,8 +3023,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('Bar'),
false,
'$bar',
- '2nd multi world description'
- )
+ '2nd multi world description',
+ false,
+ ),
),
]),
],
@@ -2688,8 +3044,9 @@ public function provideMultiLinePhpDocData(): array
false,
'$foo',
'1st multi world description
-some text in the middle'
- )
+some text in the middle',
+ false,
+ ),
),
new PhpDocTagNode(
'@param',
@@ -2697,8 +3054,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('Bar'),
false,
'$bar',
- '2nd multi world description'
- )
+ '2nd multi world description',
+ false,
+ ),
),
]),
],
@@ -2727,26 +3085,29 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('Foo'),
false,
'$foo',
- '1st multi world description with empty lines'
- )
+ '1st multi world description with empty lines
+
+
+some text in the middle',
+ false,
+ ),
),
new PhpDocTextNode(''),
new PhpDocTextNode(''),
- new PhpDocTextNode('some text in the middle'),
- new PhpDocTextNode(''),
- new PhpDocTextNode(''),
new PhpDocTagNode(
'@param',
new ParamTagValueNode(
new IdentifierTypeNode('Bar'),
false,
'$bar',
- '2nd multi world description with empty lines'
- )
+ '2nd multi world description with empty lines
+
+
+test',
+ false,
+ ),
),
- new PhpDocTextNode(''),
- new PhpDocTextNode(''),
- new PhpDocTextNode('test'),
+
]),
],
[
@@ -2774,8 +3135,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('int'),
false,
'$foo',
- '@param string $bar'
- )
+ '@param string $bar',
+ false,
+ ),
),
]),
],
@@ -2833,18 +3195,19 @@ public function provideMultiLinePhpDocData(): array
false,
false,
'$a',
- null
+ null,
),
new MethodTagValueParameterNode(
new IdentifierTypeNode('int'),
false,
false,
'$b',
- null
+ null,
),
],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -2858,18 +3221,19 @@ public function provideMultiLinePhpDocData(): array
false,
false,
'$a',
- null
+ null,
),
new MethodTagValueParameterNode(
null,
false,
false,
'$b',
- null
+ null,
),
],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -2881,8 +3245,9 @@ public function provideMultiLinePhpDocData(): array
]),
'getFooOrBar',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -2891,8 +3256,9 @@ public function provideMultiLinePhpDocData(): array
null,
'methodWithNoReturnType',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -2906,18 +3272,19 @@ public function provideMultiLinePhpDocData(): array
false,
false,
'$a',
- null
+ null,
),
new MethodTagValueParameterNode(
new IdentifierTypeNode('int'),
false,
false,
'$b',
- null
+ null,
),
],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -2931,18 +3298,19 @@ public function provideMultiLinePhpDocData(): array
false,
false,
'$a',
- null
+ null,
),
new MethodTagValueParameterNode(
null,
false,
false,
'$b',
- null
+ null,
),
],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -2954,8 +3322,9 @@ public function provideMultiLinePhpDocData(): array
]),
'getFooOrBarStatically',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -2964,8 +3333,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('static'),
'methodWithNoReturnTypeStatically',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -2979,18 +3349,19 @@ public function provideMultiLinePhpDocData(): array
false,
false,
'$a',
- null
+ null,
),
new MethodTagValueParameterNode(
new IdentifierTypeNode('int'),
false,
false,
'$b',
- null
+ null,
),
],
- 'Get an integer with a description.'
- )
+ 'Get an integer with a description.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3004,18 +3375,19 @@ public function provideMultiLinePhpDocData(): array
false,
false,
'$a',
- null
+ null,
),
new MethodTagValueParameterNode(
null,
false,
false,
'$b',
- null
+ null,
),
],
- 'Do something with a description.'
- )
+ 'Do something with a description.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3027,8 +3399,9 @@ public function provideMultiLinePhpDocData(): array
]),
'getFooOrBarWithDescription',
[],
- 'Get a Foo or a Bar with a description.'
- )
+ 'Get a Foo or a Bar with a description.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3037,8 +3410,9 @@ public function provideMultiLinePhpDocData(): array
null,
'methodWithNoReturnTypeWithDescription',
[],
- 'Do something with a description but what, who knows!'
- )
+ 'Do something with a description but what, who knows!',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3052,18 +3426,19 @@ public function provideMultiLinePhpDocData(): array
false,
false,
'$a',
- null
+ null,
),
new MethodTagValueParameterNode(
new IdentifierTypeNode('int'),
false,
false,
'$b',
- null
+ null,
),
],
- 'Get an integer with a description statically.'
- )
+ 'Get an integer with a description statically.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3077,18 +3452,19 @@ public function provideMultiLinePhpDocData(): array
false,
false,
'$a',
- null
+ null,
),
new MethodTagValueParameterNode(
null,
false,
false,
'$b',
- null
+ null,
),
],
- 'Do something with a description statically.'
- )
+ 'Do something with a description statically.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3100,8 +3476,9 @@ public function provideMultiLinePhpDocData(): array
]),
'getFooOrBarStaticallyWithDescription',
[],
- 'Get a Foo or a Bar with a description statically.'
- )
+ 'Get a Foo or a Bar with a description statically.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3110,8 +3487,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('static'),
'methodWithNoReturnTypeStaticallyWithDescription',
[],
- 'Do something with a description statically, but what, who knows!'
- )
+ 'Do something with a description statically, but what, who knows!',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3120,8 +3498,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('bool'),
'aStaticMethodThatHasAUniqueReturnTypeInThisClass',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3130,8 +3509,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('string'),
'aStaticMethodThatHasAUniqueReturnTypeInThisClassWithDescription',
[],
- 'A Description.'
- )
+ 'A Description.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3140,8 +3520,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('int'),
'getIntegerNoParams',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3150,8 +3531,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('void'),
'doSomethingNoParams',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3163,8 +3545,9 @@ public function provideMultiLinePhpDocData(): array
]),
'getFooOrBarNoParams',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3173,8 +3556,9 @@ public function provideMultiLinePhpDocData(): array
null,
'methodWithNoReturnTypeNoParams',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3183,8 +3567,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('int'),
'getIntegerStaticallyNoParams',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3193,8 +3578,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('void'),
'doSomethingStaticallyNoParams',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3206,8 +3592,9 @@ public function provideMultiLinePhpDocData(): array
]),
'getFooOrBarStaticallyNoParams',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3216,8 +3603,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('static'),
'methodWithNoReturnTypeStaticallyNoParams',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3226,8 +3614,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('int'),
'getIntegerWithDescriptionNoParams',
[],
- 'Get an integer with a description.'
- )
+ 'Get an integer with a description.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3236,8 +3625,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('void'),
'doSomethingWithDescriptionNoParams',
[],
- 'Do something with a description.'
- )
+ 'Do something with a description.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3249,8 +3639,9 @@ public function provideMultiLinePhpDocData(): array
]),
'getFooOrBarWithDescriptionNoParams',
[],
- 'Get a Foo or a Bar with a description.'
- )
+ 'Get a Foo or a Bar with a description.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3259,8 +3650,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('int'),
'getIntegerStaticallyWithDescriptionNoParams',
[],
- 'Get an integer with a description statically.'
- )
+ 'Get an integer with a description statically.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3269,8 +3661,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('void'),
'doSomethingStaticallyWithDescriptionNoParams',
[],
- 'Do something with a description statically.'
- )
+ 'Do something with a description statically.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3282,8 +3675,9 @@ public function provideMultiLinePhpDocData(): array
]),
'getFooOrBarStaticallyWithDescriptionNoParams',
[],
- 'Get a Foo or a Bar with a description statically.'
- )
+ 'Get a Foo or a Bar with a description statically.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3295,8 +3689,9 @@ public function provideMultiLinePhpDocData(): array
]),
'aStaticMethodThatHasAUniqueReturnTypeInThisClassNoParams',
[],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3308,8 +3703,9 @@ public function provideMultiLinePhpDocData(): array
]),
'aStaticMethodThatHasAUniqueReturnTypeInThisClassWithDescriptionNoParams',
[],
- 'A Description.'
- )
+ 'A Description.',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3323,11 +3719,12 @@ public function provideMultiLinePhpDocData(): array
false,
false,
'$args',
- null
+ null,
),
],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3341,18 +3738,19 @@ public function provideMultiLinePhpDocData(): array
true,
true,
'$angle',
- new ConstExprArrayNode([])
+ new ConstExprArrayNode([]),
),
new MethodTagValueParameterNode(
null,
false,
false,
'$backgroundColor',
- null
+ null,
),
],
- ''
- )
+ '',
+ [],
+ ),
),
new PhpDocTagNode(
'@method',
@@ -3361,8 +3759,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('Foo'),
'overridenMethod',
[],
- ''
- )
+ '',
+ [],
+ ),
),
]),
],
@@ -3376,11 +3775,11 @@ public function provideMultiLinePhpDocData(): array
new PhpDocNode([
new PhpDocTagNode(
'@template',
- new TemplateTagValueNode('TKey', new IdentifierTypeNode('array-key'), '')
+ new TemplateTagValueNode('TKey', new IdentifierTypeNode('array-key'), ''),
),
new PhpDocTagNode(
'@template',
- new TemplateTagValueNode('TValue', null, '')
+ new TemplateTagValueNode('TValue', null, ''),
),
new PhpDocTagNode(
'@method',
@@ -3397,11 +3796,12 @@ public function provideMultiLinePhpDocData(): array
false,
false,
'$v',
- null
+ null,
),
],
- 'find index of $v'
- )
+ 'find index of $v',
+ [],
+ ),
),
]),
],
@@ -3423,11 +3823,11 @@ public function provideMultiLinePhpDocData(): array
new PhpDocNode([
new PhpDocTagNode(
'@template',
- new TemplateTagValueNode('TRandKey', new IdentifierTypeNode('array-key'), '')
+ new TemplateTagValueNode('TRandKey', new IdentifierTypeNode('array-key'), ''),
),
new PhpDocTagNode(
'@template',
- new TemplateTagValueNode('TRandVal', null, '')
+ new TemplateTagValueNode('TRandVal', null, ''),
),
new PhpDocTagNode(
'@template',
@@ -3443,7 +3843,7 @@ public function provideMultiLinePhpDocData(): array
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
new GenericTypeNode(
new IdentifierTypeNode('XIterator'),
@@ -3454,7 +3854,7 @@ public function provideMultiLinePhpDocData(): array
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
new GenericTypeNode(
new IdentifierTypeNode('Traversable'),
@@ -3465,11 +3865,11 @@ public function provideMultiLinePhpDocData(): array
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
]),
- ''
- )
+ '',
+ ),
),
new PhpDocTextNode(''),
new PhpDocTagNode(
@@ -3478,8 +3878,9 @@ public function provideMultiLinePhpDocData(): array
new IdentifierTypeNode('TRandList'),
false,
'$list',
- ''
- )
+ '',
+ false,
+ ),
),
new PhpDocTextNode(''),
new PhpDocTagNode(
@@ -3497,7 +3898,7 @@ public function provideMultiLinePhpDocData(): array
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
new ConditionalTypeNode(
new IdentifierTypeNode('TRandList'),
@@ -3511,7 +3912,7 @@ public function provideMultiLinePhpDocData(): array
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
new UnionTypeNode([
new GenericTypeNode(
@@ -3523,7 +3924,7 @@ public function provideMultiLinePhpDocData(): array
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
new GenericTypeNode(
new IdentifierTypeNode('LimitIterator'),
@@ -3534,229 +3935,723 @@ public function provideMultiLinePhpDocData(): array
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
]),
- false
+ false,
),
- false
+ false,
),
- ''
- )
+ '',
+ ),
),
]),
],
];
- }
- public function provideTemplateTagsData(): Iterator
- {
yield [
- 'OK without bound and description',
- '/** @template T */',
+ 'Empty lines before end',
+ '/**' . PHP_EOL .
+ ' * Real description' . PHP_EOL .
+ ' * @param int $a' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' */',
new PhpDocNode([
- new PhpDocTagNode(
- '@template',
- new TemplateTagValueNode(
- 'T',
- null,
- ''
- )
- ),
+ new PhpDocTextNode('Real description'),
+ new PhpDocTagNode('@param', new ParamTagValueNode(new IdentifierTypeNode('int'), false, '$a', '', false)),
+ new PhpDocTextNode(''),
+ new PhpDocTextNode(''),
]),
];
yield [
- 'OK without bound',
- '/** @template T the value type*/',
+ 'Empty lines before end 2',
+ '/**' . PHP_EOL .
+ ' * Real description' . PHP_EOL .
+ ' * @param int $a' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' * test' . PHP_EOL .
+ ' */',
new PhpDocNode([
+ new PhpDocTextNode('Real description'),
new PhpDocTagNode(
- '@template',
- new TemplateTagValueNode(
- 'T',
- null,
- 'the value type'
- )
+ '@param',
+ new ParamTagValueNode(
+ new IdentifierTypeNode('int'),
+ false,
+ '$a',
+ PHP_EOL
+ . PHP_EOL
+ . PHP_EOL
+ . 'test',
+ false,
+ ),
),
]),
];
yield [
- 'OK without description',
- '/** @template T of DateTime */',
+ 'Real-world test case multiline PHPDoc',
+ '/**' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' * MultiLine' . PHP_EOL .
+ ' * description' . PHP_EOL .
+ ' * @param bool $a' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' * @return void' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' * @throws \Exception' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' */',
new PhpDocNode([
- new PhpDocTagNode(
- '@template',
- new TemplateTagValueNode(
- 'T',
- new IdentifierTypeNode('DateTime'),
- ''
- )
+ new PhpDocTextNode(
+ PHP_EOL .
+ 'MultiLine' . PHP_EOL .
+ 'description',
),
+ new PhpDocTagNode('@param', new ParamTagValueNode(
+ new IdentifierTypeNode('bool'),
+ false,
+ '$a',
+ '',
+ false,
+ )),
+ new PhpDocTextNode(''),
+ new PhpDocTagNode('@return', new ReturnTagValueNode(
+ new IdentifierTypeNode('void'),
+ '',
+ )),
+ new PhpDocTextNode(''),
+ new PhpDocTagNode('@throws', new ThrowsTagValueNode(
+ new IdentifierTypeNode('\Exception'),
+ '',
+ )),
+ new PhpDocTextNode(''),
]),
];
yield [
- 'OK without description',
- '/** @template T as DateTime */',
+ 'Multiline PHPDoc with new line across generic type declaration',
+ '/**' . PHP_EOL .
+ ' * @param array,' . PHP_EOL .
+ ' * }> $a' . PHP_EOL .
+ ' */',
new PhpDocNode([
- new PhpDocTagNode(
- '@template',
- new TemplateTagValueNode(
- 'T',
- new IdentifierTypeNode('DateTime'),
- ''
- )
- ),
+ new PhpDocTagNode('@param', new ParamTagValueNode(
+ new GenericTypeNode(
+ new IdentifierTypeNode('array'),
+ [
+ new IdentifierTypeNode('string'),
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar'), true, new GenericTypeNode(
+ new IdentifierTypeNode('array'),
+ [
+ new IdentifierTypeNode('string'),
+ new UnionTypeNode([
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo1'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar1'), true, new IdentifierTypeNode('true')),
+ ]),
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo1'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo2'), false, new IdentifierTypeNode('true')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar1'), true, new IdentifierTypeNode('true')),
+ ]),
+ ]),
+ ],
+ [
+ GenericTypeNode::VARIANCE_INVARIANT,
+ GenericTypeNode::VARIANCE_INVARIANT,
+ ],
+ )),
+ ]),
+ ],
+ [
+ GenericTypeNode::VARIANCE_INVARIANT,
+ GenericTypeNode::VARIANCE_INVARIANT,
+ ],
+ ),
+ false,
+ '$a',
+ '',
+ false,
+ )),
]),
];
yield [
- 'OK with bound and description',
- '/** @template T of DateTime the value type */',
+ 'Multiline PHPDoc with new line within type declaration',
+ '/**' . PHP_EOL .
+ ' * @param array,' . PHP_EOL .
+ ' * }> $a' . PHP_EOL .
+ ' */',
new PhpDocNode([
- new PhpDocTagNode(
- '@template',
- new TemplateTagValueNode(
- 'T',
- new IdentifierTypeNode('DateTime'),
- 'the value type'
- )
- ),
+ new PhpDocTagNode('@param', new ParamTagValueNode(
+ new GenericTypeNode(
+ new IdentifierTypeNode('array'),
+ [
+ new IdentifierTypeNode('string'),
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar'), true, new GenericTypeNode(
+ new IdentifierTypeNode('array'),
+ [
+ new IdentifierTypeNode('string'),
+ new UnionTypeNode([
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo1'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar1'), true, new IdentifierTypeNode('true')),
+ ]),
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo1'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo2'), false, new IdentifierTypeNode('true')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar1'), true, new IdentifierTypeNode('true')),
+ ]),
+ ]),
+ ],
+ [
+ GenericTypeNode::VARIANCE_INVARIANT,
+ GenericTypeNode::VARIANCE_INVARIANT,
+ ],
+ )),
+ ]),
+ ],
+ [
+ GenericTypeNode::VARIANCE_INVARIANT,
+ GenericTypeNode::VARIANCE_INVARIANT,
+ ],
+ ),
+ false,
+ '$a',
+ '',
+ false,
+ )),
]),
];
yield [
- 'OK with bound and description',
- '/** @template T as DateTime the value type */',
+ 'Multiline PHPDoc with new line within type declaration including usage of braces',
+ '/**' . PHP_EOL .
+ ' * @phpstan-type FactoriesConfigurationType = array<' . PHP_EOL .
+ ' * string,' . PHP_EOL .
+ ' * (class-string|Factory\FactoryInterface)' . PHP_EOL .
+ ' * |callable(ContainerInterface,?string,array|null):object' . PHP_EOL .
+ ' * >' . PHP_EOL .
+ ' */',
new PhpDocNode([
- new PhpDocTagNode(
- '@template',
- new TemplateTagValueNode(
- 'T',
- new IdentifierTypeNode('DateTime'),
- 'the value type'
- )
- ),
+ new PhpDocTagNode('@phpstan-type', new TypeAliasTagValueNode(
+ 'FactoriesConfigurationType',
+ new GenericTypeNode(
+ new IdentifierTypeNode('array'),
+ [
+ new IdentifierTypeNode('string'),
+ new UnionTypeNode([
+ new UnionTypeNode([
+ new GenericTypeNode(
+ new IdentifierTypeNode('class-string'),
+ [new IdentifierTypeNode('Factory\\FactoryInterface')],
+ [GenericTypeNode::VARIANCE_INVARIANT],
+ ),
+ new IdentifierTypeNode('Factory\\FactoryInterface'),
+ ]),
+ new CallableTypeNode(
+ new IdentifierTypeNode('callable'),
+ [
+ new CallableTypeParameterNode(new IdentifierTypeNode('ContainerInterface'), false, false, '', false),
+ new CallableTypeParameterNode(
+ new NullableTypeNode(
+ new IdentifierTypeNode('string'),
+ ),
+ false,
+ false,
+ '',
+ false,
+ ),
+ new CallableTypeParameterNode(
+ new UnionTypeNode([
+ new GenericTypeNode(
+ new IdentifierTypeNode('array'),
+ [new IdentifierTypeNode('mixed')],
+ [GenericTypeNode::VARIANCE_INVARIANT],
+ ),
+ new IdentifierTypeNode('null'),
+ ]),
+ false,
+ false,
+ '',
+ false,
+ ),
+ ],
+ new IdentifierTypeNode('object'),
+ [],
+ ),
+ ]),
+ ],
+ [
+ GenericTypeNode::VARIANCE_INVARIANT,
+ GenericTypeNode::VARIANCE_INVARIANT,
+ ],
+ ),
+ )),
]),
];
yield [
- 'invalid without bound and description',
- '/** @template */',
+ 'Multiline PHPDoc with multiple new line within union type declaration',
+ '/**' . PHP_EOL .
+ ' * @param array,' . PHP_EOL .
+ ' * }> $a' . PHP_EOL .
+ ' */',
new PhpDocNode([
- new PhpDocTagNode(
- '@template',
- new InvalidTagValueNode(
- '',
- new ParserException(
- '*/',
- Lexer::TOKEN_CLOSE_PHPDOC,
- 14,
- Lexer::TOKEN_IDENTIFIER,
- null,
- 1
- )
- )
- ),
+ new PhpDocTagNode('@param', new ParamTagValueNode(
+ new GenericTypeNode(
+ new IdentifierTypeNode('array'),
+ [
+ new IdentifierTypeNode('string'),
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar'), true, new GenericTypeNode(
+ new IdentifierTypeNode('array'),
+ [
+ new IdentifierTypeNode('string'),
+ new UnionTypeNode([
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo1'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar1'), true, new IdentifierTypeNode('true')),
+ ]),
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo1'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo2'), false, new IdentifierTypeNode('true')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar1'), true, new IdentifierTypeNode('true')),
+ ]),
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo2'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo3'), false, new IdentifierTypeNode('bool')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar2'), true, new IdentifierTypeNode('true')),
+ ]),
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo1'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo3'), false, new IdentifierTypeNode('true')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar3'), true, new IdentifierTypeNode('false')),
+ ]),
+ ]),
+ ],
+ [
+ GenericTypeNode::VARIANCE_INVARIANT,
+ GenericTypeNode::VARIANCE_INVARIANT,
+ ],
+ )),
+ ]),
+ ],
+ [
+ GenericTypeNode::VARIANCE_INVARIANT,
+ GenericTypeNode::VARIANCE_INVARIANT,
+ ],
+ ),
+ false,
+ '$a',
+ '',
+ false,
+ )),
]),
];
yield [
- 'invalid without bound and with description',
- '/** @template #desc */',
+ 'Multiline PHPDoc with multiple new line within intersection type declaration',
+ '/**' . PHP_EOL .
+ ' * @param array,' . PHP_EOL .
+ ' * }> $a' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode('@param', new ParamTagValueNode(
+ new GenericTypeNode(
+ new IdentifierTypeNode('array'),
+ [
+ new IdentifierTypeNode('string'),
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar'), true, new GenericTypeNode(
+ new IdentifierTypeNode('array'),
+ [
+ new IdentifierTypeNode('string'),
+ new IntersectionTypeNode([
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo1'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar1'), true, new IdentifierTypeNode('true')),
+ ]),
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo1'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo2'), false, new IdentifierTypeNode('true')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar1'), true, new IdentifierTypeNode('true')),
+ ]),
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo2'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo3'), false, new IdentifierTypeNode('bool')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar2'), true, new IdentifierTypeNode('true')),
+ ]),
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo1'), false, new IdentifierTypeNode('int')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('foo3'), false, new IdentifierTypeNode('true')),
+ new ArrayShapeItemNode(new IdentifierTypeNode('bar3'), true, new IdentifierTypeNode('false')),
+ ]),
+ ]),
+ ],
+ [
+ GenericTypeNode::VARIANCE_INVARIANT,
+ GenericTypeNode::VARIANCE_INVARIANT,
+ ],
+ )),
+ ]),
+ ],
+ [
+ GenericTypeNode::VARIANCE_INVARIANT,
+ GenericTypeNode::VARIANCE_INVARIANT,
+ ],
+ ),
+ false,
+ '$a',
+ '',
+ false,
+ )),
+ ]),
+ ];
+
+ yield [
+ 'Multiline PHPDoc with multiple new line being invalid due to union and intersection type declaration',
+ '/**' . PHP_EOL .
+ ' * @param array,' . PHP_EOL .
+ ' * }> $a' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode('@param', new InvalidTagValueNode(
+ 'array,' . PHP_EOL .
+ '}> $a',
+ new ParserException(
+ '?',
+ Lexer::TOKEN_NULLABLE,
+ DIRECTORY_SEPARATOR === '\\' ? 65 : 62,
+ Lexer::TOKEN_CLOSE_CURLY_BRACKET,
+ null,
+ 4,
+ ),
+ )),
+ ]),
+ ];
+
+ /**
+ * @return object{
+ * a: int,
+ *
+ * b: int,
+ * }
+ */
+
+ yield [
+ 'Multiline PHPDoc with new line within object type declaration',
+ '/**' . PHP_EOL .
+ ' * @return object{' . PHP_EOL .
+ ' * a: int,' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' * b: int,' . PHP_EOL .
+ ' * }' . PHP_EOL .
+ ' */',
new PhpDocNode([
new PhpDocTagNode(
- '@template',
- new InvalidTagValueNode(
- '#desc',
- new ParserException(
- '#desc',
- Lexer::TOKEN_OTHER,
- 14,
- Lexer::TOKEN_IDENTIFIER,
- null,
- 1
- )
- )
+ '@return',
+ new ReturnTagValueNode(
+ new ObjectShapeNode(
+ [
+ new ObjectShapeItemNode(
+ new IdentifierTypeNode('a'),
+ false,
+ new IdentifierTypeNode('int'),
+ ),
+ new ObjectShapeItemNode(
+ new IdentifierTypeNode('b'),
+ false,
+ new IdentifierTypeNode('int'),
+ ),
+ ],
+ ),
+ '',
+ ),
),
]),
];
+ }
+ public function provideTemplateTagsData(): Iterator
+ {
yield [
- 'OK with covariance',
- '/** @template-covariant T */',
+ 'OK without bound and description',
+ '/** @template T */',
new PhpDocNode([
new PhpDocTagNode(
- '@template-covariant',
+ '@template',
new TemplateTagValueNode(
'T',
null,
- ''
- )
+ '',
+ ),
),
]),
];
yield [
- 'OK with contravariance',
- '/** @template-contravariant T */',
+ 'OK without bound',
+ '/** @template T the value type*/',
new PhpDocNode([
new PhpDocTagNode(
- '@template-contravariant',
+ '@template',
new TemplateTagValueNode(
'T',
null,
- ''
- )
+ 'the value type',
+ ),
),
]),
];
yield [
- 'OK with default',
- '/** @template T = string */',
+ 'OK without description',
+ '/** @template T of DateTime */',
new PhpDocNode([
new PhpDocTagNode(
'@template',
new TemplateTagValueNode(
'T',
- null,
+ new IdentifierTypeNode('DateTime'),
'',
- new IdentifierTypeNode('string')
- )
+ ),
),
]),
];
yield [
- 'OK with default and description',
- '/** @template T = string the value type */',
+ 'OK without description',
+ '/** @template T as DateTime */',
new PhpDocNode([
new PhpDocTagNode(
'@template',
new TemplateTagValueNode(
'T',
- null,
- 'the value type',
- new IdentifierTypeNode('string')
- )
+ new IdentifierTypeNode('DateTime'),
+ '',
+ ),
),
]),
];
yield [
- 'OK with bound and default and description',
- '/** @template T of string = \'\' the value type */',
+ 'OK with upper bound and description',
+ '/** @template T of DateTime the value type */',
new PhpDocNode([
new PhpDocTagNode(
'@template',
new TemplateTagValueNode(
'T',
- new IdentifierTypeNode('string'),
+ new IdentifierTypeNode('DateTime'),
'the value type',
- new ConstTypeNode(new ConstExprStringNode(''))
- )
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with lower bound and description',
+ '/** @template T super DateTimeImmutable the value type */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@template',
+ new TemplateTagValueNode(
+ 'T',
+ null,
+ 'the value type',
+ null,
+ new IdentifierTypeNode('DateTimeImmutable'),
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with both bounds and description',
+ '/** @template T of DateTimeInterface super DateTimeImmutable the value type */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@template',
+ new TemplateTagValueNode(
+ 'T',
+ new IdentifierTypeNode('DateTimeInterface'),
+ 'the value type',
+ null,
+ new IdentifierTypeNode('DateTimeImmutable'),
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'invalid without bounds and description',
+ '/** @template */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@template',
+ new InvalidTagValueNode(
+ '',
+ new ParserException(
+ '*/',
+ Lexer::TOKEN_CLOSE_PHPDOC,
+ 14,
+ Lexer::TOKEN_IDENTIFIER,
+ null,
+ 1,
+ ),
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'invalid without bound and with description',
+ '/** @template #desc */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@template',
+ new InvalidTagValueNode(
+ '#desc',
+ new ParserException(
+ '#desc',
+ Lexer::TOKEN_OTHER,
+ 14,
+ Lexer::TOKEN_IDENTIFIER,
+ null,
+ 1,
+ ),
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with covariance',
+ '/** @template-covariant T */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@template-covariant',
+ new TemplateTagValueNode(
+ 'T',
+ null,
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with contravariance',
+ '/** @template-contravariant T */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@template-contravariant',
+ new TemplateTagValueNode(
+ 'T',
+ null,
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with default',
+ '/** @template T = string */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@template',
+ new TemplateTagValueNode(
+ 'T',
+ null,
+ '',
+ new IdentifierTypeNode('string'),
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with default and description',
+ '/** @template T = string the value type */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@template',
+ new TemplateTagValueNode(
+ 'T',
+ null,
+ 'the value type',
+ new IdentifierTypeNode('string'),
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with bound and default and description',
+ '/** @template T of string = \'\' the value type */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@template',
+ new TemplateTagValueNode(
+ 'T',
+ new IdentifierTypeNode('string'),
+ 'the value type',
+ new ConstTypeNode(new ConstExprStringNode('', ConstExprStringNode::SINGLE_QUOTED)),
+ ),
),
]),
];
@@ -3778,10 +4673,10 @@ public function provideExtendsTagsData(): Iterator
],
[
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -3802,10 +4697,10 @@ public function provideExtendsTagsData(): Iterator
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -3826,10 +4721,10 @@ public function provideExtendsTagsData(): Iterator
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -3850,10 +4745,10 @@ public function provideExtendsTagsData(): Iterator
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -3868,10 +4763,10 @@ public function provideExtendsTagsData(): Iterator
new GenericTypeNode(
new IdentifierTypeNode('Foo'),
[new IdentifierTypeNode('A')],
- [GenericTypeNode::VARIANCE_INVARIANT]
+ [GenericTypeNode::VARIANCE_INVARIANT],
),
- 'extends foo'
- )
+ 'extends foo',
+ ),
),
]),
];
@@ -3890,9 +4785,9 @@ public function provideExtendsTagsData(): Iterator
13,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -3911,9 +4806,9 @@ public function provideExtendsTagsData(): Iterator
17,
Lexer::TOKEN_OPEN_ANGLE_BRACKET,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -3926,8 +4821,8 @@ public function provideExtendsTagsData(): Iterator
'@return',
new ReturnTagValueNode(
new IdentifierTypeNode('class-string'),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -3940,8 +4835,8 @@ public function provideExtendsTagsData(): Iterator
'@return',
new ReturnTagValueNode(
new IdentifierTypeNode('class-string'),
- 'some description'
- )
+ 'some description',
+ ),
),
]),
];
@@ -3956,8 +4851,9 @@ public function provideExtendsTagsData(): Iterator
new IdentifierTypeNode('class-string'),
false,
'$test',
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -3972,8 +4868,9 @@ public function provideExtendsTagsData(): Iterator
new IdentifierTypeNode('class-string'),
false,
'$test',
- 'some description'
- )
+ 'some description',
+ false,
+ ),
),
]),
];
@@ -3992,8 +4889,8 @@ public function provideTypeAliasTagsData(): Iterator
new UnionTypeNode([
new IdentifierTypeNode('string'),
new IdentifierTypeNode('int'),
- ])
- )
+ ]),
+ ),
),
]),
];
@@ -4009,8 +4906,8 @@ public function provideTypeAliasTagsData(): Iterator
new UnionTypeNode([
new IdentifierTypeNode('string'),
new IdentifierTypeNode('int'),
- ])
- )
+ ]),
+ ),
),
]),
];
@@ -4018,23 +4915,6 @@ public function provideTypeAliasTagsData(): Iterator
yield [
'invalid without type',
'/** @phpstan-type TypeAlias */',
- new PhpDocNode([
- new PhpDocTagNode(
- '@phpstan-type',
- new InvalidTagValueNode(
- 'TypeAlias',
- new ParserException(
- '*/',
- Lexer::TOKEN_CLOSE_PHPDOC,
- 28,
- Lexer::TOKEN_IDENTIFIER,
- null,
- 1
- )
- )
- ),
- ]),
- null,
new PhpDocNode([
new PhpDocTagNode(
'@phpstan-type',
@@ -4046,9 +4926,9 @@ public function provideTypeAliasTagsData(): Iterator
28,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- ))
- )
+ 1,
+ )),
+ ),
),
]),
];
@@ -4058,23 +4938,6 @@ public function provideTypeAliasTagsData(): Iterator
'/**
* @phpstan-type TypeAlias
*/',
- new PhpDocNode([
- new PhpDocTagNode(
- '@phpstan-type',
- new InvalidTagValueNode(
- 'TypeAlias',
- new ParserException(
- "\n\t\t\t ",
- Lexer::TOKEN_PHPDOC_EOL,
- 34,
- Lexer::TOKEN_IDENTIFIER,
- null,
- 2
- )
- )
- ),
- ]),
- null,
new PhpDocNode([
new PhpDocTagNode(
'@phpstan-type',
@@ -4086,9 +4949,9 @@ public function provideTypeAliasTagsData(): Iterator
34,
Lexer::TOKEN_IDENTIFIER,
null,
- 2
- ))
- )
+ 2,
+ )),
+ ),
),
]),
];
@@ -4099,30 +4962,6 @@ public function provideTypeAliasTagsData(): Iterator
* @phpstan-type TypeAlias
* @mixin T
*/',
- new PhpDocNode([
- new PhpDocTagNode(
- '@phpstan-type',
- new InvalidTagValueNode(
- 'TypeAlias',
- new ParserException(
- "\n\t\t\t * ",
- Lexer::TOKEN_PHPDOC_EOL,
- 34,
- Lexer::TOKEN_IDENTIFIER,
- null,
- 2
- )
- )
- ),
- new PhpDocTagNode(
- '@mixin',
- new MixinTagValueNode(
- new IdentifierTypeNode('T'),
- ''
- )
- ),
- ]),
- null,
new PhpDocNode([
new PhpDocTagNode(
'@phpstan-type',
@@ -4134,16 +4973,16 @@ public function provideTypeAliasTagsData(): Iterator
34,
Lexer::TOKEN_IDENTIFIER,
null,
- 2
- ))
- )
+ 2,
+ )),
+ ),
),
new PhpDocTagNode(
'@mixin',
new MixinTagValueNode(
new IdentifierTypeNode('T'),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -4154,30 +4993,13 @@ public function provideTypeAliasTagsData(): Iterator
* @phpstan-type Foo array{}
* @phpstan-type InvalidFoo what{}
*/',
- new PhpDocNode([
- new PhpDocTagNode(
- '@phpstan-type',
- new InvalidTagValueNode(
- "Unexpected token \"{\", expected '*/' at offset 65 on line 3",
- new ParserException(
- '{',
- Lexer::TOKEN_OPEN_CURLY_BRACKET,
- 65,
- Lexer::TOKEN_CLOSE_PHPDOC,
- null,
- 3
- )
- )
- ),
- ]),
- null,
new PhpDocNode([
new PhpDocTagNode(
'@phpstan-type',
new TypeAliasTagValueNode(
'Foo',
- new ArrayShapeNode([])
- )
+ ArrayShapeNode::createSealed([]),
+ ),
),
new PhpDocTagNode(
'@phpstan-type',
@@ -4189,9 +5011,9 @@ public function provideTypeAliasTagsData(): Iterator
65,
Lexer::TOKEN_PHPDOC_EOL,
null,
- 3
- ))
- )
+ 3,
+ )),
+ ),
),
]),
];
@@ -4203,30 +5025,13 @@ public function provideTypeAliasTagsData(): Iterator
* @phpstan-type InvalidFoo what{}
* @phpstan-type Bar array{}
*/',
- new PhpDocNode([
- new PhpDocTagNode(
- '@phpstan-type',
- new InvalidTagValueNode(
- "Unexpected token \"{\", expected '*/' at offset 65 on line 3",
- new ParserException(
- '{',
- Lexer::TOKEN_OPEN_CURLY_BRACKET,
- 65,
- Lexer::TOKEN_CLOSE_PHPDOC,
- null,
- 3
- )
- )
- ),
- ]),
- null,
new PhpDocNode([
new PhpDocTagNode(
'@phpstan-type',
new TypeAliasTagValueNode(
'Foo',
- new ArrayShapeNode([])
- )
+ ArrayShapeNode::createSealed([]),
+ ),
),
new PhpDocTagNode(
'@phpstan-type',
@@ -4238,16 +5043,16 @@ public function provideTypeAliasTagsData(): Iterator
65,
Lexer::TOKEN_PHPDOC_EOL,
null,
- 3
- ))
- )
+ 3,
+ )),
+ ),
),
new PhpDocTagNode(
'@phpstan-type',
new TypeAliasTagValueNode(
'Bar',
- new ArrayShapeNode([])
- )
+ ArrayShapeNode::createSealed([]),
+ ),
),
]),
];
@@ -4266,9 +5071,9 @@ public function provideTypeAliasTagsData(): Iterator
18,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -4285,8 +5090,8 @@ public function provideTypeAliasImportTagsData(): Iterator
new TypeAliasImportTagValueNode(
'TypeAlias',
new IdentifierTypeNode('AnotherClass'),
- null
- )
+ null,
+ ),
),
]),
];
@@ -4300,8 +5105,8 @@ public function provideTypeAliasImportTagsData(): Iterator
new TypeAliasImportTagValueNode(
'TypeAlias',
new IdentifierTypeNode('AnotherClass'),
- 'DifferentAlias'
- )
+ 'DifferentAlias',
+ ),
),
]),
];
@@ -4320,10 +5125,10 @@ public function provideTypeAliasImportTagsData(): Iterator
40,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
- ),
+ 1,
+ ),
+ ),
+ ),
]),
];
@@ -4341,9 +5146,9 @@ public function provideTypeAliasImportTagsData(): Iterator
52,
Lexer::TOKEN_CLOSE_PHPDOC,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -4362,9 +5167,9 @@ public function provideTypeAliasImportTagsData(): Iterator
35,
Lexer::TOKEN_IDENTIFIER,
'from',
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -4383,9 +5188,9 @@ public function provideTypeAliasImportTagsData(): Iterator
35,
Lexer::TOKEN_IDENTIFIER,
'from',
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -4404,9 +5209,9 @@ public function provideTypeAliasImportTagsData(): Iterator
25,
Lexer::TOKEN_IDENTIFIER,
null,
- 1
- )
- )
+ 1,
+ ),
+ ),
),
]),
];
@@ -4424,8 +5229,9 @@ public function provideAssertTagsData(): Iterator
new IdentifierTypeNode('Type'),
'$var',
false,
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -4440,8 +5246,9 @@ public function provideAssertTagsData(): Iterator
new IdentifierTypeNode('Type'),
'$var',
false,
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -4456,8 +5263,9 @@ public function provideAssertTagsData(): Iterator
new IdentifierTypeNode('Type'),
'$var',
false,
- 'assert Type to $var'
- )
+ 'assert Type to $var',
+ false,
+ ),
),
]),
];
@@ -4475,8 +5283,9 @@ public function provideAssertTagsData(): Iterator
]),
'$var',
false,
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -4492,8 +5301,9 @@ public function provideAssertTagsData(): Iterator
'$var',
'method',
false,
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -4509,29 +5319,68 @@ public function provideAssertTagsData(): Iterator
'$var',
'property',
false,
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
yield [
- 'invalid $this',
+ 'OK $this',
'/** @phpstan-assert Type $this */',
new PhpDocNode([
new PhpDocTagNode(
'@phpstan-assert',
- new InvalidTagValueNode(
- 'Type $this',
- new ParserException(
- '*/',
- Lexer::TOKEN_CLOSE_PHPDOC,
- 31,
- Lexer::TOKEN_ARROW,
- null,
- 1
- )
- )
+ new AssertTagValueNode(
+ new IdentifierTypeNode('Type'),
+ '$this',
+ false,
+ '',
+ false,
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK $this with description',
+ '/** @phpstan-assert Type $this assert Type to $this */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@phpstan-assert',
+ new AssertTagValueNode(
+ new IdentifierTypeNode('Type'),
+ '$this',
+ false,
+ 'assert Type to $this',
+ false,
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK $this with generic type',
+ '/** @phpstan-assert GenericType $this */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@phpstan-assert',
+ new AssertTagValueNode(
+ new GenericTypeNode(
+ new IdentifierTypeNode('GenericType'),
+ [
+ new IdentifierTypeNode('T'),
+ ],
+ [
+ GenericTypeNode::VARIANCE_INVARIANT,
+ ],
+ ),
+ '$this',
+ false,
+ '',
+ false,
+ ),
),
]),
];
@@ -4547,8 +5396,9 @@ public function provideAssertTagsData(): Iterator
'$this',
'method',
false,
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -4564,8 +5414,9 @@ public function provideAssertTagsData(): Iterator
'$this',
'property',
false,
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -4580,8 +5431,9 @@ public function provideAssertTagsData(): Iterator
new IdentifierTypeNode('Type'),
'$var',
false,
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -4596,8 +5448,9 @@ public function provideAssertTagsData(): Iterator
new IdentifierTypeNode('Type'),
'$var',
false,
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -4612,8 +5465,9 @@ public function provideAssertTagsData(): Iterator
new IdentifierTypeNode('Type'),
'$var',
true,
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -4629,8 +5483,8 @@ public function provideAssertTagsData(): Iterator
'$var',
false,
'',
- true
- )
+ true,
+ ),
),
]),
];
@@ -4646,8 +5500,8 @@ public function provideAssertTagsData(): Iterator
'$var',
true,
'',
- true
- )
+ true,
+ ),
),
]),
];
@@ -4668,13 +5522,13 @@ public function providerDebug(): Iterator
'OK class line',
$sample,
new PhpDocNode([
- new PhpDocTextNode('Returns the schema for the field.'),
- new PhpDocTextNode(''),
- new PhpDocTextNode('This method is static because the field schema information is needed on
+ new PhpDocTextNode('Returns the schema for the field.
+
+This method is static because the field schema information is needed on
creation of the field. FieldItemInterface objects instantiated at that
-time are not reliable as field settings might be missing.'),
- new PhpDocTextNode(''),
- new PhpDocTextNode('Computed fields having no schema should return an empty array.'),
+time are not reliable as field settings might be missing.
+
+Computed fields having no schema should return an empty array.'),
]),
];
}
@@ -4722,13 +5576,13 @@ public function provideRealWorldExampleData(): Iterator
'OK FieldItemInterface::schema',
$sample,
new PhpDocNode([
- new PhpDocTextNode('Returns the schema for the field.'),
- new PhpDocTextNode(''),
- new PhpDocTextNode('This method is static because the field schema information is needed on
+ new PhpDocTextNode('Returns the schema for the field.
+
+This method is static because the field schema information is needed on
creation of the field. FieldItemInterface objects instantiated at that
-time are not reliable as field settings might be missing.'),
- new PhpDocTextNode(''),
- new PhpDocTextNode('Computed fields having no schema should return an empty array.'),
+time are not reliable as field settings might be missing.
+
+Computed fields having no schema should return an empty array.'),
new PhpDocTextNode(''),
new PhpDocTagNode(
'@param',
@@ -4736,19 +5590,18 @@ public function provideRealWorldExampleData(): Iterator
new IdentifierTypeNode('\Drupal\Core\Field\FieldStorageDefinitionInterface'),
false,
'$field_definition',
- ''
- )
+ '
+ The field definition.',
+ false,
+ ),
),
- new PhpDocTextNode('The field definition.'),
new PhpDocTextNode(''),
new PhpDocTagNode(
'@return',
new ReturnTagValueNode(
new IdentifierTypeNode('array'),
- ''
- )
- ),
- new PhpDocTextNode("An empty array if there is no schema, or an associative array with the
+ "
+ An empty array if there is no schema, or an associative array with the
following key/value pairs:
- columns: An array of Schema API column specifications, keyed by column
name. The columns need to be a subset of the properties defined in
@@ -4770,7 +5623,9 @@ public function provideRealWorldExampleData(): Iterator
definitions. Note, however, that the field data is not necessarily
stored in SQL. Also, the possible usage is limited, as you cannot
specify another field as related, only existing SQL tables,
- such as {taxonomy_term_data}."),
+ such as {taxonomy_term_data}.",
+ ),
+ ),
]),
];
@@ -4795,9 +5650,9 @@ public function provideRealWorldExampleData(): Iterator
'OK AbstractChunkedController::parseChunkedRequest',
$sample,
new PhpDocNode([
- new PhpDocTextNode('Parses a chunked request and return relevant information.'),
- new PhpDocTextNode(''),
- new PhpDocTextNode('This function must return an array containing the following
+ new PhpDocTextNode('Parses a chunked request and return relevant information.
+
+ This function must return an array containing the following
keys and their corresponding values:
- last: Wheter this is the last chunk of the uploaded file
- uuid: A unique id which distinguishes two uploaded files
@@ -4813,16 +5668,17 @@ public function provideRealWorldExampleData(): Iterator
new IdentifierTypeNode('Request'),
false,
'$request',
- '- The request object'
- )
+ '- The request object',
+ false,
+ ),
),
new PhpDocTextNode(''),
new PhpDocTagNode(
'@return',
new ReturnTagValueNode(
new IdentifierTypeNode('array'),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -4840,9 +5696,9 @@ public function provideRealWorldExampleData(): Iterator
*
*/",
new PhpDocNode([
- new PhpDocTextNode('Finder allows searching through directory trees using iterator.'),
- new PhpDocTextNode(''),
- new PhpDocTextNode("
+ new PhpDocTextNode("Finder allows searching through directory trees using iterator.
+
+
Finder::findFiles('*.php')
->size('> 10kB')
->from('.')
@@ -4859,11 +5715,11 @@ public function provideRealWorldExampleData(): Iterator
'@return',
new ReturnTagValueNode(
new UnionTypeNode([
- new ConstTypeNode(new ConstExprStringNode('foo')),
- new ConstTypeNode(new ConstExprStringNode('bar')),
+ new ConstTypeNode(new ConstExprStringNode('foo', ConstExprStringNode::SINGLE_QUOTED)),
+ new ConstTypeNode(new ConstExprStringNode('bar', ConstExprStringNode::SINGLE_QUOTED)),
]),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -4896,10 +5752,10 @@ public function provideRealWorldExampleData(): Iterator
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -4925,10 +5781,10 @@ public function provideRealWorldExampleData(): Iterator
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -4954,10 +5810,10 @@ public function provideRealWorldExampleData(): Iterator
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
- ''
- )
+ '',
+ ),
),
]),
];
@@ -4979,12 +5835,14 @@ public function provideRealWorldExampleData(): Iterator
new CallableTypeParameterNode(new IdentifierTypeNode('A'), false, false, '', false),
new CallableTypeParameterNode(new IdentifierTypeNode('B'), false, false, '', false),
],
- new IdentifierTypeNode('void')
+ new IdentifierTypeNode('void'),
+ [],
),
false,
'$foo',
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -5007,12 +5865,14 @@ public function provideRealWorldExampleData(): Iterator
new CallableTypeParameterNode(new IdentifierTypeNode('A'), false, false, '', false),
new CallableTypeParameterNode(new IdentifierTypeNode('B'), false, false, '', false),
],
- new IdentifierTypeNode('void')
+ new IdentifierTypeNode('void'),
+ [],
),
false,
'$foo',
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -5035,12 +5895,14 @@ public function provideRealWorldExampleData(): Iterator
new CallableTypeParameterNode(new IdentifierTypeNode('A'), false, false, '', false),
new CallableTypeParameterNode(new IdentifierTypeNode('B'), false, false, '', false),
],
- new IdentifierTypeNode('void')
+ new IdentifierTypeNode('void'),
+ [],
),
false,
'$foo',
- ''
- )
+ '',
+ false,
+ ),
),
]),
];
@@ -5080,10 +5942,10 @@ public function provideRealWorldExampleData(): Iterator
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
- ''
- )
+ '',
+ ),
),
new PhpDocTextNode(''),
new PhpDocTagNode(
@@ -5092,8 +5954,9 @@ public function provideRealWorldExampleData(): Iterator
new IdentifierTypeNode('string'),
false,
'$pattern',
- ''
- )
+ '',
+ false,
+ ),
),
new PhpDocTagNode(
'@param',
@@ -5101,8 +5964,9 @@ public function provideRealWorldExampleData(): Iterator
new IdentifierTypeNode('string'),
false,
'$subject',
- ''
- )
+ '',
+ false,
+ ),
),
new PhpDocTagNode(
'@param',
@@ -5110,8 +5974,9 @@ public function provideRealWorldExampleData(): Iterator
new IdentifierTypeNode('mixed'),
false,
'$matches',
- ''
- )
+ '',
+ false,
+ ),
),
new PhpDocTagNode(
'@param',
@@ -5119,8 +5984,9 @@ public function provideRealWorldExampleData(): Iterator
new IdentifierTypeNode('TFlags'),
false,
'$flags',
- ''
- )
+ '',
+ false,
+ ),
),
new PhpDocTagNode(
'@param-out',
@@ -5133,7 +5999,7 @@ public function provideRealWorldExampleData(): Iterator
[
new IdentifierTypeNode('array-key'),
new UnionTypeNode([
- new ArrayShapeNode([
+ ArrayShapeNode::createSealed([
new ArrayShapeItemNode(null, false, new IdentifierTypeNode('string')),
new ArrayShapeItemNode(
null,
@@ -5141,11 +6007,11 @@ public function provideRealWorldExampleData(): Iterator
new UnionTypeNode([
new ConstTypeNode(new ConstExprIntegerNode('0')),
new IdentifierTypeNode('positive-int'),
- ])
+ ]),
),
]),
- new ArrayShapeNode([
- new ArrayShapeItemNode(null, false, new ConstTypeNode(new ConstExprStringNode(''))),
+ ArrayShapeNode::createSealed([
+ new ArrayShapeItemNode(null, false, new ConstTypeNode(new ConstExprStringNode('', ConstExprStringNode::SINGLE_QUOTED))),
new ArrayShapeItemNode(null, false, new ConstTypeNode(new ConstExprIntegerNode('-1'))),
]),
]),
@@ -5153,7 +6019,7 @@ public function provideRealWorldExampleData(): Iterator
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
new ConditionalTypeNode(
new IdentifierTypeNode('TFlags'),
@@ -5170,7 +6036,7 @@ public function provideRealWorldExampleData(): Iterator
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
new ConditionalTypeNode(
new IdentifierTypeNode('TFlags'),
@@ -5180,7 +6046,7 @@ public function provideRealWorldExampleData(): Iterator
[
new IdentifierTypeNode('array-key'),
new UnionTypeNode([
- new ArrayShapeNode([
+ ArrayShapeNode::createSealed([
new ArrayShapeItemNode(null, false, new IdentifierTypeNode('string')),
new ArrayShapeItemNode(
null,
@@ -5188,10 +6054,10 @@ public function provideRealWorldExampleData(): Iterator
new UnionTypeNode([
new ConstTypeNode(new ConstExprIntegerNode('0')),
new IdentifierTypeNode('positive-int'),
- ])
+ ]),
),
]),
- new ArrayShapeNode([
+ ArrayShapeNode::createSealed([
new ArrayShapeItemNode(null, false, new IdentifierTypeNode('null')),
new ArrayShapeItemNode(null, false, new ConstTypeNode(new ConstExprIntegerNode('-1'))),
]),
@@ -5200,7 +6066,7 @@ public function provideRealWorldExampleData(): Iterator
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
new GenericTypeNode(
new IdentifierTypeNode('array'),
@@ -5211,17 +6077,17 @@ public function provideRealWorldExampleData(): Iterator
[
GenericTypeNode::VARIANCE_INVARIANT,
GenericTypeNode::VARIANCE_INVARIANT,
- ]
+ ],
),
- false
+ false,
),
- false
+ false,
),
- false
+ false,
),
'$matches',
- ''
- )
+ '',
+ ),
),
new PhpDocTagNode(
'@return',
@@ -5231,280 +6097,1267 @@ public function provideRealWorldExampleData(): Iterator
new ConstTypeNode(new ConstExprIntegerNode('0')),
new IdentifierTypeNode('false'),
]),
- ''
- )
+ '',
+ ),
),
new PhpDocTagNode('@psalm-ignore-falsable-return', new GenericTagValueNode('')),
]),
];
}
- public function provideDescriptionWithOrWithoutHtml(): Iterator
+ public function provideDescriptionWithOrWithoutHtml(): Iterator
+ {
+ yield [
+ 'Description with HTML tags in @return tag (close tags together)',
+ '/**' . PHP_EOL .
+ ' * @return Foo Important description' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@return',
+ new ReturnTagValueNode(
+ new IdentifierTypeNode('Foo'),
+ 'Important description',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'Description with HTML tags in @throws tag (closed tags with text between)',
+ '/**' . PHP_EOL .
+ ' * @throws FooException Important description etc' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@throws',
+ new ThrowsTagValueNode(
+ new IdentifierTypeNode('FooException'),
+ 'Important description etc',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'Description with HTML tags in @mixin tag',
+ '/**' . PHP_EOL .
+ ' * @mixin Mixin Important description' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@mixin',
+ new MixinTagValueNode(
+ new IdentifierTypeNode('Mixin'),
+ 'Important description',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'Description with unclosed HTML tags in @return tag - unclosed HTML tag is parsed as generics',
+ '/**' . PHP_EOL .
+ ' * @return Foo Important description' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@return',
+ new InvalidTagValueNode(
+ 'Foo Important description',
+ new ParserException(
+ 'Important',
+ Lexer::TOKEN_IDENTIFIER,
+ PHP_EOL === "\n" ? 27 : 28,
+ Lexer::TOKEN_HORIZONTAL_WS,
+ null,
+ 2,
+ ),
+ ),
+ ),
+ ]),
+ ];
+ }
+
+ /**
+ * @return array
+ */
+ public function dataParseTagValue(): array
+ {
+ return [
+ [
+ '@param',
+ 'DateTimeImmutable::ATOM $a',
+ new ParamTagValueNode(
+ new ConstTypeNode(new ConstFetchNode('DateTimeImmutable', 'ATOM')),
+ false,
+ '$a',
+ '',
+ false,
+ ),
+ ],
+ [
+ '@var',
+ '$foo string[]',
+ new InvalidTagValueNode(
+ '$foo string[]',
+ new ParserException(
+ '$foo',
+ Lexer::TOKEN_VARIABLE,
+ 0,
+ Lexer::TOKEN_IDENTIFIER,
+ null,
+ 1,
+ ),
+ ),
+ ],
+ ];
+ }
+
+ public function provideTagsWithNumbers(): Iterator
+ {
+ yield [
+ 'OK without description and tag with number in it',
+ '/** @special3 Foo */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@special3',
+ new GenericTagValueNode('Foo'),
+ ),
+ ]),
+ ];
+ }
+
+ public function provideTagsWithBackslash(): Iterator
+ {
+ yield [
+ 'OK without description and tag with backslashes in it',
+ '/** @ORM\Mapping\Entity User */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@ORM\Mapping\Entity',
+ new GenericTagValueNode('User'),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK without description and tag with backslashes in it and parenthesis',
+ '/** @ORM\Mapping\JoinColumn(name="column_id", referencedColumnName="id") */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@ORM\Mapping\JoinColumn',
+ new DoctrineTagValueNode(new DoctrineAnnotation('@ORM\Mapping\JoinColumn', [
+ new DoctrineArgument(new IdentifierTypeNode('name'), new DoctrineConstExprStringNode('column_id')),
+ new DoctrineArgument(new IdentifierTypeNode('referencedColumnName'), new DoctrineConstExprStringNode('id')),
+ ]), ''),
+ ),
+ ]),
+ ];
+ }
+
+ public function provideSelfOutTagsData(): Iterator
+ {
+ yield [
+ 'OK phpstan-self-out',
+ '/** @phpstan-self-out self */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@phpstan-self-out',
+ new SelfOutTagValueNode(
+ new GenericTypeNode(new IdentifierTypeNode('self'), [new IdentifierTypeNode('T')], [GenericTypeNode::VARIANCE_INVARIANT]),
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK phpstan-this-out',
+ '/** @phpstan-this-out self */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@phpstan-this-out',
+ new SelfOutTagValueNode(
+ new GenericTypeNode(new IdentifierTypeNode('self'), [new IdentifierTypeNode('T')], [GenericTypeNode::VARIANCE_INVARIANT]),
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK psalm-self-out',
+ '/** @psalm-self-out self */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@psalm-self-out',
+ new SelfOutTagValueNode(
+ new GenericTypeNode(new IdentifierTypeNode('self'), [new IdentifierTypeNode('T')], [GenericTypeNode::VARIANCE_INVARIANT]),
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK psalm-this-out',
+ '/** @psalm-this-out self */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@psalm-this-out',
+ new SelfOutTagValueNode(
+ new GenericTypeNode(new IdentifierTypeNode('self'), [new IdentifierTypeNode('T')], [GenericTypeNode::VARIANCE_INVARIANT]),
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK with description',
+ '/** @phpstan-self-out self description */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@phpstan-self-out',
+ new SelfOutTagValueNode(
+ new GenericTypeNode(new IdentifierTypeNode('self'), [new IdentifierTypeNode('T')], [GenericTypeNode::VARIANCE_INVARIANT]),
+ 'description',
+ ),
+ ),
+ ]),
+ ];
+ }
+
+ public function provideCommentLikeDescriptions(): Iterator
+ {
+ yield [
+ 'Comment after @param',
+ '/** @param int $a // this is a description */',
+ new PhpDocNode([
+ new PhpDocTagNode('@param', new ParamTagValueNode(
+ new IdentifierTypeNode('int'),
+ false,
+ '$a',
+ '// this is a description',
+ false,
+ )),
+ ]),
+ ];
+
+ yield [
+ 'Comment after @param with https://',
+ '/** @param int $a https://phpstan.org/ */',
+ new PhpDocNode([
+ new PhpDocTagNode('@param', new ParamTagValueNode(
+ new IdentifierTypeNode('int'),
+ false,
+ '$a',
+ 'https://phpstan.org/',
+ false,
+ )),
+ ]),
+ ];
+
+ yield [
+ 'Comment after @param with https:// in // comment',
+ '/** @param int $a // comment https://phpstan.org/ */',
+ new PhpDocNode([
+ new PhpDocTagNode('@param', new ParamTagValueNode(
+ new IdentifierTypeNode('int'),
+ false,
+ '$a',
+ '// comment https://phpstan.org/',
+ false,
+ )),
+ ]),
+ ];
+
+ yield [
+ 'Comment in PHPDoc tag outside of type',
+ '/** @param // comment */',
+ new PhpDocNode([
+ new PhpDocTagNode('@param', new InvalidTagValueNode('// comment', new ParserException(
+ '// comment ',
+ 37,
+ 11,
+ 24,
+ null,
+ 1,
+ ))),
+ ]),
+ ];
+
+ yield [
+ 'Comment on a separate line',
+ '/**' . PHP_EOL .
+ ' * @param int $a' . PHP_EOL .
+ ' * // this is a comment' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode('@param', new ParamTagValueNode(
+ new IdentifierTypeNode('int'),
+ false,
+ '$a',
+ PHP_EOL . '// this is a comment',
+ false,
+ )),
+ ]),
+ ];
+ yield [
+ 'Comment on a separate line 2',
+ '/**' . PHP_EOL .
+ ' * @param int $a' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' * // this is a comment' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode('@param', new ParamTagValueNode(
+ new IdentifierTypeNode('int'),
+ false,
+ '$a',
+ PHP_EOL . PHP_EOL . '// this is a comment',
+ false,
+ )),
+ ]),
+ ];
+ yield [
+ 'Comment after Doctrine tag 1',
+ '/** @ORM\Doctrine // this is a description */',
+ new PhpDocNode([
+ new PhpDocTagNode('@ORM\Doctrine', new GenericTagValueNode('// this is a description')),
+ ]),
+ ];
+ yield [
+ 'Comment after Doctrine tag 2',
+ '/** @\ORM\Doctrine // this is a description */',
+ new PhpDocNode([
+ new PhpDocTagNode('@\ORM\Doctrine', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@\ORM\Doctrine', []),
+ '// this is a description',
+ )),
+ ]),
+ ];
+ yield [
+ 'Comment after Doctrine tag 3',
+ '/** @\ORM\Doctrine() // this is a description */',
+ new PhpDocNode([
+ new PhpDocTagNode('@\ORM\Doctrine', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@\ORM\Doctrine', []),
+ '// this is a description',
+ )),
+ ]),
+ ];
+ yield [
+ 'Comment after Doctrine tag 4',
+ '/** @\ORM\Doctrine() @\ORM\Entity() // this is a description */',
+ new PhpDocNode([
+ new PhpDocTagNode('@\ORM\Doctrine', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@\ORM\Doctrine', []),
+ '',
+ )),
+ new PhpDocTagNode('@\ORM\Entity', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@\ORM\Entity', []),
+ '// this is a description',
+ )),
+ ]),
+ ];
+ }
+
+ public function provideInlineTags(): Iterator
+ {
+ yield [
+ 'Inline @link tag in @copyright',
+ '/**' . PHP_EOL .
+ ' * Unit tests for stored_progress_bar_cleanup' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' * @package core' . PHP_EOL .
+ ' * @copyright 2024 onwards Catalyst IT EU {@link https://catalyst-eu.net}' . PHP_EOL .
+ ' * @\ORM\Entity() 2024 onwards Catalyst IT EU {@link https://catalyst-eu.net}' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTextNode('Unit tests for stored_progress_bar_cleanup'),
+ new PhpDocTextNode(''),
+ new PhpDocTagNode('@package', new GenericTagValueNode('core')),
+ new PhpDocTagNode('@copyright', new GenericTagValueNode('2024 onwards Catalyst IT EU {@link https://catalyst-eu.net}')),
+ new PhpDocTagNode('@\ORM\Entity', new DoctrineTagValueNode(new DoctrineAnnotation('@\ORM\Entity', []), '2024 onwards Catalyst IT EU {@link https://catalyst-eu.net}')),
+ ]),
+ ];
+ }
+
+ public function provideParamOutTagsData(): Iterator
+ {
+ yield [
+ 'OK param-out',
+ '/** @param-out string $s */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@param-out',
+ new ParamOutTagValueNode(
+ new IdentifierTypeNode('string'),
+ '$s',
+ '',
+ ),
+ ),
+ ]),
+ ];
+
+ yield [
+ 'OK param-out description',
+ '/** @param-out string $s description */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@param-out',
+ new ParamOutTagValueNode(
+ new IdentifierTypeNode('string'),
+ '$s',
+ 'description',
+ ),
+ ),
+ ]),
+ ];
+ }
+
+ public function provideDoctrineData(): Iterator
+ {
+ yield [
+ 'single tag node with empty parameters',
+ '/**' . PHP_EOL .
+ ' * @X() Content' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@X',
+ new DoctrineTagValueNode(
+ new DoctrineAnnotation('@X', []),
+ 'Content',
+ ),
+ ),
+ ]),
+ [new Doctrine\X()],
+ ];
+
+ $xWithZ = new Doctrine\X();
+ $xWithZ->a = new Doctrine\Z();
+ yield [
+ 'single tag node with nested PHPDoc tag',
+ '/**' . PHP_EOL .
+ ' * @X(@Z) Content' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@X',
+ new DoctrineTagValueNode(
+ new DoctrineAnnotation('@X', [
+ new DoctrineArgument(null, new DoctrineAnnotation('@Z', [])),
+ ]),
+ 'Content',
+ ),
+ ),
+ ]),
+ [$xWithZ],
+ ];
+
+ yield [
+ 'single tag node with nested PHPDoc tag with field name',
+ '/**' . PHP_EOL .
+ ' * @X(a=@Z) Content' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@X',
+ new DoctrineTagValueNode(
+ new DoctrineAnnotation('@X', [
+ new DoctrineArgument(new IdentifierTypeNode('a'), new DoctrineAnnotation('@Z', [])),
+ ]),
+ 'Content',
+ ),
+ ),
+ ]),
+ [$xWithZ],
+ ];
+
+ yield [
+ 'single tag node with nested Doctrine tag',
+ '/**' . PHP_EOL .
+ ' * @X(@\PHPStan\PhpDocParser\Parser\Doctrine\Z) Content' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@X',
+ new DoctrineTagValueNode(
+ new DoctrineAnnotation('@X', [
+ new DoctrineArgument(null, new DoctrineAnnotation('@\PHPStan\PhpDocParser\Parser\Doctrine\Z', [])),
+ ]),
+ 'Content',
+ ),
+ ),
+ ]),
+ [$xWithZ],
+ ];
+
+ yield [
+ 'single tag node with nested Doctrine tag with field name',
+ '/**' . PHP_EOL .
+ ' * @X( a = @\PHPStan\PhpDocParser\Parser\Doctrine\Z) Content' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@X',
+ new DoctrineTagValueNode(
+ new DoctrineAnnotation('@X', [
+ new DoctrineArgument(new IdentifierTypeNode('a'), new DoctrineAnnotation('@\PHPStan\PhpDocParser\Parser\Doctrine\Z', [])),
+ ]),
+ 'Content',
+ ),
+ ),
+ ]),
+ [$xWithZ],
+ ];
+
+ yield [
+ 'single tag node with empty parameters with crazy whitespace',
+ '/**' . PHP_EOL .
+ ' * @X ( ' . PHP_EOL .
+ ' * ) Content' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@X',
+ new DoctrineTagValueNode(
+ new DoctrineAnnotation('@X', []),
+ 'Content',
+ ),
+ ),
+ ]),
+ [new Doctrine\X()],
+ ];
+
+ yield [
+ 'single tag node with empty parameters with crazy whitespace with extra text node',
+ '/**' . PHP_EOL .
+ ' * @X ()' . PHP_EOL .
+ ' * Content' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@X',
+ new DoctrineTagValueNode(
+ new DoctrineAnnotation('@X', []),
+ PHP_EOL .
+ 'Content',
+ ),
+ ),
+ ]),
+ [new Doctrine\X()],
+ ];
+
+ yield [
+ 'single FQN tag node without parentheses',
+ '/**' . PHP_EOL .
+ ' * @\PHPStan\PhpDocParser\Parser\Doctrine\X Content' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@\PHPStan\PhpDocParser\Parser\Doctrine\X',
+ new DoctrineTagValueNode(
+ new DoctrineAnnotation('@\PHPStan\PhpDocParser\Parser\Doctrine\X', []),
+ 'Content',
+ ),
+ ),
+ ]),
+ [new Doctrine\X()],
+ ];
+
+ yield [
+ 'single FQN tag node with empty parameters',
+ '/**' . PHP_EOL .
+ ' * @\PHPStan\PhpDocParser\Parser\Doctrine\X() Content' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@\PHPStan\PhpDocParser\Parser\Doctrine\X',
+ new DoctrineTagValueNode(
+ new DoctrineAnnotation('@\PHPStan\PhpDocParser\Parser\Doctrine\X', []),
+ 'Content',
+ ),
+ ),
+ ]),
+ [new Doctrine\X()],
+ ];
+
+ $x = new Doctrine\X();
+ $x->a = Doctrine\Y::SOME;
+
+ $z = new Doctrine\Z();
+ $z->code = 123;
+ $x->b = [$z];
+ yield [
+ 'single tag node with other tags in parameters',
+ '/**' . PHP_EOL .
+ ' * @X(' . PHP_EOL .
+ ' * a=Y::SOME,' . PHP_EOL .
+ ' * b={' . PHP_EOL .
+ ' * @Z(' . PHP_EOL .
+ ' * code=123' . PHP_EOL .
+ ' * )' . PHP_EOL .
+ ' * }' . PHP_EOL .
+ ' * ) Content' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@X',
+ new DoctrineTagValueNode(
+ new DoctrineAnnotation(
+ '@X',
+ [
+ new DoctrineArgument(new IdentifierTypeNode('a'), new ConstFetchNode('Y', 'SOME')),
+ new DoctrineArgument(new IdentifierTypeNode('b'), new DoctrineArray([
+ new DoctrineArrayItem(null, new DoctrineAnnotation('@Z', [
+ new DoctrineArgument(new IdentifierTypeNode('code'), new ConstExprIntegerNode('123')),
+ ])),
+ ])),
+ ],
+ ),
+ 'Content',
+ ),
+ ),
+ ]),
+ [$x],
+ ];
+
+ yield [
+ 'single tag node with other tags in parameters with crazy whitespace inbetween',
+ '/**' . PHP_EOL .
+ ' * @X (' . PHP_EOL .
+ ' * a' . PHP_EOL .
+ ' * = Y::SOME,' . PHP_EOL .
+ ' * b = ' . PHP_EOL .
+ ' * {' . PHP_EOL .
+ ' * @Z (' . PHP_EOL .
+ ' * code=123,' . PHP_EOL .
+ ' * ),' . PHP_EOL .
+ ' * },' . PHP_EOL .
+ ' * ) Content' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode(
+ '@X',
+ new DoctrineTagValueNode(
+ new DoctrineAnnotation(
+ '@X',
+ [
+ new DoctrineArgument(new IdentifierTypeNode('a'), new ConstFetchNode('Y', 'SOME')),
+ new DoctrineArgument(new IdentifierTypeNode('b'), new DoctrineArray([
+ new DoctrineArrayItem(null, new DoctrineAnnotation('@Z', [
+ new DoctrineArgument(new IdentifierTypeNode('code'), new ConstExprIntegerNode('123')),
+ ])),
+ ])),
+ ],
+ ),
+ 'Content',
+ ),
+ ),
+ ]),
+ [$x],
+ ];
+
+ yield [
+ 'Multiline tag behaviour 1',
+ '/**' . PHP_EOL .
+ ' * @X() test' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new DoctrineTagValueNode(new DoctrineAnnotation(
+ '@X',
+ [],
+ ), 'test')),
+ ]),
+ [new Doctrine\X()],
+ ];
+
+ yield [
+ 'Multiline tag behaviour 2',
+ '/**' . PHP_EOL .
+ ' * @X() test' . PHP_EOL .
+ ' * test2' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new DoctrineTagValueNode(new DoctrineAnnotation(
+ '@X',
+ [],
+ ), 'test' . PHP_EOL . 'test2')),
+ ]),
+ [new Doctrine\X()],
+ ];
+ yield [
+ 'Multiline tag behaviour 3',
+ '/**' . PHP_EOL .
+ ' * @X() test' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' * test2' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new DoctrineTagValueNode(new DoctrineAnnotation(
+ '@X',
+ [],
+ ), 'test' . PHP_EOL .
+ PHP_EOL . 'test2')),
+ ]),
+ [new Doctrine\X()],
+ ];
+ yield [
+ 'Multiline tag behaviour 4',
+ '/**' . PHP_EOL .
+ ' * @X() test' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' * test2' . PHP_EOL .
+ ' * @Z()' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new DoctrineTagValueNode(new DoctrineAnnotation(
+ '@X',
+ [],
+ ), 'test' . PHP_EOL .
+ PHP_EOL . 'test2')),
+ new PhpDocTagNode('@Z', new DoctrineTagValueNode(new DoctrineAnnotation(
+ '@Z',
+ [],
+ ), '')),
+ ]),
+ [new Doctrine\X(), new Doctrine\Z()],
+ ];
+
+ yield [
+ 'Multiline generic tag behaviour 1',
+ '/**' . PHP_EOL .
+ ' * @X test' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new GenericTagValueNode('test')),
+ ]),
+ [new Doctrine\X()],
+ ];
+
+ yield [
+ 'Multiline generic tag behaviour 2',
+ '/**' . PHP_EOL .
+ ' * @X test' . PHP_EOL .
+ ' * test2' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new GenericTagValueNode('test' . PHP_EOL . 'test2')),
+ ]),
+ [new Doctrine\X()],
+ ];
+ yield [
+ 'Multiline generic tag behaviour 3',
+ '/**' . PHP_EOL .
+ ' * @X test' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' * test2' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new GenericTagValueNode('test' . PHP_EOL .
+ PHP_EOL .
+ 'test2')),
+ ]),
+ [new Doctrine\X()],
+ ];
+ yield [
+ 'Multiline generic tag behaviour 4',
+ '/**' . PHP_EOL .
+ ' * @X test' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' * test2' . PHP_EOL .
+ ' * @Z' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new GenericTagValueNode('test' . PHP_EOL .
+ PHP_EOL .
+ 'test2')),
+ new PhpDocTagNode('@Z', new GenericTagValueNode('')),
+ ]),
+ [new Doctrine\X(), new Doctrine\Z()],
+ ];
+
+ yield [
+ 'More tags on the same line',
+ '/** @X() @Z() */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new DoctrineTagValueNode(new DoctrineAnnotation('@X', []), '')),
+ new PhpDocTagNode('@Z', new DoctrineTagValueNode(new DoctrineAnnotation('@Z', []), '')),
+ ]),
+ [new Doctrine\X(), new Doctrine\Z()],
+ ];
+
+ yield [
+ 'More tags on the same line with description inbetween',
+ '/** @X() test @Z() */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new DoctrineTagValueNode(new DoctrineAnnotation('@X', []), 'test')),
+ new PhpDocTagNode('@Z', new DoctrineTagValueNode(new DoctrineAnnotation('@Z', []), '')),
+ ]),
+ [new Doctrine\X(), new Doctrine\Z()],
+ ];
+
+ yield [
+ 'More tags on the same line with description inbetween, first one generic',
+ '/** @X test @Z() */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new GenericTagValueNode('test')),
+ new PhpDocTagNode('@Z', new DoctrineTagValueNode(new DoctrineAnnotation('@Z', []), '')),
+ ]),
+ [new Doctrine\X(), new Doctrine\Z()],
+ ];
+
+ yield [
+ 'More generic tags on the same line with description inbetween, 2nd one @param which should become description',
+ '/** @X @phpstan-param int $z */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new GenericTagValueNode('@phpstan-param int $z')),
+ ]),
+ [new Doctrine\X()],
+ ];
+
+ yield [
+ 'More generic tags on the same line with description inbetween, 2nd one @param which should become description can have a parse error',
+ '/** @X @phpstan-param |int $z */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new GenericTagValueNode('@phpstan-param |int $z')),
+ ]),
+ [new Doctrine\X()],
+ ];
+
+ yield [
+ 'More tags on the same line with description inbetween, 2nd one @param which should become description',
+ '/** @X() @phpstan-param int $z */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new DoctrineTagValueNode(new DoctrineAnnotation('@X', []), '@phpstan-param int $z')),
+ ]),
+ [new Doctrine\X()],
+ ];
+
+ yield [
+ 'More tags on the same line with description inbetween, 2nd one @param which should become description can have a parse error',
+ '/** @X() @phpstan-param |int $z */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new DoctrineTagValueNode(new DoctrineAnnotation('@X', []), '@phpstan-param |int $z')),
+ ]),
+ [new Doctrine\X()],
+ ];
+
+ $apiResource = new Doctrine\ApiResource();
+ $apiResource->itemOperations = [
+ 'get' => [
+ 'security' => 'is_granted(' . PHP_EOL .
+ "constant('REDACTED')," . PHP_EOL .
+ 'object' . PHP_EOL . ')',
+ 'normalization_context' => [
+ 'groups' => ['Redacted:read'],
+ ],
+ ],
+ ];
+ yield [
+ 'Regression test for issue #207',
+ '/**' . PHP_EOL .
+ ' * @ApiResource(' . PHP_EOL .
+ ' * itemOperations={' . PHP_EOL .
+ ' * "get"={' . PHP_EOL .
+ ' * "security"="is_granted(' . PHP_EOL .
+ "constant('REDACTED')," . PHP_EOL .
+ 'object' . PHP_EOL .
+ ')",' . PHP_EOL .
+ ' * "normalization_context"={"groups"={"Redacted:read"}}' . PHP_EOL .
+ ' * }' . PHP_EOL .
+ ' * }' . PHP_EOL .
+ ' * )' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTagNode('@ApiResource', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@ApiResource', [
+ new DoctrineArgument(new IdentifierTypeNode('itemOperations'), new DoctrineArray([
+ new DoctrineArrayItem(
+ new DoctrineConstExprStringNode('get'),
+ new DoctrineArray([
+ new DoctrineArrayItem(
+ new DoctrineConstExprStringNode('security'),
+ new DoctrineConstExprStringNode('is_granted(' . PHP_EOL .
+ "constant('REDACTED')," . PHP_EOL .
+ 'object' . PHP_EOL .
+ ')'),
+ ),
+ new DoctrineArrayItem(
+ new DoctrineConstExprStringNode('normalization_context'),
+ new DoctrineArray([
+ new DoctrineArrayItem(
+ new DoctrineConstExprStringNode('groups'),
+ new DoctrineArray([
+ new DoctrineArrayItem(null, new DoctrineConstExprStringNode('Redacted:read')),
+ ]),
+ ),
+ ]),
+ ),
+ ]),
+ ),
+ ])),
+ ]),
+ '',
+ )),
+ ]),
+ [$apiResource],
+ ];
+
+ $xWithString = new Doctrine\X();
+ $xWithString->a = '"bar"';
+ yield [
+ 'Escaped strings',
+ '/** @X(a="""bar""") */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@X', [
+ new DoctrineArgument(new IdentifierTypeNode('a'), new DoctrineConstExprStringNode($xWithString->a)),
+ ]),
+ '',
+ )),
+ ]),
+ [$xWithString],
+ ];
+
+ $xWithString2 = new Doctrine\X();
+ $xWithString2->a = 'Allowed choices are "bar" or "baz".';
+ yield [
+ 'Escaped strings 2',
+ '/** @X(a="Allowed choices are ""bar"" or ""baz"".") */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@X', [
+ new DoctrineArgument(new IdentifierTypeNode('a'), new DoctrineConstExprStringNode($xWithString2->a)),
+ ]),
+ '',
+ )),
+ ]),
+ [$xWithString2],
+ ];
+
+ $xWithString3 = new Doctrine\X();
+ $xWithString3->a = 'In PHP, "" is an empty string';
+ yield [
+ 'Escaped strings 3',
+ '/** @X(a="In PHP, """" is an empty string") */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@X', [
+ new DoctrineArgument(new IdentifierTypeNode('a'), new DoctrineConstExprStringNode($xWithString3->a)),
+ ]),
+ '',
+ )),
+ ]),
+ [$xWithString3],
+ ];
+
+ $xWithString4 = new Doctrine\X();
+ $xWithString4->a = '"May the Force be with you," he said.';
+ yield [
+ 'Escaped strings 4',
+ '/** @X(a="""May the Force be with you,"" he said.") */',
+ new PhpDocNode([
+ new PhpDocTagNode('@X', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@X', [
+ new DoctrineArgument(new IdentifierTypeNode('a'), new DoctrineConstExprStringNode($xWithString4->a)),
+ ]),
+ '',
+ )),
+ ]),
+ [$xWithString4],
+ ];
+ }
+
+ public function provideDoctrineWithoutDoctrineCheckData(): Iterator
{
yield [
- 'Description with HTML tags in @return tag (close tags together)',
- '/**' . PHP_EOL .
- ' * @return Foo Important description' . PHP_EOL .
- ' */',
+ 'Dummy 1',
+ '/** @DummyAnnotation(dummyValue="hello") */',
new PhpDocNode([
- new PhpDocTagNode(
- '@return',
- new ReturnTagValueNode(
- new IdentifierTypeNode('Foo'),
- 'Important description'
- )
- ),
+ new PhpDocTagNode('@DummyAnnotation', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@DummyAnnotation', [
+ new DoctrineArgument(new IdentifierTypeNode('dummyValue'), new DoctrineConstExprStringNode('hello')),
+ ]),
+ '',
+ )),
+ ]),
+ ];
+ yield [
+ 'Dummy 2',
+ '/**
+ * @DummyJoinTable(name="join_table",
+ * joinColumns={@DummyJoinColumn(name="col1", referencedColumnName="col2")},
+ * inverseJoinColumns={
+ * @DummyJoinColumn(name="col3", referencedColumnName="col4")
+ * })
+ */',
+ new PhpDocNode([
+ new PhpDocTagNode('@DummyJoinTable', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@DummyJoinTable', [
+ new DoctrineArgument(new IdentifierTypeNode('name'), new DoctrineConstExprStringNode('join_table')),
+ new DoctrineArgument(new IdentifierTypeNode('joinColumns'), new DoctrineArray([
+ new DoctrineArrayItem(null, new DoctrineAnnotation('@DummyJoinColumn', [
+ new DoctrineArgument(new IdentifierTypeNode('name'), new DoctrineConstExprStringNode('col1')),
+ new DoctrineArgument(new IdentifierTypeNode('referencedColumnName'), new DoctrineConstExprStringNode('col2')),
+ ])),
+ ])),
+ new DoctrineArgument(new IdentifierTypeNode('inverseJoinColumns'), new DoctrineArray([
+ new DoctrineArrayItem(null, new DoctrineAnnotation('@DummyJoinColumn', [
+ new DoctrineArgument(new IdentifierTypeNode('name'), new DoctrineConstExprStringNode('col3')),
+ new DoctrineArgument(new IdentifierTypeNode('referencedColumnName'), new DoctrineConstExprStringNode('col4')),
+ ])),
+ ])),
+ ]),
+ '',
+ )),
]),
];
yield [
- 'Description with HTML tags in @throws tag (closed tags with text between)',
- '/**' . PHP_EOL .
- ' * @throws FooException Important description etc' . PHP_EOL .
- ' */',
+ 'Annotation in annotation',
+ '/** @AnnotationTargetAll(@AnnotationTargetAnnotation) */',
new PhpDocNode([
- new PhpDocTagNode(
- '@throws',
- new ThrowsTagValueNode(
- new IdentifierTypeNode('FooException'),
- 'Important description etc'
- )
- ),
+ new PhpDocTagNode('@AnnotationTargetAll', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@AnnotationTargetAll', [
+ new DoctrineArgument(null, new DoctrineAnnotation('@AnnotationTargetAnnotation', [])),
+ ]),
+ '',
+ )),
]),
];
yield [
- 'Description with HTML tags in @mixin tag',
- '/**' . PHP_EOL .
- ' * @mixin Mixin Important description' . PHP_EOL .
- ' */',
+ 'Dangling comma annotation',
+ '/** @DummyAnnotation(dummyValue = "bar",) */',
new PhpDocNode([
- new PhpDocTagNode(
- '@mixin',
- new MixinTagValueNode(
- new IdentifierTypeNode('Mixin'),
- 'Important description'
- )
- ),
+ new PhpDocTagNode('@DummyAnnotation', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@DummyAnnotation', [
+ new DoctrineArgument(new IdentifierTypeNode('dummyValue'), new DoctrineConstExprStringNode('bar')),
+ ]),
+ '',
+ )),
]),
];
yield [
- 'Description with unclosed HTML tags in @return tag - unclosed HTML tag is parsed as generics',
- '/**' . PHP_EOL .
- ' * @return Foo Important description' . PHP_EOL .
- ' */',
+ 'Multiple on one line',
+ '/**
+ * @DummyId @DummyColumn(type="integer") @DummyGeneratedValue
+ * @var int
+ */',
new PhpDocNode([
- new PhpDocTagNode(
- '@return',
- new ReturnTagValueNode(
- new GenericTypeNode(
- new IdentifierTypeNode('Foo'),
- [
- new IdentifierTypeNode('strong'),
- ],
- [
- GenericTypeNode::VARIANCE_INVARIANT,
- ]
- ),
- 'Important description'
- )
- ),
+ new PhpDocTagNode('@DummyId', new GenericTagValueNode('')),
+ new PhpDocTagNode('@DummyColumn', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@DummyColumn', [
+ new DoctrineArgument(new IdentifierTypeNode('type'), new DoctrineConstExprStringNode('integer')),
+ ]),
+ '',
+ )),
+ new PhpDocTagNode('@DummyGeneratedValue', new GenericTagValueNode('')),
+ new PhpDocTagNode('@var', new VarTagValueNode(new IdentifierTypeNode('int'), '', '')),
]),
+ ];
+
+ yield [
+ 'Parse error with dashes',
+ '/** @AlsoDoNot\Parse-me */',
new PhpDocNode([
- new PhpDocTagNode(
- '@return',
- new InvalidTagValueNode(
- 'Foo Important description',
- new ParserException(
- 'Important',
- Lexer::TOKEN_IDENTIFIER,
- 27,
- Lexer::TOKEN_HORIZONTAL_WS,
- null,
- 2
- )
- )
- ),
+ new PhpDocTagNode('@AlsoDoNot\Parse-me', new GenericTagValueNode('')),
]),
];
- }
- /**
- * @return array
- */
- public function dataParseTagValue(): array
- {
- return [
- [
- '@param',
- 'DateTimeImmutable::ATOM $a',
- new ParamTagValueNode(
- new ConstTypeNode(new ConstFetchNode('DateTimeImmutable', 'ATOM')),
- false,
- '$a',
- ''
- ),
- ],
- [
- '@var',
- '$foo string[]',
- new InvalidTagValueNode(
- '$foo string[]',
- new ParserException(
- '$foo',
- Lexer::TOKEN_VARIABLE,
- 0,
- Lexer::TOKEN_IDENTIFIER,
- null,
- 1
- )
- ),
- ],
+ yield [
+ 'Annotation with constant',
+ '/** @AnnotationWithConstants(PHP_EOL) */',
+ new PhpDocNode([
+ new PhpDocTagNode('@AnnotationWithConstants', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@AnnotationWithConstants', [
+ new DoctrineArgument(null, new IdentifierTypeNode('PHP_EOL')),
+ ]),
+ '',
+ )),
+ ]),
];
- }
- public function provideTagsWithNumbers(): Iterator
- {
yield [
- 'OK without description and tag with number in it',
- '/** @special3 Foo */',
+ 'Nested arrays with nested annotations',
+ '/** @Name(foo={1,2, {"key"=@Name}}) */',
new PhpDocNode([
- new PhpDocTagNode(
- '@special3',
- new GenericTagValueNode('Foo')
- ),
+ new PhpDocTagNode('@Name', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@Name', [
+ new DoctrineArgument(new IdentifierTypeNode('foo'), new DoctrineArray([
+ new DoctrineArrayItem(null, new ConstExprIntegerNode('1')),
+ new DoctrineArrayItem(null, new ConstExprIntegerNode('2')),
+ new DoctrineArrayItem(null, new DoctrineArray([
+ new DoctrineArrayItem(new DoctrineConstExprStringNode('key'), new DoctrineAnnotation(
+ '@Name',
+ [],
+ )),
+ ])),
+ ])),
+ ]),
+ '',
+ )),
]),
];
- }
- public function provideTagsWithBackslash(): Iterator
- {
yield [
- 'OK without description and tag with backslashes in it',
- '/** @ORM\Mapping\Entity User */',
+ 'Namespaced constant',
+ '/** @AnnotationWithConstants(Doctrine\Tests\Common\Annotations\Fixtures\AnnotationWithConstants::FLOAT) */',
new PhpDocNode([
- new PhpDocTagNode(
- '@ORM\Mapping\Entity',
- new GenericTagValueNode('User')
- ),
+ new PhpDocTagNode('@AnnotationWithConstants', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@AnnotationWithConstants', [
+ new DoctrineArgument(null, new ConstFetchNode('Doctrine\Tests\Common\Annotations\Fixtures\AnnotationWithConstants', 'FLOAT')),
+ ]),
+ '',
+ )),
]),
];
yield [
- 'OK without description and tag with backslashes in it and parenthesis',
- '/** @ORM\Mapping\JoinColumn(name="column_id", referencedColumnName="id") */',
+ 'Another namespaced constant',
+ '/** @AnnotationWithConstants(\Doctrine\Tests\Common\Annotations\Fixtures\AnnotationWithConstants::FLOAT) */',
new PhpDocNode([
- new PhpDocTagNode(
- '@ORM\Mapping\JoinColumn',
- new GenericTagValueNode('(name="column_id", referencedColumnName="id")')
- ),
+ new PhpDocTagNode('@AnnotationWithConstants', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@AnnotationWithConstants', [
+ new DoctrineArgument(null, new ConstFetchNode('\Doctrine\Tests\Common\Annotations\Fixtures\AnnotationWithConstants', 'FLOAT')),
+ ]),
+ '',
+ )),
]),
];
- }
- public function provideSelfOutTagsData(): Iterator
- {
yield [
- 'OK phpstan-self-out',
- '/** @phpstan-self-out self */',
+ 'Array with namespaced constants',
+ '/** @AnnotationWithConstants({
+ Doctrine\Tests\Common\Annotations\Fixtures\InterfaceWithConstants::SOME_KEY = AnnotationWithConstants::INTEGER
+}) */',
new PhpDocNode([
- new PhpDocTagNode(
- '@phpstan-self-out',
- new SelfOutTagValueNode(
- new GenericTypeNode(new IdentifierTypeNode('self'), [new IdentifierTypeNode('T')], [GenericTypeNode::VARIANCE_INVARIANT]),
- ''
- )
- ),
+ new PhpDocTagNode('@AnnotationWithConstants', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@AnnotationWithConstants', [
+ new DoctrineArgument(null, new DoctrineArray([
+ new DoctrineArrayItem(
+ new ConstFetchNode('Doctrine\Tests\Common\Annotations\Fixtures\InterfaceWithConstants', 'SOME_KEY'),
+ new ConstFetchNode('AnnotationWithConstants', 'INTEGER'),
+ ),
+ ])),
+ ]),
+ '',
+ )),
]),
];
yield [
- 'OK phpstan-this-out',
- '/** @phpstan-this-out self */',
+ 'Array with colon',
+ '/** @Name({"foo": "bar"}) */',
new PhpDocNode([
- new PhpDocTagNode(
- '@phpstan-this-out',
- new SelfOutTagValueNode(
- new GenericTypeNode(new IdentifierTypeNode('self'), [new IdentifierTypeNode('T')], [GenericTypeNode::VARIANCE_INVARIANT]),
- ''
- )
- ),
+ new PhpDocTagNode('@Name', new DoctrineTagValueNode(
+ new DoctrineAnnotation('@Name', [
+ new DoctrineArgument(null, new DoctrineArray([
+ new DoctrineArrayItem(new DoctrineConstExprStringNode('foo'), new DoctrineConstExprStringNode('bar')),
+ ])),
+ ]),
+ '',
+ )),
]),
];
yield [
- 'OK psalm-self-out',
- '/** @psalm-self-out self */',
+ 'More tags on the same line with description inbetween, second Doctrine one cannot have parse error',
+ '/** @X test @Z(test= */',
new PhpDocNode([
- new PhpDocTagNode(
- '@psalm-self-out',
- new SelfOutTagValueNode(
- new GenericTypeNode(new IdentifierTypeNode('self'), [new IdentifierTypeNode('T')], [GenericTypeNode::VARIANCE_INVARIANT]),
- ''
- )
- ),
+ new PhpDocTagNode('@X', new GenericTagValueNode('test')),
+ new PhpDocTagNode('@Z', new InvalidTagValueNode('(test=', new ParserException(
+ '=',
+ 14,
+ 19,
+ 5,
+ null,
+ 1,
+ ))),
]),
+ [new Doctrine\X()],
];
yield [
- 'OK psalm-this-out',
- '/** @psalm-this-out self */',
+ 'More tags on the same line with description inbetween, second Doctrine one cannot have parse error 2',
+ '/** @X() test @Z(test= */',
new PhpDocNode([
- new PhpDocTagNode(
- '@psalm-this-out',
- new SelfOutTagValueNode(
- new GenericTypeNode(new IdentifierTypeNode('self'), [new IdentifierTypeNode('T')], [GenericTypeNode::VARIANCE_INVARIANT]),
- ''
- )
- ),
+ new PhpDocTagNode('@X', new DoctrineTagValueNode(new DoctrineAnnotation('@X', []), 'test')),
+ new PhpDocTagNode('@Z', new InvalidTagValueNode('(test=', new ParserException(
+ '=',
+ 14,
+ 21,
+ 5,
+ null,
+ 1,
+ ))),
]),
+ [new Doctrine\X()],
];
yield [
- 'OK with description',
- '/** @phpstan-self-out self description */',
+ 'Doctrine tag after common tag is just a description',
+ '/** @phpstan-param int $z @X() */',
new PhpDocNode([
- new PhpDocTagNode(
- '@phpstan-self-out',
- new SelfOutTagValueNode(
- new GenericTypeNode(new IdentifierTypeNode('self'), [new IdentifierTypeNode('T')], [GenericTypeNode::VARIANCE_INVARIANT]),
- 'description'
- )
- ),
+ new PhpDocTagNode('@phpstan-param', new ParamTagValueNode(
+ new IdentifierTypeNode('int'),
+ false,
+ '$z',
+ '@X()',
+ false,
+ )),
]),
];
- }
- public function provideParamOutTagsData(): Iterator
- {
yield [
- 'OK param-out',
- '/** @param-out string $s */',
+ 'Doctrine tag after common tag is just a description 2',
+ '/** @phpstan-param int $z @\X\Y() */',
new PhpDocNode([
- new PhpDocTagNode(
- '@param-out',
- new ParamOutTagValueNode(
- new IdentifierTypeNode('string'),
- '$s',
- ''
- )
- ),
+ new PhpDocTagNode('@phpstan-param', new ParamTagValueNode(
+ new IdentifierTypeNode('int'),
+ false,
+ '$z',
+ '@\X\Y()',
+ false,
+ )),
]),
];
yield [
- 'OK param-out description',
- '/** @param-out string $s description */',
+ 'Generic tag after common tag is just a description',
+ '/** @phpstan-param int $z @X */',
new PhpDocNode([
- new PhpDocTagNode(
- '@param-out',
- new ParamOutTagValueNode(
- new IdentifierTypeNode('string'),
- '$s',
- 'description'
- )
- ),
+ new PhpDocTagNode('@phpstan-param', new ParamTagValueNode(
+ new IdentifierTypeNode('int'),
+ false,
+ '$z',
+ '@X',
+ false,
+ )),
+ ]),
+ ];
+
+ yield [
+ 'Slevomat CS issue #1608',
+ '/**' . PHP_EOL .
+ ' * `"= "`' . PHP_EOL .
+ ' * a' . PHP_EOL .
+ ' * "' . PHP_EOL .
+ ' *' . PHP_EOL .
+ ' * @package foo' . PHP_EOL .
+ ' */',
+ new PhpDocNode([
+ new PhpDocTextNode('`"= "`' . PHP_EOL .
+ ' * a' . PHP_EOL .
+ ' * "'),
+ new PhpDocTextNode(''),
+ new PhpDocTagNode('@package', new GenericTagValueNode('foo')),
]),
];
}
@@ -5518,8 +7371,8 @@ public function provideSpecializedTags(): Iterator
new PhpDocTagNode(
'@special:param',
new GenericTagValueNode(
- 'this is special'
- )
+ 'this is special',
+ ),
),
]),
];
@@ -5532,7 +7385,6 @@ public function provideSpecializedTags(): Iterator
public function testParseTagValue(string $tag, string $phpDoc, Node $expectedPhpDocNode): void
{
$this->executeTestParseTagValue($this->phpDocParser, $tag, $phpDoc, $expectedPhpDocNode);
- $this->executeTestParseTagValue($this->phpDocParserWithRequiredWhitespaceBeforeDescription, $tag, $phpDoc, $expectedPhpDocNode);
}
private function executeTestParseTagValue(PhpDocParser $phpDocParser, string $tag, string $phpDoc, Node $expectedPhpDocNode): void
@@ -5647,47 +7499,140 @@ public function dataLinesAndIndexes(): iterable
yield [
'/** @param Foo::** $a*/',
[
- [1, 1, 1, 8],
+ [1, 1, 1, 8],
+ ],
+ ];
+
+ yield [
+ '/** @return Foo */',
+ [
+ [1, 1, 1, 3],
+ ],
+ ];
+
+ yield [
+ '/** @return Foo*/',
+ [
+ [1, 1, 1, 3],
+ ],
+ ];
+
+ yield [
+ '/** @api */',
+ [
+ [1, 1, 1, 1],
+ ],
+ ];
+ }
+
+ /**
+ * @dataProvider dataLinesAndIndexes
+ * @param list $childrenLines
+ */
+ public function testLinesAndIndexes(string $phpDoc, array $childrenLines): void
+ {
+ $tokens = new TokenIterator($this->lexer->tokenize($phpDoc));
+ $config = new ParserConfig([
+ 'lines' => true,
+ 'indexes' => true,
+ ]);
+ $constExprParser = new ConstExprParser($config);
+ $typeParser = new TypeParser($config, $constExprParser);
+ $phpDocParser = new PhpDocParser($config, $typeParser, $constExprParser);
+ $phpDocNode = $phpDocParser->parse($tokens);
+ $children = $phpDocNode->children;
+ $this->assertCount(count($childrenLines), $children);
+ foreach ($children as $i => $child) {
+ $this->assertSame($childrenLines[$i][0], $child->getAttribute(Attribute::START_LINE));
+ $this->assertSame($childrenLines[$i][1], $child->getAttribute(Attribute::END_LINE));
+ $this->assertSame($childrenLines[$i][2], $child->getAttribute(Attribute::START_INDEX));
+ $this->assertSame($childrenLines[$i][3], $child->getAttribute(Attribute::END_INDEX));
+ }
+ }
+
+
+ /**
+ * @return iterable}>
+ */
+ public function dataDeepNodesLinesAndIndexes(): iterable
+ {
+ yield [
+ '/**' . PHP_EOL .
+ ' * @X({' . PHP_EOL .
+ ' * 1,' . PHP_EOL .
+ ' * 2' . PHP_EOL .
+ ' * , ' . PHP_EOL .
+ ' * 3,' . PHP_EOL .
+ ' * }' . PHP_EOL .
+ ' * )' . PHP_EOL .
+ ' */',
+ [
+ [1, 9, 0, 25], // PhpDocNode
+ [2, 8, 2, 23], // PhpDocTagNode
+ [2, 8, 3, 23], // DoctrineTagValueNode
+ [2, 8, 3, 23], // DoctrineAnnotation
+ [2, 8, 4, 21], // DoctrineArgument
+ [2, 8, 4, 21], // DoctrineArray
+ [3, 3, 7, 7], // DoctrineArrayItem
+ [3, 3, 7, 7], // ConstExprIntegerNode
+ [4, 5, 11, 11], // DoctrineArrayItem
+ [4, 5, 11, 11], // ConstExprIntegerNode
+ [6, 6, 18, 18], // DoctrineArrayItem
+ [6, 6, 18, 18], // ConstExprIntegerNode
],
];
yield [
- '/** @return Foo */',
+ '/**' . PHP_EOL .
+ ' * @\Foo\Bar({' . PHP_EOL .
+ ' * }' . PHP_EOL .
+ ' * )' . PHP_EOL .
+ ' */',
[
- [1, 1, 1, 3],
+ [1, 5, 0, 10], // PhpDocNode
+ [2, 4, 2, 8], // PhpDocTagNode
+ [2, 4, 3, 8], // DoctrineTagValueNode
+ [2, 4, 3, 8], // DoctrineAnnotation
+ [2, 4, 4, 6], // DoctrineArgument
+ [2, 4, 4, 6], // DoctrineArray
],
];
yield [
- '/** @return Foo*/',
+ '/** @api */',
[
- [1, 1, 1, 3],
+ [1, 1, 0, 3],
+ [1, 1, 1, 1],
+ [1, 1, 3, 1], // GenericTagValueNode is empty so start index is higher than end index
],
];
}
+
/**
- * @dataProvider dataLinesAndIndexes
- * @param list $childrenLines
+ * @dataProvider dataDeepNodesLinesAndIndexes
+ * @param list $nodeAttributes
*/
- public function testLinesAndIndexes(string $phpDoc, array $childrenLines): void
+ public function testDeepNodesLinesAndIndexes(string $phpDoc, array $nodeAttributes): void
{
$tokens = new TokenIterator($this->lexer->tokenize($phpDoc));
- $usedAttributes = [
+ $config = new ParserConfig([
'lines' => true,
'indexes' => true,
- ];
- $constExprParser = new ConstExprParser(true, true, $usedAttributes);
- $typeParser = new TypeParser($constExprParser, true, $usedAttributes);
- $phpDocParser = new PhpDocParser($typeParser, $constExprParser, true, true, $usedAttributes);
- $phpDocNode = $phpDocParser->parse($tokens);
- $children = $phpDocNode->children;
- $this->assertCount(count($childrenLines), $children);
- foreach ($children as $i => $child) {
- $this->assertSame($childrenLines[$i][0], $child->getAttribute(Attribute::START_LINE));
- $this->assertSame($childrenLines[$i][1], $child->getAttribute(Attribute::END_LINE));
- $this->assertSame($childrenLines[$i][2], $child->getAttribute(Attribute::START_INDEX));
- $this->assertSame($childrenLines[$i][3], $child->getAttribute(Attribute::END_INDEX));
+ ]);
+ $constExprParser = new ConstExprParser($config);
+ $typeParser = new TypeParser($config, $constExprParser);
+ $phpDocParser = new PhpDocParser($config, $typeParser, $constExprParser);
+ $visitor = new NodeCollectingVisitor();
+ $traverser = new NodeTraverser([$visitor]);
+ $traverser->traverse([$phpDocParser->parse($tokens)]);
+ $nodes = $visitor->nodes;
+ $this->assertCount(count($nodeAttributes), $nodes);
+ foreach ($nodes as $i => $node) {
+ $this->assertSame($nodeAttributes[$i][0], $node->getAttribute(Attribute::START_LINE), sprintf('Start line of %d. node', $i + 1));
+ $this->assertSame($nodeAttributes[$i][1], $node->getAttribute(Attribute::END_LINE), sprintf('End line of %d. node', $i + 1));
+ $this->assertSame($nodeAttributes[$i][2], $node->getAttribute(Attribute::START_INDEX), sprintf('Start index of %d. node', $i + 1));
+ $this->assertSame($nodeAttributes[$i][3], $node->getAttribute(Attribute::END_INDEX), sprintf('End index of %d. node', $i + 1));
}
}
@@ -5744,13 +7689,13 @@ public function dataReturnTypeLinesAndIndexes(): iterable
public function testReturnTypeLinesAndIndexes(string $phpDoc, array $lines): void
{
$tokens = new TokenIterator($this->lexer->tokenize($phpDoc));
- $usedAttributes = [
+ $config = new ParserConfig([
'lines' => true,
'indexes' => true,
- ];
- $constExprParser = new ConstExprParser(true, true, $usedAttributes);
- $typeParser = new TypeParser($constExprParser, true, $usedAttributes);
- $phpDocParser = new PhpDocParser($typeParser, $constExprParser, true, true, $usedAttributes);
+ ]);
+ $constExprParser = new ConstExprParser($config);
+ $typeParser = new TypeParser($config, $constExprParser);
+ $phpDocParser = new PhpDocParser($config, $typeParser, $constExprParser);
$phpDocNode = $phpDocParser->parse($tokens);
$returnTag = $phpDocNode->getReturnTagValues()[0];
$type = $returnTag->type;
@@ -5767,6 +7712,9 @@ public function testReturnTypeLinesAndIndexes(string $phpDoc, array $lines): voi
* @dataProvider provideSpecializedTags
* @dataProvider provideParamTagsData
* @dataProvider provideTypelessParamTagsData
+ * @dataProvider provideParamImmediatelyInvokedCallableTagsData
+ * @dataProvider provideParamLaterInvokedCallableTagsData
+ * @dataProvider provideParamClosureThisTagsData
* @dataProvider provideVarTagsData
* @dataProvider provideReturnTagsData
* @dataProvider provideThrowsTagsData
@@ -5786,13 +7734,18 @@ public function testReturnTypeLinesAndIndexes(string $phpDoc, array $lines): voi
* @dataProvider provideTagsWithBackslash
* @dataProvider provideSelfOutTagsData
* @dataProvider provideParamOutTagsData
+ * @dataProvider provideDoctrineData
+ * @dataProvider provideDoctrineWithoutDoctrineCheckData
*/
public function testVerifyAttributes(string $label, string $input): void
{
- $usedAttributes = ['lines' => true, 'indexes' => true];
- $constExprParser = new ConstExprParser(true, true, $usedAttributes);
- $typeParser = new TypeParser($constExprParser, true, $usedAttributes);
- $phpDocParser = new PhpDocParser($typeParser, $constExprParser, true, true, $usedAttributes);
+ $config = new ParserConfig([
+ 'lines' => true,
+ 'indexes' => true,
+ ]);
+ $constExprParser = new ConstExprParser($config);
+ $typeParser = new TypeParser($config, $constExprParser);
+ $phpDocParser = new PhpDocParser($config, $typeParser, $constExprParser);
$tokens = new TokenIterator($this->lexer->tokenize($input));
$visitor = new NodeCollectingVisitor();
@@ -5807,4 +7760,368 @@ public function testVerifyAttributes(string $label, string $input): void
}
}
+ /**
+ * @dataProvider provideDoctrineData
+ * @param list