Skip to content

Commit f094b41

Browse files
sreichelsreichel
authored
phpcs-fixer: phpdoc_order_by_value (#5079)
* phpcs-fixer: `phpdoc_order_by_value` - see https://cs.symfony.com/doc/rules/phpdoc/phpdoc_order_by_value.html Sort method tags is pretty nice :) * update
1 parent dc4841c commit f094b41

File tree

316 files changed

+3406
-3580
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

316 files changed

+3406
-3580
lines changed

‎.php-cs-fixer.dist.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
'phpdoc_indent' => true,
2929
// Annotations in PHPDoc should be ordered in defined sequence.
3030
'phpdoc_order' => true,
31+
// Order PHPDoc tags by value.
32+
'phpdoc_order_by_value' => ['annotations' => ['author', 'covers', 'group', 'method', 'throws', 'uses']],
3133
// Orders all @param annotations in DocBlocks according to method signature.
3234
'phpdoc_param_order' => true,
3335
// PHPDoc should start and end with content, excluding the very first and last line of the docblocks.

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,21 @@
1313
* @package Mage_Admin
1414
*
1515
* @method Mage_Admin_Model_Resource_Acl_Role _getResource()
16-
* @method Mage_Admin_Model_Resource_Acl_Role getResource()
1716
* @method Mage_Admin_Model_Resource_Acl_Role_Collection getCollection()
18-
* @method Mage_Admin_Model_Resource_Acl_Role_Collection getResourceCollection()
19-
*
2017
* @method int getParentId()
21-
* @method $this setParentId(int $value)
22-
* @method int getTreeLevel()
23-
* @method $this setTreeLevel(int $value)
24-
* @method int getSortOrder()
25-
* @method $this setSortOrder(int $value)
18+
* @method Mage_Admin_Model_Resource_Acl_Role getResource()
19+
* @method Mage_Admin_Model_Resource_Acl_Role_Collection getResourceCollection()
20+
* @method string getRoleName()
2621
* @method string getRoleType()
27-
* @method $this setRoleType(string $value)
22+
* @method int getSortOrder()
23+
* @method int getTreeLevel()
2824
* @method int getUserId()
29-
* @method $this setUserId(int $value)
30-
* @method string getRoleName()
25+
* @method $this setParentId(int $value)
3126
* @method $this setRoleName(string $value)
27+
* @method $this setRoleType(string $value)
28+
* @method $this setSortOrder(int $value)
29+
* @method $this setTreeLevel(int $value)
30+
* @method $this setUserId(int $value)
3231
*/
3332
class Mage_Admin_Model_Acl_Role extends Mage_Core_Model_Abstract
3433
{

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,11 @@
1313
* @package Mage_Adminhtml
1414
*
1515
* @method Mage_Admin_Model_Resource_Block _getResource()
16-
* @method Mage_Admin_Model_Resource_Block getResource()
17-
* @method Mage_Admin_Model_Resource_Block_Collection getCollection()
18-
* @method Mage_Admin_Model_Resource_Block_Collection getResourceCollection()
19-
*
2016
* @method string getBlockName()
17+
* @method Mage_Admin_Model_Resource_Block_Collection getCollection()
2118
* @method string getIsAllowed()
19+
* @method Mage_Admin_Model_Resource_Block getResource()
20+
* @method Mage_Admin_Model_Resource_Block_Collection getResourceCollection()
2221
*/
2322
class Mage_Admin_Model_Block extends Mage_Core_Model_Abstract
2423
{

‎app/code/core/Mage/Admin/Model/Role.php‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,26 @@
1313
* @package Mage_Admin
1414
*
1515
* @method Mage_Admin_Model_Resource_Role _getResource()
16-
* @method Mage_Admin_Model_Resource_Role getResource()
1716
* @method Mage_Admin_Model_Resource_Role_Collection getCollection()
18-
* @method Mage_Admin_Model_Resource_Role_Collection getResourceCollection()
19-
*
17+
* @method string getName()
2018
* @method int getParentId()
21-
* @method $this setParentId(int $value)
22-
* @method int getTreeLevel()
23-
* @method $this setTreeLevel(int $value)
24-
* @method int getSortOrder()
25-
* @method $this setSortOrder(int $value)
19+
* @method int getPid()
20+
* @method Mage_Admin_Model_Resource_Role getResource()
21+
* @method Mage_Admin_Model_Resource_Role_Collection getResourceCollection()
2622
* @method int getRoleId()
23+
* @method string getRoleName()
2724
* @method string getRoleType()
28-
* @method $this setRoleType(string $value)
25+
* @method int getSortOrder()
26+
* @method int getTreeLevel()
2927
* @method int getUserId()
30-
* @method $this setUserId(int $value)
31-
* @method string getRoleName()
32-
* @method $this setRoleName(string $value)
33-
* @method int getPid()
34-
* @method string getName()
3528
* @method $this setCreated(string $value)
3629
* @method $this setModified(string $value)
30+
* @method $this setParentId(int $value)
31+
* @method $this setRoleName(string $value)
32+
* @method $this setRoleType(string $value)
33+
* @method $this setSortOrder(int $value)
34+
* @method $this setTreeLevel(int $value)
35+
* @method $this setUserId(int $value)
3736
*/
3837
class Mage_Admin_Model_Role extends Mage_Core_Model_Abstract
3938
{

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

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,23 @@
1313
* @package Mage_Admin
1414
*
1515
* @method Mage_Admin_Model_Resource_Roles _getResource()
16-
* @method Mage_Admin_Model_Resource_Roles getResource()
1716
* @method Mage_Admin_Model_Resource_Roles_Collection getCollection()
18-
* @method Mage_Admin_Model_Resource_Roles_Collection getResourceCollection()
19-
*
17+
* @method string getName()
2018
* @method int getParentId()
21-
* @method $this setParentId(int $value)
22-
* @method int getTreeLevel()
23-
* @method $this setTreeLevel(int $value)
24-
* @method int getSortOrder()
25-
* @method $this setSortOrder(int $value)
19+
* @method int getPid()
20+
* @method Mage_Admin_Model_Resource_Roles getResource()
21+
* @method Mage_Admin_Model_Resource_Roles_Collection getResourceCollection()
22+
* @method string getRoleName()
2623
* @method string getRoleType()
27-
* @method $this setRoleType(string $value)
24+
* @method int getSortOrder()
25+
* @method int getTreeLevel()
2826
* @method int getUserId()
29-
* @method $this setUserId(int $value)
30-
* @method string getRoleName()
27+
* @method $this setParentId(int $value)
3128
* @method $this setRoleName(string $value)
32-
* @method string getName()
33-
* @method int getPid()
29+
* @method $this setRoleType(string $value)
30+
* @method $this setSortOrder(int $value)
31+
* @method $this setTreeLevel(int $value)
32+
* @method $this setUserId(int $value)
3433
*/
3534
class Mage_Admin_Model_Roles extends Mage_Core_Model_Abstract
3635
{

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

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,21 @@
1313
* @package Mage_Admin
1414
*
1515
* @method Mage_Admin_Model_Resource_Rules _getResource()
16+
* @method int getAssertId()
17+
* @method string getPermission()
18+
* @method string getPrivileges()
1619
* @method Mage_Admin_Model_Resource_Rules getResource()
1720
* @method Mage_Admin_Model_Resource_Rules_Collection getResourceCollection()
18-
*
19-
* @method int getAssertId()
21+
* @method string getResourceId()
22+
* @method array getResources()
23+
* @method int getRoleId()
24+
* @method string getRoleType()
2025
* @method $this setAssertId(int $value)
21-
* @method string getPermission()
2226
* @method $this setPermission(string $value)
23-
* @method array getResources()
24-
* @method $this setResources(array $value)
25-
* @method string getResourceId()
26-
* @method $this setResourceId(string $value)
27-
* @method string getPrivileges()
2827
* @method $this setPrivileges(string $value)
29-
* @method int getRoleId()
28+
* @method $this setResourceId(string $value)
29+
* @method $this setResources(array $value)
3030
* @method $this setRoleId(int $value)
31-
* @method string getRoleType()
3231
* @method $this setRoleType(string $value)
3332
*/
3433
class Mage_Admin_Model_Rules extends Mage_Core_Model_Abstract

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,29 @@
1313
* @package Mage_Admin
1414
*
1515
* @method Mage_Admin_Model_Acl getAcl()
16-
* @method $this setAcl(Mage_Admin_Model_Acl $acl)
1716
* @method int getActiveTabId()
17+
* @method string getDeletedPath()
18+
* @method bool getIndirectLogin()
19+
* @method bool getIsTreeWasExpanded()
20+
* @method int getLastEditedCategory()
21+
* @method string getLastViewedStore()
22+
* @method bool getSyncProcessStopWatch()
23+
* @method Mage_Admin_Model_User getUser()
24+
* @method bool getUserPasswordChanged()
25+
* @method bool hasSyncProcessStopWatch()
26+
* @method $this setAcl(Mage_Admin_Model_Acl $acl)
1827
* @method $this setActiveTabId(int $value)
19-
* @method $this unsActiveTabId()
2028
* @method $this setAttributeData(array|false $data)
21-
* @method string getDeletedPath()
2229
* @method $this setDeletedPath(string $value)
23-
* @method bool getIndirectLogin()
2430
* @method $this setIndirectLogin(bool $value)
2531
* @method $this setIsFirstVisit(bool $value)
26-
* @method bool getIsTreeWasExpanded()
2732
* @method $this setIsTreeWasExpanded(bool $value)
28-
* @method int getLastEditedCategory()
2933
* @method $this setLastEditedCategory(int $value)
30-
* @method string getLastViewedStore()
3134
* @method $this setLastViewedStore(string $value)
32-
* @method bool getUserPasswordChanged()
33-
* @method $this setUserPasswordChanged(bool $value)
34-
* @method bool hasSyncProcessStopWatch()
35-
* @method bool getSyncProcessStopWatch()
3635
* @method $this setSyncProcessStopWatch(bool $value)
37-
* @method Mage_Admin_Model_User getUser()
3836
* @method $this setUser(Mage_Admin_Model_User $user)
37+
* @method $this setUserPasswordChanged(bool $value)
38+
* @method $this unsActiveTabId()
3939
*/
4040
class Mage_Admin_Model_Session extends Mage_Core_Model_Session_Abstract
4141
{

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

Lines changed: 30 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -13,53 +13,52 @@
1313
* @package Mage_Admin
1414
*
1515
* @method Mage_Admin_Model_Resource_User _getResource()
16-
* @method Mage_Admin_Model_Resource_User getResource()
17-
* @method Mage_Admin_Model_Resource_User_Collection getResourceCollection()
18-
*
16+
* @method string getCreated()
17+
* @method string getEmail()
18+
* @method array getExtra()
1919
* @method string getFirstname()
20-
* @method $this setFirstname(string $value)
20+
* @method int getIsActive()
2121
* @method string getLastname()
22-
* @method $this setLastname(string $value)
23-
* @method string getEmail()
24-
* @method $this setEmail(string $value)
25-
* @method string getUsername()
26-
* @method $this setUsername(string $value)
27-
* @method string getPassword()
28-
* @method $this setPassword(string $value)
29-
* @method string getCreated()
30-
* @method $this setCreated(string $value)
31-
* @method string getModified()
32-
* @method $this setModified(string $value)
3322
* @method string getLogdate()
34-
* @method $this setLogdate(string $value)
3523
* @method int getLognum()
36-
* @method $this setLognum(int $value)
24+
* @method string getModified()
25+
* @method string getNewPassword()
26+
* @method string getPassword()
27+
* @method string getPasswordConfirmation()
3728
* @method int getReloadAclFlag()
38-
* @method $this setReloadAclFlag(int $value)
39-
* @method int getIsActive()
40-
* @method $this setIsActive(int $value)
41-
* @method array getExtra()
42-
* @method $this setExtra(string $value)
43-
* @method int getUserId()
29+
* @method Mage_Admin_Model_Resource_User getResource()
30+
* @method Mage_Admin_Model_Resource_User_Collection getResourceCollection()
4431
* @method int getRoleId()
32+
* @method array getRoleIds()
33+
* @method string getRpToken()
34+
* @method string getRpTokenCreatedAt()
35+
* @method int getUserId()
36+
* @method string getUsername()
4537
* @method bool hasNewPassword()
46-
* @method string getNewPassword()
47-
* @method $this setNewPassword(string $value)
48-
* @method $this unsNewPassword()
4938
* @method bool hasPassword()
5039
* @method bool hasPasswordConfirmation()
51-
* @method string getPasswordConfirmation()
40+
* @method $this setCreated(string $value)
41+
* @method $this setEmail(string $value)
42+
* @method $this setExtra(string $value)
43+
* @method $this setFirstname(string $value)
44+
* @method $this setIsActive(int $value)
45+
* @method $this setLastname(string $value)
46+
* @method $this setLogdate(string $value)
47+
* @method $this setLognum(int $value)
48+
* @method $this setModified(string $value)
49+
* @method $this setNewPassword(string $value)
50+
* @method $this setPassword(string $value)
5251
* @method $this setPasswordConfirmation(string $value)
53-
* @method $this unsPasswordConfirmation()
52+
* @method $this setReloadAclFlag(int $value)
5453
* @method $this setRoleId(int $value)
55-
* @method array getRoleIds()
5654
* @method $this setRoleIds(array $value)
5755
* @method $this setRoleUserId(int $value)
58-
* @method string getRpToken()
5956
* @method $this setRpToken(string $value)
60-
* @method string getRpTokenCreatedAt()
6157
* @method $this setRpTokenCreatedAt(string $value)
6258
* @method $this setUserId(int $value)
59+
* @method $this setUsername(string $value)
60+
* @method $this unsNewPassword()
61+
* @method $this unsPasswordConfirmation()
6362
*/
6463
class Mage_Admin_Model_User extends Mage_Core_Model_Abstract
6564
{

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,10 @@
1313
* @package Mage_Admin
1414
*
1515
* @method Mage_Admin_Model_Resource_Variable _getResource()
16-
* @method Mage_Admin_Model_Resource_Variable getResource()
1716
* @method Mage_Admin_Model_Resource_Variable_Collection getCollection()
18-
* @method Mage_Admin_Model_Resource_Variable_Collection getResourceCollection()
19-
*
2017
* @method string getIsAllowed()
18+
* @method Mage_Admin_Model_Resource_Variable getResource()
19+
* @method Mage_Admin_Model_Resource_Variable_Collection getResourceCollection()
2120
* @method string getVariableName()
2221
*/
2322
class Mage_Admin_Model_Variable extends Mage_Core_Model_Abstract

‎app/code/core/Mage/AdminNotification/Model/Inbox.php‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,22 @@
1313
* @package Mage_AdminNotification
1414
*
1515
* @method Mage_AdminNotification_Model_Resource_Inbox _getResource()
16-
* @method Mage_AdminNotification_Model_Resource_Inbox getResource()
1716
* @method Mage_AdminNotification_Model_Resource_Inbox_Collection getCollection()
18-
* @method Mage_AdminNotification_Model_Resource_Inbox_Collection getResourceCollection()
19-
*
2017
* @method string getDateAdded()
21-
* @method $this setDateAdded(string $value)
2218
* @method string getDescription()
23-
* @method $this setDescription(string $value)
2419
* @method int getIsRead()
25-
* @method $this setIsRead(int $value)
2620
* @method int getIsRemove()
27-
* @method $this setIsRemove(int $value)
21+
* @method Mage_AdminNotification_Model_Resource_Inbox getResource()
22+
* @method Mage_AdminNotification_Model_Resource_Inbox_Collection getResourceCollection()
2823
* @method int getSeverity()
29-
* @method $this setSeverity(int $value)
3024
* @method string getTitle()
31-
* @method $this setTitle(string $value)
3225
* @method string getUrl()
26+
* @method $this setDateAdded(string $value)
27+
* @method $this setDescription(string $value)
28+
* @method $this setIsRead(int $value)
29+
* @method $this setIsRemove(int $value)
30+
* @method $this setSeverity(int $value)
31+
* @method $this setTitle(string $value)
3332
* @method $this setUrl(string $value)
3433
*/
3534
class Mage_AdminNotification_Model_Inbox extends Mage_Core_Model_Abstract

0 commit comments

Comments
 (0)