PHPStan: added missing returns (#2832)

OpenMage · Dec 22, 2022 · 2bd4e09 · 2bd4e09
1 parent 355cff5
commit 2bd4e09
Show file tree

Hide file tree

Showing 56 changed files with 173 additions and 516 deletions.
diff --git a/app/code/core/Mage/Adminhtml/Block/Catalog/Product/Attribute/Set/Grid.php b/app/code/core/Mage/Adminhtml/Block/Catalog/Product/Attribute/Set/Grid.php
@@ -48,25 +48,19 @@ protected function _prepareCollection()
     }
 
     /**
-     * @return void
+     * @return $this
      * @throws Exception
      */
     protected function _prepareColumns()
     {
-        /*$this->addColumn('set_id', array(
-            'header'    => Mage::helper('catalog')->__('ID'),
-            'align'     => 'right',
-            'sortable'  => true,
-            'width'     => '50px',
-            'index'     => 'attribute_set_id',
-        ));*/
-
         $this->addColumn('set_name', [
             'header'    => Mage::helper('catalog')->__('Set Name'),
             'align'     => 'left',
             'sortable'  => true,
             'index'     => 'attribute_set_name',
         ]);
+
+        return $this;
     }
 
     /**

diff --git a/app/code/core/Mage/Adminhtml/Block/Catalog/Product/Edit/Tab/Attributes.php b/app/code/core/Mage/Adminhtml/Block/Catalog/Product/Edit/Tab/Attributes.php
@@ -43,9 +43,7 @@ protected function _prepareLayout()
     }
 
     /**
-     * Prepare attributes form
-     *
-     * @return void
+     * @inheritDoc
      */
     protected function _prepareForm()
     {
@@ -140,6 +138,8 @@ protected function _prepareForm()
 
             $this->setForm($form);
         }
+
+        return parent::_prepareForm();
     }
 
     /**

diff --git a/app/code/core/Mage/Adminhtml/Block/Catalog/Product/Edit/Tab/Super/Config/Simple.php b/app/code/core/Mage/Adminhtml/Block/Catalog/Product/Edit/Tab/Super/Config/Simple.php
@@ -35,6 +35,10 @@ class Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Super_Config_Simple extends
      */
     protected $_product = null;
 
+    /**
+     * @return $this
+     * @throws Mage_Core_Exception
+     */
     protected function _prepareForm()
     {
         $form = new Varien_Data_Form();
@@ -173,6 +177,8 @@ protected function _prepareForm()
         ]);
 
         $this->setForm($form);
+
+        return $this;
     }
 
     /**

diff --git a/app/code/core/Mage/Adminhtml/Block/Report/Customer/Accounts/Grid.php b/app/code/core/Mage/Adminhtml/Block/Report/Customer/Accounts/Grid.php
@@ -34,10 +34,14 @@ public function __construct()
         $this->setId('gridAccounts');
     }
 
+    /**
+     * @return $this
+     */
     protected function _prepareCollection()
     {
         parent::_prepareCollection();
         $this->getCollection()->initReport('reports/accounts_collection');
+        return $this;
     }
 
     /**

diff --git a/app/code/core/Mage/Adminhtml/Block/Report/Customer/Orders/Grid.php b/app/code/core/Mage/Adminhtml/Block/Report/Customer/Orders/Grid.php
@@ -34,12 +34,19 @@ public function __construct()
         $this->setId('gridOrdersCustomer');
     }
 
+    /**
+     * @return $this
+     */
     protected function _prepareCollection()
     {
         parent::_prepareCollection();
         $this->getCollection()->initReport('reports/customer_orders_collection');
+        return $this;
     }
 
+    /**
+     * @inheritDoc
+     */
     protected function _prepareColumns()
     {
         $this->addColumn('name', [

diff --git a/app/code/core/Mage/Adminhtml/Block/Report/Customer/Totals/Grid.php b/app/code/core/Mage/Adminhtml/Block/Report/Customer/Totals/Grid.php
@@ -34,12 +34,19 @@ public function __construct()
         $this->setId('gridTotalsCustomer');
     }
 
+    /**
+     * @return $this
+     */
     protected function _prepareCollection()
     {
         parent::_prepareCollection();
         $this->getCollection()->initReport('reports/customer_totals_collection');
+        return $this;
     }
 
+    /**
+     * @inheritDoc
+     */
     protected function _prepareColumns()
     {
         $this->addColumn('name', [

diff --git a/app/code/core/Mage/Adminhtml/Block/Report/Grid.php b/app/code/core/Mage/Adminhtml/Block/Report/Grid.php
@@ -78,6 +78,9 @@ public function __construct()
         $this->setCountTotals(true);
     }
 
+    /**
+     * @return $this
+     */
     protected function _prepareLayout()
     {
         $this->setChild(
@@ -114,7 +117,7 @@ protected function _prepareColumns()
     }
 
     /**
-     * @return void
+     * @return $this
      */
     protected function _prepareCollection()
     {
@@ -201,6 +204,8 @@ protected function _prepareCollection()
             'adminhtml_widget_grid_filter_collection',
             ['collection' => $this->getCollection(), 'filter_values' => $this->_filterValues]
         );
+
+        return $this;
     }
 
     /**

diff --git a/app/code/core/Mage/Adminhtml/Block/Report/Product/Grid.php b/app/code/core/Mage/Adminhtml/Block/Report/Product/Grid.php
@@ -51,12 +51,14 @@ protected function _prepareCollection()
     }
 
     /**
-     * @return void
+     * @inheritDoc
      */
     protected function _afterLoadCollection()
     {
         $totalObj = new Mage_Reports_Model_Totals();
         $this->setTotals($totalObj->countTotals($this));
+
+        return parent::_afterLoadCollection();
     }
 
     /**

diff --git a/app/code/core/Mage/Adminhtml/Block/Report/Product/Ordered/Grid.php b/app/code/core/Mage/Adminhtml/Block/Report/Product/Ordered/Grid.php
@@ -33,14 +33,18 @@ public function __construct()
     }
 
     /**
-     * @return void
+     * @return $this
      */
     protected function _prepareCollection()
     {
         parent::_prepareCollection();
         $this->getCollection()->initReport('reports/product_ordered_collection');
+        return $this;
     }
 
+    /**
+     * @inheritDoc
+     */
     protected function _prepareColumns()
     {
         $this->addColumn('name', [

diff --git a/app/code/core/Mage/Adminhtml/Block/Report/Shopcart/Customer/Grid.php b/app/code/core/Mage/Adminhtml/Block/Report/Shopcart/Customer/Grid.php
@@ -55,11 +55,12 @@ protected function _prepareCollection()
     }
 
     /**
-     * @return void
+     * @inheritDoc
      */
     protected function _afterLoadCollection()
     {
         $this->getCollection()->addCartInfo();
+        return parent::_afterLoadCollection();
     }
 
     /**

diff --git a/app/code/core/Mage/Adminhtml/Block/Review/Product/Grid.php b/app/code/core/Mage/Adminhtml/Block/Review/Product/Grid.php
@@ -37,7 +37,7 @@ public function __construct()
     }
 
     /**
-     * @return void
+     * @return $this
      */
     protected function _prepareColumns()
     {
@@ -103,6 +103,8 @@ protected function _prepareColumns()
                 ]
             );
         }
+
+        return $this;
     }
 
     /**

diff --git a/app/code/core/Mage/Adminhtml/Helper/Catalog/Product/Edit/Action/Attribute.php b/app/code/core/Mage/Adminhtml/Helper/Catalog/Product/Edit/Action/Attribute.php
@@ -75,7 +75,7 @@ public function getProducts()
     /**
      * Return array of selected product ids from post or session
      *
-     * @return string|null
+     * @return array|string|null
      */
     public function getProductIds()
     {

diff --git a/app/code/core/Mage/Adminhtml/Model/Session.php b/app/code/core/Mage/Adminhtml/Model/Session.php
@@ -26,8 +26,8 @@
  * @package    Mage_Adminhtml
  * @author     Magento Core Team <core@magentocommerce.com>
  *
- * @method string getProductIds()
- * @method $this setProductIds(string $value)
+ * @method array|string getProductIds()
+ * @method $this setProductIds(array|string $value)
  */
 class Mage_Adminhtml_Model_Session extends Mage_Core_Model_Session_Abstract
 {

diff --git a/app/code/core/Mage/Api2/Block/Adminhtml/Attribute/Grid.php b/app/code/core/Mage/Api2/Block/Adminhtml/Attribute/Grid.php
@@ -41,7 +41,7 @@ public function __construct($attributes = [])
 
     /**
      * Collection object set up
-     * @return void
+     * @return $this
      */
     protected function _prepareCollection()
     {
@@ -54,6 +54,8 @@ protected function _prepareCollection()
         }
 
         $this->setCollection($collection);
+
+        return $this;
     }
 
     /**

diff --git a/app/code/core/Mage/Bundle/Block/Adminhtml/Catalog/Product/Edit/Tab/Attributes.php b/app/code/core/Mage/Bundle/Block/Adminhtml/Catalog/Product/Edit/Tab/Attributes.php
@@ -33,7 +33,7 @@ class Mage_Bundle_Block_Adminhtml_Catalog_Product_Edit_Tab_Attributes extends Ma
     /**
      * Prepare attributes form of bundle product
      *
-     * @return void
+     * @return $this
      */
     protected function _prepareForm()
     {
@@ -155,6 +155,8 @@ function changePriceTypeMap() {
                 . '</script>'
             );
         }
+
+        return $this;
     }
 
     /**

diff --git a/app/code/core/Mage/Bundle/Block/Adminhtml/Catalog/Product/Edit/Tabs.php b/app/code/core/Mage/Bundle/Block/Adminhtml/Catalog/Product/Edit/Tabs.php
@@ -31,7 +31,7 @@ class Mage_Bundle_Block_Adminhtml_Catalog_Product_Edit_Tabs extends Mage_Adminht
     protected $_attributeTabBlock = 'bundle/adminhtml_catalog_product_edit_tab_attributes';
 
     /**
-     * @return void
+     * @return $this
      * @throws Exception
      */
     protected function _prepareLayout()
@@ -44,5 +44,7 @@ protected function _prepareLayout()
             'class' => 'ajax',
         ]);
         $this->bindShadowTabs('bundle_items', 'customer_options');
+
+        return $this;
     }
 }
diff --git a/app/code/core/Mage/Catalog/Model/Layer/Filter/Decimal.php b/app/code/core/Mage/Catalog/Model/Layer/Filter/Decimal.php
@@ -184,7 +184,7 @@ public function getRange()
      * Retrieve information about products count in range
      *
      * @param int $range
-     * @return int
+     * @return array
      */
     public function getRangeItemCounts($range)
     {

diff --git a/app/code/core/Mage/Catalog/Model/Layer/Filter/Price.php b/app/code/core/Mage/Catalog/Model/Layer/Filter/Price.php
@@ -142,7 +142,7 @@ public function getMaxPriceInt()
      * Get information about products count in range
      *
      * @param   int $range
-     * @return  int
+     * @return  array
      */
     public function getRangeItemCounts($range)
     {

diff --git a/app/code/core/Mage/Catalog/Model/Product.php b/app/code/core/Mage/Catalog/Model/Product.php
@@ -864,8 +864,8 @@ public function getGroupPrice()
     /**
      * Get product tier price by qty
      *
-     * @param   double $qty
-     * @return  double
+     * @param   float $qty
+     * @return  float|array
      */
     public function getTierPrice($qty = null)
     {

diff --git a/app/code/core/Mage/CatalogInventory/Model/Resource/Stock/Item/Collection.php b/app/code/core/Mage/CatalogInventory/Model/Resource/Stock/Item/Collection.php
@@ -137,9 +137,7 @@ public function addQtyFilter($comparsionMethod, $qty)
     }
 
     /**
-     * Initialize select object
-     *
-     * @return Varien_Db_Select
+     * @inheritDoc
      */
     protected function _initSelect()
     {

diff --git a/app/code/core/Mage/Core/Block/Template/Zend.php b/app/code/core/Mage/Core/Block/Template/Zend.php
@@ -62,11 +62,12 @@ public function assign($key, $value = null)
 
     /**
      * @param string $dir
-     * @return void
+     * @return $this
      */
     public function setScriptPath($dir)
     {
         $this->_view->setScriptPath($dir . DS);
+        return $this;
     }
 
     /**

diff --git a/app/code/core/Mage/Core/Helper/Data.php b/app/code/core/Mage/Core/Helper/Data.php
@@ -389,7 +389,7 @@ public function removeAccents($string, $german = false)
     }
 
     /**
-     * @param int|null $storeId
+     * @param null|string|bool|int|Mage_Core_Model_Store $storeId
      * @return bool
      */
     public function isDevAllowed($storeId = null)

diff --git a/app/code/core/Mage/Core/Model/App.php b/app/code/core/Mage/Core/Model/App.php
@@ -752,7 +752,7 @@ protected function _getStoreByWebsite($website)
     /**
      * Set current default store
      *
-     * @param string $store
+     * @param null|string|bool|int|Mage_Core_Model_Store $store
      * @return $this
      */
     public function setCurrentStore($store)
@@ -936,7 +936,7 @@ protected function _getDefaultStore()
     /**
      * Retrieve default store for default group and website
      *
-     * @return Mage_Core_Model_Store
+     * @return Mage_Core_Model_Store|null
      */
     public function getDefaultStoreView()
     {
@@ -1431,6 +1431,10 @@ public function getUpdateMode()
         return $this->_updateMode;
     }
 
+    /**
+     * @param string $text
+     * @throws Mage_Core_Model_Store_Exception
+     */
     public function throwStoreException($text = '')
     {
         throw new Mage_Core_Model_Store_Exception($text);