PHPStan: some fixes (#4346)

* some fixes

- #4291 (comment)

* some fixes

* rector

* Update app/code/core/Mage/Paypal/Model/Payflowlink.php

Co-authored-by: Ng Kiat Siong <kiatsiong.ng@gmail.com>

---------

Co-authored-by: Ng Kiat Siong <kiatsiong.ng@gmail.com>

app/code/core/Mage/Payment/Model/Method/Abstract.php

@@ -371,12 +371,13 @@ public function getInfoBlockType()
     /**
      * Retrieve payment information model object
      *
-     * @return Mage_Payment_Model_Info
+     * @return Mage_Sales_Model_Order_Payment|Mage_Sales_Model_Quote_Payment
      */
     public function getInfoInstance()
     {
+        /** @var Mage_Sales_Model_Order_Payment|Mage_Sales_Model_Quote_Payment $instance */
         $instance = $this->getData('info_instance');
-        if (!($instance instanceof Mage_Payment_Model_Info)) {
+        if (!$instance instanceof Mage_Payment_Model_Info) {
             Mage::throwException(Mage::helper('payment')->__('Cannot retrieve the payment information object instance.'));
         }
         return $instance;

app/code/core/Mage/Paypal/Model/Payflowlink.php

@@ -366,8 +366,7 @@ protected function _getOrderFromResponse()
     /**
      * Build request for getting token
      *
-     * @param Mage_Sales_Model_Order_Payment|Mage_Payment_Model_Info $payment
-     * @return Varien_Object
+     * @return Mage_Paypal_Model_Payflow_Request
      */
     protected function _buildTokenRequest(Mage_Sales_Model_Order_Payment $payment)
     {

app/code/core/Mage/Reports/Model/Resource/Helper/Interface.php

@@ -28,7 +28,7 @@ interface Mage_Reports_Model_Resource_Helper_Interface
      * @param string $mainTable
      * @param array $data
      * @param mixed $matchFields
-     * @return string
+     * @return int
      */
     public function mergeVisitorProductIndex($mainTable, $data, $matchFields);
 

app/code/core/Mage/Sales/Model/Order/Payment.php

@@ -434,7 +434,7 @@ public function place()
      *
      * TODO: eliminate logic duplication with registerCaptureNotification()
      *
-     * @param Mage_Sales_Model_Order_Invoice $invoice
+     * @param Mage_Sales_Model_Order_Invoice|null $invoice
      * @return $this
      * @throws Mage_Core_Exception
      */
@@ -1252,7 +1252,7 @@ protected function _void($isOnline, $amount = null, $gatewayCallback = 'void')
      * @param string $type
      * @param Mage_Sales_Model_Abstract $salesDocument
      * @param bool $failsafe
-     * @return null|Mage_Sales_Model_Order_Payment_Transaction
+     * @return null|Mage_Sales_Model_Order_Payment_Transaction|void
      */
     protected function _addTransaction($type, $salesDocument = null, $failsafe = false)
     {
@@ -1414,7 +1414,7 @@ protected function _isTransactionExists($txnId = null)
     /**
      * Append transaction ID (if any) message to the specified message
      *
-     * @param Mage_Sales_Model_Order_Payment_Transaction|null $transaction
+     * @param Mage_Sales_Model_Order_Payment_Transaction|string|null $transaction
      * @param string $message
      * @return string
      */
@@ -1480,7 +1480,7 @@ protected function _formatPrice($amount, $currency = null)
 
     /**
      * Find one transaction by ID or type
-     * @param string $txnId
+     * @param string|false|null $txnId
      * @param string|false $txnType
      * @return Mage_Sales_Model_Order_Payment_Transaction|false
      */
@@ -1519,7 +1519,7 @@ protected function _lookupTransaction($txnId, $txnType = false)
 
     /**
      * Find one transaction by ID or type
-     * @param string $txnId
+     * @param string|false $txnId
      * @param string|false $txnType
      * @return Mage_Sales_Model_Order_Payment_Transaction|false
      */

app/code/core/Mage/SalesRule/Model/Quote/Discount.php

@@ -135,7 +135,7 @@ protected function _aggregateItemDiscount($item)
     /**
      * Add discount total information to address
      *
-     * @return $this
+     * @return $this|array
      */
     public function fetch(Mage_Sales_Model_Quote_Address $address)
     {

app/code/core/Mage/Weee/Helper/Data.php

@@ -171,7 +171,7 @@ public function getAmount($product, $shipping = null, $billing = null, $website
     /**
      * Returns display type for price accordingly to current zone
      *
-     * @param Mage_Catalog_Model_Product $product
+     * @param mixed                      $product
      * @param array|int|null             $compareTo
      * @param string                     $zone
      * @param Mage_Core_Model_Store      $store
@@ -221,7 +221,7 @@ public function typeOfDisplay($product, $compareTo = null, $zone = null, $store
      * @param Mage_Catalog_Model_Product $product
      * @param null|false|Varien_Object   $shipping
      * @param null|false|Varien_Object   $billing
-     * @param int|Mage_Core_Model_Website $website
+     * @param int|Mage_Core_Model_Website|null|string|true $website
      * @param bool                       $calculateTaxes
      * @return array
      */
@@ -301,7 +301,7 @@ public function getProductWeeeAttributesForDisplay($product)
      * @param Mage_Catalog_Model_Product $product
      * @param null|false|Varien_Object $shipping Shipping Address
      * @param null|false|Varien_Object $billing Billing Address
-     * @param null|int $website
+     * @param int|Mage_Core_Model_Website|null|string|true $website
      * @param mixed $calculateTaxes
      * @return array
      */

app/code/core/Mage/Weee/Model/Tax.php

@@ -149,7 +149,7 @@ public function getWeeeTaxAttributeCodes($forceEnabled = false)
      * @param Mage_Catalog_Model_Product $product
      * @param Mage_Sales_Model_Quote_Address $shipping
      * @param Mage_Sales_Model_Quote_Address $billing
-     * @param int|Mage_Core_Model_Website $website
+     * @param int|Mage_Core_Model_Website|null|string|true $website
      * @param bool $calculateTax
      * @param bool $ignoreDiscount
      * @return array

app/design/adminhtml/default/default/template/permissions/role_users_grid_js.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Template $this */
 ?>
 <script type="text/javascript">
 <!--

app/design/adminhtml/default/default/template/permissions/rolesusers.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Permissions_Tab_Rolesusers $this */
 ?>
 <h4 class="icon-head head-edit-form fieldset-legend"><?php echo $this->__('Role Users') ?></h4>
 <?php echo $this->_getGridHtml() ?>

app/design/adminhtml/default/default/template/permissions/user_roles_grid_js.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Template $this */
 ?>
 <script type="text/javascript">
 <!--

app/design/adminhtml/default/default/template/report/refresh/statistics.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Report_Refresh_Statistics $this */
 ?>
 <div class="content-header">
     <table cellspacing="0">

app/design/adminhtml/default/default/template/sales/order/shipment/packaging/packed.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Sales_Order_Shipment_Packaging $this */
 ?>
 
 <div id="packed_window" style="display:none;" class="packed-window">

app/design/adminhtml/default/default/template/sales/order/shipment/packaging/popup.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Sales_Order_Shipment_Packaging $this */
  ?>
 <?php
 $shippingMethod = $this->getShipment()->getOrder()->getShippingMethod();

app/design/adminhtml/default/default/template/system/design/edit.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_System_Design_Edit $this */
 ?>
 <div class="content-header">
     <table cellspacing="0">

app/design/adminhtml/default/default/template/system/design/index.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_System_Design $this */
 ?>
 <div class="content-header">
 <table cellspacing="0">

app/design/adminhtml/default/default/template/system/email/template/edit.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2023 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_System_Email_Template_Edit $this */
 ?>
 <div class="content-header">
     <h3 class="icon-head head-system-email-template"><?php echo $this->getHeaderText() ?></h3>

app/design/adminhtml/default/default/template/system/email/template/list.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_System_Email_Template $this */
 ?>
 <div class="content-header">
     <table cellspacing="0">

app/design/adminhtml/default/default/template/system/email/template/preview.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Core_Block_Template $this */
 ?>
 <?php echo $this->getChildHtml('content') ?>
 <?php echo $this->getChildHtml('profiler') ?>

app/design/adminhtml/default/default/template/tag/edit/container.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Tag_Edit $this */
 ?>
 <?php echo $this->getFormInitScripts() ?>
 <div class="content-header">

app/design/adminhtml/default/default/template/tag/index.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Tag_Pending $this */
 ?>
 <div class="content-header">
 <table cellspacing="0">

app/design/adminhtml/default/default/template/tax/importExport.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Tax_Rate_ImportExport $this */
 ?>
 <div class="content-header">
     <table cellspacing="0">

app/design/adminhtml/default/default/template/tax/rate/form.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Tax_Rate_Form $this */
 ?>
 <div class="entry-edit">
     <?php echo $this->getFormHtml() ?>

app/design/adminhtml/default/default/template/tax/rate/title.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Tax_Rate_Title $this */
 ?>
 <?php /* <table class="dynamic-grid" cellspacing="0" id="tax-rate-titles-table"> */ ?>
     <tr class="dynamic-grid">

app/design/adminhtml/default/default/template/tax/toolbar/rate/add.phtml

@@ -12,6 +12,11 @@
  * @copyright   Copyright (c) 2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/**
+ * @var Mage_Adminhtml_Block_Tax_Rate_Toolbar_Add $this
+ * @var string $header
+ */
 ?>
 <div class="content-header">
     <table cellspacing="0">

app/design/adminhtml/default/default/template/tax/toolbar/rate/save.phtml

@@ -12,6 +12,12 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/**
+ * @var Mage_Adminhtml_Block_Tax_Rate_Toolbar_Save $this
+ * @var string $header
+ * @var Mage_Adminhtml_Block_Tax_Rate_Form $form
+ */
 ?>
 <div class="content-header">
     <table cellspacing="0">

app/design/adminhtml/default/default/template/widget/form.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Tax_Rule_Edit_Form $this */
 ?>
 <div class="entry-edit">
     <?php echo $this->getFormHtml();?>

app/design/frontend/base/default/template/catalog/msrp/popup.phtml

@@ -12,11 +12,11 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
-?>
-<?php
+
 /**
  * Template for MAP popup
  *
+ * @var Mage_Core_Block_Template $this
  */
 ?>
 <?php if (Mage::helper('catalog')->isMsrpEnabled()): ?>

app/design/frontend/base/default/template/catalog/product/list/related.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Catalog_Block_Product_List_Related $this */
 ?>
 <?php if($this->getItems()->getSize()): ?>
 <div class="block block-related">

app/design/frontend/base/default/template/catalog/product/list/upsell.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Catalog_Block_Product_List_Upsell $this */
 ?>
 <?php if(count($this->getItemCollection()->getItems())): ?>
 <div class="box-collateral box-up-sell">

app/design/frontend/base/default/template/catalog/product/view/addto.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Catalog_Block_Product_View $this */
 ?>
 
 <?php $_product = $this->getProduct(); ?>

app/design/frontend/base/default/template/catalog/product/view/addtocart.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Catalog_Block_Product_View $this */
 ?>
 <?php $_product = $this->getProduct(); ?>
 <?php $buttonTitle = $this->__('Add to Cart'); ?>

app/design/frontend/base/default/template/catalog/seo/sitemap.phtml

@@ -15,8 +15,8 @@
 ?>
 <?php
 /**
- * @see Mage_Catalog_Block_Seo_Sitemap_
- * @var Mage_Catalog_Block_Seo_Sitemap_ $this
+ * @see Mage_Catalog_Block_Seo_Sitemap_Product
+ * @var Mage_Catalog_Block_Seo_Sitemap_Product $this
  */
 ?>
 <?php $_items = $this->getCollection(); ?>

app/design/frontend/base/default/template/catalog/seo/sitemap/container.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Page_Block_Template_Container $this */
 ?>
 <div class="page-sitemap">
     <div class="page-title">

app/design/frontend/base/default/template/catalog/seo/tree.phtml

@@ -15,8 +15,8 @@
 ?>
 <?php
 /**
- * @see Mage_Catalog_Block_Seo_Sitemap_
- * @var Mage_Catalog_Block_Seo_Sitemap_ $this 
+ * @see Mage_Catalog_Block_Seo_Sitemap_Tree_Category
+ * @var Mage_Catalog_Block_Seo_Sitemap_Tree_Category $this
  */
 ?>
 <?php $_items = $this->getCollection(); ?>

app/design/frontend/base/default/template/catalogsearch/advanced/result.phtml

@@ -12,6 +12,8 @@
  * @copyright   Copyright (c) 2021-2022 The OpenMage Contributors (https://www.openmage.org)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_CatalogSearch_Block_Advanced_Result $this */
 ?>
 <div class="page-title">
     <h1><?php echo $this->__('Catalog Advanced Search') ?></h1>