Skip to content

Commit 6d024bb

Browse files
added short descriptions for methods
1 parent 7199dfe commit 6d024bb

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

app/code/Magento/CatalogInventory/Model/StockState.php

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
use Magento\Framework\DataObject;
1313

1414
/**
15+
* Provides functionality for stock state information
16+
*
1517
* Interface StockState
1618
*/
1719
class StockState implements StockStateInterface
@@ -32,6 +34,8 @@ class StockState implements StockStateInterface
3234
protected $stockConfiguration;
3335

3436
/**
37+
* StockState constructor
38+
*
3539
* @param StockStateProviderInterface $stockStateProvider
3640
* @param StockRegistryProviderInterface $stockRegistryProvider
3741
* @param StockConfigurationInterface $stockConfiguration
@@ -47,6 +51,8 @@ public function __construct(
4751
}
4852

4953
/**
54+
* Verify stock by product id
55+
*
5056
* @param int $productId
5157
* @param int $scopeId
5258
* @return bool
@@ -60,6 +66,8 @@ public function verifyStock($productId, $scopeId = null)
6066
}
6167

6268
/**
69+
* Verify notification by product id
70+
*
6371
* @param int $productId
6472
* @param int $scopeId
6573
* @return bool
@@ -90,8 +98,7 @@ public function checkQty($productId, $qty, $scopeId = null)
9098
}
9199

92100
/**
93-
* Returns suggested qty that satisfies qty increments and minQty/maxQty/minSaleQty/maxSaleQty conditions
94-
* or original qty if such value does not exist
101+
* Returns suggested qty that satisfies qty increments/minQty/maxQty/minSaleQty/maxSaleQty conditions else original qty
95102
*
96103
* @param int $productId
97104
* @param float $qty
@@ -122,6 +129,8 @@ public function getStockQty($productId, $scopeId = null)
122129
}
123130

124131
/**
132+
* Check qty increments by product id
133+
*
125134
* @param int $productId
126135
* @param float $qty
127136
* @param int $websiteId
@@ -136,6 +145,8 @@ public function checkQtyIncrements($productId, $qty, $websiteId = null)
136145
}
137146

138147
/**
148+
* Check quote item qty
149+
*
139150
* @param int $productId
140151
* @param float $itemQty
141152
* @param float $qtyToCheck

0 commit comments

Comments
 (0)