Skip to content

Improve Array Shape and Object Shape composition inference on generic type composition #89

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

Merged
rcalicdan merged 2 commits into from
Sep 30, 2026
Merged

Improve Array Shape and Object Shape composition inference on generic type composition #89

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
0ee163e
Add support for inferring templates from array shapes and implement r…
rcalicdan Sep 30, 2026
6ece179
Enhance ParamChecker to support inference from object and array shapes
rcalicdan Sep 30, 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
165 changes: 162 additions & 3 deletions src/Internal/Checker/ParamChecker.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
namespace TypePHP\Internal\Checker;

use PHPStan\PhpDocParser\Ast\PhpDoc\TemplateTagValueNode;
use PHPStan\PhpDocParser\Ast\Type\ArrayShapeNode;
use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
use PHPStan\PhpDocParser\Ast\Type\CallableTypeNode;
use PHPStan\PhpDocParser\Ast\Type\ConditionalTypeForParameterNode;
Expand All @@ -13,6 +14,7 @@
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use PHPStan\PhpDocParser\Ast\Type\IntersectionTypeNode;
use PHPStan\PhpDocParser\Ast\Type\NullableTypeNode;
use PHPStan\PhpDocParser\Ast\Type\ObjectShapeNode;
use PHPStan\PhpDocParser\Ast\Type\TypeNode;
use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
use TypePHP\Internal\Diagnostic\ErrorFactory;
Expand Down Expand Up @@ -476,7 +478,7 @@ private static function handleMagicCall(
}

/**
* Pre-infers generic template parameters from closure typehints, array arguments, and generic object arguments.
* Pre-infers generic template parameters from closure typehints, array arguments, shapes, and generic object arguments.
*
* @param array<string, TypeNode> $types
* @param array<string, mixed> $vars
Expand Down Expand Up @@ -506,6 +508,7 @@ private static function preInferGenericTemplates(

if (\count($types) > 0) {
self::inferTemplatesFromArrays($types, $vars, $effectiveFunction, $thisObj, $templates);
self::inferTemplatesFromShapes($types, $vars, $effectiveFunction, $thisObj, $templates, $classTemplates);
self::inferTemplatesFromGenericObjects($types, $vars, $effectiveFunction, $thisObj, $templates, $classTemplates);
}
}
Expand Down Expand Up @@ -650,6 +653,151 @@ private static function inferTemplatesFromArrays(
}
}

/**
* Infers generic template parameters from array and object shapes.
*
* @param array<string, TypeNode> $types
* @param array<string, mixed> $vars
* @param array<string, TemplateTagValueNode> $templates
* @param array<string, TemplateTagValueNode> $classTemplates
*/
private static function inferTemplatesFromShapes(
array $types,
array $vars,
string $effectiveFunction,
?object $thisObj,
array $templates,
array $classTemplates = []
): void {
foreach ($types as $paramName => $typeNode) {
if (isset($vars[$paramName])) {
self::inferShapeNodeTemplates($typeNode, $vars[$paramName], $effectiveFunction, $thisObj, $templates, $classTemplates);
}
}
}

/**
* Traverses shape nodes (including within intersections/unions) and inspects properties or keys.
*
* @param array<string, TemplateTagValueNode> $templates
* @param array<string, TemplateTagValueNode> $classTemplates
*/
private static function inferShapeNodeTemplates(
TypeNode $typeNode,
mixed $value,
string $effectiveFunction,
?object $thisObj,
array $templates,
array $classTemplates = []
): void {
if ($typeNode instanceof NullableTypeNode) {
$typeNode = $typeNode->type;
}

if ($typeNode instanceof IntersectionTypeNode || $typeNode instanceof UnionTypeNode) {
foreach ($typeNode->types as $subType) {
self::inferShapeNodeTemplates($subType, $value, $effectiveFunction, $thisObj, $templates, $classTemplates);
}

return;
}

if ($typeNode instanceof ObjectShapeNode && \is_object($value)) {
foreach ($typeNode->items as $item) {
$prop = $item->keyName instanceof IdentifierTypeNode ? $item->keyName->name : (string) $item->keyName;

// @phpstan-ignore property.dynamicName
if (isset($value->$prop) || property_exists($value, $prop)) {
// @phpstan-ignore property.dynamicName
$propVal = $value->$prop;
self::inferTemplateFromTypeAndValue($item->valueType, $propVal, $effectiveFunction, $thisObj, $templates, $classTemplates);
}
}

return;
}

if ($typeNode instanceof ArrayShapeNode && \is_array($value)) {
$nextIdx = 0;
foreach ($typeNode->items as $item) {
$key = match (true) {
$item->keyName instanceof \PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprStringNode => $item->keyName->value,
$item->keyName instanceof \PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprIntegerNode => (int) $item->keyName->value,
$item->keyName instanceof IdentifierTypeNode => $item->keyName->name,
$item->keyName !== null => (string) $item->keyName,
default => $nextIdx,
};

if (\is_int($key)) {
$nextIdx = max($nextIdx, $key + 1);
}

if (\array_key_exists($key, $value)) {
self::inferTemplateFromTypeAndValue($item->valueType, $value[$key], $effectiveFunction, $thisObj, $templates, $classTemplates);
}
}

if ($typeNode->unsealedType !== null) {
$unsealed = $typeNode->unsealedType;
foreach ($value as $k => $v) {
self::inferTemplateFromTypeAndValue($unsealed->valueType, $v, $effectiveFunction, $thisObj, $templates, $classTemplates);
if ($unsealed->keyType !== null) {
self::inferTemplateFromTypeAndValue($unsealed->keyType, $k, $effectiveFunction, $thisObj, $templates, $classTemplates);
}
}
}
}
}

/**
* Unified type-value dispatcher: resolves any field type (bare template, generic collection, object, nested shape).
*
* @param array<string, TemplateTagValueNode> $templates
* @param array<string, TemplateTagValueNode> $classTemplates
*/
private static function inferTemplateFromTypeAndValue(
TypeNode $typeNode,
mixed $value,
string $effectiveFunction,
?object $thisObj,
array $templates,
array $classTemplates = []
): void {
if ($typeNode instanceof NullableTypeNode) {
$typeNode = $typeNode->type;
}

if ($typeNode instanceof IdentifierTypeNode) {
if (isset($templates[$typeNode->name])) {
$inferred = TemplateManager::inferTypeFromValue($value);
self::bindTemplateIfUnbound($typeNode->name, $inferred, $effectiveFunction, $thisObj, $templates);
}

return;
}

if ($typeNode instanceof ArrayShapeNode || $typeNode instanceof ObjectShapeNode || $typeNode instanceof IntersectionTypeNode) {
self::inferShapeNodeTemplates($typeNode, $value, $effectiveFunction, $thisObj, $templates, $classTemplates);

return;
}

if ($typeNode instanceof GenericTypeNode) {
$baseType = strtolower($typeNode->type->name);
if (isset(self::ITERABLE_TYPES[$baseType]) && \is_array($value)) {
self::inferArrayTemplatesFromAllElements($typeNode, $value, $effectiveFunction, $thisObj, $templates);
} elseif (\is_object($value)) {
self::inferGenericObjectNode($typeNode, $value, $effectiveFunction, $thisObj, $templates, $classTemplates);
}

return;
}

if ($typeNode instanceof ArrayTypeNode && \is_array($value)) {
self::inferArrayTemplatesFromAllElements($typeNode, $value, $effectiveFunction, $thisObj, $templates);
}
}

/**
* Extracts and unifies template parameters across all elements of an array argument.
* Uses Beartype O(1) hybrid random sampling on arrays > 128 items when hybrid mode is active.
Expand Down Expand Up @@ -759,7 +907,8 @@ private static function getSampleArraySlice(array $arrVal): array
}

/**
* Binds a template parameter if it is not already bound in the current scope.
* Binds a template parameter if it is not already bound in the current scope,
* ensuring it satisfies declared upper bounds.
*
* @param array<string, TemplateTagValueNode> $templates
*/
Expand All @@ -776,7 +925,17 @@ private static function bindTemplateIfUnbound(
$targetObj = $isClassLevelTemplate ? $thisObj : null;

if (isset($templates[$templateName]) && ! TemplateManager::isBound($effectiveFunction, $targetObj, $templateName)) {
TemplateManager::bindTemplate($effectiveFunction, $targetObj, $templateName, $inferredType);
$templateTag = $templates[$templateName];
$satisfiesBound = true;

if ($templateTag->bound !== null) {
$resolvedBound = SpecialTypeResolver::resolve($templateTag->bound, $effectiveFunction, $thisObj);
$satisfiesBound = TemplateManager::checkVariance($inferredType, $resolvedBound, GenericTypeNode::VARIANCE_COVARIANT);
}

if ($satisfiesBound) {
TemplateManager::bindTemplate($effectiveFunction, $targetObj, $templateName, $inferredType);
}
}
}

Expand Down
Loading
Loading