Skip to content

escapeHtml use @phpstan-return instead #5691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Hanmac wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

escapeHtml use @phpstan-return instead #5691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b346df2
escapeHtml use @phpstan-return instead
Hanmac Jul 16, 2026
872f761
Apply suggestions from code review
Hanmac Jul 30, 2026
8829329
Update View.php
Hanmac Jul 30, 2026
64b4090
Update History.php
Hanmac Jul 30, 2026
261693a
Update Sales.php
Hanmac Jul 30, 2026
834c06b
~ fix phpstan
Hanmac Jul 30, 2026
33d303e
~ fix cs
Hanmac Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions app/code/core/Mage/Adminhtml/Block/Sales/Order/Comments/View.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,10 @@ public function canSendCommentEmail()
/**
* Replace links in string
*
* @param null|string|string[] $data
* @param null|string[] $allowedTags
* @return ($data is array ? array<?string> : ?string)
* @param null|string|string[] $data
* @param null|string[] $allowedTags
* @return null|array<int, null|string>|string
* @phpstan-return ($data is array ? array<?string> : ?string)
*/
#[Override]
public function escapeHtml($data, $allowedTags = null)
Expand Down
7 changes: 4 additions & 3 deletions app/code/core/Mage/Adminhtml/Block/Sales/Order/View/History.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,10 @@ public function isCustomerNotificationNotApplicable(Mage_Sales_Model_Order_Statu
/**
* Replace links in string
*
* @param null|string|string[] $data
* @param null|string[] $allowedTags
* @return ($data is array ? array<?string> : ?string)
* @param null|string|string[] $data
* @param null|string[] $allowedTags
* @return null|array<int, null|string>|string
* @phpstan-return ($data is array ? array<?string> : ?string)
*/
#[Override]
public function escapeHtml($data, $allowedTags = null)
Expand Down
7 changes: 4 additions & 3 deletions app/code/core/Mage/Adminhtml/Helper/Sales.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,10 @@ public function applySalableProductTypesFilter($collection)
/**
* Escape string preserving links
*
* @param null|string|string[] $data
* @param null|string[] $allowedTags
* @return ($data is array ? array<?string> : ?string)
* @param null|string|string[] $data
* @param null|string[] $allowedTags
* @return null|array<int, null|string>|string
* @phpstan-return ($data is array ? array<?string> : ?string)
*/
public function escapeHtmlWithLinks($data, $allowedTags = null)
{
Expand Down
7 changes: 4 additions & 3 deletions app/code/core/Mage/Core/Block/Abstract.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1213,9 +1213,10 @@ public function __()

/**
* Escape html entities
* @param null|string|string[] $data
* @param null|string[] $allowedTags
* @return ($data is array ? array<?string> : ?string)
* @param null|string|string[] $data
* @param null|string[] $allowedTags
* @return null|array<int, null|string>|string
* @phpstan-return ($data is array ? array<?string> : ?string)
*/
public function escapeHtml($data, $allowedTags = null)
{
Expand Down
14 changes: 8 additions & 6 deletions app/code/core/Mage/Core/Helper/Abstract.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,9 +182,10 @@ public function __()
* Escape html entities
*
* @template T of mixed|string|string[]
* @param T $data
* @param null|string[] $allowedTags
* @return (T is array ? string[] : (T is null|bool|int|string ? T : mixed))
* @param T $data
* @param null|string[] $allowedTags
* @return mixed|string|string[]
* @phpstan-return (T is array ? string[] : (T is null|bool|int|string ? T : mixed))
Comment thread
Hanmac marked this conversation as resolved.
*/
public function escapeHtml($data, $allowedTags = null)
{
Expand Down Expand Up @@ -299,9 +300,10 @@ public function escapeScriptIdentifiers($data)
/**
* Escape quotes in java script
*
* @param string|string[] $data
* @param string $quote
* @return ($data is array ? string[] : string)
* @param string|string[] $data
* @param string $quote
* @return string|string[]
* @phpstan-return ($data is array ? string[] : string)
*/
public function jsQuoteEscape($data, $quote = "'")
{
Expand Down
Loading