[PHPDOC] Fix bad phpdoc for Magento\Framework\Message\ManagerInterface

[dimitriBouteille]

Description (*)

This PR fix the bad phpdoc for \Magento\Framework\Message\ManagerInterface and remove all duplicate phpdoc in \Magento\Framework\Message\Manager (use inheritdoc syntaxe).

Actually all add*Message functions (addErrorMessage, addSuccess, addWarningMessage, ...) accept a string value in $message variable.

This PR allows to pass either a \Magento\Framework\Phrase or a string.

Here is an example where the type \Magento\Framework\Phrase is used :

magento2/app/code/Magento/Checkout/Controller/Cart/Delete.php

Line 38 in 0cfe4a3

$this->messageManager->addErrorMessage(__('We can\'t remove the item.'));

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

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] [PHPDOC] Fix bad phpdoc for Magento\Framework\Message\ManagerInterface #39593: [PHPDOC] Fix bad phpdoc for Magento\Framework\Message\ManagerInterface

[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 run all tests

[engcom-Hotel]

@magento run Static Tests

[engcom-Hotel]

@magento run Functional Tests B2B, Functional Tests CE, Functional Tests EE, Unit Tests

[engcom-Hotel]

Hello @dimitriBouteille,

Thanks for the contribution!

The changes look good to us. However, please address the failed tests, particularly the static tests.

Thanks

[engcom-Charlie]

@magento run all tests

[engcom-Charlie]

@magento run all tests

[engcom-Charlie]

@magento run all tests

[engcom-Charlie]

@magento run all tests

[engcom-Charlie]

@magento run all tests

[engcom-Charlie]

@engcom-Hotel, I have fixed the static test failures. Requesting for the review.

Thank you!

[engcom-Charlie]

As @ihor-sviziev started reviewing the PR again, moving it back to Changes Requested from Merge in Progress.

[engcom-Charlie]

@magento run all tests

[engcom-Charlie]

@magento run all tests

[engcom-Charlie]

@magento run Integration Tests, Functional Tests CE, Functional Tests EE

[engcom-Charlie]

The review changes have been implemented and approved hence moving it to Ready for Testing.

[engcom-Charlie]

No manual testing is required here, as only the bad doc blocks are getting updated. Currently moving this PR to Extended Testing as the build is failing.

[engcom-Charlie]

@magento run WebAPI Tests

[engcom-Charlie]

@magento run all tests

[engcom-Charlie]

@magento run Integration Tests

[engcom-Charlie]

@magento run all tests

[engcom-Charlie]

@magento run Functional Tests B2B, Functional Tests CE, Unit Tests

[engcom-Charlie]

Hi @dimitriBouteille,

As I am working on the build stabilization activity of this PR, requesting you to please don't merge latest codebase in this PR. If any input needed from your end will let you know.

Thank you!

[engcom-Charlie]

@magento run all tests

[engcom-Charlie]

@magento run Functional Tests B2B, Functional Tests CE, Integration Tests

[engcom-Charlie]

One of the Functional B2B test failure is inconsistent in the last two builds, it seem to be flaky and the other one is a known issue. They neither part of PR nor failing because of the PR changes.

Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39153/6b368458733182aecc9a07f0fcf2b7a6/Functional/allure-report-b2b/index.html#categories/2fc037f47773dd7551f2e766bbf34efa/d01814eab6700437/

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

Known Issue:
StorefrontAssertAsLowAsLabelTest: ACQE-7389

One of the Functional CE test failure is inconsistent in the last two builds, it seem to be flaky . They neither part of PR nor failing because of the PR changes. Hence moving it to Merge In Progress.

Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39153/81d5a862903c6903ed35b5ab74dc7190/Functional/allure-report-ce/index.html#categories

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39153/3e5cd018f3060fafd0c32d7d158f7fc2/Functional/allure-report-ce/index.html#categories