[PHPDOC] Fix bad phpdoc \Magento\Sales\Model\Order\Email\Container\Template::$id property

[dimitriBouteille]

Description (*)

This PR fix the bad phpdoc for \Magento\Sales\Model\Order\Email\Container\Template::$id, actually $id is type int but in reality is string.

For example, with PHPSTAN is very complicated to setup the project with level 5 or higher :(

Workaround

Add @phpstan-ignore-next-line before call setTemplateId :(

Related Pull Requests

None

Fixed Issues (if relevant)

None

Manual testing scenarios (*)

Setup PHPSTAN with level 5 or higher and run check.

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)

Resolved issues:

1. resolves [Issue] Fix bad \Magento\Sales\Model\Order\Email\Container\Template::$id property #39151: Fix bad \Magento\Sales\Model\Order\Email\Container\Template::$id property

[m2-assistant]

Hi @dimitriBouteille. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.

Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ 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.

[dimitriBouteille]

@magento run all tests

[engcom-Hotel]

@magento create issue

[orlangur]

Hi @dimitriBouteille! Is there some ongoing big effort at the moment to adopt PhpStan at certain level or something?

Generally, everywhere in Magento int in PHPDoc always assumes numeric string as well, please check #26930 (review) which we raised before on this. We can make some decision on how we're going to deal with this in general but changing PHPDoc at some random place is definitely not a way to do.

[dimitriBouteille]

Hi @orlangur Thanks for your feedback :)

Today, if I want to set up PHPStan with level 5 (even worth testing a higher level) it is very complicated because the Magento code is not clean, a good part of the PHPDoc is not correct ...

The best solution to implement PHPStan today is to go through bitExpert/phpstan-magento and add several ignores in PHPStan. Ignoring rules is stupid, especially when the goal is to ensure the quality of the code.

I know that Magento has been around for a while and typing with PHP was complicated, but now with the arrival of PHP 8.x, we should still improve the typing. The idea is to improve PHPDoc because less cumbersome than modifying the code by adding the strict type (e.g : returns type, arguments type, ...).

Decisions made some time ago are one thing, but knowing how to evolve with your time to improve the code is better ❤️

Finally, I’m not sure that adding int from everywhere is a better solution than doing a real typing as I propose with these different PR: https://github.com/magento/magento2/pulls?q=is%3Aopen+is%3Apr+author%3AdimitriBouteille+phpdoc

[engcom-Hotel]

@magento run all tests

[engcom-Hotel]

Hello @dimitriBouteille,

Thanks for the contribution!

Please fix the static test failures.

Thanks

[engcom-Charlie]

@magento run all tests

[engcom-Charlie]

Hi @engcom-Hotel,

I have fixed the static test failure. Requesting for review again.

Thank you!

[engcom-Charlie]

Manual testing is not required here, as this PR is only updating the doc block. Since the build is failing, moving it to Extended Testing.

[engcom-Charlie]

@magento run all tests

[engcom-Charlie]

@magento run Functional Tests B2B, Functional Tests EE

[engcom-Charlie]

One of the Functional B2B test is not consistent in recent 2 builds. The other failing test is a known issue. The failure is neither related to PR nor part of this PR.

Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39150/1f3e88135fbe06c09f5f7978ab3e22fb/Functional/allure-report-b2b/index.html#categories/988933238a2456b9ee17504aca2226e3/81d53ac848616c13/

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39150/e13caf98f24f728547ce8509f8927ff9/Functional/allure-report-b2b/index.html#categories

The Functional EE test failure is neither related to PR nor part of this PR. Its a known failure. Hence moving this PR to Merge in Progress.

Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39150/cec8fb588ac457b943a9c3ad78a40683/Functional/allure-report-ee/index.html#categories

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39150/cc6af5e36e3896eb108fce2432b803b3/Functional/allure-report-ee/index.html#categories

Known Issue:
ACQE-7460: CheckingOfPreviewingRegistryUpdateEmailTest