From 8b4d5a265cdea25cdc3958d518509152643a484b Mon Sep 17 00:00:00 2001 From: Christian Flothmann Date: Sun, 30 Mar 2025 13:35:01 +0200 Subject: [PATCH] add TypeFactoryTrait::arrayKey() --- src/Symfony/Component/TypeInfo/CHANGELOG.md | 2 +- .../TypeInfo/Tests/Type/ArrayShapeTypeTest.php | 4 ++-- .../TypeInfo/Tests/Type/CollectionTypeTest.php | 2 +- .../Component/TypeInfo/Tests/TypeFactoryTest.php | 9 +++++++-- .../Tests/TypeResolver/StringTypeResolverTest.php | 2 +- .../Component/TypeInfo/Type/ArrayShapeType.php | 2 +- .../Component/TypeInfo/Type/CollectionType.php | 2 +- src/Symfony/Component/TypeInfo/TypeFactoryTrait.php | 11 ++++++++--- .../TypeInfo/TypeResolver/StringTypeResolver.php | 2 +- 9 files changed, 23 insertions(+), 13 deletions(-) diff --git a/src/Symfony/Component/TypeInfo/CHANGELOG.md b/src/Symfony/Component/TypeInfo/CHANGELOG.md index 491f36ccc0b0e..a8c96108c7f51 100644 --- 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 index 20b413a65d3b6..006a5f1b06040 100644 --- 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 index fa0be0c7efdc3..2b8d6031efdcc 100644 --- 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 index 65a33739bf0fb..6a9aaf4cfe25b 100644 --- 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 index 21abd8d72c283..fcfe909cecf6e 100644 --- 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 index 504a59ac619ba..a08e6118a0432 100644 --- 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 index 579d6d358cc6d..80fbbdba6c3fa 100644 --- 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 index 125b3702016fb..b922c2749ba5d 100644 --- 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 index 244563f602f7d..475e0212490d7 100644 --- 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()),