Should getQty() return int/float or string?

[sreichel]

Summary

• Magento 2.2-dev/2.3-dev
• PHP7.1 (strict)

PHPDocs blocks say getQty() should return float/int, but in most cases it returns a string. This is no problem until I use strict type declaration for my own extensions and trust in annotations.

Examples

Magento\Catalog\Model\Product

    /**
     * Get quantity for product
     *
     * @return float
     */
    public function getQty()
    {
        return $this->getData('qty');
    }

I'd expect to get a float returned, but you'll get a string ...

Proposed solution

1. how to fix?
   a. cast to float in getters?
   b. cast to float in setters?

2. where to fix?
   a. fix step by step?
   b. fix all occurrence?

Please let me know, how to fix before i create PRs.

[magento-engcom-team]

Hi @sreichel. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento-engcom-team give me $VERSION instance

where $VERSION is version tags (starting from 2.2.0+) or develop branches (for example: 2.3-develop).
For more details, please, review the Magento Contributor Assistant documentation.

@sreichel do you confirm that you was able to reproduce the issue on vanilla Magento instance following steps to reproduce?

• yes
• no

[magento-engcom-team]

Hi @engcom-backlog-nazar. 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: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label G1 Passed will be added to the issue automatically. Please, edit issue description if needed, until label G1 Passed appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add G2 Passed label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento-engcom-team give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.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. Verify that the issue is reproducible on 2.2-develop branch.

  Details

  - Add the comment @magento-engcom-team give me 2.2-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.2-develop branch, please add the label Reproduced on 2.2.x

• 6. Add label acknowledged once verification is complete.

• 7. Make sure that automatic system confirms that report is acknowledged.

HI @sreichel How did you use the getQty() ? i'm using the Magento\CatalogInventory\Api\StockStateInterface;
method $this->stockInvertory->getStockQty();
and was have correct return type 'float'

[sreichel]

Hi @engcom-backlog-nazar,

I observe checkout_cart_product_add_after event to manipulate cart items.

Simplified code:

$product = $observer->getProduct();
$qty = $product->getQty();
$result = $this->doSomething($qty);

In this case Magento\Catalog\Model\Product::getQty() is used.

@sreichel But i'm have correct return type.

@sreichel Ok i'm reproduce this with another number of qty like 110 :)

[sreichel]

@engcom-backlog-nazar very strange. Again tested on 2.2-dev ...