Merge branch 'main' into slugger

# Conflicts: # app/code/core/Mage/Catalog/Model/Category/Url.php # tests/unit/Mage/Catalog/Helper/Product/UrlTest.php
OpenMage · Nov 28, 2024 · c1a5d70 · c1a5d70
2 parents cd4fbf2 + 0b965e9
commit c1a5d70
Show file tree

Hide file tree

Showing 86 changed files with 258 additions and 800 deletions.
diff --git a/.phpstan.dist.baseline.neon b/.phpstan.dist.baseline.neon
diff --git a/.rector.php b/.rector.php
@@ -39,4 +39,23 @@
         DeadCode\ClassMethod\RemoveUselessReturnTagRector::class,
         DeadCode\Property\RemoveUselessVarTagRector::class,
         TypeDeclaration\ClassMethod\ReturnNeverTypeRector::class,
-    ]);
+    ])
+    ->withPreparedSets(
+        false,
+        false,
+        false,
+        false,
+        false,
+        false,
+        false,
+        false,
+        false,
+        false,
+        false,
+        true,
+        false,
+        false,
+        false,
+        false,
+        true,
+    );
diff --git a/app/code/core/Mage/Adminhtml/Block/Customer/Sales/Order/Address/Form/Renderer/Vat.php b/app/code/core/Mage/Adminhtml/Block/Customer/Sales/Order/Address/Form/Renderer/Vat.php
@@ -75,7 +75,10 @@ public function getValidateButton()
             $optionsVarName = $this->getJsVariablePrefix() . 'VatParameters';
             $beforeHtml = '<script type="text/javascript">var ' . $optionsVarName . ' = ' . $vatValidateOptions
                 . ';</script>';
-            $this->_validateButton = $this->getLayout()->createBlock('adminhtml/widget_button')->setData([
+
+            /** @var Mage_Adminhtml_Block_Widget_Button $block */
+            $block = $this->getLayout()->createBlock('adminhtml/widget_button');
+            $this->_validateButton = $block->setData([
                 'label'       => Mage::helper('customer')->__('Validate VAT Number'),
                 'before_html' => $beforeHtml,
                 'onclick'     => 'order.validateVat(' . $optionsVarName . ')'

diff --git a/app/code/core/Mage/Adminhtml/Block/Sales/Order/Create/Shipping/Address.php b/app/code/core/Mage/Adminhtml/Block/Sales/Order/Create/Shipping/Address.php
@@ -112,7 +112,7 @@ public function getAddressId()
     /**
      * Return address object
      *
-     * @return Mage_Customer_Model_Address
+     * @return Mage_Sales_Model_Quote_Address
      */
     public function getAddress()
     {

diff --git a/app/code/core/Mage/Adminhtml/Block/System/Config/Form/Fieldset.php b/app/code/core/Mage/Adminhtml/Block/System/Config/Form/Fieldset.php
@@ -183,7 +183,7 @@ protected function _getExtraJs($element, $tooltipsExist = false)
      * Collapsed or expanded fieldset when page loaded?
      *
      * @param Varien_Data_Form_Element_Abstract $element
-     * @return int|bool
+     * @return int|false
      */
     protected function _getCollapseState($element)
     {

diff --git a/app/code/core/Mage/Adminhtml/Block/Widget/Grid.php b/app/code/core/Mage/Adminhtml/Block/Widget/Grid.php
@@ -46,7 +46,7 @@ class Mage_Adminhtml_Block_Widget_Grid extends Mage_Adminhtml_Block_Widget
     /**
      * Collection object
      *
-     * @var Mage_Core_Model_Resource_Db_Collection_Abstract|Varien_Data_Collection_Db|null
+     * @var Varien_Data_Collection_Db|null
      */
     protected $_collection = null;
 

diff --git a/app/code/core/Mage/Authorizenet/Model/Directpost.php b/app/code/core/Mage/Authorizenet/Model/Directpost.php
@@ -67,6 +67,7 @@ public function authorize(Varien_Object $payment, $amount)
     /**
      * Send capture request to gateway
      *
+     * @param Mage_Sales_Model_Order_Payment $payment
      * @param float $amount
      * @return $this
      * @throws Mage_Core_Exception
@@ -221,6 +222,7 @@ public function refund(Varien_Object $payment, $amount)
     /**
      * refund the amount with transaction id
      *
+     * @param Mage_Sales_Model_Order_Payment $payment
      * @param string $amount
      * @return $this
      * @throws Mage_Core_Exception
@@ -324,7 +326,7 @@ public function initialize($paymentAction, $stateObject)
         switch ($paymentAction) {
             case self::ACTION_AUTHORIZE:
             case self::ACTION_AUTHORIZE_CAPTURE:
-                /** @var Mage_Authorizenet_Model_Directpost $payment */
+                /** @var Mage_Sales_Model_Order_Payment|Mage_Sales_Model_Quote_Payment $payment */
                 $payment = $this->getInfoInstance();
                 $order = $payment->getOrder();
                 $order->setCanSendNewEmailFlag(false);
@@ -639,7 +641,7 @@ protected function _captureOrder(Mage_Sales_Model_Order $order)
     /**
      * Return additional information`s transaction_id value of parent transaction model
      *
-     * @param Mage_Sales_Model_Order_Payment $payment
+     * @param Mage_Sales_Model_Order_Payment|Varien_Object $payment
      * @return string
      */
     protected function _getRealParentTransactionId($payment)

diff --git a/app/code/core/Mage/Authorizenet/Model/Directpost/Request.php b/app/code/core/Mage/Authorizenet/Model/Directpost/Request.php
@@ -163,7 +163,7 @@ public function setDataFromOrder(Mage_Sales_Model_Order $order, Mage_Authorizene
      */
     public function signRequestData()
     {
-        $fpTimestamp = time();
+        $fpTimestamp = (string) time();
         $signatureKey = $this->_getSignatureKey();
         if (!empty($signatureKey)) {
             $hash = $this->_generateSha2RequestSign(

diff --git a/app/code/core/Mage/Bundle/Model/Sales/Order/Pdf/Items/Abstract.php b/app/code/core/Mage/Bundle/Model/Sales/Order/Pdf/Items/Abstract.php
@@ -230,7 +230,7 @@ public function getOrderItem()
     /**
      * Retrieve Value HTML
      *
-     * @param Mage_Sales_Model_Order_Item $item
+     * @param Mage_Sales_Model_Order_Invoice_Item $item
      * @return string
      */
     public function getValueHtml($item)
@@ -254,13 +254,13 @@ public function getValueHtml($item)
     /**
      * Can show price info for item
      *
-     * @param Mage_Sales_Model_Order_Item $item
+     * @param Mage_Sales_Model_Order_Invoice_Item $item
      * @return bool
      */
     public function canShowPriceInfo($item)
     {
         if (($item->getOrderItem()->getParentItem() && $this->isChildCalculated())
-                || (!$item->getOrderItem()->getParentItem() && !$this->isChildCalculated())
+            || (!$item->getOrderItem()->getParentItem() && !$this->isChildCalculated())
         ) {
             return true;
         }

diff --git a/app/code/core/Mage/Catalog/Block/Navigation.php b/app/code/core/Mage/Catalog/Block/Navigation.php
@@ -32,7 +32,7 @@ class Mage_Catalog_Block_Navigation extends Mage_Core_Block_Template
     /**
      * Current category key
      *
-     * @var string
+     * @var int|string
      */
     protected $_currentCategoryKey;
 
@@ -94,7 +94,7 @@ public function getCacheKeyInfo()
     /**
      * Get current category key
      *
-     * @return mixed
+     * @return int|string
      */
     public function getCurrenCategoryKey()
     {

diff --git a/app/code/core/Mage/Catalog/Block/Product/Abstract.php b/app/code/core/Mage/Catalog/Block/Product/Abstract.php
@@ -167,7 +167,7 @@ public function getAddToCompareUrl($product)
      * Gets minimal sales quantity
      *
      * @param Mage_Catalog_Model_Product $product
-     * @return int|null
+     * @return float|null
      */
     public function getMinimalQty($product)
     {
@@ -317,7 +317,9 @@ protected function _initReviewsHelperBlock()
                 return false;
             }
 
-            $this->_reviewsHelperBlock = $this->getLayout()->createBlock('review/helper');
+            /** @var Mage_Review_Block_Helper $block */
+            $block = $this->getLayout()->createBlock('review/helper');
+            $this->_reviewsHelperBlock = $block;
         }
 
         return true;

diff --git a/app/code/core/Mage/Catalog/Block/Product/List/Toolbar.php b/app/code/core/Mage/Catalog/Block/Product/List/Toolbar.php
@@ -77,7 +77,7 @@ class Mage_Catalog_Block_Product_List_Toolbar extends Mage_Core_Block_Template
     /**
      * List of available view types
      *
-     * @var string
+     * @var array
      */
     protected $_availableMode       = [];
 
@@ -536,7 +536,7 @@ public function isModeActive($mode)
     /**
      * Retrieve availables view modes
      *
-     * @return string
+     * @return array
      */
     public function getModes()
     {
@@ -551,7 +551,7 @@ public function getModes()
      */
     public function setModes($modes)
     {
-        if (!isset($this->_availableMode)) {
+        if (!$this->_availableMode) {
             $this->_availableMode = $modes;
         }
         return $this;
@@ -650,7 +650,7 @@ public function getDefaultPerPageValue()
             }
             return Mage::getStoreConfig('catalog/frontend/grid_per_page');
         }
-        return 0;
+        return '0';
     }
 
     /**

diff --git a/app/code/core/Mage/Catalog/Block/Product/New.php b/app/code/core/Mage/Catalog/Block/Product/New.php
@@ -30,7 +30,7 @@ class Mage_Catalog_Block_Product_New extends Mage_Catalog_Block_Product_Abstract
     /**
      * Products count
      *
-     * @var null
+     * @var int
      */
     protected $_productsCount;
 

diff --git a/app/code/core/Mage/Catalog/Block/Product/Widget/Html/Pager.php b/app/code/core/Mage/Catalog/Block/Product/Widget/Html/Pager.php
@@ -168,7 +168,7 @@ public function getTotalNum()
     public function getLastPageNum()
     {
         if ($this->_lastPage === null) {
-            $this->_lastPage = ceil($this->getCollectionSize() / $this->getLimit());
+            $this->_lastPage = (int) ceil($this->getCollectionSize() / $this->getLimit());
             if ($this->_lastPage <= 0) {
                 $this->_lastPage = 1;
             }

diff --git a/app/code/core/Mage/Catalog/Block/Seo/Sitemap/Product.php b/app/code/core/Mage/Catalog/Block/Seo/Sitemap/Product.php
@@ -54,8 +54,8 @@ protected function _prepareLayout()
      */
     public function getItemUrl($product)
     {
-        $helper = Mage::helper('catalog/product');
         /** @var Mage_Catalog_Helper_Product $helper */
+        $helper = Mage::helper('catalog/product');
         return $helper->getProductUrl($product);
     }
 }
diff --git a/app/code/core/Mage/Catalog/Helper/Data.php b/app/code/core/Mage/Catalog/Helper/Data.php
@@ -45,7 +45,7 @@ class Mage_Catalog_Helper_Data extends Mage_Core_Helper_Abstract
     /**
      * Breadcrumb Path cache
      *
-     * @var string|array<string, array<string, string|null>>
+     * @var array<string, array<string, string|null>>
      */
     protected $_categoryPath;
 
@@ -79,7 +79,7 @@ public function setStoreId($store)
      * Return current category path or get it from current category
      * and creating array of categories|product paths for breadcrumbs
      *
-     * @return string
+     * @return array
      */
     public function getBreadcrumbPath()
     {

diff --git a/app/code/core/Mage/Catalog/Helper/Product.php b/app/code/core/Mage/Catalog/Helper/Product.php
@@ -501,7 +501,7 @@ public function getSkipSaleableCheck()
      * Gets minimal sales quantity
      *
      * @param Mage_Catalog_Model_Product $product
-     * @return int|null
+     * @return float|null
      */
     public function getMinimalQty($product)
     {

diff --git a/app/code/core/Mage/Catalog/Model/Api2/Product/Rest.php b/app/code/core/Mage/Catalog/Model/Api2/Product/Rest.php
@@ -375,7 +375,7 @@ protected function _getTierPrices()
     /**
      * Default implementation. May be different for customer/guest/admin role.
      *
-     * @return null
+     * @return int|null
      */
     protected function _getCustomerGroupId()
     {

diff --git a/app/code/core/Mage/Catalog/Model/Api2/Product/Rest/Admin/V1.php b/app/code/core/Mage/Catalog/Model/Api2/Product/Rest/Admin/V1.php
@@ -355,7 +355,7 @@ protected function _filterStockData(&$stockData)
      * Filter out fields if Use Config Settings option used
      *
      * @param array $data
-     * @param string $fields
+     * @param array $fields
      */
     protected function _filterConfigValueUsed(&$data, $fields)
     {

diff --git a/app/code/core/Mage/Catalog/Model/Design.php b/app/code/core/Mage/Catalog/Model/Design.php
@@ -76,7 +76,7 @@ protected function _apply($package, $theme)
      * Apply custom design
      *
      * @param string $design
-     * @return null|false
+     * @return void|false
      */
     public function applyCustomDesign($design)
     {

diff --git a/app/code/core/Mage/Catalog/Model/Factory.php b/app/code/core/Mage/Catalog/Model/Factory.php
@@ -47,9 +47,11 @@ class Mage_Catalog_Model_Factory extends Mage_Core_Model_Factory
      */
     public function getCategoryUrlRewriteHelper()
     {
-        return $this->getHelper(
+        /** @var Mage_Catalog_Helper_Category_Url_Rewrite_Interface $model */
+        $model = $this->getHelper(
             (string)$this->_config->getNode(self::XML_PATH_CATEGORY_URL_REWRITE_HELPER_CLASS)
         );
+        return $model;
     }
 
     /**
@@ -59,9 +61,11 @@ public function getCategoryUrlRewriteHelper()
      */
     public function getProductUrlRewriteHelper()
     {
-        return $this->getHelper(
+        /** @var Mage_Catalog_Helper_Product_Url_Rewrite_Interface $model */
+        $model = $this->getHelper(
             (string)$this->_config->getNode(self::XML_PATH_PRODUCT_URL_REWRITE_HELPER_CLASS)
         );
+        return $model;
     }
 
     /**
@@ -71,9 +75,11 @@ public function getProductUrlRewriteHelper()
      */
     public function getProductUrlInstance()
     {
-        return $this->getModel(
+        /** @var Mage_Catalog_Model_Product_Url $model */
+        $model = $this->getModel(
             (string)$this->_config->getNode(self::XML_PATH_PRODUCT_URL_MODEL)
         );
+        return $model;
     }
 
     /**
@@ -83,8 +89,10 @@ public function getProductUrlInstance()
      */
     public function getCategoryUrlInstance()
     {
-        return $this->getModel(
+        /** @var Mage_Catalog_Model_Category_Url $model */
+        $model = $this->getModel(
             (string)$this->_config->getNode(self::XML_PATH_CATEGORY_URL_MODEL)
         );
+        return $model;
     }
 }
diff --git a/app/code/core/Mage/Catalog/Model/Product.php b/app/code/core/Mage/Catalog/Model/Product.php
@@ -1898,8 +1898,8 @@ public function addOption(Mage_Catalog_Model_Product_Option $option)
     /**
      * Get option from options array of product by given option id
      *
-     * @param int $optionId
-     * @return Mage_Catalog_Model_Product_Option | null
+     * @param string $optionId
+     * @return Mage_Catalog_Model_Product_Option|null
      */
     public function getOptionById($optionId)
     {
@@ -1997,7 +1997,7 @@ public function hasCustomOptions()
      * Check availability display product in category
      *
      * @param   int $categoryId
-     * @return  bool
+     * @return  string
      */
     public function canBeShowInCategory($categoryId)
     {

diff --git a/app/code/core/Mage/Catalog/Model/Product/Api.php b/app/code/core/Mage/Catalog/Model/Product/Api.php
@@ -384,7 +384,7 @@ public function delete($productId, $identifierType = null)
     /**
      * Get list of additional attributes which are not in default create/update list
      *
-     * @param  int $productType
+     * @param  string $productType
      * @param  int $attributeSetId
      * @return array
      */
@@ -429,7 +429,7 @@ public function getAdditionalAttributes($productType, $attributeSetId)
     /**
      * Check if product type exists
      *
-     * @param int $productType
+     * @param string $productType
      * @throw Mage_Api_Exception
      */
     protected function _checkProductTypeExists($productType)

diff --git a/app/code/core/Mage/Catalog/Model/Product/Type/Configurable/Price.php b/app/code/core/Mage/Catalog/Model/Product/Type/Configurable/Price.php
@@ -113,7 +113,7 @@ protected function _calcSelectionPrice($priceInfo, $productPrice)
     /**
      * @param array $values
      * @param string $index
-     * @return bool
+     * @return array|false
      */
     protected function _getValueByIndex($values, $index)
     {

diff --git a/app/code/core/Mage/Catalog/Model/Resource/Attribute.php b/app/code/core/Mage/Catalog/Model/Resource/Attribute.php
@@ -123,7 +123,7 @@ public function deleteEntity(Mage_Core_Model_Abstract $object)
      * Defines is Attribute used by super products
      *
      * @param int $attributeSet
-     * @return int
+     * @return false|string|null
      */
     public function isUsedBySuperProducts(Mage_Core_Model_Abstract $object, $attributeSet = null)
     {