Skip to content

Initial implementation of unsealed array shapes #5501

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

Draft
ondrejmirtes wants to merge 2 commits into
base: 2.2.x
Choose a base branch
from
Draft

Initial implementation of unsealed array shapes #5501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
132fd1a
Initial implementation of unsealed array shapes
ondrejmirtes Apr 17, 2026
8557fbb
WIP TMP - try without bleeding edge
ondrejmirtes Apr 21, 2026
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
84 changes: 62 additions & 22 deletions src/PhpDoc/TypeNodeResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -704,24 +704,7 @@ static function (string $variance): TemplateTypeVariance {
if (count($genericTypes) === 1) { // array<ValueType>
$arrayType = new ArrayType((new BenevolentUnionType([new IntegerType(), new StringType()]))->toArrayKey(), $genericTypes[0]);
} elseif (count($genericTypes) === 2) { // array<KeyType, ValueType>
$originalKey = $genericTypes[0];
if ($this->reportUnsafeArrayStringKeyCasting === ReportUnsafeArrayStringKeyCastingToggle::PREVENT) {
$originalKey = TypeTraverser::map($originalKey, static function (Type $type, callable $traverse) {
if ($type instanceof UnionType || $type instanceof IntersectionType) {
return $traverse($type);
}

if ($type instanceof StringType) {
return TypeCombinator::intersect($type, new AccessoryDecimalIntegerStringType(inverse: true));
}

return $type;
});
}
$keyType = TypeCombinator::intersect($originalKey->toArrayKey(), new UnionType([
new IntegerType(),
new StringType(),
]))->toArrayKey();
$keyType = $this->transformUnsafeArrayKey($genericTypes[0]);
$finiteTypes = $keyType->getFiniteTypes();
if (
count($finiteTypes) === 1
Expand Down Expand Up @@ -1001,6 +984,28 @@ static function (string $variance): TemplateTypeVariance {
return new ErrorType();
}

private function transformUnsafeArrayKey(Type $keyType): Type
{
if ($this->reportUnsafeArrayStringKeyCasting === ReportUnsafeArrayStringKeyCastingToggle::PREVENT) {
$keyType = TypeTraverser::map($keyType, static function (Type $type, callable $traverse) {
if ($type instanceof UnionType || $type instanceof IntersectionType) {
return $traverse($type);
}

if ($type instanceof StringType) {
return TypeCombinator::intersect($type, new AccessoryDecimalIntegerStringType(inverse: true));
}

return $type;
});
}

return TypeCombinator::intersect($keyType->toArrayKey(), new UnionType([
new IntegerType(),
new StringType(),
]))->toArrayKey();
}

private function resolveCallableTypeNode(CallableTypeNode $typeNode, NameScope $nameScope): Type
{
$templateTags = [];
Expand Down Expand Up @@ -1100,13 +1105,48 @@ private function resolveArrayShapeNode(ArrayShapeNode $typeNode, NameScope $name
$builder->setOffsetValueType($offsetType, $this->resolve($itemNode->valueType, $nameScope), $itemNode->optional);
}

$isList = in_array($typeNode->kind, [
ArrayShapeNode::KIND_LIST,
ArrayShapeNode::KIND_NON_EMPTY_LIST,
], true);

if (!$typeNode->sealed) {
if ($typeNode->unsealedType === null) {
if ($isList) {
$unsealedKeyType = IntegerRangeType::createAllGreaterThanOrEqualTo(0);
} else {
$unsealedKeyType = (new BenevolentUnionType([new IntegerType(), new StringType()]))->toArrayKey();
}
$builder->makeUnsealed(
$unsealedKeyType,
new MixedType(),
);
} else {
if ($typeNode->unsealedType->keyType === null) {
if ($isList) {
$unsealedKeyType = IntegerRangeType::createAllGreaterThanOrEqualTo(0);
} else {
$unsealedKeyType = (new BenevolentUnionType([new IntegerType(), new StringType()]))->toArrayKey();
}
} else {
$unsealedKeyType = $this->transformUnsafeArrayKey($this->resolve($typeNode->unsealedType->keyType, $nameScope));
}
$unsealedKeyFiniteTypes = $unsealedKeyType->getFiniteTypes();
$unsealedValueType = $this->resolve($typeNode->unsealedType->valueType, $nameScope);
if (count($unsealedKeyFiniteTypes) > 0) {
foreach ($unsealedKeyFiniteTypes as $unsealedKeyFiniteType) {
$builder->setOffsetValueType($unsealedKeyFiniteType, $unsealedValueType, true);
}
} else {
$builder->makeUnsealed($unsealedKeyType, $unsealedValueType);
}
}
}

$arrayType = $builder->getArray();

$accessories = [];
if (in_array($typeNode->kind, [
ArrayShapeNode::KIND_LIST,
ArrayShapeNode::KIND_NON_EMPTY_LIST,
], true)) {
if ($isList) {
$accessories[] = new AccessoryArrayListType();
}

Expand Down
Loading
Loading