Fix accepted types for escaper methods

[hostep]

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 a string or array 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)

1. Fixes Unclear/invalid return types in Magento\Framework\Escaper #40012

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 (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
• All automated tests passed successfully (all builds are green)

[m2-assistant]

Hi @hostep. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

• @magento run all tests - run or re-run all required tests against the PR changes
• @magento run <test-build(s)> - run or re-run specific test build(s)
  For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. WebAPI Tests
13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

---

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

[hostep]

@magento run all tests

[engcom-Hotel]

@magento run all tests

[engcom-Hotel]

Hello @hostep,

Thanks for the contribution!

Please refer to the below review comment. The failed functional test seems flaky to me, hence re-running the test.

For SVC failure we have created a JIRA for approval. Please fix the review comment, so that we can proceed for the SVC approval.

Thanks

[engcom-Hotel]

Suggested change

	* Copyright 2013 Adobe
	* Copyright 2011 Adobe

[hostep]

@engcom-Hotel: it should be 2013, not 2011. Looking at the git history, github is guessing it got renamed from app/code/core/Mage/Adminhtml/Model/System/Config/Backend/Price/Scope.php to app/code/core/Mage/Adminhtml/Block/Tax/Rate/ImportExportHeader.php in 2011 and then to app/code/Magento/Adminhtml/Block/Sales/Order/View/History.php in 2013

But going from a PriceScopeBackendConfig to a TaxRateImportExportHeader to a SalesOrderViewHistoryBlock makes no sense to me. So in my opinion it should be 2013.

Can you double check this again?

I didn't check the other files, only this one...

[hostep]

If you really believe it should be 2011, go ahead and change it yourself because I'm unavailable for the next 2 weeks, since I'll go on holiday. Thanks!

[engcom-Hotel]

Suggested change

	* Copyright 2013 Adobe
	* Copyright 2011 Adobe

[engcom-Hotel]

Suggested change

	* Copyright 2014 Adobe
	* Copyright 2013 Adobe

[engcom-Hotel]

Suggested change

	* Copyright 2014 Adobe
	* Copyright 2011 Adobe

[engcom-Hotel]

@magento run Functional Tests EE, Functional Tests B2B