Skip to content

Support array-shapes in "array_merge" #641

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 2 commits into from
Aug 25, 2021
Merged

Support array-shapes in "array_merge" #641

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
f427a3e
support array-shapes in "array_merge"
voku Aug 25, 2021
5632630
Add more tests for "array_merge"
voku Aug 25, 2021
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
48 changes: 37 additions & 11 deletions src/Type/Php/ArrayMergeFunctionDynamicReturnTypeExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
use PHPStan\Reflection\ParametersAcceptorSelector;
use PHPStan\Type\Accessory\NonEmptyArrayType;
use PHPStan\Type\ArrayType;
use PHPStan\Type\Constant\ConstantArrayTypeBuilder;
use PHPStan\Type\GeneralizePrecision;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use PHPStan\Type\TypeUtils;
use PHPStan\Type\UnionType;

class ArrayMergeFunctionDynamicReturnTypeExtension implements \PHPStan\Type\DynamicFunctionReturnTypeExtension
{
Expand All @@ -30,20 +30,33 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,

$keyTypes = [];
$valueTypes = [];
$returnedArrayBuilder = ConstantArrayTypeBuilder::createEmpty();
$returnedArrayBuilderFilled = false;
$nonEmpty = false;
foreach ($functionCall->args as $arg) {
$argType = $scope->getType($arg->value);

if ($arg->unpack) {
$argType = $argType->getIterableValueType();
if ($argType instanceof UnionType) {
foreach ($argType->getTypes() as $innerType) {
$argType = $innerType;
}

$arrays = TypeUtils::getConstantArrays($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]
);
}
}
}

$keyTypes[] = TypeUtils::generalizeType($argType->getIterableKeyType(), GeneralizePrecision::moreSpecific());
$valueTypes[] = $argType->getIterableValueType();
} else {
$keyTypes[] = TypeUtils::generalizeType($argType->getIterableKeyType(), GeneralizePrecision::moreSpecific());
$valueTypes[] = $argType->getIterableValueType();
}

if (!$argType->isIterableAtLeastOnce()->yes()) {
continue;
Expand All @@ -52,10 +65,23 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
$nonEmpty = true;
}

$arrayType = new ArrayType(
TypeCombinator::union(...$keyTypes),
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(
TypeCombinator::union(...$keyTypes),
TypeCombinator::union(...$valueTypes)
);
}

if ($nonEmpty) {
$arrayType = TypeCombinator::intersect($arrayType, new NonEmptyArrayType());
Expand Down
25 changes: 19 additions & 6 deletions tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5153,31 +5153,44 @@ public function dataArrayFunctions(): array
'array_values($generalStringKeys)',
],
[
'array<int|non-empty-string, stdClass>&nonEmpty',
"array('foo' => stdClass, 0 => stdClass)",
'array_merge($stringOrIntegerKeys)',
],
[
'array<int|string, DateTimeImmutable|int>',
'array_merge($generalStringKeys, $generalDateTimeValues)',
],
[
'array<int|string, int|stdClass>&nonEmpty',
'array<0|string, int|stdClass>&nonEmpty',
'array_merge($generalStringKeys, $stringOrIntegerKeys)',
],
[
'array<int|string, int|stdClass>&nonEmpty',
'array<0|string, int|stdClass>&nonEmpty',
'array_merge($stringOrIntegerKeys, $generalStringKeys)',
],
[
'array<int|non-empty-string, \'foo\'|stdClass>&nonEmpty',
"array('foo' => stdClass, 'bar' => stdClass, 0 => stdClass)",
'array_merge($stringKeys, $stringOrIntegerKeys)',
],
[
'array<int|non-empty-string, \'foo\'|stdClass>&nonEmpty',
"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('foo' => 'foo', 0 => stdClass, 'bar' => stdClass)",
'array_merge($stringOrIntegerKeys, $stringKeys)',
],
[
'array<int|non-empty-string, 2|4|\'a\'|\'b\'|\'green\'|\'red\'|\'trapezoid\'>&nonEmpty',
"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
2 changes: 2 additions & 0 deletions tests/PHPStan/Analyser/NodeScopeResolverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,8 @@ public function dataFileAsserts(): iterable
yield from $this->gatherAssertTypes(__DIR__ . '/data/throw-expr.php');
}

yield from $this->gatherAssertTypes(__DIR__ . '/data/array-merge.php');

yield from $this->gatherAssertTypes(__DIR__ . '/data/non-empty-array.php');

if (PHP_VERSION_ID >= 80000 || self::$useStaticReflectionProvider) {
Expand Down
75 changes: 75 additions & 0 deletions tests/PHPStan/Analyser/data/array-merge.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<?php

namespace NonEmptyArray;

use function PHPStan\Testing\assertType;

class Foo
{

private const DEFAULT_SETTINGS = [
'remove' => 'first',
'limit' => PHP_INT_MAX,
];

/**
* @param array<string, float|null> $settings
*/
public function arrayMergeWithConst(array $settings): void
{
$settings = array_merge(self::DEFAULT_SETTINGS, $settings);

assertType("array<string, 9223372036854775807|'first'|float|null>&nonEmpty", $settings);
}

/**
* @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));

assertType("array('foo' => '')", array_merge(['foo' => ''])); // issue #2567
}

/**
* @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));
}
}