[TypeInfo] Add ArrayShapeType::$sealed

mtarld · mtarld · commit 9030a26a45e6 · 2025-03-16T13:04:23.000+01:00
diff --git a/src/Symfony/Component/TypeInfo/Tests/Type/ArrayShapeTypeTest.php b/src/Symfony/Component/TypeInfo/Tests/Type/ArrayShapeTypeTest.php
@@ -76,6 +76,12 @@ public function testAccepts()
 
         $this->assertTrue($type->accepts(['foo' => true]));
         $this->assertTrue($type->accepts(['foo' => true, 'bar' => 'string']));
+
+        $type = new ArrayShapeType(['foo' => ['type' => Type::bool()]], sealed: false);
+
+        $this->assertTrue($type->accepts(['foo' => true, 'other' => 'string']));
+        $this->assertTrue($type->accepts(['other' => 'string', 'foo' => true]));
+        $this->assertFalse($type->accepts(['other' => 'string', 'foo' => 'foo']));
     }
 
     public function testToString()
@@ -94,5 +100,10 @@ public function testToString()
             'bar' => ['type' => Type::string(), 'optional' => true],
         ]);
         $this->assertSame("array{'bar'?: string, 'foo': bool}", (string) $type);
+
+        $type = new ArrayShapeType([
+            'foo' => ['type' => Type::bool()],
+        ], sealed: false);
+        $this->assertSame("array{'foo': bool, ...}", (string) $type);
     }
 }
diff --git a/src/Symfony/Component/TypeInfo/Tests/TypeResolver/StringTypeResolverTest.php b/src/Symfony/Component/TypeInfo/Tests/TypeResolver/StringTypeResolverTest.php
@@ -76,6 +76,7 @@ public static function resolveDataProvider(): iterable
         // array shape
         yield [Type::arrayShape(['foo' => Type::true(), 1 => Type::false()]), 'array{foo: true, 1: false}'];
         yield [Type::arrayShape(['foo' => ['type' => Type::bool(), 'optional' => true]]), 'array{foo?: bool}'];
+        yield [Type::arrayShape(['foo' => Type::bool()], sealed: false), 'array{foo: bool, ...}'];
 
         // object shape
         yield [Type::object(), 'object{foo: true, bar: false}'];
diff --git a/src/Symfony/Component/TypeInfo/Type/ArrayShapeType.php b/src/Symfony/Component/TypeInfo/Type/ArrayShapeType.php
@@ -31,8 +31,10 @@ final class ArrayShapeType extends CollectionType
     /**
      * @param array<array{type: Type, optional: bool}> $shape
      */
-    public function __construct(array $shape)
-    {
+    public function __construct(
+        array $shape,
+        private readonly bool $sealed = true,
+    ) {
         $keyTypes = [];
         $valueTypes = [];
 
@@ -66,6 +68,11 @@ public function getShape(): array
         return $this->shape;
     }
 
+    public function isSealed(): bool
+    {
+        return $this->sealed;
+    }
+
     public function accepts(mixed $value): bool
     {
         if (!\is_array($value)) {
@@ -80,11 +87,12 @@ public function accepts(mixed $value): bool
 
         foreach ($value as $key => $itemValue) {
             $valueType = $this->shape[$key]['type'] ?? false;
-            if (!$valueType) {
+
+            if ($valueType && !$valueType->accepts($itemValue)) {
                 return false;
             }
 
-            if (!$valueType->accepts($itemValue)) {
+            if (!$valueType && $this->sealed) {
                 return false;
             }
         }
@@ -105,6 +113,10 @@ public function __toString(): string
             $items[] = \sprintf('%s: %s', $itemKey, $value['type']);
         }
 
+        if (!$this->sealed) {
+            $items[] = '...';
+        }
+
         return \sprintf('array{%s}', implode(', ', $items));
     }
 }
diff --git a/src/Symfony/Component/TypeInfo/TypeFactoryTrait.php b/src/Symfony/Component/TypeInfo/TypeFactoryTrait.php
@@ -198,13 +198,13 @@ public static function dict(?Type $value = null): CollectionType
     /**
      * @param array<array{type: Type, optional?: bool}|Type> $shape
      */
-    public static function arrayShape(array $shape): ArrayShapeType
+    public static function arrayShape(array $shape, bool $sealed = true): ArrayShapeType
     {
         return new ArrayShapeType(array_map(static function (array|Type $item): array {
             return $item instanceof Type
                 ? ['type' => $item, 'optional' => false]
                 : ['type' => $item['type'], 'optional' => $item['optional'] ?? false];
-        }, $shape));
+        }, $shape), $sealed);
     }
 
     /**
diff --git a/src/Symfony/Component/TypeInfo/TypeResolver/StringTypeResolver.php b/src/Symfony/Component/TypeInfo/TypeResolver/StringTypeResolver.php
@@ -110,7 +110,7 @@ private function getTypeFromNode(TypeNode $node, ?TypeContext $typeContext): Typ
                 ];
             }
 
-            return Type::arrayShape($shape);
+            return Type::arrayShape($shape, $node->sealed);
         }
 
         if ($node instanceof ObjectShapeNode) {

Original file line number	Diff line number	Diff line change
`@@ -31,8 +31,10 @@ final class ArrayShapeType extends CollectionType`
`31`	`31`	`/**`
`32`	`32`	`* @param array<array{type: Type, optional: bool}> $shape`
`33`	`33`	`*/`
`34`		`- public function __construct(array $shape)`
`35`		`- {`
	`34`	`+ public function __construct(`
	`35`	`+ array $shape,`
	`36`	`+ private readonly bool $sealed = true,`
	`37`	`+ ) {`
`36`	`38`	`$keyTypes = [];`
`37`	`39`	`$valueTypes = [];`
`38`	`40`
`@@ -66,6 +68,11 @@ public function getShape(): array`
`66`	`68`	`return $this->shape;`
`67`	`69`	`}`
`68`	`70`
	`71`	`+ public function isSealed(): bool`
	`72`	`+ {`
	`73`	`+ return $this->sealed;`
	`74`	`+ }`
	`75`	`+`
`69`	`76`	`public function accepts(mixed $value): bool`
`70`	`77`	`{`
`71`	`78`	`if (!\is_array($value)) {`
`@@ -80,11 +87,12 @@ public function accepts(mixed $value): bool`
`80`	`87`
`81`	`88`	`foreach ($value as $key => $itemValue) {`
`82`	`89`	`$valueType = $this->shape[$key]['type'] ?? false;`
`83`		`- if (!$valueType) {`
	`90`	`+`
	`91`	`+ if ($valueType && !$valueType->accepts($itemValue)) {`
`84`	`92`	`return false;`
`85`	`93`	`}`
`86`	`94`
`87`		`- if (!$valueType->accepts($itemValue)) {`
	`95`	`+ if (!$valueType && $this->sealed) {`
`88`	`96`	`return false;`
`89`	`97`	`}`
`90`	`98`	`}`
`@@ -105,6 +113,10 @@ public function __toString(): string`
`105`	`113`	`$items[] = \sprintf('%s: %s', $itemKey, $value['type']);`
`106`	`114`	`}`
`107`	`115`
	`116`	`+ if (!$this->sealed) {`
	`117`	`+ $items[] = '...';`
	`118`	`+ }`
	`119`	`+`
`108`	`120`	`return \sprintf('array{%s}', implode(', ', $items));`
`109`	`121`	`}`
`110`	`122`	`}`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ private function getTypeFromNode(TypeNode $node, ?TypeContext $typeContext): Typ`
`110`	`110`	`];`
`111`	`111`	`}`
`112`	`112`
`113`		`- return Type::arrayShape($shape);`
	`113`	`+ return Type::arrayShape($shape, $node->sealed);`
`114`	`114`	`}`
`115`	`115`
`116`	`116`	`if ($node instanceof ObjectShapeNode) {`