Specify return type for `filter_input()` #2010

herndlm · 2022-11-18T17:05:23Z

See https://www.php.net/manual/en/function.filter-input.php, the important difference to filter_var is the handling of the non-set variables in the superglobal arrays

Return Values
Value of the requested variable on success, false if the filter fails, or null if the var_name variable is not set. If the flag FILTER_NULL_ON_FAILURE is used, it returns false if the variable is not set and null if the filter fails.

phpstan-bot · 2022-11-18T20:53:53Z

This pull request has been marked as ready for review.

phpstan-bot · 2022-11-20T19:57:38Z

This pull request has been marked as ready for review.

herndlm · 2022-12-21T08:00:32Z

do you think we can get that this one in the next release? 😊 it's 90% refactor and would help me get rid of some errors in a legacy app which helps me finish the 7.4 -> 8.x upgrade. at least that's what I was telling myself when I was last procrastinating when working on it :D

tests/PHPStan/Analyser/data/filter-input.php

tests/PHPStan/Rules/Functions/data/bug-6261.php

phpstan-bot · 2023-01-20T16:24:01Z

This pull request has been marked as ready for review.

src/Type/Php/FilterInputDynamicReturnTypeExtension.php

herndlm · 2023-01-31T07:04:35Z

Fyi the return type in case the array offset does not exist and the force array flag is set is not handled properly. It's a bit tricky and I might need to refactor the helper maybe. Good that you didn't merge it yet 😅

herndlm · 2023-02-25T21:21:41Z

I'm happy with this now, maybe the new method in the helper is useful for #2257 too.

phpstan-bot · 2023-02-25T21:21:53Z

This pull request has been marked as ready for review.

src/Type/Php/FilterInputDynamicReturnTypeExtension.php

ondrejmirtes · 2023-04-05T08:47:35Z

src/Type/Php/FilterInputDynamicReturnTypeExtension.php

+		$typeExpr = $functionCall->getArgs()[0]->value;
+		if (
+			!($typeExpr instanceof ConstFetch)
+			|| !in_array((string) $typeExpr->name, ['INPUT_GET', 'INPUT_POST', 'INPUT_COOKIE', 'INPUT_SERVER', 'INPUT_ENV'], true)


I don't like that this condition only works for literal INPUT_GET ConstFetch in the code, but doesn't work for @param INPUT_GET|INPUT_POST $abc from PHPDocs.

so rebasing does summon you :D

good point, I also dislike that. I'm not good with constants, do you have any better ideas you can think of? Do I need to resolve them somehow I suppose?

I thought this is already a solved problem, FilterFunctionReturnTypeHelper does this with hasFlag, $this->getConstant() etc.

yeah that would work I guess, I thought there's a better approach. I'll switch it to use those helpers then :)

adapted. I could not re-use those methods but found another approach. not sure yet if there's a better one though

can still be made stricter / more correct any time

ondrejmirtes · 2023-04-07T12:18:45Z

Thank you!

herndlm force-pushed the filter-input branch 5 times, most recently from 3c28408 to 41e927e Compare November 18, 2022 20:42

herndlm marked this pull request as ready for review November 18, 2022 20:52

herndlm force-pushed the filter-input branch from 41e927e to dade61f Compare November 18, 2022 21:17

herndlm marked this pull request as draft November 19, 2022 12:00

herndlm force-pushed the filter-input branch 3 times, most recently from 22740d4 to ff19000 Compare November 20, 2022 19:48

herndlm marked this pull request as ready for review November 20, 2022 19:57

herndlm force-pushed the filter-input branch 2 times, most recently from 3ca69d1 to 2ec1ef0 Compare December 11, 2022 20:41

herndlm force-pushed the filter-input branch from 2ec1ef0 to 84d53c7 Compare December 16, 2022 10:38

herndlm commented Dec 21, 2022

View reviewed changes

tests/PHPStan/Analyser/data/filter-input.php Show resolved Hide resolved

herndlm marked this pull request as draft December 27, 2022 14:45

ondrejmirtes force-pushed the 1.9.x branch from a5d90c1 to a69c7f0 Compare January 5, 2023 14:23

staabm reviewed Jan 20, 2023

View reviewed changes

tests/PHPStan/Rules/Functions/data/bug-6261.php Outdated Show resolved Hide resolved

herndlm force-pushed the filter-input branch from c4baa79 to d855530 Compare January 20, 2023 16:15

herndlm marked this pull request as ready for review January 20, 2023 16:23

herndlm commented Jan 20, 2023

View reviewed changes

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

ondrejmirtes requested changes Jan 20, 2023

View reviewed changes

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

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

herndlm commented Jan 20, 2023

View reviewed changes

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

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

herndlm force-pushed the filter-input branch from 266f71d to 4959e62 Compare January 30, 2023 17:24

herndlm marked this pull request as draft January 30, 2023 17:25

herndlm mentioned this pull request Feb 25, 2023

Add FilterVarArrayDynamicReturnTypeExtension #2257

Merged

herndlm force-pushed the filter-input branch from 4959e62 to 45e9d42 Compare February 25, 2023 21:09

herndlm changed the base branch from 1.9.x to 1.10.x February 25, 2023 21:09

herndlm force-pushed the filter-input branch from 45e9d42 to 30070eb Compare February 25, 2023 21:10

herndlm marked this pull request as ready for review February 25, 2023 21:21

herndlm requested a review from ondrejmirtes February 25, 2023 21:22

herndlm commented Feb 25, 2023

View reviewed changes

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

herndlm force-pushed the filter-input branch 2 times, most recently from 23874d7 to 7db3ed6 Compare February 27, 2023 08:04

herndlm mentioned this pull request Mar 4, 2023

Check filter_input* type param type #2271

Merged

herndlm mentioned this pull request Apr 3, 2023

Improve filter_* array handling, support FILTER_REQUIRE_ARRAY #2318

Merged

herndlm force-pushed the filter-input branch from 49d86e4 to e163865 Compare April 5, 2023 08:44

ondrejmirtes requested changes Apr 5, 2023

View reviewed changes

herndlm added 8 commits April 6, 2023 14:23

Specify return type for filter_input()

Verified

This commit was signed with the committer’s verified signature.

ondrejmirtes Ondřej Mirtes

SSH Key Fingerprint: nQaBxsLsjyDI9zZYhoglyLtC5WkW8FxBYwCGpmgkhlM
Verified
Learn about vigilant mode

9e1b8ab

Update src/Type/Php/FilterInputDynamicReturnTypeExtension.php

Verified

This commit was signed with the committer’s verified signature.

ondrejmirtes Ondřej Mirtes

SSH Key Fingerprint: nQaBxsLsjyDI9zZYhoglyLtC5WkW8FxBYwCGpmgkhlM
Verified
Learn about vigilant mode

b80da01

Update src/Type/Php/FilterInputDynamicReturnTypeExtension.php

Verified

This commit was signed with the committer’s verified signature.

ondrejmirtes Ondřej Mirtes

SSH Key Fingerprint: nQaBxsLsjyDI9zZYhoglyLtC5WkW8FxBYwCGpmgkhlM
Verified
Learn about vigilant mode

cd777e7

fix, improve and simplify

Verified

This commit was signed with the committer’s verified signature.

ondrejmirtes Ondřej Mirtes

SSH Key Fingerprint: nQaBxsLsjyDI9zZYhoglyLtC5WkW8FxBYwCGpmgkhlM
Verified
Learn about vigilant mode

5628019

Use ArrayType instead of Type in helper method arg

Verified

This commit was signed with the committer’s verified signature.

ondrejmirtes Ondřej Mirtes

SSH Key Fingerprint: nQaBxsLsjyDI9zZYhoglyLtC5WkW8FxBYwCGpmgkhlM
Verified
Learn about vigilant mode

7f85e3c

No need to limit input to array..

Verified

This commit was signed with the committer’s verified signature.

ondrejmirtes Ondřej Mirtes

SSH Key Fingerprint: nQaBxsLsjyDI9zZYhoglyLtC5WkW8FxBYwCGpmgkhlM
Verified
Learn about vigilant mode

35cf323

Support compound types as filter_input type constant

0883ece

herndlm force-pushed the filter-input branch from e163865 to 0883ece Compare April 6, 2023 12:43

ondrejmirtes merged commit 9c72fc1 into phpstan:1.10.x Apr 7, 2023

herndlm deleted the filter-input branch April 7, 2023 12:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Specify return type for `filter_input()` #2010

Specify return type for `filter_input()` #2010

herndlm commented Nov 18, 2022 •

edited

Loading

phpstan-bot commented Nov 18, 2022

phpstan-bot commented Nov 20, 2022

herndlm commented Dec 21, 2022

phpstan-bot commented Jan 20, 2023

herndlm commented Jan 31, 2023 •

edited

Loading

herndlm commented Feb 25, 2023

phpstan-bot commented Feb 25, 2023

ondrejmirtes Apr 5, 2023

herndlm Apr 5, 2023

ondrejmirtes Apr 5, 2023

herndlm Apr 5, 2023

herndlm Apr 6, 2023

ondrejmirtes commented Apr 7, 2023

Specify return type for filter_input() #2010

Specify return type for filter_input() #2010

Conversation

herndlm commented Nov 18, 2022 • edited Loading

phpstan-bot commented Nov 18, 2022

phpstan-bot commented Nov 20, 2022

herndlm commented Dec 21, 2022

phpstan-bot commented Jan 20, 2023

herndlm commented Jan 31, 2023 • edited Loading

herndlm commented Feb 25, 2023

phpstan-bot commented Feb 25, 2023

ondrejmirtes Apr 5, 2023

Choose a reason for hiding this comment

herndlm Apr 5, 2023

Choose a reason for hiding this comment

ondrejmirtes Apr 5, 2023

Choose a reason for hiding this comment

herndlm Apr 5, 2023

Choose a reason for hiding this comment

herndlm Apr 6, 2023

Choose a reason for hiding this comment

ondrejmirtes commented Apr 7, 2023

Specify return type for `filter_input()` #2010

Specify return type for `filter_input()` #2010

herndlm commented Nov 18, 2022 •

edited

Loading

herndlm commented Jan 31, 2023 •

edited

Loading