phpcs-fixer: phpdoc_param_order (#5051)

- see https://cs.symfony.com/doc/rules/phpdoc/phpdoc_param_order.html

Author: sreichel

.php-cs-fixer.dist.php

@@ -18,6 +18,8 @@
         'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
         // Docblocks should have the same indentation as the documented subject.
         'phpdoc_indent' => true,
+        // Orders all @param annotations in DocBlocks according to method signature.
+        'phpdoc_param_order' => true,
         // Convert double quotes to single quotes for simple strings.
         'single_quote' => true,
         // Arguments lists, array destructuring lists, arrays that are multi-line, match-lines and parameters lists must have a trailing comma.

app/code/core/Mage/Admin/Model/Session.php

@@ -304,9 +304,9 @@ protected function _getRequestUri($request = null)
      * Login failed process
      *
      * @param Exception $e
+     * @param Mage_Core_Controller_Request_Http|null $request
      * @param string $username
      * @param string $message
-     * @param Mage_Core_Controller_Request_Http|null $request
      */
     protected function _loginFailed($e, $request, $username, $message)
     {

app/code/core/Mage/Adminhtml/Model/Giftmessage/Save.php

@@ -117,8 +117,8 @@ protected function _saveOne($entityId, $giftmessage)
     /**
      * Delete a single gift message from entity
      *
-     * @param Mage_GiftMessage_Model_Message|null $giftmessageModel
      * @param Varien_Object $entityModel
+     * @param Mage_GiftMessage_Model_Message|null $giftmessageModel
      * @return $this
      * @throws Throwable
      */

app/code/core/Mage/Catalog/Model/Api2/Product/Validator/Product.php

@@ -429,8 +429,8 @@ protected function _isManageStockEnabled($stockData)
     /**
      * Validate Customer Group field
      *
-     * @param string $fieldSet
      * @param array $data
+     * @param string $fieldSet
      */
     protected function _validateCustomerGroup($data, $fieldSet)
     {

app/code/core/Mage/Eav/Model/Config.php

@@ -444,8 +444,8 @@ public function getEntityType($code, $field = null)
      * Entity_Type->getEntity() which itself requires this class and re-triggers loading.
      *
      * @param Mage_Eav_Model_Entity_Type $entityType
-     * @param int $storeId
      * @param string $attributeCode
+     * @param int $storeId
      * @return Mage_Eav_Model_Entity_Attribute_Abstract|false
      */
     protected function _getDefaultAttributeIfExists($entityType, $attributeCode, $storeId)

lib/Mage/HTTP/Client/Socket.php

@@ -477,8 +477,8 @@ public function doError($string)
 
     /**
      * Convert headers hash to string
-     * @param $delimiter
      * @param $append
+     * @param $delimiter
      * @return string
      */
     protected function headersToString($append = [])

lib/Varien/Db/Adapter/Mysqli.php

@@ -203,8 +203,8 @@ public function dropKey($table, $key)
      * @param string $keyName
      * @param string $refTableName
      * @param string $refKeyName
-     * @param string $onUpdate
      * @param string $onDelete
+     * @param string $onUpdate
      */
     public function addConstraint(
         $fkName,

lib/Varien/Db/Adapter/Pdo/Mysql.php

@@ -528,8 +528,8 @@ public function query($sql, $bind = [])
      * with named binds.
      *
      * @param Zend_Db_Select|string $sql
-     * @param-out string $sql
      * @param mixed $bind
+     * @param-out string $sql
      * @return $this
      */
     protected function _prepareQuery(&$sql, &$bind = [])
@@ -878,8 +878,8 @@ public function purgeOrphanRecords(
      * @param string $columnName main table field name
      * @param string $refTableName referred table name
      * @param string $refColumnName referred table field name
-     * @param string $onUpdate on update statement
      * @param string $onDelete on delete statement
+     * @param string $onUpdate on update statement
      * @param bool $purge
      * @return mixed
      */

lib/Varien/Image.php

@@ -29,8 +29,8 @@ class Varien_Image
     /**
      * Constructor
      *
-     * @param string $adapter Default value is GD2
      * @param string $fileName
+     * @param string $adapter Default value is GD2
      * @return void
      */
     public function __construct($fileName = null, $adapter = Varien_Image_Adapter::ADAPTER_GD2)