OM PR 4328

OpenMage/magento-lts#4328

Author: fballiano

.phpstan.baseline.neon

@@ -15,7 +15,11 @@
  */
 class Mage_Adminhtml_Block_Sales_Order_Creditmemo_Create_Adjustments extends Mage_Adminhtml_Block_Template
 {
+    /**
+     * @var Mage_Sales_Model_Order_Creditmemo
+     */
     protected $_source;
+
     /**
      * Initialize creditmemo adjustment totals
      *
@@ -36,6 +40,9 @@ public function initTotals()
         return $this;
     }
 
+    /**
+     * @return Mage_Sales_Model_Order_Creditmemo
+     */
     public function getSource()
     {
         return $this->_source;

app/code/core/Mage/Adminhtml/Block/Sales/Order/Creditmemo/Create/Adjustments.php

@@ -95,8 +95,10 @@ public function getValue($key, $default = '', $defaultNew = null)
 
     /**
      * @param string $key
-     * @param string $value
+     * @param string|bool|int $value
      * @return string
+     *
+     * @todo check remove int from param value
      */
     public function getSelected($key, $value)
     {

app/code/core/Mage/Adminhtml/Block/System/Convert/Gui/Edit/Tab/Wizard.php

@@ -212,7 +212,7 @@ public function getItemConfigureUrl($product)
     /**
      * Retrieve Escaped Description for Wishlist Item
      *
-     * @param Mage_Catalog_Model_Product $item
+     * @param Mage_Wishlist_Model_Item $item
      * @return string
      */
     public function getEscapedDescription($item)

app/code/core/Mage/Wishlist/Block/Abstract.php

@@ -9,8 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
-/** @var $this Mage_Api2_Block_Adminhtml_Attribute_Buttons */
 
+/** @var Mage_Api2_Block_Adminhtml_Attribute_Buttons $this */
 ?>
 <div class="content-header">
     <table cellspacing="0">
@@ -33,7 +33,5 @@
     <?= $this->getBlockHtml('formkey') ?>
 </form>
 <script type="text/javascript">
-//<![CDATA[
     var roleForm = new varienForm('role_edit_form');
-//]]>
 </script>

app/design/adminhtml/default/default/template/api2/attribute/buttons.phtml

@@ -9,12 +9,12 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
-
 ?>
+
 <script type="text/javascript">
 //<![CDATA[
 <?php
-    /** @var $myBlock Mage_Api2_Block_Adminhtml_Roles_Tab_Users */
+    /** @var Mage_Api2_Block_Adminhtml_Roles_Tab_Users $myBlock */
     $myBlock = $this->getLayout()->getBlock('adminhtml.role.edit.tab.users');
     $name = $myBlock->getJsObjectName();
 ?>

app/design/adminhtml/default/default/template/api2/role/users_grid_js.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Catalog_Category_Edit_Form $this */
 ?>
 
 <div class="content-header">

app/design/adminhtml/default/default/template/catalog/category/edit/form.phtml

@@ -9,8 +9,7 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
-?>
-<?php
+
 /**
  * Template for Mage_Adminhtml_Block_Catalog_Product_Edit
  *

app/design/adminhtml/default/default/template/catalog/product/edit.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Catalog_Product_Helper_Form_Gallery_Content $this */
 ?>
 <div id="<?= $this->getHtmlId() ?>">
     <ul class="messages">

app/design/adminhtml/default/default/template/catalog/product/helper/gallery.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Widget_Form_Renderer_Fieldset_Element $this */
 ?>
 <?php $_element = $this->getElement() ?>
 <?php if (!$_element->getNoDisplay()): ?>

app/design/adminhtml/default/default/template/cms/page/edit/form/renderer/content.phtml

@@ -9,29 +9,12 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
-/*
+
+/** @see Mage_Adminhtml_Block_Dashboard_Tab_Amounts */
+/** @see Mage_Adminhtml_Block_Dashboard_Tab_Orders */
+/** @var Mage_Adminhtml_Block_Dashboard_Graph $this */
 ?>
-<div style="width:587px;margin:20px;position:relative;margin-left:-294px;left:50%">
-    <div style="position:absolute;right:1px;top:0px;left: expression(parentNode.offsetWidth - offsetWidth - 1 + 'px');">
-        <div style="padding:5px;height:15px;width:15px;background-color:#F4F4F4" id="dashboard_<?= $this->getHtmlId() ?>_cal_div"></div>
-        <div style="padding:5px;display:none;width:200px;" id="dashboard_<?= $this->getHtmlId() ?>_range_div" class="switcher">
-            <?= $this->__('Select Range') ?>:
-            <select name="period" id="order_<?= $this->getHtmlId() ?>_period" onchange="changePeriod(this)">
-                <?php foreach ($this->helper('adminhtml/dashboard_data')->getDatePeriods() as $_value=>$_label): ?>
-                    <?php if(in_array($_value, array('custom'))) continue; ?>
-                    <option value="<?= $_value ?>" <?php if($this->getRequest()->getParam('period')==$_value): ?> selected<?php endif ?>><?= $_label ?></option>
-                <?php endforeach ?>
-            </select>
-            <img src="<?= Mage::getDesign()->getSkinUrl('images/dashboard-close.gif') ?>" onclick="toggleCal('<?= $this->getHtmlId() ?>')" />
-        </div>
-    </div>
-    <?php if($this->getCount()): ?>
-    <img src="<?= $this->getChartUrl() ?>" />
-    <?php else: ?>
-    <div align="center" style="width:587px;height:300px;"><?= $this->__('No Data Found') ?></div>
-    <?php endif ?>
-</div>
-<?php */ ?>
+
 <div style="margin:20px;">
     <p class="switcher a-right" style="padding:5px 10px;"><?= $this->__('Select Range') ?>:
     <select name="period" id="order_<?= $this->getHtmlId() ?>_period" onchange="changeDiagramsPeriod(this);">

app/design/adminhtml/default/default/template/dashboard/graph.phtml

@@ -9,8 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
-?>
-<?php
+
+/** @var Mage_Adminhtml_Block_Widget_Grid $this */
 
 $numColumns = count($this->getColumns());
 ?>

app/design/adminhtml/default/default/template/dashboard/grid.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Dashboard $this */
 ?>
 
 <?php if (is_array($this->getChild('diagrams')->getTabsIds())) : ?>

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

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Dashboard_Sales $this */
 ?>
 <?php if(count($this->getTotals()) > 0): ?>
             <?php foreach( $this->getTotals() as $_total ): ?>

app/design/adminhtml/default/default/template/dashboard/salebar.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Dashboard_Totals $this */
 ?>
 <?php if(count($this->getTotals()) > 0): ?>
 <div class="box" id="dashboard_diagram_totals">

app/design/adminhtml/default/default/template/dashboard/totalbar.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Downloadable_Block_Adminhtml_Sales_Items_Column_Downloadable_Name $this */
 ?>
 
 <?php if ($_item = $this->getItem()): ?>

app/design/adminhtml/default/default/template/downloadable/sales/items/column/downloadable/creditmemo/name.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Downloadable_Block_Adminhtml_Sales_Items_Column_Downloadable_Name $this */
 ?>
 
 <?php if ($_item = $this->getItem()): ?>

app/design/adminhtml/default/default/template/downloadable/sales/items/column/downloadable/invoice/name.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Downloadable_Block_Adminhtml_Sales_Items_Column_Downloadable_Name $this */
 ?>
 
 <?php if ($_item = $this->getItem()): ?>

app/design/adminhtml/default/default/template/downloadable/sales/items/column/downloadable/name.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Index_Block_Adminhtml_Notifications $this */
 ?>
 <?php $_processes = $this->getProcessesForReindex()?>
 <?php if($_processes):?>

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

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Store_Switcher $this */
 ?>
 
 <?php if ($websites = $this->getWebsites()): ?>

app/design/adminhtml/default/default/template/newsletter/preview/store.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Newsletter_Problem $this */
 ?>
 <div class="content-header">
     <table cellspacing="0">

app/design/adminhtml/default/default/template/newsletter/problem/list.phtml

@@ -9,6 +9,7 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
 /** @var Mage_Adminhtml_Block_Newsletter_Queue_Edit $this */
 ?>
 <div class="content-header">

app/design/adminhtml/default/default/template/newsletter/queue/edit.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Newsletter_Queue_Edit $this */
 ?>
 <div class="content-header">
     <table cellspacing="0">

app/design/adminhtml/default/default/template/newsletter/queue/list.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Core_Block_Template $this */
 ?>
 <!DOCTYPE html>
 <html lang="en">

app/design/adminhtml/default/default/template/newsletter/queue/preview.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Newsletter_Subscriber $this */
 ?>
 <div class="content-header">
     <table cellspacing="0">

app/design/adminhtml/default/default/template/newsletter/subscriber/list.phtml

@@ -9,6 +9,7 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
 /** @var Mage_Adminhtml_Block_Newsletter_Template_Edit $this */
 ?>
 <div class="content-header">

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

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Newsletter_Template $this */
 ?>
 <div class="content-header">
     <table cellspacing="0">

app/design/adminhtml/default/default/template/newsletter/template/list.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Core_Block_Template $this */
 ?>
 <!DOCTYPE html>
 <html lang="en">

app/design/adminhtml/default/default/template/newsletter/template/preview.phtml

@@ -12,8 +12,8 @@
 ?>
 <?php
 /**
- * @see Mage_Adminhtml_Page_Block_Notices
- * @var Mage_Adminhtml_Page_Block_Notices $this
+ * @see Mage_Adminhtml_Block_Page_Notices
+ * @var Mage_Adminhtml_Block_Page_Notices $this
  */
 ?>
 <?php if ($this->displayNoscriptNotice()): ?>

app/design/adminhtml/default/default/template/page/notices.phtml

@@ -11,8 +11,8 @@
  */
 
 /**
- * @see Saas_Payment_Block_Form_Cashondelivery
- * @var Saas_Payment_Block_Form_Cashondelivery $this 
+ * @see Mage_Payment_Block_Form_Cashondelivery
+ * @var Mage_Payment_Block_Form_Cashondelivery $this
  */
 ?>
 <?php if ($this->getInstructions()): ?>

app/design/adminhtml/default/default/template/payment/form/cashondelivery.phtml

@@ -12,8 +12,8 @@
 ?>
 <?php
 /**
- * @see Mage_Paypal_Block_System_Config_Fieldset_Hint
- * @var Mage_Paypal_Block_System_Config_Fieldset_Hint $this
+ * @see Mage_Paypal_Block_Adminhtml_System_Config_Fieldset_Hint
+ * @var Mage_Paypal_Block_Adminhtml_System_Config_Fieldset_Hint $this
  */
 ?>
 <?php if ($this->getHelpLink()): ?>

app/design/adminhtml/default/default/template/paypal/system/config/fieldset/hint.phtml

@@ -12,8 +12,8 @@
 ?>
 <?php
 /**
- * @see Mage_Paypal_Block_System_Config_Fieldset_Store
- * @var Mage_Paypal_Block_System_Config_Fieldset_Store $this 
+ * @see Mage_Paypal_Block_Adminhtml_System_Config_Fieldset_Store
+ * @var Mage_Paypal_Block_Adminhtml_System_Config_Fieldset_Store $this
  */
 ?>
 <script type="text/javascript">

app/design/adminhtml/default/default/template/paypal/system/config/fieldset/store.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Permissions_Buttons $this */
 ?>
 <div class="content-header">
     <table cellspacing="0">

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

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Permissions_Roles $this */
 ?>
 <div class="content-header">
     <table cellspacing="0">

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

@@ -9,6 +9,9 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Widget_Form_Renderer_Fieldset $this */
+/** @var Varien_Data_Form_Element_Fieldset $_element */
 ?>
 <?php $_element = $this->getElement() ?>
 <div class="rule-tree">

app/design/adminhtml/default/default/template/promo/fieldset.phtml

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

app/design/adminhtml/default/default/template/promo/js.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Review_Rating_Detailed $this */
 ?>
 <?php if( $this->getRating() && $this->getRating()->getSize()): ?>
     <div class="product-review-box">

app/design/adminhtml/default/default/template/rating/detailed.phtml

@@ -9,6 +9,8 @@
  * @copyright   Copyright (c) 2024 Maho (https://mahocommerce.com)
  * @license     https://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
  */
+
+/** @var Mage_Adminhtml_Block_Review_Rating_Summary $this */
 ?>
 <?php if($this->getRatingSummary()->getCount()): ?>
     <div class="rating-box">