Better typing for mb_convert_encoding #3749
Open
+33
−21
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jack-worman
force-pushed
the
mb_convert_encoding-can-return-false
branch
2 times, most recently
from
e514bc3 to
6f121ae
Compare
jack-worman
commented
Dec 21, 2024
| @@ -6312,7 +6312,7 @@ | |||
| 'mb_check_encoding' => ['bool', 'var='=>'string|array<string>', 'encoding='=>'string'], | |||
| 'mb_chr' => ['string|false', 'cp'=>'int', 'encoding='=>'string'], | |||
| 'mb_convert_case' => ['string', 'sourcestring'=>'string', 'mode'=>'int', 'encoding='=>'string'], | |||
| 'mb_convert_encoding' => ['string|array<int, string>|false', 'val'=>'string|array<int, string>', 'to_encoding'=>'string', 'from_encoding='=>'mixed'], | |||
| 'mb_convert_encoding' => ['string|array<scalar|null|array<scalar|null>>|false', 'val'=>'string|array<scalar|null|array<scalar|null>>', 'to_encoding'=>'string', 'from_encoding='=>'mixed'], | |||
There was a problem hiding this comment.
Is there a way to represent a recursive type?
Or is only going 3 layers deep good enough?
jack-worman
force-pushed
the
mb_convert_encoding-can-return-false
branch
3 times, most recently
from
7004ae4 to
8a95b77
Compare
jack-worman
force-pushed
the
mb_convert_encoding-can-return-false
branch
from
8a95b77 to
daee21d
Compare
zonuexe
reviewed
Jan 2, 2025
| } elseif ($compare === $isArray) { | ||
| return new ArrayType(new IntegerType(), new StringType()); | ||
| if ($isString->yes() || $isArray->yes()) { | ||
| return new UnionType([$argType, new ConstantBooleanType(false)]); |
There was a problem hiding this comment.
In all versions, the mb_convert_encoding() function throws an error for invalid encodings, so it makes sense to use BenevolentUnionType instead of Union. https://3v4l.org/YuXmF
Suggested change
| return new UnionType([$argType, new ConstantBooleanType(false)]); | |
| return new BenevolentUnionType([$argType, new ConstantBooleanType(false)]); |
Using a benevolent union, we can pass it to function calls expecting strings without any extra assertions, like this: https://phpstan.org/r/fbcfe268-adc6-48cd-9f35-c66b3117c269
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes phpstan/phpstan#12309
Also, fixed types related to the array input and output; the output array has the exact same shape as the input array: https://3v4l.org/OrdDb