PHPStan: return type fixes (#2587)

Author: sreichel

.github/phpstan-baseline.neon

@@ -29,7 +29,6 @@ class Mage_Adminhtml_Block_Newsletter_Queue_Edit extends Mage_Adminhtml_Block_Te
 {
     /**
      * Check for template Id in request
-     *
      */
     protected function _construct()
     {
@@ -50,6 +49,9 @@ public function getQueue()
         return Mage::registry('current_queue');
     }
 
+    /**
+     * @inheritDoc
+     */
     protected  function _beforeToHtml() {
 
         $this->setTemplate('newsletter/queue/edit.phtml');
@@ -61,6 +63,10 @@ protected  function _beforeToHtml() {
         return parent::_beforeToHtml();
     }
 
+    /**
+     * @return string
+     * @throws Exception
+     */
     public function getSaveUrl()
     {
         if ($this->getTemplateId()) {
@@ -71,6 +77,9 @@ public function getSaveUrl()
         return $this->getUrl('*/*/save', $params);
     }
 
+    /**
+     * @inheritDoc
+     */
     protected function _prepareLayout()
     {
         // Load Wysiwyg on demand and Prepare layout
@@ -244,10 +253,10 @@ public function getCanResume()
     /**
      * Getter for header text
      *
-     * @return bool
+     * @return string
      */
     public function getHeaderText()
     {
-        return ( $this->getIsPreview() ? Mage::helper('newsletter')->__('View Newsletter') : Mage::helper('newsletter')->__('Edit Newsletter'));
+        return ($this->getIsPreview() ? Mage::helper('newsletter')->__('View Newsletter') : Mage::helper('newsletter')->__('Edit Newsletter'));
     }
 }

app/code/core/Mage/Adminhtml/Block/Newsletter/Queue/Edit.php

@@ -41,7 +41,7 @@ class Mage_Adminhtml_Block_Report_Grid_Shopcart extends Mage_Adminhtml_Block_Wid
      * storeIds setter
      *
      * @param  array $storeIds
-     * @return Mage_Adminhtml_Block_Report_Grid_Shopcart_Abstract
+     * @return $this
      */
     public function setStoreIds($storeIds)
     {

app/code/core/Mage/Adminhtml/Block/Report/Grid/Shopcart.php

@@ -63,7 +63,7 @@ protected function _prepareCollection()
     /**
      * Prepare and add columns to grid
      *
-     * @return Mage_Adminhtml_Block_Widget_Grid
+     * @inheritDoc
      */
     protected function _prepareColumns()
     {
@@ -130,20 +130,16 @@ protected function _prepareColumns()
     /**
      * Get url for row
      *
-     * @param string $row
-     * @return string
+     * @param Mage_Sales_Model_Order_Shipment $row
+     * @return string|false
      */
     public function getRowUrl($row)
     {
         if (!Mage::getSingleton('admin/session')->isAllowed('sales/order/shipment')) {
             return false;
         }
 
-        return $this->getUrl('*/sales_shipment/view',
-            [
-                'shipment_id'=> $row->getId(),
-            ]
-        );
+        return $this->getUrl('*/sales_shipment/view', ['shipment_id' => $row->getId()]);
     }
 
     /**

app/code/core/Mage/Adminhtml/Block/Sales/Shipment/Grid.php

@@ -30,7 +30,7 @@ class Mage_Adminhtml_Model_System_Config_Backend_Catalog_Search_Type extends Mag
     /**
      * After change Catalog Search Type process
      *
-     * @return Mage_Adminhtml_Model_System_Config_Catalog_Search_Type
+     * @return $this
      */
     protected function _afterSave()
     {

app/code/core/Mage/Adminhtml/Model/System/Config/Backend/Catalog/Search/Type.php

@@ -55,6 +55,7 @@ public function preDispatch()
         $this->_setForcedFormKeyActions('delete');
         parent::preDispatch();
         $this->_entityTypeId = Mage::getModel('eav/entity')->setType(Mage_Catalog_Model_Product::ENTITY)->getTypeId();
+        return $this;
     }
 
     protected function _initAction()

app/code/core/Mage/Adminhtml/controllers/Catalog/Product/AttributeController.php

@@ -289,6 +289,7 @@ protected function _isSectionAllowed($section)
             $this->setFlag('', self::FLAG_NO_DISPATCH, true);
             return false;
         }
+        return false;
     }
 
     /**

app/code/core/Mage/Adminhtml/controllers/System/ConfigController.php

@@ -169,7 +169,7 @@ public function canShowTab()
     /**
      * Returns status flag about this tab hidden or not
      *
-     * @return true
+     * @return false
      */
     public function isHidden()
     {

app/code/core/Mage/Api2/Block/Adminhtml/Permissions/User/Edit/Tab/Roles.php

@@ -39,23 +39,23 @@ protected function _prepareLayout()
     }
 
     /**
-     * @return mixed
+     * @return Mage_Catalog_Model_Product
      */
     public function getProduct()
     {
         return Mage::registry('product');
     }
 
     /**
-     * @return mixed
+     * @return Varien_Data_Collection
      */
     public function getGalleryCollection()
     {
         return $this->getProduct()->getMediaGalleryImages();
     }
 
     /**
-     * @return null |null
+     * @return Varien_Object|null
      * @throws Exception
      */
     public function getCurrentImage()
@@ -91,7 +91,7 @@ public function getImageFile()
     /**
      * Retrieve image width
      *
-     * @return bool|int
+     * @return false|int
      */
     public function getImageWidth()
     {
@@ -111,7 +111,8 @@ public function getImageWidth()
     }
 
     /**
-     * @return bool
+     * @return false|Varien_Object
+     * @throws Exception
      */
     public function getPreviusImage()
     {
@@ -130,7 +131,8 @@ public function getPreviusImage()
     }
 
     /**
-     * @return bool
+     * @return false|Varien_Object
+     * @throws Exception
      */
     public function getNextImage()
     {
@@ -153,23 +155,23 @@ public function getNextImage()
     }
 
     /**
-     * @return bool|string
+     * @return false|string
      */
     public function getPreviusImageUrl()
     {
         if ($image = $this->getPreviusImage()) {
-            return $this->getUrl('*/*/*', ['_current'=>true, 'image'=>$image->getValueId()]);
+            return $this->getUrl('*/*/*', ['_current' => true, 'image' => $image->getValueId()]);
         }
         return false;
     }
 
     /**
-     * @return bool|string
+     * @return false|string
      */
     public function getNextImageUrl()
     {
         if ($image = $this->getNextImage()) {
-            return $this->getUrl('*/*/*', ['_current'=>true, 'image'=>$image->getValueId()]);
+            return $this->getUrl('*/*/*', ['_current' => true, 'image' => $image->getValueId()]);
         }
         return false;
     }

app/code/core/Mage/Catalog/Block/Product/Gallery.php

@@ -36,7 +36,7 @@ class Mage_Catalog_Block_Product_View_Tabs extends Mage_Core_Block_Template
      * @param string $title
      * @param string $block
      * @param string $template
-     * @return bool
+     * @return false|void
      */
     public function addTab($alias, $title, $block, $template)
     {