Skip to content

Support array-shapes in array_merge #1653

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
merged 1 commit into from
Aug 25, 2022
Merged

Support array-shapes in array_merge #1653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 38 additions & 6 deletions src/Type/Php/ArrayMergeFunctionDynamicReturnTypeExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,11 @@
use PHPStan\Type\NeverType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use PHPStan\Type\TypeUtils;
use function array_keys;
use function count;
use function in_array;
use function is_numeric;

class ArrayMergeFunctionDynamicReturnTypeExtension implements DynamicFunctionReturnTypeExtension
{
Expand Down Expand Up @@ -99,10 +101,27 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,

$keyTypes = [];
$valueTypes = [];
$returnedArrayBuilder = ConstantArrayTypeBuilder::createEmpty();
$returnedArrayBuilderFilled = false;
$nonEmpty = false;
foreach ($argTypes as $key => $argType) {
$keyTypes[] = $argType->getIterableKeyType();
$valueTypes[] = $argType->getIterableValueType();
$arrays = TypeUtils::getOldConstantArrays($argType);
if (count($arrays) > 0) {
foreach ($arrays as $constantArray) {
foreach ($constantArray->getKeyTypes() as $i => $keyType) {
$returnedArrayBuilderFilled = true;

$returnedArrayBuilder->setOffsetValueType(
is_numeric($keyType->getValue()) ? null : $keyType,
$constantArray->getValueTypes()[$i],
$constantArray->isOptionalKey($i),
);
}
}
} else {
$keyTypes[] = $argType->getIterableKeyType();
$valueTypes[] = $argType->getIterableValueType();
}

if (in_array($key, $optionalArgTypes, true) || !$argType->isIterableAtLeastOnce()->yes()) {
continue;
Expand All @@ -116,10 +135,23 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
return new ConstantArrayType([], []);
}

$arrayType = new ArrayType(
$keyType,
TypeCombinator::union(...$valueTypes),
);
if (count($keyTypes) > 0) {
$arrayType = new ArrayType(
TypeCombinator::union(...$keyTypes),
TypeCombinator::union(...$valueTypes),
);

if ($returnedArrayBuilderFilled) {
$arrayType = TypeCombinator::union($returnedArrayBuilder->getArray(), $arrayType);
}
} elseif ($returnedArrayBuilderFilled) {
$arrayType = $returnedArrayBuilder->getArray();
} else {
$arrayType = new ArrayType(
$keyType,
TypeCombinator::union(...$valueTypes),
);
}

if ($nonEmpty) {
$arrayType = TypeCombinator::intersect($arrayType, new NonEmptyArrayType());
Expand Down
17 changes: 15 additions & 2 deletions tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4663,11 +4663,11 @@ public function dataArrayFunctions(): array
'array_merge($generalStringKeys, $generalDateTimeValues)',
],
[
'non-empty-array<1|string, int|stdClass>',
'non-empty-array<0|string, int|stdClass>',
'array_merge($generalStringKeys, $stringOrIntegerKeys)',
],
[
'non-empty-array<1|string, int|stdClass>',
'non-empty-array<0|string, int|stdClass>',
'array_merge($stringOrIntegerKeys, $generalStringKeys)',
],
[
Expand All @@ -4678,6 +4678,19 @@ public function dataArrayFunctions(): array
"array{foo: 'foo', 0: stdClass, bar: stdClass}",
'array_merge($stringOrIntegerKeys, $stringKeys)',
],
[
'array{foo: 1, bar: 2, 0: 2, 1: 3}',
"array_merge(['foo' => 4, 'bar' => 5], ...[['foo' => 1, 'bar' => 2], [2, 3]])",
],
[
'array{foo: 1, foo2: stdClass}',
'array_merge([\'foo\' => new stdClass()], ...[[\'foo2\' => new stdClass()], [\'foo\' => 1]])',
],

[
'array{foo: 1, foo2: stdClass}',
'array_merge([\'foo\' => new stdClass()], ...[[\'foo2\' => new stdClass()], [\'foo\' => 1]])',
],
[
"array{color: 'green', 0: 2, 1: 4, 2: 'a', 3: 'b', shape: 'trapezoid', 4: 4}",
'array_merge(array("color" => "red", 2, 4), array("a", "b", "color" => "green", "shape" => "trapezoid", 4))',
Expand Down
1 change: 1 addition & 0 deletions tests/PHPStan/Analyser/NodeScopeResolverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,7 @@ public function dataFileAsserts(): iterable
yield from $this->gatherAssertTypes(__DIR__ . '/data/array-map.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/array-map-closure.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/array-merge.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/array-merge2.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/array-sum.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/array-plus.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-4573.php');
Expand Down
58 changes: 58 additions & 0 deletions tests/PHPStan/Analyser/data/array-merge2.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<?php

namespace ArrayMerge2;

use function PHPStan\Testing\assertType;

class Foo
{

/**
* @param array{foo: '1', bar: '2', lall: '3', 2: '2', 3: '3'} $array1
* @param array{foo: '1', bar: '4', lall2: '3', 2: '4', 3: '6'} $array2
*/
public function arrayMergeArrayShapes($array1, $array2): void
{
assertType("array{foo: '1', bar: '2', lall: '3', 0: '2', 1: '3'}", array_merge($array1));
assertType("array{foo: '1', bar: '2', lall: '3', 0: '2', 1: '3'}", array_merge([], $array1));
assertType("array{foo: '1', bar: '2', lall: '3', 0: '2', 1: '3'}", array_merge($array1, []));
assertType("array{foo: '1', bar: '2', lall: '3', 0: '2', 1: '3', 2: '2', 3: '3'}", array_merge($array1, $array1));
assertType("array{foo: '1', bar: '4', lall: '3', 0: '2', 1: '3', lall2: '3', 2: '4', 3: '6'}", array_merge($array1, $array2));
assertType("array{foo: '1', bar: '2', lall2: '3', 0: '4', 1: '6', lall: '3', 2: '2', 3: '3'}", array_merge($array2, $array1));
assertType("array{foo: 3, bar: '2', lall2: '3', 0: '4', 1: '6', lall: '3', 2: '2', 3: '3'}", array_merge($array2, $array1, ['foo' => 3]));
assertType("array{foo: 3, bar: '2', lall2: '3', 0: '4', 1: '6', lall: '3', 2: '2', 3: '3'}", array_merge($array2, $array1, ...[['foo' => 3]]));
}

/**
* @param int[] $array1
* @param string[] $array2
*/
public function arrayMergeSimple($array1, $array2): void
{
assertType("array<int>", array_merge($array1, $array1));
assertType("array<int|string>", array_merge($array1, $array2));
assertType("array<int|string>", array_merge($array2, $array1));
}

/**
* @param array<int, int|string> $array1
* @param array<int, bool|float> $array2
*/
public function arrayMergeUnionType($array1, $array2): void
{
assertType("array<int, int|string>", array_merge($array1, $array1));
assertType("array<int, bool|float|int|string>", array_merge($array1, $array2));
assertType("array<int, bool|float|int|string>", array_merge($array2, $array1));
}

/**
* @param array<int, array{bar: '2'}|array{foo: '1'}> $array1
* @param array<int, array{bar: '3'}|array{foo: '2'}> $array2
*/
public function arrayMergeUnionTypeArrayShapes($array1, $array2): void
{
assertType("array<int, array{bar: '2'}|array{foo: '1'}>", array_merge($array1, $array1));
assertType("array<int, array{bar: '2'|'3'}|array{foo: '1'|'2'}>", array_merge($array1, $array2));
assertType("array<int, array{bar: '2'|'3'}|array{foo: '1'|'2'}>", array_merge($array2, $array1));
}
}