Cover non-empty-array in array_flip

Author: staabm

conf/config.neon

@@ -930,6 +930,11 @@ services:
 		tags:
 			- phpstan.broker.dynamicFunctionReturnTypeExtension
 
+	-
+		class: PHPStan\Type\Php\ArrayFlipFunctionReturnTypeExtension
+		tags:
+			- phpstan.broker.dynamicFunctionReturnTypeExtension
+
 	-
 		class: PHPStan\Type\Php\ArrayKeyDynamicReturnTypeExtension
 		tags:

src/Type/Php/ArrayFlipFunctionReturnTypeExtension.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Php;
+
+use PhpParser\Node\Expr\FuncCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\Type\Accessory\NonEmptyArrayType;
+use PHPStan\Type\ArrayType;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeCombinator;
+
+class ArrayFlipFunctionReturnTypeExtension implements \PHPStan\Type\DynamicFunctionReturnTypeExtension
+{
+
+	public function isFunctionSupported(FunctionReflection $functionReflection): bool
+	{
+		return $functionReflection->getName() === 'array_flip';
+	}
+
+	public function getTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $functionCall, Scope $scope): Type
+	{
+		if (count($functionCall->args) !== 1) {
+			return ParametersAcceptorSelector::selectSingle($functionReflection->getVariants())->getReturnType();
+		}
+
+		$array = $functionCall->args[0]->value;
+		$argType = $scope->getType($array);
+
+		if ($argType->isArray()->yes()) {
+			$keyType = $argType->getIterableKeyType();
+			$itemType = $argType->getIterableValueType();
+
+			$itemType = ArrayType::castToArrayKeyType($itemType);
+
+			$flippedArrayType = new ArrayType(
+				$itemType,
+				$keyType
+			);
+
+			if ($argType->isIterableAtLeastOnce()->yes()) {
+				$flippedArrayType = TypeCombinator::intersect($flippedArrayType, new NonEmptyArrayType());
+			}
+
+			return $flippedArrayType;
+		}
+
+		return ParametersAcceptorSelector::selectSingle($functionReflection->getVariants())->getReturnType();
+	}
+
+}

tests/PHPStan/Analyser/NodeScopeResolverTest.php

@@ -264,6 +264,7 @@ public function dataFileAsserts(): iterable
 		yield from $this->gatherAssertTypes(__DIR__ . '/../Rules/Methods/data/infer-array-key.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/offset-value-after-assign.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-2112.php');
+		yield from $this->gatherAssertTypes(__DIR__ . '/data/array-flip.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/array-map-closure.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/array-sum.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-4573.php');

tests/PHPStan/Analyser/data/array-flip.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace ArrayFlip;
+
+use function PHPStan\Testing\assertType;
+
+/**
+ * @param int[] $integerList
+ */
+function foo($integerList)
+{
+	$flip = array_flip($integerList);
+	assertType('array<int, (int|string)>', $flip);
+}
+
+/**
+ * @param mixed[] $list
+ */
+function foo3($list)
+{
+	$flip = array_flip($list);
+
+	assertType('array<int|string, (int|string)>', $flip);
+}
+
+/**
+ * @param array<int, 1|2|3> $array
+ */
+function foo4($array)
+{
+	$flip = array_flip($array);
+	assertType('array<1|2|3, int>', $flip);
+}
+
+
+/**
+ * @param array<1|2|3, string> $array
+ */
+function foo5($array)
+{
+	$flip = array_flip($array);
+	assertType('array<string, 1|2|3>', $flip);
+}

tests/PHPStan/Analyser/data/non-empty-array.php

@@ -37,8 +37,9 @@ public function doFoo(
 	/**
 	 * @param non-empty-array $array
 	 * @param non-empty-list $list
+	 * @param non-empty-array<string> $stringArray
 	 */
-	public function arrayFunctions($array, $list): void
+	public function arrayFunctions($array, $list, $stringArray): void
 	{
 		assertType('array&nonEmpty', array_combine($array, $array));
 		assertType('array&nonEmpty', array_combine($list, $list));
@@ -47,5 +48,8 @@ public function arrayFunctions($array, $list): void
 		assertType('array&nonEmpty', array_merge([], $array));
 		assertType('array&nonEmpty', array_merge($array, []));
 		assertType('array&nonEmpty', array_merge($array, $array));
+
+		assertType('array<int|string, (int|string)>&nonEmpty', array_flip($array));
+		assertType('array<string, (int|string)>&nonEmpty', array_flip($stringArray));
 	}
 }