PHPdoc of setUseConfigMinSaleQty method uses int instead of bool

[hostep]

Preconditions and environment

• Magento 2.4.5-p1 or 2.4-develop (and probably all older versions)

Steps to reproduce

1. Look at https://github.com/magento/magento2/blob/fc4d9cc9673dc1ae123fca5db96a64947b49c567/app/code/Magento/CatalogInventory/Api/Data/StockItemInterface.php#L175-L179
2. Also look at https://github.com/magento/magento2/blob/fc4d9cc9673dc1ae123fca5db96a64947b49c567/app/code/Magento/CatalogInventory/Model/Stock/Item.php#L656-L663

Expected result

* @param bool $useConfigMinSaleQty

This documentation is incorrect, this flag should be a boolean and not an integer

Actual result

You'll see:

* @param int $useConfigMinSaleQty

Additional information

When running a static analyser like phpstan on our custom code that tries to set this flag with a boolean value, we get a warning that we should provide an integer. But that's not correct in my opinion. This is a flag and not an integer value that's expected. So the documentation should be updated here.

All othersetUseConfig* methods in those classes are defined with a boolean, just the setUseConfigMinSaleQty is incorrectly defined.

Release note

Fixes phpdoc block for the StockItemInterface::setUseConfigMinSaleQty method, from expecting an integer to expecting a boolean value.

Triage and priority

• [ ] Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• [ ] Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• [ ] Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• [ ] Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• [X] Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant[bot]]

Hi @hostep. Thank you for your report. To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

For more details, review the Magento Contributor Assistant documentation.

Add a comment to assign the issue: @magento I am working on this

To learn more about issue processing workflow, refer to the Code Contributions.

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

  :warning: According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

:clock10: You can find the schedule on the Magento Community Calendar page.

:telephone_receiver: The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[m2-assistant[bot]]

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]

Hi @hostep , Thank you for reporting and collaboration. Verified the issue on Magento 2.4-develop instance and the issue is reproducible. Hence confirming the issue. All othersetUseConfig methods in the class are defined as boolean, onlysetUseConfigMinSaleQty is incorrectly defined.

[github-jira-sync-bot]

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

[m2-assistant[bot]]

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