Fix the issues reported by phpcs [#3391931]

Problem/Motivation

FILE: /var/www/html/drupal_module_development/web/modules/contrib/role_watchdog/src/RoleWatchdogListBuilder.php
---------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------------
29 | WARNING | [x] Inline @var declarations should use the /** */ delimiters
---------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/drupal_module_development/web/modules/contrib/role_watchdog/src/Form/RoleWatchdogForm.php
-------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
-------------------------------------------------------------------------------------------------------------
19 | WARNING | [x] Inline @var declarations should use the /** */ delimiters
22 | WARNING | [ ] Unused variable $entity.
-------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/drupal_module_development/web/modules/contrib/role_watchdog/src/Form/RoleWatchdogSettingsForm.php
---------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
---------------------------------------------------------------------------------------------------------------------
10 | WARNING | The class short comment should describe what the class does and not simply repeat the class name
55 | WARNING | Avoid backslash escaping in translatable strings when possible, use "" quotes instead
---------------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/drupal_module_development/web/modules/contrib/role_watchdog/src/Entity/RoleWatchdogInterface.php
--------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------------------
68 | WARNING | Line exceeds 80 characters; contains 83 characters
--------------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/drupal_module_development/web/modules/contrib/role_watchdog/src/Entity/RoleWatchdog.php
------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------------------------------
7 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Entity\ContentEntityBase.
------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/drupal_module_development/web/modules/contrib/role_watchdog/src/RoleWatchdogAccessControlHandler.php
-------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------------------------------------------------------------------------------------------------------------
8 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Access\AccessResult.
-------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/drupal_module_development/web/modules/contrib/role_watchdog/role_watchdog.module
---------------------------------------------------------------------------------------------------------------------------------------------
FOUND 17 ERRORS AND 1 WARNING AFFECTING 11 LINES
---------------------------------------------------------------------------------------------------------------------------------------------
10 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Entity\EntityInterface.
71 | ERROR | [ ] Missing parameter comment
71 | ERROR | [ ] Missing parameter type
72 | ERROR | [ ] Missing parameter comment
72 | ERROR | [ ] Missing parameter type
73 | ERROR | [ ] Missing parameter comment
73 | ERROR | [ ] Missing parameter type
74 | ERROR | [ ] Missing parameter comment
74 | ERROR | [ ] Missing parameter type
75 | ERROR | [ ] Missing parameter comment
95 | WARNING | [ ] Line exceeds 80 characters; contains 82 characters
126 | ERROR | [ ] Missing parameter comment
126 | ERROR | [ ] Missing parameter type
127 | ERROR | [ ] Missing parameter comment
127 | ERROR | [ ] Missing parameter type
128 | ERROR | [ ] Missing parameter comment
128 | ERROR | [ ] Missing parameter type
134 | ERROR | [ ] The array declaration extends to column 212 (the limit is 80). The array content should be split up over multiple lines
---------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------------------------

Steps to reproduce

Install the role watchdog module and perform PHPCS for Drupal Standards

Proposed resolution

Fix the errors found from PHPCS

Comment	File	Size	Author
#5	issue-fixed.PNG	25.2 KB	gautam_105@
#5	Apply-patch.PNG	40.67 KB	gautam_105@
#2	3391931-1.patch	7.44 KB	Akshat26

Issue fork role_watchdog-3391931

Show commands

Start within a Git clone of the project using the version control instructions.

Add & fetch this issue fork’s repository

Or, if you do not have SSH keys set up on git.drupalcode.org:

Add & fetch this issue fork’s repository

3391931-fix-the-issues changes, plain diff MR !5
Check out this branch for the first time

Check out existing branch, if you already have it locally

About issue forks

Comments

Comment #1

5 October 2023 at 12:41

Akshat26 created an issue. See original summary.

Comment #2

Akshat26 commented 5 October 2023 at 12:45

Assigned:	Akshat26	» Unassigned
Status:	Active	» Needs review

Status	File	Size
new	3391931-1.patch	7.44 KB

All the mentioned phpcs issues have been fixed. Please review the patch #3391931-1

Comment #3

gautam_105@ commented 6 October 2023 at 05:04

Assigned:

Unassigned

» gautam_105@

Comment #4

gautam_105@ commented 6 October 2023 at 05:26

Status:

Needs review

» Reviewed & tested by the community

Patch get applied cleanly and resolved all the phpcs issues.

Comment #5

gautam_105@ commented 6 October 2023 at 05:32

Status	File	Size
new	Apply-patch.PNG	40.67 KB
new	issue-fixed.PNG	25.2 KB

1 file was hidden/shown/deleted

Status	File	Size
hidden	3391931-1.patch	7.44 KB

@ Akshat26,
i have applied patch #2 that resolved all the phpcs issues And i have created MR for the same. see screenshot as well.

Comment #6

6 October 2023 at 05:33

Gautam_105@ opened merge request !5

Comment #7

gautam_105@ commented 6 October 2023 at 05:38

Assigned:

gautam_105@

» Unassigned

Comment #8

23 January 2024 at 07:10

ericgsmith made their first commit to this issue’s fork.

Comment #9

23 January 2024 at 07:10

ericgsmith committed bebce2ac on 2.x authored by Gautam_105@

Issue #3391931 by Gautam_105@, Akshat26: Fix the issues reported by...

Comment #10

ericgsmith commented 23 January 2024 at 07:11

Version:	2.0.x-dev	» 2.x-dev
Status:	Reviewed & tested by the community	» Fixed

Changes look good to me and the phpcs job is now green, thank you!

Comment #11

6 February 2024 at 07:14

Status:

Fixed

» Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

Fix the issues reported by phpcs