Skip to content

Commit e99bce9

Browse files
ondrejmirtesondrejmirtes
committed
[BCB] ArrayShapeNode constructor made private, added public static methods createSealed() and createUnsealed() 
1 parent 1a0544c commit e99bce9

File tree

7 files changed

+113
-107
lines changed

7 files changed

+113
-107
lines changed

‎UPGRADING.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,10 @@ Multi-line descriptions between tags were previously represented as separate [Ph
114114

115115
The line with `some text in the middle` in phpdoc-parser 2.0 is now part of the description of the first `@param` tag.
116116

117+
### `ArrayShapeNode` construction changes
118+
119+
`ArrayShapeNode` constructor made private, added public static methods `createSealed()` and `createUnsealed()`.
120+
117121
### Minor BC breaks
118122

119123
* Constructor parameter `$isEquality` in `AssertTag*ValueNode` made required

‎src/Ast/Type/ArrayShapeNode.php‎

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,36 @@ class ArrayShapeNode implements TypeNode
2727
* @param ArrayShapeItemNode[] $items
2828
* @param self::KIND_* $kind
2929
*/
30-
public function __construct(
30+
private function __construct(
3131
array $items,
3232
bool $sealed = true,
33-
string $kind = self::KIND_ARRAY,
34-
?ArrayShapeUnsealedTypeNode $unsealedType = null
33+
?ArrayShapeUnsealedTypeNode $unsealedType = null,
34+
string $kind = self::KIND_ARRAY
3535
)
3636
{
3737
$this->items = $items;
3838
$this->sealed = $sealed;
39-
$this->kind = $kind;
4039
$this->unsealedType = $unsealedType;
40+
$this->kind = $kind;
41+
}
42+
43+
44+
/**
45+
* @param ArrayShapeItemNode[] $items
46+
* @param self::KIND_* $kind
47+
*/
48+
public static function createSealed(array $items, string $kind = self::KIND_ARRAY): self
49+
{
50+
return new self($items, true, null, $kind);
51+
}
52+
53+
/**
54+
* @param ArrayShapeItemNode[] $items
55+
* @param self::KIND_* $kind
56+
*/
57+
public static function createUnsealed(array $items, ?ArrayShapeUnsealedTypeNode $unsealedType, string $kind = self::KIND_ARRAY): self
58+
{
59+
return new self($items, false, $unsealedType, $kind);
4160
}
4261

4362

‎src/Parser/TypeParser.php‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -818,7 +818,7 @@ private function parseArrayShape(TokenIterator $tokens, Ast\Type\TypeNode $type,
818818
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
819819

820820
if ($tokens->tryConsumeTokenType(Lexer::TOKEN_CLOSE_CURLY_BRACKET)) {
821-
return new Ast\Type\ArrayShapeNode($items, true, $kind);
821+
return Ast\Type\ArrayShapeNode::createSealed($items, $kind);
822822
}
823823

824824
if ($tokens->tryConsumeTokenType(Lexer::TOKEN_VARIADIC)) {
@@ -846,7 +846,11 @@ private function parseArrayShape(TokenIterator $tokens, Ast\Type\TypeNode $type,
846846
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
847847
$tokens->consumeTokenType(Lexer::TOKEN_CLOSE_CURLY_BRACKET);
848848

849-
return new Ast\Type\ArrayShapeNode($items, $sealed, $kind, $unsealedType);
849+
if ($sealed) {
850+
return Ast\Type\ArrayShapeNode::createSealed($items, $kind);
851+
}
852+
853+
return Ast\Type\ArrayShapeNode::createUnsealed($items, $unsealedType, $kind);
850854
}
851855

852856

‎tests/PHPStan/Ast/ToString/TypeToStringTest.php‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,31 +58,31 @@ public static function provideArrayCases(): Generator
5858
];
5959

6060
yield from [
61-
['array{}', new ArrayShapeNode([])],
62-
['array{...}', new ArrayShapeNode([], false)],
61+
['array{}', ArrayShapeNode::createSealed([])],
62+
['array{...}', ArrayShapeNode::createUnsealed([], null)],
6363
[
6464
'array{string, int, ...}',
65-
new ArrayShapeNode([
65+
ArrayShapeNode::createUnsealed([
6666
new ArrayShapeItemNode(null, false, new IdentifierTypeNode('string')),
6767
new ArrayShapeItemNode(null, false, new IdentifierTypeNode('int')),
68-
], false),
68+
], null),
6969
],
7070
[
7171
'array{\'foo\': Foo, \'bar\'?: Bar, 1: Baz}',
72-
new ArrayShapeNode([
72+
ArrayShapeNode::createSealed([
7373
new ArrayShapeItemNode(new ConstExprStringNode('foo', ConstExprStringNode::SINGLE_QUOTED), false, new IdentifierTypeNode('Foo')),
7474
new ArrayShapeItemNode(new ConstExprStringNode('bar', ConstExprStringNode::SINGLE_QUOTED), true, new IdentifierTypeNode('Bar')),
7575
new ArrayShapeItemNode(new ConstExprIntegerNode('1'), false, new IdentifierTypeNode('Baz')),
7676
]),
7777
],
78-
['list{}', new ArrayShapeNode([], true, 'list')],
79-
['list{...}', new ArrayShapeNode([], false, 'list')],
78+
['list{}', ArrayShapeNode::createSealed([], 'list')],
79+
['list{...}', ArrayShapeNode::createUnsealed([], null, 'list')],
8080
[
8181
'list{string, int, ...}',
82-
new ArrayShapeNode([
82+
ArrayShapeNode::createUnsealed([
8383
new ArrayShapeItemNode(null, false, new IdentifierTypeNode('string')),
8484
new ArrayShapeItemNode(null, false, new IdentifierTypeNode('int')),
85-
], false, 'list'),
85+
], null, 'list'),
8686
],
8787
];
8888
}

‎tests/PHPStan/Parser/PhpDocParserTest.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4507,7 +4507,7 @@ public function provideTypeAliasTagsData(): Iterator
45074507
'@phpstan-type',
45084508
new TypeAliasTagValueNode(
45094509
'Foo',
4510-
new ArrayShapeNode([]),
4510+
ArrayShapeNode::createSealed([]),
45114511
),
45124512
),
45134513
new PhpDocTagNode(
@@ -4539,7 +4539,7 @@ public function provideTypeAliasTagsData(): Iterator
45394539
'@phpstan-type',
45404540
new TypeAliasTagValueNode(
45414541
'Foo',
4542-
new ArrayShapeNode([]),
4542+
ArrayShapeNode::createSealed([]),
45434543
),
45444544
),
45454545
new PhpDocTagNode(
@@ -4560,7 +4560,7 @@ public function provideTypeAliasTagsData(): Iterator
45604560
'@phpstan-type',
45614561
new TypeAliasTagValueNode(
45624562
'Bar',
4563-
new ArrayShapeNode([]),
4563+
ArrayShapeNode::createSealed([]),
45644564
),
45654565
),
45664566
]),
@@ -5505,7 +5505,7 @@ public function provideRealWorldExampleData(): Iterator
55055505
[
55065506
new IdentifierTypeNode('array-key'),
55075507
new UnionTypeNode([
5508-
new ArrayShapeNode([
5508+
ArrayShapeNode::createSealed([
55095509
new ArrayShapeItemNode(null, false, new IdentifierTypeNode('string')),
55105510
new ArrayShapeItemNode(
55115511
null,
@@ -5516,7 +5516,7 @@ public function provideRealWorldExampleData(): Iterator
55165516
]),
55175517
),
55185518
]),
5519-
new ArrayShapeNode([
5519+
ArrayShapeNode::createSealed([
55205520
new ArrayShapeItemNode(null, false, new ConstTypeNode(new ConstExprStringNode('', ConstExprStringNode::SINGLE_QUOTED))),
55215521
new ArrayShapeItemNode(null, false, new ConstTypeNode(new ConstExprIntegerNode('-1'))),
55225522
]),
@@ -5552,7 +5552,7 @@ public function provideRealWorldExampleData(): Iterator
55525552
[
55535553
new IdentifierTypeNode('array-key'),
55545554
new UnionTypeNode([
5555-
new ArrayShapeNode([
5555+
ArrayShapeNode::createSealed([
55565556
new ArrayShapeItemNode(null, false, new IdentifierTypeNode('string')),
55575557
new ArrayShapeItemNode(
55585558
null,
@@ -5563,7 +5563,7 @@ public function provideRealWorldExampleData(): Iterator
55635563
]),
55645564
),
55655565
]),
5566-
new ArrayShapeNode([
5566+
ArrayShapeNode::createSealed([
55675567
new ArrayShapeItemNode(null, false, new IdentifierTypeNode('null')),
55685568
new ArrayShapeItemNode(null, false, new ConstTypeNode(new ConstExprIntegerNode('-1'))),
55695569
]),

0 commit comments

Comments
 (0)