Skip to content

Support multiline callable syntax #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 28, 2022
Merged

Support multiline callable syntax #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/Parser/TypeParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,12 +240,19 @@ public function parseGeneric(TokenIterator $tokens, Ast\Type\IdentifierTypeNode
private function parseCallable(TokenIterator $tokens, Ast\Type\IdentifierTypeNode $identifier): Ast\Type\TypeNode
{
$tokens->consumeTokenType(Lexer::TOKEN_OPEN_PARENTHESES);
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);

$parameters = [];
if (!$tokens->isCurrentTokenType(Lexer::TOKEN_CLOSE_PARENTHESES)) {
$parameters[] = $this->parseCallableParameter($tokens);
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
while ($tokens->tryConsumeTokenType(Lexer::TOKEN_COMMA)) {
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
if ($tokens->isCurrentTokenType(Lexer::TOKEN_CLOSE_PARENTHESES)) {
break;
}
$parameters[] = $this->parseCallableParameter($tokens);
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
}
}

Expand Down
83 changes: 83 additions & 0 deletions tests/PHPStan/Parser/PhpDocParserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3492,6 +3492,89 @@ public function provideRealWorldExampleData(): Iterator
),
]),
];

yield [
'multiline callable types',
'/**' . PHP_EOL .
' * @param callable(' . PHP_EOL .
' * A, B' . PHP_EOL .
' * ): void $foo' . PHP_EOL .
' */',
new PhpDocNode([
new PhpDocTagNode(
'@param',
new ParamTagValueNode(
new CallableTypeNode(
new IdentifierTypeNode('callable'),
[
new CallableTypeParameterNode(new IdentifierTypeNode('A'), false, false, '', false),
new CallableTypeParameterNode(new IdentifierTypeNode('B'), false, false, '', false),
],
new IdentifierTypeNode('void')
),
false,
'$foo',
''
)
),
]),
];

yield [
'multiline callable types - leading comma',
'/**' . PHP_EOL .
' * @param callable(' . PHP_EOL .
' * A' . PHP_EOL .
' * , B' . PHP_EOL .
' * ): void $foo' . PHP_EOL .
' */',
new PhpDocNode([
new PhpDocTagNode(
'@param',
new ParamTagValueNode(
new CallableTypeNode(
new IdentifierTypeNode('callable'),
[
new CallableTypeParameterNode(new IdentifierTypeNode('A'), false, false, '', false),
new CallableTypeParameterNode(new IdentifierTypeNode('B'), false, false, '', false),
],
new IdentifierTypeNode('void')
),
false,
'$foo',
''
)
),
]),
];

yield [
'multiline callable types - traling comma',
'/**' . PHP_EOL .
' * @param callable(' . PHP_EOL .
' * A,' . PHP_EOL .
' * B,' . PHP_EOL .
' * ): void $foo' . PHP_EOL .
' */',
new PhpDocNode([
new PhpDocTagNode(
'@param',
new ParamTagValueNode(
new CallableTypeNode(
new IdentifierTypeNode('callable'),
[
new CallableTypeParameterNode(new IdentifierTypeNode('A'), false, false, '', false),
new CallableTypeParameterNode(new IdentifierTypeNode('B'), false, false, '', false),
],
new IdentifierTypeNode('void')
),
false,
'$foo',
''
)
),
]),
];
}

public function provideDescriptionWithOrWithoutHtml(): Iterator
Expand Down
95 changes: 95 additions & 0 deletions tests/PHPStan/Parser/TypeParserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1004,6 +1004,101 @@ public function provideParseData(): array
'int|array{}',
new UnionTypeNode([new IdentifierTypeNode('int'), new ArrayShapeNode([])]),
],
[
'callable(' . PHP_EOL .
' Foo' . PHP_EOL .
'): void',
new CallableTypeNode(
new IdentifierTypeNode('callable'),
[
new CallableTypeParameterNode(new IdentifierTypeNode('Foo'), false, false, '', false),
],
new IdentifierTypeNode('void')
),
],
[
'callable(' . PHP_EOL .
' Foo,' . PHP_EOL .
' Bar' . PHP_EOL .
'): void',
new CallableTypeNode(
new IdentifierTypeNode('callable'),
[
new CallableTypeParameterNode(new IdentifierTypeNode('Foo'), false, false, '', false),
new CallableTypeParameterNode(new IdentifierTypeNode('Bar'), false, false, '', false),
],
new IdentifierTypeNode('void')
),
],
[
'callable(' . PHP_EOL .
' Foo, Bar' . PHP_EOL .
'): void',
new CallableTypeNode(
new IdentifierTypeNode('callable'),
[
new CallableTypeParameterNode(new IdentifierTypeNode('Foo'), false, false, '', false),
new CallableTypeParameterNode(new IdentifierTypeNode('Bar'), false, false, '', false),
],
new IdentifierTypeNode('void')
),
],
[
'callable(' . PHP_EOL .
' Foo,' . PHP_EOL .
' callable(' . PHP_EOL .
' Bar' . PHP_EOL .
' ): void' . PHP_EOL .
'): void',
new CallableTypeNode(
new IdentifierTypeNode('callable'),
[
new CallableTypeParameterNode(new IdentifierTypeNode('Foo'), false, false, '', false),
new CallableTypeParameterNode(
new CallableTypeNode(
new IdentifierTypeNode('callable'),
[
new CallableTypeParameterNode(new IdentifierTypeNode('Bar'), false, false, '', false),
],
new IdentifierTypeNode('void')
),
false,
false,
'',
false
),
],
new IdentifierTypeNode('void')
),
],
[
'callable(' . PHP_EOL .
' Foo,' . PHP_EOL .
' callable(' . PHP_EOL .
' Bar,' . PHP_EOL .
' ): void' . PHP_EOL .
'): void',
new CallableTypeNode(
new IdentifierTypeNode('callable'),
[
new CallableTypeParameterNode(new IdentifierTypeNode('Foo'), false, false, '', false),
new CallableTypeParameterNode(
new CallableTypeNode(
new IdentifierTypeNode('callable'),
[
new CallableTypeParameterNode(new IdentifierTypeNode('Bar'), false, false, '', false),
],
new IdentifierTypeNode('void')
),
false,
false,
'',
false
),
],
new IdentifierTypeNode('void')
),
],
];
}

Expand Down