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.

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

Jump to bottom

[PHPDOC] Fix functions orderComment in Magento\Sales\Model\Order #39572

Open
wants to merge 1 commit into
base: 2.4-develop
Choose a base branch
from
Open

[PHPDOC] Fix functions orderComment in Magento\Sales\Model\Order #39572

wants to merge 1 commit into from

Conversation

dimitriBouteille
Copy link
Contributor

@dimitriBouteille dimitriBouteille commented Jan 28, 2025 •
edited by m2-assistant bot
Loading

Description (*)

This PR fix the bad phpdoc in \Magento\Sales\Model\Order. The argument $comment in the following functions accept a Phrase object

  • addStatusToHistory
  • addStatusHistoryComment
  • addCommentToStatusHistory

Here is an example where the type Phrase is used :

magento2/app/code/Magento/Paypal/Model/Ipn.php

Lines 220 to 226 in d06337a

$message = __(
'IPN "%1". A dispute has been resolved and closed. %2 Transaction amount %3.',
ucfirst($reasonCode),
$notificationAmount,
$reasonComment
);
$this->_order->addStatusHistoryComment($message)->setIsCustomerNotified(false)->save();

With PHPSTAN is very complicated to setup the project with level 5 or higher :(

Capture d’écran du 2025-01-28 12-01-59

Related Pull Requests

None

Fixed Issues (if relevant)

None

Manual testing scenarios (*)

Setup PHPSTAN with level 5 or higher and run check.

Questions or comments

The quality of Magento code needs to be improved so that it is easier to use the code quality tools (phpstan, rector, ...) ❤️

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 functions orderComment in Magento\Sales\Model\Order #39575: [PHPDOC] Fix functions orderComment in Magento\Sales\Model\Order

@m2-assistant M2 Assistant
Copy link

m2-assistant bot commented Jan 28, 2025

Hi @dimitriBouteille. 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.

@dimitriBouteille
Copy link
Contributor Author

@magento run all tests

@engcom-Hotel
Copy link
Contributor

@magento create issue

@m2-assistant m2-assistant bot mentioned this pull request Jan 28, 2025
Open
5 tasks
@engcom-Hotel engcom-Hotel added the Priority: P3 May be fixed according to the position in the backlog. label Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Priority: P3 May be fixed according to the position in the backlog.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Issue] [PHPDOC] Fix functions orderComment in Magento\Sales\Model\Order
2 participants
@dimitriBouteille @engcom-Hotel