[Issue] Update bundle price renderer docblock

m2-assistant[bot] commented 3 years ago

This issue is automatically created based on existing pull request: magento/magento2#31823: Update bundle price renderer docblock

Description

PHPStan fails when using the original block:

 ------ --------------------------------------------------------------------------------------------------------------------- 
  Line   app/design/frontend/my/theme-x/Magento_Bundle/templates/email/order/items/creditmemo/default.phtml  
 ------ --------------------------------------------------------------------------------------------------------------------- 
  25     Parameter #1 $item of method                                                                                         
         Magento\Bundle\Block\Sales\Order\Items\Renderer::getItemPrice()                                                      
         expects                                                                                                              
         Magento\Bundle\Block\Sales\Order\Items\CreditmemoItem|Magento\Bundle\                                                
         Block\Sales\Order\Items\InvoiceItem|Magento\Bundle\Block\Sales\Order\                                                
         Items\OrderItem, Magento\Sales\Model\Order\Item given.                                                               
 ------ ---------------------------------------------------------------------------------------------------------------------

default.phtml line 25:

<p class="item-price"><?= /* @noEscape */ $block->getItemPrice($item->getOrderItem()) ?></p>

Related Pull Requests

Fixed Issues (if relevant)

Fixes magento/magento2#

Manual testing scenarios

Configure PHPStan to run against your app/design files;
Have the following line on your app/design/frontend/my/theme-x/Magento_Bundle/templates/email/order/items/creditmemo/default.phtml file:

<p class="item-price"><?= /* @noEscape */ $block->getItemPrice($item->getOrderItem()) ?></p>

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)
[ ] All automated tests passed successfully (all builds are green)

m2-assistant[bot] commented 5 months ago

Hi @engcom-November. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

[ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
[ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
[ ] 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
[ ] 4. Verify that the issue is reproducible on 2.4-develop branch
Details
- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
[ ] 5. Add label Issue: Confirmed once verification is complete.
[ ] 6. Make sure that automatic system confirms that report has been added to the backlog.

engcom-November commented 5 months ago

Hello @kassner,

Thank you for the report and collaboration!

Verified this issue on 2.4-develop. When calling $item->getOrderItem() of type Magento\Sales\Model\Order\Item inside $block->getItemPrice($item->getOrderItem()) of type \Magento\Bundle\Block\Sales\Order\Items\Renderer, php stan is throwing the below error:

The return type of getItemPrice method is incorrect.

Hence confirming the issue.

Thank you.

github-jira-sync-bot commented 5 months ago

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

m2-assistant[bot] commented 5 months ago

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

github-jira-sync-bot commented 5 months ago

:x: Cannot export the issue. This GitHub issue is already linked to Jira issue(s): https://jira.corp.adobe.com/browse/AC-11737

magento / magento2