Fix accepted types for escaper methods #40114
Open
+22
−22
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.
Description (*)
When performing static analysis using phpstan on level 5 or higher on (custom) phtml files, we often run into false positives that have to do with the kind of data we send to one of the many
escape
methods.Also the return type of
escapeHtml
was not clear as it can return astring
orarray
depending on the type you send to the method.We fix that in this PR.
Many thanks to @navarr who came up this suggested solution in scope of bitExpert/phpstan-magento#346
Related Pull Requests
Fixed Issues (if relevant)
Manual testing scenarios (*)
See #40012 & bitExpert/phpstan-magento#346
Maybe I'll find more time later to work out a good example, but I don't have the time at the moment.
Questions or comments
Contribution checklist (*)