Add ArrayFindFunctionReturnTypeExtension #3518

zonuexe · 2024-09-30T17:48:04Z

Supports PHP RFC: array_find for PHP 8.4.

VincentLanglet · 2024-10-01T06:35:33Z

tests/PHPStan/Analyser/nsrt/array-find.php

+	function testConstant(array $array, callable $callback): void
+	{
+		assertType("1|'foo'|DateTime|null", array_find($array, $callback));
+		assertType("1|null", array_find($array, 'is_int'));


This cannot be Null.

Fixed f0d9c25

VincentLanglet · 2024-10-01T06:36:15Z

tests/PHPStan/Analyser/nsrt/array-find.php

+	function testMixed(array $array, callable $callback): void
+	{
+		assertType('mixed', array_find($array, $callback));
+		assertType('int|null', array_find($array, 'is_int'));


You should also test it on non empty array, and the result should be an int

It seems like it can be improved at the same time as array_filter().

https://phpstan.org/r/ab62bff1-d485-46ae-9dfa-1931ce320a25

VincentLanglet · 2024-10-01T06:36:42Z

tests/PHPStan/Analyser/nsrt/array-find-key.php

+	function testConstant(array $array, callable $callback): void
+	{
+		assertType("0|1|2|null", array_find_key($array, $callback));
+		assertType("0|1|2|null", array_find_key($array, 'is_int'));


It should be 0

Ideally, that's correct. This PR does not implement the logic to detect this.

What's the current behavior ? I assume the type is considered as mixed.

This means that merging the PR as if will introduce a lot of false positif PHPstan errors on level 7 (unions) when it's currently on level 9 (mixed).
That's why IMHO if a dynamic return type extension is introduced, the implementation need to handle such case.

What's the current behavior ? I assume the type is considered as mixed.

just copy the test over into the playground:
https://phpstan.org/r/ece55e5c-33bf-47cb-b538-35708d025dfa

VincentLanglet · 2024-10-01T06:37:53Z

tests/PHPStan/Analyser/nsrt/array-find-key.php

+	function testMixed(array $array, callable $callback): void
+	{
+		assertType('int|string|null', array_find_key($array, $callback));
+		assertType('int|string|null', array_find_key($array, 'is_int'));


You should test on non-empty-array and it should gives int|string

We can add a test case, but if you pass a non-empty-array<mixed> the function may return any int|string|null.

https://3v4l.org/Biok8

Indeed, my bad.

phpstan-bot · 2024-11-02T18:24:57Z

This pull request has been marked as ready for review.

ondrejmirtes · 2024-11-05T13:02:38Z

src/Type/Php/ArrayFilterFunctionReturnTypeExtension.php

-	 * @param self::USE_* $mode
-	 * @return array{list<Arg>, ?Variable, ?Variable}
-	 */
-	private function createDummyArgs(int $mode): array


Do this refactoring in a separate PR first please.

Ok, create a pull request.

Cherry-picked #3606

zonuexe · 2024-11-05T14:48:19Z

I just cherry-picked them, so there should be no conflicts when #3606 is merged.

ondrejmirtes · 2024-11-05T14:56:08Z

Fix CS please.

zonuexe · 2024-11-05T16:07:42Z

@ondrejmirtes I fixed and rebased.

ondrejmirtes · 2024-11-05T17:10:44Z

src/Reflection/ParametersAcceptorSelector.php

+				];
+			}
+
+			if (isset($args[0]) && (bool) $args[0]->getAttribute(ArrayWalkArgVisitor::ATTRIBUTE_NAME)) {


Why is there a section about array_walk and it has no tests? It should be a separate PR in any case.

Oops, I copied too much existing code.
I'm sure you're right, I'll split out the changes to ParametersAcceptorSelector into a separate PR.

ondrejmirtes

Now you’ve removed too much 😀 It’s useful to declare the callable parameters for two reasons:

To infer the parameter type inside the callable based on array (even when the parameter does not have a native type).
To report wrong callable parameter tpe when it’s different to the passed array.

Please add tests for these.

zonuexe · 2024-11-05T17:56:06Z

Ok, I'll get to it right away.

…rnTypeExtension

…metersRuleTest

phpstan-bot · 2024-11-05T20:13:56Z

This pull request has been marked as ready for review.

ondrejmirtes · 2024-11-05T20:21:21Z

Perfect, thank you!

VincentLanglet reviewed Oct 1, 2024

View reviewed changes

zonuexe force-pushed the feature/array_find branch from 581fba3 to 7dd1e43 Compare October 4, 2024 10:42

zonuexe marked this pull request as draft October 4, 2024 10:43

zonuexe force-pushed the feature/array_find branch from 7dd1e43 to 380c077 Compare November 2, 2024 18:12

zonuexe marked this pull request as ready for review November 2, 2024 18:24

ondrejmirtes requested changes Nov 5, 2024

View reviewed changes

zonuexe mentioned this pull request Nov 5, 2024

Split ArrayFilterFunctionReturnTypeExtension to Helper #3606

Merged

zonuexe force-pushed the feature/array_find branch from 8df85ed to cc25101 Compare November 5, 2024 14:46

zonuexe force-pushed the feature/array_find branch 3 times, most recently from 3a80801 to 2a12198 Compare November 5, 2024 15:59

ondrejmirtes requested changes Nov 5, 2024

View reviewed changes

zonuexe added 7 commits November 6, 2024 03:16

Add ArrayFindFunctionReturnTypeExtension and ArrayFindKeyFunctionRetu…

Loading
Loading status checks…

be71b31

…rnTypeExtension

Make ArrayFindFunctionReturnTypeExtension a wrapper for array_filter()

b18c7e0

Convert non-empty-arrays resulting from array_filter() to non-nullable

0aea23f

Add ArrayFindArgVisitor

cbacc8a

Fix

4b6752d

Use ArrayFilterFunctionReturnTypeHelper instead of FuncCall

c4f0089

Remove redundant copied code

a4ba9df

zonuexe marked this pull request as draft November 5, 2024 19:58

Fix ParametersAcceptorSelector

9a75d3d

zonuexe force-pushed the feature/array_find branch from 7d72141 to 8459f4d Compare November 5, 2024 19:59

Add tests for array_find() and array_find_key() to CallToFunctionPara…

104d3fb

…metersRuleTest

zonuexe force-pushed the feature/array_find branch from 8459f4d to 104d3fb Compare November 5, 2024 20:08

zonuexe marked this pull request as ready for review November 5, 2024 20:13

ondrejmirtes merged commit 9798bd4 into phpstan:1.12.x Nov 5, 2024
452 checks passed

zonuexe deleted the feature/array_find branch November 5, 2024 20:24

zonuexe mentioned this pull request Nov 5, 2024

Make ArrayFindArgVisitor supports array_any() and array_all() #3608

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ArrayFindFunctionReturnTypeExtension #3518

Add ArrayFindFunctionReturnTypeExtension #3518

zonuexe commented Sep 30, 2024

VincentLanglet Oct 1, 2024

zonuexe Oct 1, 2024

VincentLanglet Oct 1, 2024

zonuexe Oct 1, 2024

VincentLanglet Oct 1, 2024

zonuexe Oct 1, 2024

VincentLanglet Oct 1, 2024

staabm Oct 1, 2024

VincentLanglet Oct 1, 2024

zonuexe Oct 1, 2024

VincentLanglet Oct 1, 2024

phpstan-bot commented Nov 2, 2024

ondrejmirtes Nov 5, 2024

zonuexe Nov 5, 2024

zonuexe Nov 5, 2024

zonuexe commented Nov 5, 2024

ondrejmirtes commented Nov 5, 2024

zonuexe commented Nov 5, 2024

ondrejmirtes Nov 5, 2024

zonuexe Nov 5, 2024

ondrejmirtes left a comment

zonuexe commented Nov 5, 2024

phpstan-bot commented Nov 5, 2024

ondrejmirtes commented Nov 5, 2024

Add ArrayFindFunctionReturnTypeExtension #3518

Add ArrayFindFunctionReturnTypeExtension #3518

Conversation

zonuexe commented Sep 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phpstan-bot commented Nov 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zonuexe commented Nov 5, 2024

ondrejmirtes commented Nov 5, 2024

zonuexe commented Nov 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ondrejmirtes left a comment

Choose a reason for hiding this comment

zonuexe commented Nov 5, 2024

phpstan-bot commented Nov 5, 2024

ondrejmirtes commented Nov 5, 2024