phpcs-fixer: phpdoc_scalar (OpenMage#5063)

sreichel · web-flow · commit 5af5f4383f75 · 2025-11-02T07:40:35.000+01:00
- see https://cs.symfony.com/doc/rules/phpdoc/phpdoc_scalar.html
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -30,6 +30,8 @@
         'phpdoc_trim' => true,
         // Removes extra blank lines after summary and after description in PHPDoc.
         'phpdoc_trim_consecutive_blank_line_separation' => true,
+        // Scalar types should always be written in the same form. int not integer, bool not boolean, float not real or double.
+        'phpdoc_scalar' => true,
         // Single line @var PHPDoc should have proper spacing.
         'phpdoc_single_line_var_spacing' => true,
         // Fixes casing of PHPDoc tags.
diff --git a/app/Mage.php b/app/Mage.php
@@ -493,7 +493,7 @@ public static function getConfig()
      * Add observer to events object
      *
      * @param string $eventName
-     * @param callback $callback
+     * @param callable $callback
      * @param array $data
      * @param string $observerName
      * @param string $observerClass
@@ -1035,7 +1035,7 @@ public static function printException(Throwable $e, $extra = '')
      * Try to find requested folder by shifting to domain root directory
      *
      * @param   string  $folder
-     * @param   boolean $exitIfNot
+     * @param   bool $exitIfNot
      * @return  string
      */
     public static function getScriptSystemUrl($folder, $exitIfNot = false)
diff --git a/app/code/core/Mage/Adminhtml/Block/Report/Grid.php b/app/code/core/Mage/Adminhtml/Block/Report/Grid.php
@@ -655,7 +655,7 @@ public function getCurrentCurrencyCode()
      * Get currency rate (base to given currency)
      *
      * @param Mage_Directory_Model_Currency|string $toCurrency
-     * @return double
+     * @return float
      */
     public function getRate($toCurrency)
     {
diff --git a/app/code/core/Mage/Adminhtml/Block/Report/Grid/Abstract.php b/app/code/core/Mage/Adminhtml/Block/Report/Grid/Abstract.php
@@ -294,7 +294,7 @@ public function getCurrentCurrencyCode()
      * Get currency rate (base to given currency)
      *
      * @param Mage_Directory_Model_Currency|string $toCurrency
-     * @return double
+     * @return float
      */
     public function getRate($toCurrency)
     {
diff --git a/app/code/core/Mage/Adminhtml/Block/Report/Grid/Shopcart.php b/app/code/core/Mage/Adminhtml/Block/Report/Grid/Shopcart.php
@@ -57,7 +57,7 @@ public function getCurrentCurrencyCode()
      * Get currency rate (base to given currency)
      *
      * @param Mage_Directory_Model_Currency|string $toCurrency
-     * @return double
+     * @return float
      */
     public function getRate($toCurrency)
     {
diff --git a/app/code/core/Mage/Adminhtml/Block/Sales/Order/Create/Items/Grid.php b/app/code/core/Mage/Adminhtml/Block/Sales/Order/Create/Items/Grid.php
@@ -108,7 +108,7 @@ public function getOriginalEditablePrice($item)
      * Returns the item's original price
      *
      * @param Mage_Sales_Model_Quote_Item $item
-     * @return double
+     * @return float
      */
     public function getItemOrigPrice($item)
     {
@@ -364,7 +364,7 @@ public function displaySubtotalInclTax($item)
      * Returns the item's original price that includes tax
      *
      * @param Mage_Sales_Model_Quote_Item $item
-     * @return double
+     * @return float
      */
     public function displayOriginalPriceInclTax($item)
     {
diff --git a/app/code/core/Mage/Catalog/Model/Product.php b/app/code/core/Mage/Catalog/Model/Product.php
@@ -921,8 +921,8 @@ public function getTierPriceCount()
     /**
      * Get formatted by currency tier price
      *
-     * @param   double $qty
-     * @return  array|double
+     * @param   float $qty
+     * @return  array|float
      */
     public function getFormatedTierPrice($qty = null)
     {
@@ -932,7 +932,7 @@ public function getFormatedTierPrice($qty = null)
     /**
      * Get formatted by currency product price
      *
-     * @return  array|double
+     * @return  array|float
      */
     public function getFormatedPrice()
     {
@@ -958,8 +958,8 @@ public function setFinalPrice($price)
     /**
      * Get product final price
      *
-     * @param double $qty
-     * @return double
+     * @param float $qty
+     * @return float
      */
     public function getFinalPrice($qty = null)
     {
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
@@ -19,7 +19,7 @@ class Mage_Catalog_Model_Product_Type_Configurable_Price extends Mage_Catalog_Mo
      *
      * @param null|float $qty
      * @param Mage_Catalog_Model_Product $product
-     * @return  double
+     * @return  float
      */
     public function getFinalPrice($qty, $product)
     {
diff --git a/app/code/core/Mage/Catalog/Model/Product/Type/Grouped/Price.php b/app/code/core/Mage/Catalog/Model/Product/Type/Grouped/Price.php
@@ -19,7 +19,7 @@ class Mage_Catalog_Model_Product_Type_Grouped_Price extends Mage_Catalog_Model_P
      *
      * @param null|float $qty
      * @param Mage_Catalog_Model_Product $product
-     * @return  double
+     * @return  float
      */
     public function getFinalPrice($qty, $product)
     {
diff --git a/app/code/core/Mage/CatalogIndex/Model/Indexer.php b/app/code/core/Mage/CatalogIndex/Model/Indexer.php
@@ -569,7 +569,7 @@ protected function _getPriorifiedProductTypes()
      * Retrieve Base to Specified Currency Rate
      *
      * @param string $code
-     * @return double
+     * @return float
      */
     protected function _getBaseToSpecifiedCurrencyRate($code)
     {
diff --git a/app/code/core/Mage/Centinel/Model/Service.php b/app/code/core/Mage/Centinel/Model/Service.php
@@ -83,7 +83,7 @@ protected function _getConfig()
      * @param string $cardNumber
      * @param string $cardExpMonth
      * @param string $cardExpYear
-     * @param double $amount
+     * @param float $amount
      * @param string $currencyCode
      * @return string
      */
diff --git a/app/code/core/Mage/Core/Model/Store.php b/app/code/core/Mage/Core/Model/Store.php
@@ -989,7 +989,7 @@ public function convertPrice($price, $format = false, $includeContainer = true)
      * Round price
      *
      * @param mixed $price
-     * @return double
+     * @return float
      */
     public function roundPrice($price)
     {
diff --git a/app/code/core/Mage/Core/Model/Url/Rewrite.php b/app/code/core/Mage/Core/Model/Url/Rewrite.php
@@ -51,7 +51,7 @@ class Mage_Core_Model_Url_Rewrite extends Mage_Core_Model_Abstract implements Ma
     /**
      * Cache tag for clear cache in after save and after delete
      *
-     * @var array|boolean|mixed|string
+     * @var array|bool|mixed|string
      */
     protected $_cacheTag = false;
 
diff --git a/app/code/core/Mage/Directory/Model/Currency/Filter.php b/app/code/core/Mage/Directory/Model/Currency/Filter.php
@@ -42,7 +42,7 @@ public function __construct($code, $rate = 1)
     /**
      * Set filter rate
      *
-     * @param double $rate
+     * @param float $rate
      */
     public function setRate($rate)
     {
@@ -52,7 +52,7 @@ public function setRate($rate)
     /**
      * Filter value
      *
-     * @param   double $value
+     * @param   float $value
      * @return  string
      */
     public function filter($value)
diff --git a/app/code/core/Mage/Paypal/Block/Adminhtml/System/Config/Fieldset/Payment.php b/app/code/core/Mage/Paypal/Block/Adminhtml/System/Config/Fieldset/Payment.php
@@ -30,7 +30,7 @@ protected function _getFrontendClass($element)
      * Check whether current payment method is enabled
      *
      * @param Varien_Data_Form_Element_Abstract $element
-     * @param null|callback $configCallback
+     * @param null|callable $configCallback
      * @return bool
      */
     protected function _isPaymentEnabled($element, $configCallback = null)
diff --git a/app/code/core/Mage/Paypal/Model/Info.php b/app/code/core/Mage/Paypal/Model/Info.php
@@ -212,7 +212,7 @@ public function getPublicPaymentInfo(Mage_Payment_Model_Info $payment, $labelVal
     /**
      * Grab data from source and map it into payment
      *
-     * @param array|callback|Varien_Object $from
+     * @param array|callable|Varien_Object $from
      */
     public function importToPayment($from, Mage_Payment_Model_Info $payment)
     {
@@ -227,7 +227,7 @@ public function importToPayment($from, Mage_Payment_Model_Info $payment)
     /**
      * Grab data from payment and map it into target
      *
-     * @param array|callback|Varien_Object $to
+     * @param array|callable|Varien_Object $to
      * @return array|Varien_Object
      */
     public function &exportFromPayment(Mage_Payment_Model_Info $payment, $to, ?array $map = null)
diff --git a/app/code/core/Mage/ProductAlert/Block/Email/Abstract.php b/app/code/core/Mage/ProductAlert/Block/Email/Abstract.php
@@ -66,10 +66,10 @@ public function getStore()
     /**
      * Convert price from default currency to current currency
      *
-     * @param double $price
+     * @param float $price
      * @param bool $format             Format price to currency format
      * @param bool $includeContainer   Enclose into <span class="price"><span>
-     * @return double
+     * @return float
      */
     public function formatPrice($price, $format = true, $includeContainer = true)
     {
diff --git a/lib/Mage/Cache/Backend/File.php b/lib/Mage/Cache/Backend/File.php
@@ -118,7 +118,7 @@ public function __construct(array $options = [])
      * Trying to load cached value by id, in case of failure will return false, in other case will return cached string
      *
      * @param  string  $id                     Cache id
-     * @param  boolean $doNotTestCacheValidity If set to true, the cache validity won't be tested
+     * @param  bool $doNotTestCacheValidity If set to true, the cache validity won't be tested
      *
      * @return bool|string Cached data or false
      */
@@ -424,7 +424,7 @@ protected function _getMetadatas($id)
      *
      * @param  string  $id        Cache id
      * @param  array   $metadatas Associative array of metadatas
-     * @param  boolean $save      Optional pass false to disable saving to file
+     * @param  bool $save      Optional pass false to disable saving to file
      *
      * @return bool In case of success returns true
      */
@@ -440,7 +440,7 @@ protected function _setMetadatas($id, $metadatas, $save = true)
      * Uses multiple letters for a single-level hash rather than multiple levels
      *
      * @param  string  $id    Cache id
-     * @param  boolean $parts If true, returns array of directory parts instead of single string
+     * @param  bool $parts If true, returns array of directory parts instead of single string
      *
      * @return array|string Complete directory path
      */
diff --git a/lib/Varien/Cache/Backend/Database.php b/lib/Varien/Cache/Backend/Database.php
@@ -119,7 +119,7 @@ protected function _getTagsTable()
      * Note : return value is always "string" (unserialization is done by the core not by the backend)
      *
      * @param  string  $id                     Cache id
-     * @param  boolean $doNotTestCacheValidity If set to true, the cache validity won't be tested
+     * @param  bool $doNotTestCacheValidity If set to true, the cache validity won't be tested
      * @return false|string cached data
      */
     public function load($id, $doNotTestCacheValidity = false)
diff --git a/lib/Varien/Cache/Core.php b/lib/Varien/Cache/Core.php
@@ -133,8 +133,8 @@ public function save($data, $id = null, $tags = [], $specificLifetime = false, $
      * Load data from cached, glue from several chunks if it was split upon save.
      *
      * @param  string  $id                     Cache id
-     * @param  boolean $doNotTestCacheValidity If set to true, the cache validity won't be tested
-     * @param  boolean $doNotUnserialize       Do not serialize (even if automatic_serialization is true) => for internal use
+     * @param  bool $doNotTestCacheValidity If set to true, the cache validity won't be tested
+     * @param  bool $doNotUnserialize       Do not serialize (even if automatic_serialization is true) => for internal use
      * @return false|mixed Cached data
      */
     public function load($id, $doNotTestCacheValidity = false, $doNotUnserialize = false)
diff --git a/lib/Varien/Data/Collection/Filesystem.php b/lib/Varien/Data/Collection/Filesystem.php
@@ -384,7 +384,7 @@ protected function _generateRow($filename)
      * @param string $field
      * @param mixed $value
      * @param string $type 'and'|'or'
-     * @param callback $callback
+     * @param callable $callback
      * @param bool $isInverted
      * @return $this
      */
@@ -441,7 +441,7 @@ protected function _filterRow($row)
      * Invokes specified callback
      * Skips, if there is no filtered key in the row
      *
-     * @param callback $callback
+     * @param callable $callback
      * @param array $callbackParams
      * @return bool
      */
diff --git a/lib/Varien/Db/Adapter/Interface.php b/lib/Varien/Db/Adapter/Interface.php
@@ -595,7 +595,7 @@ public function quote($value, $type = null);
      * @param string  $text  the text with a placeholder
      * @param null|array|float|int|string|Zend_Db_Expr|Zend_Db_Select $value OPTIONAL A single value to quote into the condition
      * @param null|int|string $type  OPTIONAL The type of the given value e.g. Zend_Db::INT_TYPE, "INT"
-     * @param integer $count OPTIONAL count of placeholders to replace
+     * @param int $count OPTIONAL count of placeholders to replace
      * @return string an SQL-safe quoted value placed into the original text
      */
     public function quoteInto($text, $value, $type = null, $count = null);
diff --git a/lib/Varien/Db/Adapter/Pdo/Mysql.php b/lib/Varien/Db/Adapter/Pdo/Mysql.php
@@ -1566,7 +1566,7 @@ protected function _debugWriteToFile($str)
      * @param string  $text  the text with a placeholder
      * @param null|array|float|int|string|Zend_Db_Expr|Zend_Db_Select $value OPTIONAL A single value to quote into the condition
      * @param null|int|string $type  OPTIONAL The type of the given value e.g. Zend_Db::INT_TYPE, "INT"
-     * @param integer $count OPTIONAL count of placeholders to replace
+     * @param int $count OPTIONAL count of placeholders to replace
      * @return string an SQL-safe quoted value placed into the original text
      */
     public function quoteInto($text, $value, $type = null, $count = null)
diff --git a/lib/Varien/Io/File.php b/lib/Varien/Io/File.php
@@ -886,7 +886,7 @@ public function ls($grep = null)
     /**
      * Convert integer permissions format into human readable
      *
-     * @param integer $mode
+     * @param int $mode
      * @access protected
      * @return string
      */
diff --git a/lib/Varien/Object/Cache.php b/lib/Varien/Object/Cache.php
@@ -392,7 +392,7 @@ public function debug($idx, $object = null)
     /**
      * Return debug information by ids
      *
-     * @param array|integer $ids
+     * @param array|int $ids
      * @return array
      */
     public function debugByIds($ids)
diff --git a/lib/Varien/Object/Mapper.php b/lib/Varien/Object/Mapper.php
@@ -33,8 +33,8 @@ class Varien_Object_Mapper
      *     <Varien_Object> => $from->setData($key, <from>)
      *     array(<Varien_Object>, <method>) => $from->$method($key, <from>)
      *
-     * @param array|callback|Varien_Object $from
-     * @param array|callback|Varien_Object $to
+     * @param array|callable|Varien_Object $from
+     * @param array|callable|Varien_Object $to
      * @return array|Varien_Object
      */
     public static function &accumulateByMap($from, $to, array $map, array $defaults = [])

Original file line number	Diff line number	Diff line change
`@@ -655,7 +655,7 @@ public function getCurrentCurrencyCode()`
`655`	`655`	`* Get currency rate (base to given currency)`
`656`	`656`	`*`
`657`	`657`	`* @param Mage_Directory_Model_Currency\|string $toCurrency`
`658`		`- * @return double`
	`658`	`+ * @return float`
`659`	`659`	`*/`
`660`	`660`	`public function getRate($toCurrency)`
`661`	`661`	`{`
Original file line number	Diff line number	Diff line change
`@@ -294,7 +294,7 @@ public function getCurrentCurrencyCode()`
`294`	`294`	`* Get currency rate (base to given currency)`
`295`	`295`	`*`
`296`	`296`	`* @param Mage_Directory_Model_Currency\|string $toCurrency`
`297`		`- * @return double`
	`297`	`+ * @return float`
`298`	`298`	`*/`
`299`	`299`	`public function getRate($toCurrency)`
`300`	`300`	`{`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public function getCurrentCurrencyCode()`
`57`	`57`	`* Get currency rate (base to given currency)`
`58`	`58`	`*`
`59`	`59`	`* @param Mage_Directory_Model_Currency\|string $toCurrency`
`60`		`- * @return double`
	`60`	`+ * @return float`
`61`	`61`	`*/`
`62`	`62`	`public function getRate($toCurrency)`
`63`	`63`	`{`
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ public function getOriginalEditablePrice($item)`
`108`	`108`	`* Returns the item's original price`
`109`	`109`	`*`
`110`	`110`	`* @param Mage_Sales_Model_Quote_Item $item`
`111`		`- * @return double`
	`111`	`+ * @return float`
`112`	`112`	`*/`
`113`	`113`	`public function getItemOrigPrice($item)`
`114`	`114`	`{`
`@@ -364,7 +364,7 @@ public function displaySubtotalInclTax($item)`
`364`	`364`	`* Returns the item's original price that includes tax`
`365`	`365`	`*`
`366`	`366`	`* @param Mage_Sales_Model_Quote_Item $item`
`367`		`- * @return double`
	`367`	`+ * @return float`
`368`	`368`	`*/`
`369`	`369`	`public function displayOriginalPriceInclTax($item)`
`370`	`370`	`{`
Original file line number	Diff line number	Diff line change
`@@ -921,8 +921,8 @@ public function getTierPriceCount()`
`921`	`921`	`/**`
`922`	`922`	`* Get formatted by currency tier price`
`923`	`923`	`*`
`924`		`- * @param double $qty`
`925`		`- * @return array\|double`
	`924`	`+ * @param float $qty`
	`925`	`+ * @return array\|float`
`926`	`926`	`*/`
`927`	`927`	`public function getFormatedTierPrice($qty = null)`
`928`	`928`	`{`
`@@ -932,7 +932,7 @@ public function getFormatedTierPrice($qty = null)`
`932`	`932`	`/**`
`933`	`933`	`* Get formatted by currency product price`
`934`	`934`	`*`
`935`		`- * @return array\|double`
	`935`	`+ * @return array\|float`
`936`	`936`	`*/`
`937`	`937`	`public function getFormatedPrice()`
`938`	`938`	`{`
`@@ -958,8 +958,8 @@ public function setFinalPrice($price)`
`958`	`958`	`/**`
`959`	`959`	`* Get product final price`
`960`	`960`	`*`
`961`		`- * @param double $qty`
`962`		`- * @return double`
	`961`	`+ * @param float $qty`
	`962`	`+ * @return float`
`963`	`963`	`*/`
`964`	`964`	`public function getFinalPrice($qty = null)`
`965`	`965`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class Mage_Catalog_Model_Product_Type_Configurable_Price extends Mage_Catalog_Mo`
`19`	`19`	`*`
`20`	`20`	`* @param null\|float $qty`
`21`	`21`	`* @param Mage_Catalog_Model_Product $product`
`22`		`- * @return double`
	`22`	`+ * @return float`
`23`	`23`	`*/`
`24`	`24`	`public function getFinalPrice($qty, $product)`
`25`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -569,7 +569,7 @@ protected function _getPriorifiedProductTypes()`
`569`	`569`	`* Retrieve Base to Specified Currency Rate`
`570`	`570`	`*`
`571`	`571`	`* @param string $code`
`572`		`- * @return double`
	`572`	`+ * @return float`
`573`	`573`	`*/`
`574`	`574`	`protected function _getBaseToSpecifiedCurrencyRate($code)`
`575`	`575`	`{`