feature #60087 [TypeInfo] add TypeFactoryTrait::arrayKey() (xabbuh)

GromNaN · GromNaN · commit 4ca9c2ddf93d · 2025-03-31T10:07:52.000+02:00
This PR was merged into the 7.3 branch. Discussion ---------- [TypeInfo] add TypeFactoryTrait::arrayKey() | Q | A | ------------- | --- | Branch? | 7.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | | License | MIT reading the latest PRs about array shapes I wondered if it wouldn't be useful to have a dedicated method for the array key types supported by PHP Commits ------- 8b4d5a2 add TypeFactoryTrait::arrayKey()
diff --git a/src/Symfony/Component/TypeInfo/CHANGELOG.md b/src/Symfony/Component/TypeInfo/CHANGELOG.md
@@ -5,7 +5,7 @@ CHANGELOG
 ---
 
  * Add `Type::accepts()` method
- * Add `TypeFactoryTrait::fromValue()` method
+ * Add the `TypeFactoryTrait::fromValue()`, `TypeFactoryTrait::arrayShape()`, and `TypeFactoryTrait::arrayKey()` methods
  * Deprecate constructing a `CollectionType` instance as a list that is not an array
  * Deprecate the third `$asList` argument of `TypeFactoryTrait::iterable()`, use `TypeFactoryTrait::list()` instead
  * Add type alias support in `TypeContext` and `StringTypeResolver`
diff --git a/src/Symfony/Component/TypeInfo/Tests/Type/ArrayShapeTypeTest.php b/src/Symfony/Component/TypeInfo/Tests/Type/ArrayShapeTypeTest.php
@@ -59,7 +59,7 @@ public function testGetCollectionKeyType()
             1 => ['type' => Type::bool(), 'optional' => false],
             'foo' => ['type' => Type::bool(), 'optional' => false],
         ]);
-        $this->assertEquals(Type::union(Type::int(), Type::string()), $type->getCollectionKeyType());
+        $this->assertEquals(Type::arrayKey(), $type->getCollectionKeyType());
     }
 
     public function testGetCollectionValueType()
@@ -134,7 +134,7 @@ public function testToString()
 
         $type = new ArrayShapeType(
             shape: ['foo' => ['type' => Type::bool()]],
-            extraKeyType: Type::union(Type::int(), Type::string()),
+            extraKeyType: Type::arrayKey(),
             extraValueType: Type::mixed(),
         );
         $this->assertSame("array{'foo': bool, ...}", (string) $type);
diff --git a/src/Symfony/Component/TypeInfo/Tests/Type/CollectionTypeTest.php b/src/Symfony/Component/TypeInfo/Tests/Type/CollectionTypeTest.php
@@ -50,7 +50,7 @@ public function testIsList()
     public function testGetCollectionKeyType()
     {
         $type = new CollectionType(Type::builtin(TypeIdentifier::ARRAY));
-        $this->assertEquals(Type::union(Type::int(), Type::string()), $type->getCollectionKeyType());
+        $this->assertEquals(Type::arrayKey(), $type->getCollectionKeyType());
 
         $type = new CollectionType(Type::generic(Type::builtin(TypeIdentifier::ARRAY), Type::bool()));
         $this->assertEquals(Type::int(), $type->getCollectionKeyType());
diff --git a/src/Symfony/Component/TypeInfo/Tests/TypeFactoryTest.php b/src/Symfony/Component/TypeInfo/Tests/TypeFactoryTest.php
@@ -212,7 +212,7 @@ public function testCreateArrayShape()
         $this->assertEquals(new ArrayShapeType(['foo' => ['type' => Type::bool(), 'optional' => false]]), Type::arrayShape(['foo' => Type::bool()]));
         $this->assertEquals(new ArrayShapeType(
             shape: ['foo' => ['type' => Type::bool(), 'optional' => false]],
-            extraKeyType: Type::union(Type::int(), Type::string()),
+            extraKeyType: Type::arrayKey(),
             extraValueType: Type::mixed(),
         ), Type::arrayShape(['foo' => Type::bool()], sealed: false));
         $this->assertEquals(new ArrayShapeType(
@@ -222,6 +222,11 @@ public function testCreateArrayShape()
         ), Type::arrayShape(['foo' => Type::bool()], extraKeyType: Type::string(), extraValueType: Type::bool()));
     }
 
+    public function testCreateArrayKey()
+    {
+        $this->assertEquals(new UnionType(Type::int(), Type::string()), Type::arrayKey());
+    }
+
     /**
      * @dataProvider createFromValueProvider
      */
@@ -275,7 +280,7 @@ public function offsetUnset(mixed $offset): void
         yield [Type::dict(Type::bool()), ['a' => true, 'b' => false]];
         yield [Type::array(Type::string()), [1 => 'foo', 'bar' => 'baz']];
         yield [Type::array(Type::nullable(Type::bool()), Type::int()), [1 => true, 2 => null, 3 => false]];
-        yield [Type::collection(Type::object(\ArrayIterator::class), Type::mixed(), Type::union(Type::int(), Type::string())), new \ArrayIterator()];
+        yield [Type::collection(Type::object(\ArrayIterator::class), Type::mixed(), Type::arrayKey()), new \ArrayIterator()];
         yield [Type::collection(Type::object(\Generator::class), Type::string(), Type::int()), (fn (): iterable => yield 'string')()];
         yield [Type::collection(Type::object($arrayAccess::class)), $arrayAccess];
     }
diff --git a/src/Symfony/Component/TypeInfo/Tests/TypeResolver/StringTypeResolverTest.php b/src/Symfony/Component/TypeInfo/Tests/TypeResolver/StringTypeResolverTest.php
@@ -137,7 +137,7 @@ public static function resolveDataProvider(): iterable
         yield [Type::never(), 'never-return'];
         yield [Type::never(), 'never-returns'];
         yield [Type::never(), 'no-return'];
-        yield [Type::union(Type::int(), Type::string()), 'array-key'];
+        yield [Type::arrayKey(), 'array-key'];
         yield [Type::union(Type::int(), Type::float(), Type::string(), Type::bool()), 'scalar'];
         yield [Type::union(Type::int(), Type::float()), 'number'];
         yield [Type::union(Type::int(), Type::float(), Type::string()), 'numeric'];
diff --git a/src/Symfony/Component/TypeInfo/Type/ArrayShapeType.php b/src/Symfony/Component/TypeInfo/Type/ArrayShapeType.php
@@ -49,7 +49,7 @@ public function __construct(
             $keyTypes = array_values(array_unique($keyTypes));
             $keyType = \count($keyTypes) > 1 ? self::union(...$keyTypes) : $keyTypes[0];
         } else {
-            $keyType = Type::union(Type::int(), Type::string());
+            $keyType = Type::arrayKey();
         }
 
         $valueType = $valueTypes ? CollectionType::mergeCollectionValueTypes($valueTypes) : Type::mixed();
diff --git a/src/Symfony/Component/TypeInfo/Type/CollectionType.php b/src/Symfony/Component/TypeInfo/Type/CollectionType.php
@@ -117,7 +117,7 @@ public function isList(): bool
 
     public function getCollectionKeyType(): Type
     {
-        $defaultCollectionKeyType = self::union(self::int(), self::string());
+        $defaultCollectionKeyType = self::arrayKey();
 
         if ($this->type instanceof GenericType) {
             return match (\count($this->type->getVariableTypes())) {
diff --git a/src/Symfony/Component/TypeInfo/TypeFactoryTrait.php b/src/Symfony/Component/TypeInfo/TypeFactoryTrait.php
@@ -153,7 +153,7 @@ public static function never(): BuiltinType
     public static function collection(BuiltinType|ObjectType|GenericType $type, ?Type $value = null, ?Type $key = null, bool $asList = false): CollectionType
     {
         if (!$type instanceof GenericType && (null !== $value || null !== $key)) {
-            $type = self::generic($type, $key ?? self::union(self::int(), self::string()), $value ?? self::mixed());
+            $type = self::generic($type, $key ?? self::arrayKey(), $value ?? self::mixed());
         }
 
         return new CollectionType($type, $asList);
@@ -210,12 +210,17 @@ public static function arrayShape(array $shape, bool $sealed = true, ?Type $extr
             $sealed = false;
         }
 
-        $extraKeyType ??= !$sealed ? Type::union(Type::int(), Type::string()) : null;
+        $extraKeyType ??= !$sealed ? Type::arrayKey() : null;
         $extraValueType ??= !$sealed ? Type::mixed() : null;
 
         return new ArrayShapeType($shape, $extraKeyType, $extraValueType);
     }
 
+    public static function arrayKey(): UnionType
+    {
+        return self::union(self::int(), self::string());
+    }
+
     /**
      * @template T of class-string
      *
@@ -434,7 +439,7 @@ public static function fromValue(mixed $value): Type
                 $keyTypes = array_values(array_unique($keyTypes));
                 $keyType = \count($keyTypes) > 1 ? self::union(...$keyTypes) : $keyTypes[0];
             } else {
-                $keyType = Type::union(Type::int(), Type::string());
+                $keyType = Type::arrayKey();
             }
 
             $valueType = $valueTypes ? CollectionType::mergeCollectionValueTypes($valueTypes) : Type::mixed();
diff --git a/src/Symfony/Component/TypeInfo/TypeResolver/StringTypeResolver.php b/src/Symfony/Component/TypeInfo/TypeResolver/StringTypeResolver.php
@@ -171,7 +171,7 @@ private function getTypeFromNode(TypeNode $node, ?TypeContext $typeContext): Typ
                 'iterable' => Type::iterable(),
                 'mixed' => Type::mixed(),
                 'null' => Type::null(),
-                'array-key' => Type::union(Type::int(), Type::string()),
+                'array-key' => Type::arrayKey(),
                 'scalar' => Type::union(Type::int(), Type::float(), Type::string(), Type::bool()),
                 'number' => Type::union(Type::int(), Type::float()),
                 'numeric' => Type::union(Type::int(), Type::float(), Type::string()),

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public function testIsList()`
`50`	`50`	`public function testGetCollectionKeyType()`
`51`	`51`	`{`
`52`	`52`	`$type = new CollectionType(Type::builtin(TypeIdentifier::ARRAY));`
`53`		`- $this->assertEquals(Type::union(Type::int(), Type::string()), $type->getCollectionKeyType());`
	`53`	`+ $this->assertEquals(Type::arrayKey(), $type->getCollectionKeyType());`
`54`	`54`
`55`	`55`	`$type = new CollectionType(Type::generic(Type::builtin(TypeIdentifier::ARRAY), Type::bool()));`
`56`	`56`	`$this->assertEquals(Type::int(), $type->getCollectionKeyType());`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public function __construct(`
`49`	`49`	`$keyTypes = array_values(array_unique($keyTypes));`
`50`	`50`	`$keyType = \count($keyTypes) > 1 ? self::union(...$keyTypes) : $keyTypes[0];`
`51`	`51`	`} else {`
`52`		`- $keyType = Type::union(Type::int(), Type::string());`
	`52`	`+ $keyType = Type::arrayKey();`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`$valueType = $valueTypes ? CollectionType::mergeCollectionValueTypes($valueTypes) : Type::mixed();`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ public function isList(): bool`
`117`	`117`
`118`	`118`	`public function getCollectionKeyType(): Type`
`119`	`119`	`{`
`120`		`- $defaultCollectionKeyType = self::union(self::int(), self::string());`
	`120`	`+ $defaultCollectionKeyType = self::arrayKey();`
`121`	`121`
`122`	`122`	`if ($this->type instanceof GenericType) {`
`123`	`123`	`return match (\count($this->type->getVariableTypes())) {`
Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ public static function never(): BuiltinType`
`153`	`153`	`public static function collection(BuiltinType\|ObjectType\|GenericType $type, ?Type $value = null, ?Type $key = null, bool $asList = false): CollectionType`
`154`	`154`	`{`
`155`	`155`	`if (!$type instanceof GenericType && (null !== $value \|\| null !== $key)) {`
`156`		`- $type = self::generic($type, $key ?? self::union(self::int(), self::string()), $value ?? self::mixed());`
	`156`	`+ $type = self::generic($type, $key ?? self::arrayKey(), $value ?? self::mixed());`
`157`	`157`	`}`
`158`	`158`
`159`	`159`	`return new CollectionType($type, $asList);`
`@@ -210,12 +210,17 @@ public static function arrayShape(array $shape, bool $sealed = true, ?Type $extr`
`210`	`210`	`$sealed = false;`
`211`	`211`	`}`
`212`	`212`
`213`		`- $extraKeyType ??= !$sealed ? Type::union(Type::int(), Type::string()) : null;`
	`213`	`+ $extraKeyType ??= !$sealed ? Type::arrayKey() : null;`
`214`	`214`	`$extraValueType ??= !$sealed ? Type::mixed() : null;`
`215`	`215`
`216`	`216`	`return new ArrayShapeType($shape, $extraKeyType, $extraValueType);`
`217`	`217`	`}`
`218`	`218`
	`219`	`+ public static function arrayKey(): UnionType`
	`220`	`+ {`
	`221`	`+ return self::union(self::int(), self::string());`
	`222`	`+ }`
	`223`	`+`
`219`	`224`	`/**`
`220`	`225`	`* @template T of class-string`
`221`	`226`	`*`
`@@ -434,7 +439,7 @@ public static function fromValue(mixed $value): Type`
`434`	`439`	`$keyTypes = array_values(array_unique($keyTypes));`
`435`	`440`	`$keyType = \count($keyTypes) > 1 ? self::union(...$keyTypes) : $keyTypes[0];`
`436`	`441`	`} else {`
`437`		`- $keyType = Type::union(Type::int(), Type::string());`
	`442`	`+ $keyType = Type::arrayKey();`
`438`	`443`	`}`
`439`	`444`
`440`	`445`	`$valueType = $valueTypes ? CollectionType::mergeCollectionValueTypes($valueTypes) : Type::mixed();`