escapeHtml use @phpstan-return instead - #5691
Draft
Hanmac wants to merge 7 commits into
Draft
Conversation
github-actions
Bot
added
Component: Core
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adjusts PHPDoc return type annotations for various escapeHtml* helpers/wrappers to move conditional return types into @phpstan-return, aiming to keep IDE-friendly @return types while retaining PHPStan precision.
Changes:
- Replaced conditional
@returnannotations with@phpstan-returnin severalescapeHtml*-related methods. - Simplified/realigned PHPDoc
@param/@returntype declarations for IDE consumption.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| app/code/core/Mage/Core/Helper/Abstract.php | Moves escapeHtml() conditional typing to @phpstan-return and adjusts the public @return. |
| app/code/core/Mage/Core/Block/Abstract.php | Updates wrapper escapeHtml() PHPDoc to pair IDE-friendly @return with @phpstan-return. |
| app/code/core/Mage/Adminhtml/Helper/Sales.php | Updates escapeHtmlWithLinks() PHPDoc return typing and phpstan return typing split. |
| app/code/core/Mage/Adminhtml/Block/Sales/Order/View/History.php | Updates overridden escapeHtml() PHPDoc return typing split. |
| app/code/core/Mage/Adminhtml/Block/Sales/Order/Comments/View.php | Updates overridden escapeHtml() PHPDoc return typing split. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
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
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 (*)
kinda revert from #5402
looks like the IDE aren't ready yet, so i moved the stuff to
@phpstan-returnRelated Pull Requests
Fixed Issues (if relevant)
Manual testing scenarios (*)
Questions or comments
Contribution checklist (*)