Skip to content
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.

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

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

Closed
3 of 5 tasks
m2-assistant bot opened this issue Jan 31, 2025 · 2 comments · Fixed by #39153
Closed
3 of 5 tasks

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

m2-assistant bot opened this issue Jan 31, 2025 · 2 comments · Fixed by #39153
Labels
Area: Framework Component: Framework/Message Component: Message Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P3 May be fixed according to the position in the backlog. Reported on 2.4.x Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it

Comments

@m2-assistant
Copy link

m2-assistant bot commented Jan 31, 2025

This issue is automatically created based on existing pull request: #39153: [PHPDOC] Fix bad phpdoc for Magento\Framework\Message\ManagerInterface


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 :

$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 :(

Capture d’écran du 2024-09-10 14-39-16

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)
@m2-assistant m2-assistant bot added the Priority: P3 May be fixed according to the position in the backlog. label Jan 31, 2025
@engcom-Hotel engcom-Hotel moved this to Ready for Development in Low Priority Backlog Feb 24, 2025
@engcom-November engcom-November added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Mar 17, 2025
@engcom-Charlie engcom-Charlie added Component: Message Reported on 2.4.x Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Area: Framework Component: Framework/Message Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed labels Mar 26, 2025
@github-jira-sync-bot
Copy link

✅ Jira issue https://jira.corp.adobe.com/browse/AC-14312 is successfully created for this GitHub issue.

Copy link
Author

m2-assistant bot commented Mar 26, 2025

✅ Confirmed by @engcom-Charlie. Thank you for verifying the issue.
Issue Available: @engcom-Charlie, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Framework Component: Framework/Message Component: Message Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P3 May be fixed according to the position in the backlog. Reported on 2.4.x Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
Status: Ready for Development
Development

Successfully merging a pull request may close this issue.

4 participants