`array_fill()`: handle negative cases, support integer ranges and `non-empty-array` #603

staabm · 2021-07-31T06:52:02Z

array_fill expected the first arg to be an int.

see https://3v4l.org/Sq4tH

closes phpstan/phpstan#5284

staabm · 2021-07-31T07:14:02Z

array_fill expected the first arg to be an int.

when passing in e.g. 'abc' then it will return null.
see https://3v4l.org/TfY0e

not sure whether/how this function signature violating cases should be handled

staabm · 2021-07-31T07:26:04Z

build error looks unrelated to me. should be good to go.

ondrejmirtes

This isn't ideal. Ideally you'd return array when you're sure the count is 0 or positive, false if you're sure it's negative, and array|false if it's just an int or for example int<-3, 5..

For PHP 8 we should return NeverType here, and also modify functionMap_php80delta.php to have 0|positive-int there.

staabm

This isn't ideal. Ideally you'd return array when you're sure the count is 0 or positive, false if you're sure it's negative, and array|false if it's just an int or for example int<-3, 5..

For PHP 8 we should return NeverType here, and also modify functionMap_php80delta.php to have 0|positive-int there.

oh wow, a lot of cases I didn't think about. great feedback as always <3.
I think it should be incorporated into the PR

src/Type/Php/ArrayFillFunctionReturnTypeExtension.php

staabm · 2021-08-17T19:09:47Z

the latest commit adds the test-cases from #602 - which I closed now

ondrejmirtes · 2021-08-18T07:00:24Z

resources/functionMap_php80delta.php

@@ -146,6 +146,7 @@
 	'old' => [

 		'array_combine' => ['associative-array|false', 'keys'=>'string[]|int[]', 'values'=>'array'],
+		'array_fill' => ['array', 'start_key'=>'int', 'num'=>'0|positive', 'val'=>'mixed'],


If you add something to the old section, you just remove the key from the final map.

I am not sure what todo. I moved this line to the new section now.

is there anything I can do to test the change to this file?

It's not necessary to test it. You can test it yourself simply by analysing file with wrong array_fill() call.

ok - tested the latest change locally and it works:

$ php bin/phpstan analyze test.php --level max Note: Using configuration file C:\xampp7.3\htdocs\phpstan-src\phpstan.neon.dist. 1/1 [============================] 100% ------ -------------------------------------------------------------------- Line test.php ------ -------------------------------------------------------------------- 4 Parameter #2 $count of function array_fill expects int<0, max>, -5 given. ------ -------------------------------------------------------------------- [ERROR] Found 1 error

src/Type/Php/ArrayFillFunctionReturnTypeExtension.php

staabm · 2021-08-19T16:08:45Z

resources/functionMap.php

@@ -271,7 +271,7 @@
 'array_diff_uassoc\'1' => ['array', 'arr1'=>'array', 'arr2'=>'array', 'arr3'=>'array', 'arg4'=>'array|callable(mixed,mixed):int', '...rest='=>'array|callable'],
 'array_diff_ukey' => ['array', 'arr1'=>'array', 'arr2'=>'array', 'key_comp_func'=>'callable(mixed,mixed):int'],
 'array_diff_ukey\'1' => ['array', 'arr1'=>'array', 'arr2'=>'array', 'arr3'=>'array', 'arg4'=>'array|callable(mixed,mixed):int', '...rest='=>'array|callable(mixed,mixed):int'],
-'array_fill' => ['array', 'start_key'=>'int', 'num'=>'int', 'val'=>'mixed'],
+'array_fill' => ['array', 'start_index'=>'int', 'count'=>'int', 'value'=>'mixed'],


adjusted the param names to the ones named on php.net: https://www.php.net/manual/en/function.array-fill.php

I don't want this. The parameter names are correct because on PHP 8 these signatures are merged with https://github.com/phpstan/php-8-stubs. So there's no need for this change.

ondrejmirtes · 2021-08-20T09:59:42Z

resources/functionMap.php

@@ -271,7 +271,7 @@
 'array_diff_uassoc\'1' => ['array', 'arr1'=>'array', 'arr2'=>'array', 'arr3'=>'array', 'arg4'=>'array|callable(mixed,mixed):int', '...rest='=>'array|callable'],
 'array_diff_ukey' => ['array', 'arr1'=>'array', 'arr2'=>'array', 'key_comp_func'=>'callable(mixed,mixed):int'],
 'array_diff_ukey\'1' => ['array', 'arr1'=>'array', 'arr2'=>'array', 'arr3'=>'array', 'arg4'=>'array|callable(mixed,mixed):int', '...rest='=>'array|callable(mixed,mixed):int'],
-'array_fill' => ['array', 'start_key'=>'int', 'num'=>'int', 'val'=>'mixed'],
+'array_fill' => ['array', 'start_index'=>'int', 'count'=>'int', 'value'=>'mixed'],


I don't want this. The parameter names are correct because on PHP 8 these signatures are merged with https://github.com/phpstan/php-8-stubs. So there's no need for this change.

ondrejmirtes · 2021-08-20T10:00:27Z

tests/PHPStan/Parallel/SchedulerTest.php

@@ -87,6 +87,10 @@ public function testSchedule(
 		array $expectedJobSizes
 	): void
 	{
+		if ($numberOfFiles < 0) {
+			throw new \PHPStan\ShouldNotHappenException();


I'd rather just have 0|positive-int in the PHPDoc

since phpstan does not verify the phpdoc against the phpunit-data-provider I figured it would be more safe to use a IF check here.

will change to your suggestion though

ondrejmirtes · 2021-08-20T11:07:50Z

Thank you!

ntzm · 2021-08-20T14:28:23Z

Thanks @staabm!

staabm changed the title ~~array_fill() always returns false on negative 2nd arg~~ array_fill() always returns false on negative 2nd arg Jul 31, 2021

ondrejmirtes requested changes Aug 12, 2021

View reviewed changes

staabm force-pushed the array_fill_always_false branch from 02d53ed to 4eef39d Compare August 17, 2021 18:52

staabm commented Aug 17, 2021

View reviewed changes

src/Type/Php/ArrayFillFunctionReturnTypeExtension.php Show resolved Hide resolved

staabm changed the title ~~array_fill() always returns false on negative 2nd arg~~ array_fill() handle negative cases and support integer ranges Aug 17, 2021

staabm changed the title ~~array_fill() handle negative cases and support integer ranges~~ array_fill() handle negative cases, support integer and non-empty-array ranges Aug 17, 2021

staabm mentioned this pull request Aug 17, 2021

Support non-empty-array with positive-int given to array_fill #602

Closed

staabm changed the title ~~array_fill() handle negative cases, support integer and non-empty-array ranges~~ array_fill(): handle negative cases, support integer ranges and non-empty-array Aug 17, 2021

ondrejmirtes requested changes Aug 18, 2021

View reviewed changes

ondrejmirtes requested changes Aug 19, 2021

View reviewed changes

src/Type/Php/ArrayFillFunctionReturnTypeExtension.php Outdated Show resolved Hide resolved

staabm added 7 commits August 19, 2021 17:49

array_fill() always returns false on negative 2nd arg

7e13ef2

cover integer-range in array_fill

a60c9af

adjust functionMap php8-delta

f41fe10

fix CS

de4a669

added more testcases

49ca5f0

try to fix function map

3783f90

utilize throwsValueErrorForInternalFunctions

b974285

staabm force-pushed the array_fill_always_false branch from e20072f to b974285 Compare August 19, 2021 15:49

adjusted function-map

a571745

staabm commented Aug 19, 2021

View reviewed changes

staabm added 2 commits August 19, 2021 18:14

pass positive-int to array_fill()

5b669cc

fix CS

5fc8496

ondrejmirtes requested changes Aug 20, 2021

View reviewed changes

staabm added 2 commits August 20, 2021 12:09

revert naming changes

1cd28f4

use 0|positive-int instead

af9196d

ondrejmirtes merged commit fdf732c into phpstan:master Aug 20, 2021

staabm deleted the array_fill_always_false branch August 20, 2021 11:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`array_fill()`: handle negative cases, support integer ranges and `non-empty-array` #603

`array_fill()`: handle negative cases, support integer ranges and `non-empty-array` #603

staabm commented Jul 31, 2021 •

edited

staabm commented Jul 31, 2021 •

edited

staabm commented Jul 31, 2021

ondrejmirtes left a comment

staabm left a comment

staabm commented Aug 17, 2021

ondrejmirtes Aug 18, 2021

staabm Aug 18, 2021

ondrejmirtes Aug 19, 2021

staabm Aug 19, 2021

staabm Aug 19, 2021

ondrejmirtes Aug 20, 2021

ondrejmirtes Aug 20, 2021

ondrejmirtes Aug 20, 2021

staabm Aug 20, 2021

ondrejmirtes commented Aug 20, 2021

ntzm commented Aug 20, 2021

array_fill(): handle negative cases, support integer ranges and non-empty-array #603

array_fill(): handle negative cases, support integer ranges and non-empty-array #603

Conversation

staabm commented Jul 31, 2021 • edited

staabm commented Jul 31, 2021 • edited

staabm commented Jul 31, 2021

ondrejmirtes left a comment

Choose a reason for hiding this comment

staabm left a comment

Choose a reason for hiding this comment

staabm commented Aug 17, 2021

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

ondrejmirtes commented Aug 20, 2021

ntzm commented Aug 20, 2021

`array_fill()`: handle negative cases, support integer ranges and `non-empty-array` #603

`array_fill()`: handle negative cases, support integer ranges and `non-empty-array` #603

staabm commented Jul 31, 2021 •

edited

staabm commented Jul 31, 2021 •

edited