Mage_CatalogInventory - DOC block update

app/code/core/Mage/CatalogInventory/Block/Adminhtml/Form/Field/Customergroup.php

@@ -60,7 +60,7 @@ protected function _getCustomerGroups($groupId = null)
             $this->_customerGroups = array();
             $collection = Mage::getModel('customer/group')->getCollection();
             foreach ($collection as $item) {
-                /* @var $item Mage_Customer_Model_Group */
+                /* @var Mage_Customer_Model_Group $item */
                 $this->_customerGroups[$item->getId()] = $item->getCustomerGroupCode();
             }
         }
@@ -70,6 +70,10 @@ protected function _getCustomerGroups($groupId = null)
         return $this->_customerGroups;
     }
 
+    /**
+     * @param string $value
+     * @return Mage_CatalogInventory_Block_Adminhtml_Form_Field_Customergroup
+     */
     public function setInputName($value)
     {
         return $this->setName($value);

app/code/core/Mage/CatalogInventory/Block/Adminhtml/Form/Field/Minsaleqty.php

@@ -47,7 +47,8 @@ protected function _getGroupRenderer()
     {
         if (!$this->_groupRenderer) {
             $this->_groupRenderer = $this->getLayout()->createBlock(
-                'cataloginventory/adminhtml_form_field_customergroup', '',
+                'cataloginventory/adminhtml_form_field_customergroup',
+                '',
                 array('is_render_to_js_template' => true)
             );
             $this->_groupRenderer->setClass('customer_group_select');
@@ -76,7 +77,7 @@ protected function _prepareToRender()
     /**
      * Prepare existing row data object
      *
-     * @param Varien_Object
+     * @param Varien_Object $row
      */
     protected function _prepareArrayRow(Varien_Object $row)
     {

app/code/core/Mage/CatalogInventory/Block/Stockqty/Abstract.php

@@ -96,5 +96,4 @@ public function isMsgVisible()
     {
         return ($this->getStockQty() > 0 && $this->getStockQty() <= $this->getThresholdQty());
     }
-
 }

app/code/core/Mage/CatalogInventory/Block/Stockqty/Composite.php

@@ -64,6 +64,7 @@ public function getChildProducts()
     /**
      * Retrieve product stock qty
      *
+     * @param Mage_Catalog_Model_Product $product
      * @return float
      */
     public function getProductStockQty($product)

app/code/core/Mage/CatalogInventory/Helper/Minsaleqty.php

@@ -51,7 +51,7 @@ protected function _serializeValue($value)
         if (is_numeric($value)) {
             $data = (float)$value;
             return (string)$data;
-        } else if (is_array($value)) {
+        } elseif (is_array($value)) {
             $data = array();
             foreach ($value as $groupId => $qty) {
                 if (!array_key_exists($groupId, $data)) {
@@ -79,7 +79,7 @@ protected function _unserializeValue($value)
             return array(
                 Mage_Customer_Model_Group::CUST_GROUP_ALL => $this->_fixQty($value)
             );
-        } else if (is_string($value) && !empty($value)) {
+        } elseif (is_string($value) && !empty($value)) {
             try {
                 return Mage::helper('core/unserializeArray')->unserialize($value);
             } catch (Exception $e) {
@@ -93,7 +93,7 @@ protected function _unserializeValue($value)
     /**
      * Check whether value is in form retrieved by _encodeArrayFieldValue()
      *
-     * @param mixed
+     * @param mixed $value
      * @return bool
      */
     protected function _isEncodedArrayFieldValue($value)
@@ -113,7 +113,7 @@ protected function _isEncodedArrayFieldValue($value)
     /**
      * Encode value to be used in Mage_Adminhtml_Block_System_Config_Form_Field_Array_Abstract
      *
-     * @param array
+     * @param array $value
      * @return array
      */
     protected function _encodeArrayFieldValue(array $value)
@@ -132,7 +132,7 @@ protected function _encodeArrayFieldValue(array $value)
     /**
      * Decode value from used in Mage_Adminhtml_Block_System_Config_Form_Field_Array_Abstract
      *
-     * @param array
+     * @param array $value
      * @return array
      */
     protected function _decodeArrayFieldValue(array $value)
@@ -169,7 +169,7 @@ public function getConfigValue($customerGroupId, $store = null)
             if ($groupId == $customerGroupId) {
                 $result = $qty;
                 break;
-            } else if ($groupId == Mage_Customer_Model_Group::CUST_GROUP_ALL) {
+            } elseif ($groupId == Mage_Customer_Model_Group::CUST_GROUP_ALL) {
                 $result = $qty;
             }
         }

app/code/core/Mage/CatalogInventory/Model/Api2/Stock/Item.php

@@ -42,7 +42,7 @@ class Mage_CatalogInventory_Model_Api2_Stock_Item extends Mage_Api2_Model_Resour
      */
     protected function _loadStockItemById($id)
     {
-        /* @var $stockItem Mage_CatalogInventory_Model_Stock_Item */
+        /* @var Mage_CatalogInventory_Model_Stock_Item $stockItem */
         $stockItem = Mage::getModel('cataloginventory/stock_item')->load($id);
         if (!$stockItem->getId()) {
             $this->_critical(self::RESOURCE_NOT_FOUND);

app/code/core/Mage/CatalogInventory/Model/Api2/Stock/Item/Rest.php

@@ -31,8 +31,7 @@
  * @package    Mage_CatalogInventory
  * @author     Magento Core Team <core@magentocommerce.com>
  */
-abstract class Mage_CatalogInventory_Model_Api2_Stock_Item_Rest
-    extends Mage_CatalogInventory_Model_Api2_Stock_Item
+abstract class Mage_CatalogInventory_Model_Api2_Stock_Item_Rest extends Mage_CatalogInventory_Model_Api2_Stock_Item
 {
     /**
      * Retrieve information about specified stock item
@@ -42,7 +41,7 @@ abstract class Mage_CatalogInventory_Model_Api2_Stock_Item_Rest
      */
     protected function _retrieve()
     {
-        /* @var $stockItem Mage_CatalogInventory_Model_Stock_Item */
+        /* @var Mage_CatalogInventory_Model_Stock_Item $stockItem */
         $stockItem = $this->_loadStockItemById($this->getRequest()->getParam('id'));
         return $stockItem->getData();
     }
@@ -65,7 +64,7 @@ protected function _retrieveCollection()
      */
     protected function _getCollectionForRetrieve()
     {
-        /* @var $collection Mage_CatalogInventory_Model_Resource_Stock_Item_Collection */
+        /* @var Mage_CatalogInventory_Model_Resource_Stock_Item_Collection $collection */
         $collection = Mage::getResourceModel('cataloginventory/stock_item_collection');
         $this->_applyCollectionModifiers($collection);
         return $collection;
@@ -79,10 +78,10 @@ protected function _getCollectionForRetrieve()
      */
     protected function _update(array $data)
     {
-        /* @var $stockItem Mage_CatalogInventory_Model_Stock_Item */
+        /* @var Mage_CatalogInventory_Model_Stock_Item $stockItem */
         $stockItem = $this->_loadStockItemById($this->getRequest()->getParam('id'));
 
-        /* @var $validator Mage_CatalogInventory_Model_Api2_Stock_Item_Validator_Item */
+        /* @var Mage_CatalogInventory_Model_Api2_Stock_Item_Validator_Item $validator */
         $validator = Mage::getModel('cataloginventory/api2_stock_item_validator_item', array(
             'resource' => $this
         ));
@@ -118,7 +117,7 @@ protected function _multiUpdate(array $data)
                     $this->_critical(self::RESOURCE_DATA_PRE_VALIDATION_ERROR);
                 }
 
-                /* @var $validator Mage_CatalogInventory_Model_Api2_Stock_Item_Validator_Item */
+                /* @var Mage_CatalogInventory_Model_Api2_Stock_Item_Validator_Item $validator */
                 $validator = Mage::getModel('cataloginventory/api2_stock_item_validator_item', array(
                     'resource' => $this
                 ));
@@ -132,7 +131,7 @@ protected function _multiUpdate(array $data)
                 }
 
                 // Existence of a item is checked in the validator
-                /* @var $stockItem Mage_CatalogInventory_Model_Stock_Item */
+                /* @var Mage_CatalogInventory_Model_Stock_Item $stockItem */
                 $stockItem = $this->_loadStockItemById($itemData['item_id']);
 
                 unset($itemData['item_id']); // item_id is not for update

app/code/core/Mage/CatalogInventory/Model/Api2/Stock/Item/Validator/Item.php

@@ -49,7 +49,7 @@ public function isValidSingleItemDataForMultiUpdate(array $data)
             $this->_addError('Invalid value for "item_id" in request.');
         } else {
             // Validate Stock Item
-            /* @var $stockItem Mage_CatalogInventory_Model_Stock_Item */
+            /* @var Mage_CatalogInventory_Model_Stock_Item $stockItem */
             $stockItem = Mage::getModel('cataloginventory/stock_item')->load($data['item_id']);
             if (!$stockItem->getId()) {
                 $this->_addError(sprintf('StockItem #%d not found.', $data['item_id']));

app/code/core/Mage/CatalogInventory/Model/Indexer/Stock.php

@@ -99,7 +99,7 @@ protected function _construct()
     /**
      * Retrieve resource instance wrapper
      *
-     * @return Mage_CatalogInventory_Model_Mysql4_Indexer_Stock
+     * @inheritDoc
      */
     protected function _getResource()
     {
@@ -142,22 +142,22 @@ public function matchEvent(Mage_Index_Model_Event $event)
 
         $entity = $event->getEntity();
         if ($entity == Mage_Core_Model_Store::ENTITY) {
-            /* @var $store Mage_Core_Model_Store */
+            /* @var Mage_Core_Model_Store $store */
             $store = $event->getDataObject();
             if ($store && $store->isObjectNew()) {
                 $result = true;
             } else {
                 $result = false;
             }
-        } else if ($entity == Mage_Core_Model_Store_Group::ENTITY) {
-            /* @var $storeGroup Mage_Core_Model_Store_Group */
+        } elseif ($entity == Mage_Core_Model_Store_Group::ENTITY) {
+            /* @var Mage_Core_Model_Store_Group $storeGroup */
             $storeGroup = $event->getDataObject();
             if ($storeGroup && $storeGroup->dataHasChangedFor('website_id')) {
                 $result = true;
             } else {
                 $result = false;
             }
-        } else if ($entity == Mage_Core_Model_Config_Data::ENTITY) {
+        } elseif ($entity == Mage_Core_Model_Config_Data::ENTITY) {
             $configData = $event->getDataObject();
             if ($configData && in_array($configData->getPath(), $this->_relatedConfigSettings)) {
                 $result = $configData->isValueChanged();
@@ -223,6 +223,7 @@ protected function _registerCatalogProductEvent(Mage_Index_Model_Event $event)
     {
         switch ($event->getType()) {
             case Mage_Index_Model_Event::TYPE_SAVE:
+                /** @var Mage_Catalog_Model_Product $product */
                 $product = $event->getDataObject();
                 if ($product && $product->getStockData()) {
                     $product->setForceReindexRequired(true);
@@ -260,7 +261,7 @@ protected function _registerCatalogInventoryStockItemEvent(Mage_Index_Model_Even
      */
     protected function _registerStockItemSaveEvent(Mage_Index_Model_Event $event)
     {
-        /* @var $object Mage_CatalogInventory_Model_Stock_Item */
+        /* @var Mage_CatalogInventory_Model_Stock_Item $object */
         $object      = $event->getDataObject();
 
         $event->addNewData('reindex_stock', 1);
@@ -273,7 +274,9 @@ protected function _registerStockItemSaveEvent(Mage_Index_Model_Event $event)
             $massObject->setAttributesData(array('force_reindex_required' => 1));
             $massObject->setProductIds(array($object->getProductId()));
             Mage::getSingleton('index/indexer')->logEvent(
-                $massObject, Mage_Catalog_Model_Product::ENTITY, Mage_Index_Model_Event::TYPE_MASS_ACTION
+                $massObject,
+                Mage_Catalog_Model_Product::ENTITY,
+                Mage_Index_Model_Event::TYPE_MASS_ACTION
             );
         }
 
@@ -288,7 +291,7 @@ protected function _registerStockItemSaveEvent(Mage_Index_Model_Event $event)
      */
     protected function _registerCatalogProductDeleteEvent(Mage_Index_Model_Event $event)
     {
-        /* @var $product Mage_Catalog_Model_Product */
+        /* @var Mage_Catalog_Model_Product $product */
         $product = $event->getDataObject();
 
         $parentIds = $this->_getResource()->getProductParentsByChild($product->getId());
@@ -307,7 +310,7 @@ protected function _registerCatalogProductDeleteEvent(Mage_Index_Model_Event $ev
      */
     protected function _registerCatalogProductMassActionEvent(Mage_Index_Model_Event $event)
     {
-        /* @var $actionObject Varien_Object */
+        /* @var Varien_Object $actionObject */
         $actionObject = $event->getDataObject();
         $attributes   = array(
             'status'

app/code/core/Mage/CatalogInventory/Model/Mysql4/Indexer/Stock/Configurable.php

@@ -32,7 +32,6 @@
  * @package     Mage_CatalogInventory
  * @author      Magento Core Team <core@magentocommerce.com>
  */
-class Mage_CatalogInventory_Model_Mysql4_Indexer_Stock_Configurable
-    extends Mage_CatalogInventory_Model_Resource_Indexer_Stock_Configurable
+class Mage_CatalogInventory_Model_Mysql4_Indexer_Stock_Configurable extends Mage_CatalogInventory_Model_Resource_Indexer_Stock_Configurable
 {
 }

app/code/core/Mage/CatalogInventory/Model/Mysql4/Indexer/Stock/Default.php

@@ -32,7 +32,6 @@
  * @package     Mage_CatalogInventory
  * @author      Magento Core Team <core@magentocommerce.com>
  */
-class Mage_CatalogInventory_Model_Mysql4_Indexer_Stock_Default
-    extends Mage_CatalogInventory_Model_Resource_Indexer_Stock_Default
+class Mage_CatalogInventory_Model_Mysql4_Indexer_Stock_Default extends Mage_CatalogInventory_Model_Resource_Indexer_Stock_Default
 {
 }

app/code/core/Mage/CatalogInventory/Model/Mysql4/Indexer/Stock/Grouped.php

@@ -32,7 +32,6 @@
  * @package     Mage_CatalogInventory
  * @author      Magento Core Team <core@magentocommerce.com>
  */
-class Mage_CatalogInventory_Model_Mysql4_Indexer_Stock_Grouped
-    extends Mage_CatalogInventory_Model_Resource_Indexer_Stock_Grouped
+class Mage_CatalogInventory_Model_Mysql4_Indexer_Stock_Grouped extends Mage_CatalogInventory_Model_Resource_Indexer_Stock_Grouped
 {
 }

app/code/core/Mage/CatalogInventory/Model/Mysql4/Indexer/Stock/Interface.php

@@ -32,7 +32,6 @@
  * @package     Mage_CatalogInventory
  * @author      Magento Core Team <core@magentocommerce.com>
  */
-interface Mage_CatalogInventory_Model_Mysql4_Indexer_Stock_Interface
-    extends Mage_CatalogInventory_Model_Resource_Indexer_Stock_Interface
+interface Mage_CatalogInventory_Model_Mysql4_Indexer_Stock_Interface extends Mage_CatalogInventory_Model_Resource_Indexer_Stock_Interface
 {
 }

app/code/core/Mage/CatalogInventory/Model/Mysql4/Stock/Item/Collection.php

@@ -32,7 +32,6 @@
  * @package     Mage_CatalogInventory
  * @author      Magento Core Team <core@magentocommerce.com>
  */
-class Mage_CatalogInventory_Model_Mysql4_Stock_Item_Collection
-    extends Mage_CatalogInventory_Model_Resource_Stock_Item_Collection
+class Mage_CatalogInventory_Model_Mysql4_Stock_Item_Collection extends Mage_CatalogInventory_Model_Resource_Stock_Item_Collection
 {
 }