Add Stubs for Magento's loosey-string behavior#346
Merged
shochdoerfer merged 1 commit intobitExpert:masterfrom Sep 27, 2025
Merged
Add Stubs for Magento's loosey-string behavior#346shochdoerfer merged 1 commit intobitExpert:masterfrom
shochdoerfer merged 1 commit intobitExpert:masterfrom
Conversation
In many cases, Magento typedefs a `string` but truly accepts anything that can be cast to a string. This can be annoying for things like Escaper and Session Messages, which many are inclined to pass Phrase objects into. Additionally, Escaper has return types of `string|array`, passing an array if the input is an array. However, Magento's documentation blocks don't specify that's when it passes an array - so phpstan thinks that the result of Escaper can be either at any time. In that way, you cannot echo out the result of an `escapeHtml` in a PHTML file on max level without getting some errors.
Member
|
Give me a bit more time to have a look. I am currently overloaded with work. Very much appreciated that you sent a PR! |
hostep
reviewed
Aug 4, 2025
| */ | ||
| namespace Magento\Framework\Message; | ||
|
|
||
| use \Stringable; |
Collaborator
There was a problem hiding this comment.
This \ can be removed here I believe
hostep
reviewed
Aug 4, 2025
5 tasks
Member
|
@hostep thx for helping out. Very much appreciated. |
Member
|
Thanks, @navarr, for your contribution. Sorry that it took way longer to merge than I expected. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
In many cases, Magento typedefs a
stringbut truly accepts anything that can be cast to a string. This can be annoying for things like Escaper and Session Messages, which many are inclined to pass Phrase objects into.Additionally, Escaper has return types of
string|array, passing an array if the input is an array. However, Magento's documentation blocks don't specify that's when it passes an array - so phpstan thinks that the result of Escaper can be either at any time. In that way, you cannot echo out the result of anescapeHtmlin a PHTML file on max level without getting some errors.Resolves #343