Skip to content

Unroll foreach over union of constant arrays in tryProcessUnrolledConstantArrayForeach #5558

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
ondrejmirtes merged 1 commit into from
Apr 28, 2026
+162 −77
Merged

Unroll foreach over union of constant arrays in tryProcessUnrolledConstantArrayForeach #5558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
182 changes: 105 additions & 77 deletions src/Analyser/NodeScopeResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3900,113 +3900,141 @@ private function tryProcessUnrolledConstantArrayForeach(
return null;
}
$constantArrays = $iterateeType->getConstantArrays();
if (count($constantArrays) !== 1) {
if (count($constantArrays) === 0) {
return null;
}
$constantArray = $constantArrays[0];
$keyTypes = $constantArray->getKeyTypes();
$valueTypes = $constantArray->getValueTypes();
if (count($keyTypes) === 0 || count($keyTypes) > self::FOREACH_UNROLL_LIMIT) {

$totalKeys = 0;
foreach ($constantArrays as $constantArray) {
$totalKeys += count($constantArray->getKeyTypes());
}
if ($totalKeys === 0 || $totalKeys > self::FOREACH_UNROLL_LIMIT) {
return null;
}

$nativeIterateeType = $originalScope->getNativeType($stmt->expr);
$nativeConstantArrays = $nativeIterateeType->getConstantArrays();
$nativeConstantArray = count($nativeConstantArrays) === 1 ? $nativeConstantArrays[0] : null;
$matchedNativeArrays = count($nativeConstantArrays) === count($constantArrays) ? $nativeConstantArrays : null;

$optionalKeys = array_fill_keys($constantArray->getOptionalKeys(), true);
$valueVarName = $stmt->valueVar->name;
$keyVarName = $stmt->keyVar instanceof Variable && is_string($stmt->keyVar->name) ? $stmt->keyVar->name : null;

$chainScope = $originalScope;
$entryScopes = [];
$breakScopes = [];
foreach ($keyTypes as $i => $keyType) {
$valueType = $valueTypes[$i];
$isOptional = isset($optionalKeys[$i]);

$nativeKeyType = $nativeConstantArray !== null && isset($nativeConstantArray->getKeyTypes()[$i])
? $nativeConstantArray->getKeyTypes()[$i]
: $keyType;
$nativeValueType = $nativeConstantArray !== null && isset($nativeConstantArray->getValueTypes()[$i])
? $nativeConstantArray->getValueTypes()[$i]
: $valueType;

$iterScope = $chainScope->assignVariable(
$valueVarName,
$valueType,
$nativeValueType,
TrinaryLogic::createYes(),
);
$iterScope = $iterScope->assignExpression(
new OriginalForeachValueExpr($valueVarName),
$valueType,
$nativeValueType,
);
if ($keyVarName !== null) {
$iterScope = $iterScope->assignVariable(
$keyVarName,
$keyType,
$nativeKeyType,
$allBodyScopes = [];
$allChainScopes = [];
$allBreakScopes = [];

foreach ($constantArrays as $arrayIndex => $constantArray) {
$keyTypes = $constantArray->getKeyTypes();
$valueTypes = $constantArray->getValueTypes();
if (count($keyTypes) === 0) {
continue;
}

$nativeConstantArray = $matchedNativeArrays !== null ? $matchedNativeArrays[$arrayIndex] : null;
$optionalKeys = array_fill_keys($constantArray->getOptionalKeys(), true);

$chainScope = $originalScope;
$entryScopes = [];

foreach ($keyTypes as $i => $keyType) {
$valueType = $valueTypes[$i];
$isOptional = isset($optionalKeys[$i]);

$nativeKeyType = $nativeConstantArray !== null && isset($nativeConstantArray->getKeyTypes()[$i])
? $nativeConstantArray->getKeyTypes()[$i]
: $keyType;
$nativeValueType = $nativeConstantArray !== null && isset($nativeConstantArray->getValueTypes()[$i])
? $nativeConstantArray->getValueTypes()[$i]
: $valueType;

$iterScope = $chainScope->assignVariable(
$valueVarName,
$valueType,
$nativeValueType,
TrinaryLogic::createYes(),
);
$iterScope = $iterScope->assignExpression(
new OriginalForeachKeyExpr($keyVarName),
$keyType,
$nativeKeyType,
);
$iterScope = $iterScope->assignExpression(
new ArrayDimFetch($stmt->expr, $stmt->keyVar),
new OriginalForeachValueExpr($valueVarName),
$valueType,
$nativeValueType,
);
}
if ($keyVarName !== null) {
$iterScope = $iterScope->assignVariable(
$keyVarName,
$keyType,
$nativeKeyType,
TrinaryLogic::createYes(),
);
$iterScope = $iterScope->assignExpression(
new OriginalForeachKeyExpr($keyVarName),
$keyType,
$nativeKeyType,
);
$iterScope = $iterScope->assignExpression(
new ArrayDimFetch($stmt->expr, $stmt->keyVar),
$valueType,
$nativeValueType,
);
}

$entryScopes[] = $iterScope;
$entryScopes[] = $iterScope;

$iterStorage = $originalStorage->duplicate();
$bodyResult = $this->processStmtNodesInternal(
$stmt,
$stmt->stmts,
$iterScope,
$iterStorage,
new NoopNodeCallback(),
$context->enterDeep(),
)->filterOutLoopExitPoints();
$iterStorage = $originalStorage->duplicate();
$bodyResult = $this->processStmtNodesInternal(
$stmt,
$stmt->stmts,
$iterScope,
$iterStorage,
new NoopNodeCallback(),
$context->enterDeep(),
)->filterOutLoopExitPoints();

$iterEndScope = $bodyResult->getScope();
foreach ($bodyResult->getExitPointsByType(Continue_::class) as $continueExitPoint) {
$iterEndScope = $iterEndScope->mergeWith($continueExitPoint->getScope());
}
foreach ($bodyResult->getExitPointsByType(Break_::class) as $breakExitPoint) {
$breakScopes[] = $breakExitPoint->getScope();
$iterEndScope = $bodyResult->getScope();
foreach ($bodyResult->getExitPointsByType(Continue_::class) as $continueExitPoint) {
$iterEndScope = $iterEndScope->mergeWith($continueExitPoint->getScope());
}
foreach ($bodyResult->getExitPointsByType(Break_::class) as $breakExitPoint) {
$allBreakScopes[] = $breakExitPoint->getScope();
}

if ($isOptional) {
$chainScope = $iterEndScope->mergeWith($chainScope);
} else {
$chainScope = $iterEndScope;
}
}

if ($isOptional) {
$chainScope = $iterEndScope->mergeWith($chainScope);
} else {
$chainScope = $iterEndScope;
$arrayBodyScope = $entryScopes[0];
for ($i = 1, $c = count($entryScopes); $i < $c; $i++) {
$arrayBodyScope = $arrayBodyScope->mergeWith($entryScopes[$i]);
}
if (count($entryScopes) === 1) {
$arrayBodyScope = $arrayBodyScope->mergeWith($chainScope);
}

$allBodyScopes[] = $arrayBodyScope;
$allChainScopes[] = $chainScope;
}

$bodyScope = $entryScopes[0];
for ($i = 1, $c = count($entryScopes); $i < $c; $i++) {
$bodyScope = $bodyScope->mergeWith($entryScopes[$i]);
if ($allBodyScopes === []) {
return null;
}

$bodyScope = $allBodyScopes[0];
for ($i = 1, $c = count($allBodyScopes); $i < $c; $i++) {
$bodyScope = $bodyScope->mergeWith($allBodyScopes[$i]);
}
if (count($entryScopes) === 1) {
// For a single-iteration unrolling, the merged entry scope does
// not include any post-body state. Merge the chain end scope in
// so that rules analysing the body see that prior iterations
// (which in this case means: this same iteration, from a rule
// author's perspective) could have modified variables.
$bodyScope = $bodyScope->mergeWith($chainScope);

$endScope = $allChainScopes[0];
for ($i = 1, $c = count($allChainScopes); $i < $c; $i++) {
$endScope = $endScope->mergeWith($allChainScopes[$i]);
}

foreach ($breakScopes as $breakScope) {
$chainScope = $chainScope->mergeWith($breakScope);
foreach ($allBreakScopes as $breakScope) {
$endScope = $endScope->mergeWith($breakScope);
}

return ['bodyScope' => $bodyScope, 'endScope' => $chainScope];
return ['bodyScope' => $bodyScope, 'endScope' => $endScope];
}

/**
Expand Down
57 changes: 57 additions & 0 deletions tests/PHPStan/Analyser/nsrt/bug-7978.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<?php declare(strict_types = 1);

namespace Bug7978;

use function PHPStan\Testing\assertType;

/**
* @phpstan-type TypeArrayCredentialsBasic array{
* username : string,
* password : string,
* }
*
* @phpstan-type TypeArrayCredentialsHeader array{
* app_id : string,
* app_key : string
* }
*
* @phpstan-type TypeArrayCredentials TypeArrayCredentialsBasic|TypeArrayCredentialsHeader
*/
class Test {

const FIELD_SETS = [
'basic' => ['username', 'password'],
'headers' => ['app_id', 'app_key'],
];

public function doSomething(): void
{
foreach (self::FIELD_SETS as $type => $fields) {
$credentials = [];
foreach ($fields as $field) {
$credentials[$field] = 'fake';
}
assertType("array{app_id: 'fake', app_key: 'fake'}|array{username: 'fake', password: 'fake'}", $credentials);
}
}

/** @param list{'username', 'password'}|list{'app_id', 'app_key'} $fields */
public function directUnionForeach(array $fields): void
{
$credentials = [];
foreach ($fields as $field) {
$credentials[$field] = 'fake';
}
assertType("array{app_id: 'fake', app_key: 'fake'}|array{username: 'fake', password: 'fake'}", $credentials);
}

/** @param list{'a', 'b', 'c'}|list{'x'} $fields */
public function differentLengthArrays(array $fields): void
{
$result = [];
foreach ($fields as $field) {
$result[$field] = 1;
}
assertType("array{a: 1, b: 1, c: 1}|array{x: 1}", $result);
}
}
Loading