Better php-cs-fixer config for phpdoc (#349)

Author: fballiano

.php-cs-fixer.php

@@ -18,6 +18,13 @@
         'nullable_type_declaration_for_default_null_value' => true,
         // Convert double quotes to single quotes for simple strings.
         'single_quote' => true,
+        // PHPdoc stuff
+        'phpdoc_indent' => true,
+        'phpdoc_param_order' => true,
+        'phpdoc_single_line_var_spacing' => true,
+        'phpdoc_trim' => true,
+        'phpdoc_trim_consecutive_blank_line_separation' => true,
+
     ])
     ->setFinder(
         PhpCsFixer\Finder::create()

app/Mage.php

@@ -122,7 +122,6 @@ public static function getVersion(): string
 
     /**
      * Set all my static data to defaults
-     *
      */
     public static function reset()
     {

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

@@ -18,31 +18,26 @@ class Mage_Admin_Model_Acl extends \Laminas\Permissions\Acl\Acl
 
     /**
      * All the group roles are prepended by G
-     *
      */
     public const ROLE_TYPE_GROUP = 'G';
 
     /**
      * All the user roles are prepended by U
-     *
      */
     public const ROLE_TYPE_USER = 'U';
 
     /**
      * Permission level to deny access
-     *
      */
     public const RULE_PERM_DENY = 0;
 
     /**
      * Permission level to inheric access from parent role
-     *
      */
     public const RULE_PERM_INHERIT = 1;
 
     /**
      * Permission level to allow access
-     *
      */
     public const RULE_PERM_ALLOW = 2;
 

app/code/core/Mage/Admin/Model/Resource/Acl.php

@@ -16,7 +16,6 @@ class Mage_Admin_Model_Resource_Acl extends Mage_Core_Model_Resource_Db_Abstract
 
     /**
      * Initialize resource
-     *
      */
     #[\Override]
     protected function _construct()

app/code/core/Mage/Admin/Model/Resource/Acl/Role/Collection.php

@@ -14,7 +14,6 @@ class Mage_Admin_Model_Resource_Acl_Role_Collection extends Mage_Core_Model_Reso
 {
     /**
      * Initialize resource
-     *
      */
     #[\Override]
     protected function _construct()

app/code/core/Mage/Admin/Model/Resource/Block/Collection.php

@@ -14,7 +14,6 @@ class Mage_Admin_Model_Resource_Block_Collection extends Mage_Core_Model_Resourc
 {
     /**
      * Define resource model
-     *
      */
     #[\Override]
     protected function _construct()

app/code/core/Mage/Admin/Model/Resource/Permissions/Collection.php

@@ -14,7 +14,6 @@ class Mage_Admin_Model_Resource_Permissions_Collection extends Mage_Core_Model_R
 {
     /**
      * Initialize resource
-     *
      */
     #[\Override]
     protected function _construct()

app/code/core/Mage/Admin/Model/Resource/User/Collection.php

@@ -14,7 +14,6 @@ class Mage_Admin_Model_Resource_User_Collection extends Mage_Core_Model_Resource
 {
     /**
      * Define resource model
-     *
      */
     #[\Override]
     protected function _construct()

app/code/core/Mage/Admin/Model/Resource/Variable/Collection.php

@@ -18,7 +18,6 @@ class Mage_Admin_Model_Resource_Variable_Collection extends Mage_Core_Model_Reso
 {
     /**
      * Define resource model
-     *
      */
     #[\Override]
     protected function _construct()

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

@@ -318,9 +318,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, #[\SensitiveParameter] $username, $message)
     {