phpcs-fixer: sort more tags, follow symfony sort order (#5081)

Author: sreichel

.php-cs-fixer.dist.php

@@ -27,7 +27,7 @@
         // Docblocks should have the same indentation as the documented subject.
         'phpdoc_indent' => true,
         // Annotations in PHPDoc should be ordered in defined sequence.
-        'phpdoc_order' => true,
+        'phpdoc_order' => ['order' => ['param', 'return', 'throws', 'deprecated', 'see', 'SuppressWarnings']],
         // Order PHPDoc tags by value.
         'phpdoc_order_by_value' => ['annotations' => ['author', 'covers', 'group', 'method', 'throws', 'uses']],
         // Orders all @param annotations in DocBlocks according to method signature.

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

@@ -30,9 +30,9 @@ protected function _construct()
     }
 
     /**
+     * @return array|true
      * @throws Exception
      * @throws Zend_Validate_Exception
-     * @return array|true
      */
     public function validate()
     {

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

@@ -96,8 +96,8 @@ public function actionPreDispatchAdmin($observer)
     /**
      * Unset session first visit flag after displaying page
      *
-     * @deprecated after 1.4.0.1, logic moved to admin session
      * @param Varien_Event_Observer $event
+     * @deprecated after 1.4.0.1, logic moved to admin session
      */
     public function actionPostDispatchAdmin($event) {}
 

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

@@ -40,8 +40,8 @@ protected function _construct()
      * Process role before saving
      *
      * @param Mage_Admin_Model_Roles $object
-     * @throws Mage_Core_Exception
      * @return $this
+     * @throws Mage_Core_Exception
      */
     protected function _beforeSave(Mage_Core_Model_Abstract $object)
     {
@@ -77,8 +77,8 @@ protected function _beforeSave(Mage_Core_Model_Abstract $object)
      * Process role after saving
      *
      * @param Mage_Admin_Model_Roles $object
-     * @throws Zend_Cache_Exception
      * @return $this
+     * @throws Zend_Cache_Exception
      */
     protected function _afterSave(Mage_Core_Model_Abstract $object)
     {
@@ -94,8 +94,8 @@ protected function _afterSave(Mage_Core_Model_Abstract $object)
      * Process role after deleting
      *
      * @param Mage_Admin_Model_Roles $object
-     * @throws Mage_Core_Exception
      * @return $this
+     * @throws Mage_Core_Exception
      */
     protected function _afterDelete(Mage_Core_Model_Abstract $object)
     {
@@ -108,8 +108,8 @@ protected function _afterDelete(Mage_Core_Model_Abstract $object)
     /**
      * Get role users
      *
-     * @throws Mage_Core_Exception
      * @return array
+     * @throws Mage_Core_Exception
      */
     public function getRoleUsers(Mage_Admin_Model_Roles $role)
     {
@@ -125,9 +125,9 @@ public function getRoleUsers(Mage_Admin_Model_Roles $role)
     /**
      * Update role users
      *
+     * @return bool
      * @throws Mage_Core_Exception
      * @throws Zend_Db_Adapter_Exception
-     * @return bool
      */
     private function _updateRoleUsersAcl(Mage_Admin_Model_Roles $role)
     {

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

@@ -74,9 +74,9 @@ public function saveRel(Mage_Admin_Model_Rules $rule)
 
     /**
      * Set resource ID as ID field name
-     * @see Mage_Adminhtml_Block_Permissions_OrphanedResource_Grid::_prepareCollection()
      *
      * @return $this
+     * @see Mage_Adminhtml_Block_Permissions_OrphanedResource_Grid::_prepareCollection()
      */
     public function setResourceIdAsIdFieldName()
     {

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

@@ -157,8 +157,8 @@ protected function _afterLoad(Mage_Core_Model_Abstract $user)
     /**
      * Delete user role record with user
      *
-     * @throws Exception
      * @return $this
+     * @throws Exception
      */
     public function delete(Mage_Core_Model_Abstract $user)
     {
@@ -187,9 +187,9 @@ public function delete(Mage_Core_Model_Abstract $user)
     /**
      * TODO: unify _saveRelations() and add() methods, they make same things
      *
+     * @return $this|Mage_Core_Model_Abstract
      * @throws Mage_Core_Exception
      * @throws Zend_Db_Adapter_Exception
-     * @return $this|Mage_Core_Model_Abstract
      */
     public function _saveRelations(Mage_Core_Model_Abstract $user)
     {

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

@@ -202,8 +202,8 @@ public function saveExtra($data)
     /**
      * Save user roles
      *
-     * @throws Mage_Core_Exception
      * @return $this
+     * @throws Mage_Core_Exception
      */
     public function saveRelations()
     {
@@ -366,8 +366,8 @@ public function getAclRole()
      *
      * @param string $username
      * @param string $password
-     * @throws Mage_Core_Exception
      * @return bool
+     * @throws Mage_Core_Exception
      */
     public function authenticate($username, $password)
     {
@@ -425,8 +425,8 @@ public function validatePasswordHash(string $string1, string $string2): bool
      *
      * @param string $username
      * @param string $password
-     * @throws Mage_Core_Exception
      * @return  $this
+     * @throws Mage_Core_Exception
      */
     public function login($username, $password)
     {
@@ -550,9 +550,9 @@ public function hasAvailableResources()
     /**
      * Find admin start page url
      *
+     * @return string
      * @deprecated Please use getStartupPageUrl() method instead
      * @see getStartupPageUrl()
-     * @return string
      */
     public function getStatrupPageUrl()
     {
@@ -583,8 +583,8 @@ public function getStartupPageUrl()
      * Validate user attribute values.
      * Returns TRUE or array of errors.
      *
-     * @throws Zend_Validate_Exception
      * @return array|true
+     * @throws Zend_Validate_Exception
      */
     public function validate()
     {
@@ -650,8 +650,8 @@ public function validate()
      * Returns true or array of errors.
      *
      * @param string $password
-     * @throws Zend_Validate_Exception
      * @return array|true
+     * @throws Zend_Validate_Exception
      */
     public function validateCurrentPassword($password)
     {
@@ -676,8 +676,8 @@ public function validateCurrentPassword($password)
      * Stores new reset password link token and its creation time
      *
      * @param string $newResetPasswordLinkToken
-     * @throws Mage_Core_Exception
      * @return $this
+     * @throws Mage_Core_Exception
      */
     public function changeResetPasswordLinkToken($newResetPasswordLinkToken)
     {

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

@@ -30,9 +30,9 @@ protected function _construct()
     }
 
     /**
+     * @return array|bool
      * @throws Exception
      * @throws Zend_Validate_Exception
-     * @return array|bool
      */
     public function validate()
     {

app/code/core/Mage/Adminhtml/Block/Api/Role/Grid/User.php

@@ -28,8 +28,8 @@ public function __construct()
 
     /**
      * @param Mage_Adminhtml_Block_Widget_Grid_Column $column
-     * @throws Exception
      * @return $this
+     * @throws Exception
      */
     protected function _addColumnFilterToCollection($column)
     {
@@ -123,8 +123,8 @@ protected function _prepareColumns()
     }
 
     /**
-     * @throws Exception
      * @return string
+     * @throws Exception
      */
     public function getGridUrl()
     {
@@ -134,8 +134,8 @@ public function getGridUrl()
 
     /**
      * @param bool $json
-     * @throws Exception
      * @return array|int|string
+     * @throws Exception
      */
     protected function _getUsers($json = false)
     {

app/code/core/Mage/Adminhtml/Block/Api/User/Edit/Tab/Roles.php

@@ -93,8 +93,8 @@ public function getGridUrl()
 
     /**
      * @param bool $json
-     * @throws Exception
      * @return string
+     * @throws Exception
      */
     protected function _getSelectedRoles($json = false)
     {