Fix the issue reported by phpcs

Created on 25 January 2024, 5 months ago
Updated 2 April 2024, 3 months ago

Problem/Motivation

Fix issue reported by PHPCS

DAC-0003:drupal10 jahan$ ./vendor/bin/phpcs --standard=Drupal -n --extensions=php,module,inc,install,test,profile,theme,js,css,info,txt,md web/modules/contrib/profile_manager/

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/profile_manager.module
--------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 6 LINES
--------------------------------------------------------------------------------------------------------------
1 | ERROR | [x] Missing file doc comment
142 | ERROR | [x] Missing function doc comment
156 | ERROR | [x] Data types in @var tags need to be fully namespaced
158 | ERROR | [x] Data types in @var tags need to be fully namespaced
164 | ERROR | [x] Missing function doc comment
170 | ERROR | [x] Missing function doc comment
--------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 6 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/js/toolbar.js
-----------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------------------------------------------------------------------------------------------
25 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but found "true"
-----------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/js/toolbar.menu.js
----------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------------------------------------------
30 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
35 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "NULL" but found "null"
81 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but found "true"
----------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/js/closeOnHome.js
---------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 4 LINES
---------------------------------------------------------------------------------------------------------
9 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
12 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "NULL" but found "null"
13 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "NULL" but found "null"
18 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "NULL" but found "null"
---------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/OptionalModulesTrait.php
--------------------------------------------------------------------------------------------------------------------
FOUND 10 ERRORS AFFECTING 10 LINES
--------------------------------------------------------------------------------------------------------------------
17 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [x] Data types in @var tags need to be fully namespaced
43 | ERROR | [ ] Missing short description in doc comment
44 | ERROR | [ ] Missing parameter comment
45 | ERROR | [ ] Missing parameter comment
46 | ERROR | [ ] Missing parameter comment
47 | ERROR | [ ] Missing parameter comment
59 | ERROR | [ ] Description for the @return value is missing
74 | ERROR | [x] Missing function doc comment
105 | ERROR | [ ] Description for the @return value is missing
--------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/Form/ProfileManagerModulesForm.php
------------------------------------------------------------------------------------------------------------------------------
FOUND 12 ERRORS AFFECTING 12 LINES
------------------------------------------------------------------------------------------------------------------------------
13 | ERROR | [x] Missing class doc comment
18 | ERROR | [x] Data types in @var tags need to be fully namespaced
29 | ERROR | [ ] Missing short description in doc comment
30 | ERROR | [x] Data types in @var tags need to be fully namespaced
34 | ERROR | [x] Missing function doc comment
43 | ERROR | [x] Missing function doc comment
64 | ERROR | [x] Missing function doc comment
88 | ERROR | [x] Missing function doc comment
100 | ERROR | [x] Missing function doc comment
107 | ERROR | [x] Missing function doc comment
116 | ERROR | [x] Missing function doc comment
138 | ERROR | [x] Missing function doc comment
------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 11 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/Form/ProfileManagerSettingsForm.php
-------------------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
-------------------------------------------------------------------------------------------------------------------------------
9 | ERROR | [x] Missing class doc comment
86 | ERROR | [x] Expected 1 blank line after function; 2 found
-------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/Form/ProfileManagerInstallOptionalModulesForm.php
---------------------------------------------------------------------------------------------------------------------------------------------
FOUND 17 ERRORS AFFECTING 17 LINES
---------------------------------------------------------------------------------------------------------------------------------------------
13 | ERROR | [x] Missing class doc comment
43 | ERROR | [x] Missing function doc comment
50 | ERROR | [ ] Missing short description in doc comment
51 | ERROR | [ ] Missing parameter comment
62 | ERROR | [x] Expected 1 blank line after function; 2 found
65 | ERROR | [ ] Missing short description in doc comment
66 | ERROR | [ ] Description for the @return value is missing
72 | ERROR | [ ] Missing short description in doc comment
73 | ERROR | [ ] Missing parameter comment
74 | ERROR | [ ] Missing parameter comment
76 | ERROR | [ ] Description for the @return value is missing
109 | ERROR | [ ] Missing short description in doc comment
110 | ERROR | [ ] Missing parameter comment
111 | ERROR | [ ] Missing parameter comment
113 | ERROR | [ ] Description for the @return value is missing
129 | ERROR | [x] Expected 1 blank line after function; 2 found
132 | ERROR | [x] The closing brace for the class must have an empty line before it
---------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/ProfileManagerPluginManager.php
---------------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 5 LINES
---------------------------------------------------------------------------------------------------------------------------
10 | ERROR | [x] Missing class doc comment
12 | ERROR | [ ] Missing short description in doc comment
17 | ERROR | [x] Missing function doc comment
25 | ERROR | [x] Missing function doc comment
44 | ERROR | [x] Missing function doc comment
---------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/Plugin/ProfileManager/SiteSettings.php
----------------------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 6 LINES
----------------------------------------------------------------------------------------------------------------------------------
7 | ERROR | Missing short description in doc comment
18 | ERROR | Missing short description in doc comment
19 | ERROR | Description for the @return value is missing
25 | ERROR | Missing short description in doc comment
26 | ERROR | Missing parameter comment
28 | ERROR | Description for the @return value is missing
----------------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/Plugin/ProfileManager/OptionalModules.php
-------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------------------------------------------------------------------------------------------------------------------------
7 | ERROR | Missing short description in doc comment
-------------------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/Plugin/ProfileManager/SiteSection.php
---------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------------------------------
7 | ERROR | Missing short description in doc comment
---------------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/Plugin/ProfileManager/ProfileManagerBase.php
----------------------------------------------------------------------------------------------------------------------------------------
FOUND 9 ERRORS AFFECTING 9 LINES
----------------------------------------------------------------------------------------------------------------------------------------
9 | ERROR | [x] Missing class doc comment
89 | ERROR | [ ] Description for the @return value is missing
102 | ERROR | [ ] Description for the @return value is missing
118 | ERROR | [ ] Description for the @return value is missing
133 | ERROR | [ ] Description for the @return value is missing
148 | ERROR | [ ] Description for the @return value is missing
162 | ERROR | [ ] Description for the @return value is missing
176 | ERROR | [ ] Description for the @return value is missing
190 | ERROR | [ ] Description for the @return value is missing
----------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/Annotation/ProfileManagerRoute.php
------------------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 5 LINES
------------------------------------------------------------------------------------------------------------------------------
9 | ERROR | [ ] Missing short description in doc comment
24 | ERROR | [x] Data types in @var tags need to be fully namespaced
28 | ERROR | [ ] Missing short description in doc comment
33 | ERROR | [x] Missing function doc comment
40 | ERROR | [x] Missing function doc comment
------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/Annotation/ProfileManager.php
-------------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
-------------------------------------------------------------------------------------------------------------------------
7 | ERROR | [ ] Missing short description in doc comment
12 | ERROR | [x] Missing function doc comment
-------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/Annotation/ProfileManagerDefinition.php
-----------------------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 5 LINES
-----------------------------------------------------------------------------------------------------------------------------------
10 | ERROR | [x] Missing class doc comment
65 | ERROR | [ ] Missing short description in doc comment
66 | ERROR | [ ] Description for the @return value is missing
66 | ERROR | [x] Data types in @return tags need to be fully namespaced
96 | ERROR | [ ] Missing short description in doc comment
97 | ERROR | [ ] Description for the @return value is missing
-----------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/ToolbarController.php
-----------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------------------------------------------------------------------------------------------------------
8 | ERROR | [x] Missing class doc comment
-----------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/Commands/ProfileConfigCommands.php
------------------------------------------------------------------------------------------------------------------------------
FOUND 14 ERRORS AFFECTING 13 LINES
------------------------------------------------------------------------------------------------------------------------------
41 | ERROR | [x] Data types in @var tags need to be fully namespaced
59 | ERROR | [x] Missing function doc comment
73 | ERROR | [x] Additional blank lines found at end of doc comment
146 | ERROR | [x] Newline required after opening brace
152 | ERROR | [x] Missing function doc comment
165 | ERROR | [x] Missing function doc comment
181 | ERROR | [x] Missing function doc comment
185 | ERROR | [x] Missing function doc comment
201 | ERROR | [ ] Missing parameter comment
201 | ERROR | [ ] Missing parameter type
202 | ERROR | [ ] Missing parameter comment
203 | ERROR | [ ] Missing parameter comment
217 | ERROR | [x] Expected 1 blank line after function; 0 found
218 | ERROR | [x] The closing brace for the class must have an empty line before it
------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 10 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/Routing/RouteSubscriber.php
-----------------------------------------------------------------------------------------------------------------------
FOUND 14 ERRORS AFFECTING 13 LINES
-----------------------------------------------------------------------------------------------------------------------
27 | ERROR | [x] Data types in @var tags need to be fully namespaced
52 | ERROR | [ ] Parameter $link_manager is not described in comment
52 | ERROR | [ ] Parameter $factory is not described in comment
55 | ERROR | [x] Data types in @param tags need to be fully namespaced
86 | ERROR | [x] Data types in @var tags need to be fully namespaced
99 | ERROR | [x] Missing function doc comment
106 | ERROR | [x] Missing function doc comment
132 | ERROR | [x] Missing function doc comment
146 | ERROR | [x] Missing function doc comment
148 | ERROR | [x] Data types in @var tags need to be fully namespaced
157 | ERROR | [x] Missing function doc comment
158 | ERROR | [x] Data types in @var tags need to be fully namespaced
193 | ERROR | [x] Missing function doc comment
200 | ERROR | [x] Missing function doc comment
-----------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 12 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/EventSubscriber/HandleOptionalModulesCoreExtensions.php
---------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------------------------------------------------
62 | ERROR | [x] Inline comments must start with a capital letter
---------------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/EventSubscriber/MergeOptionalModuleConfigPartials.php
-------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 4 LINES
-------------------------------------------------------------------------------------------------------------------------------------------------
86 | ERROR | [ ] Missing parameter comment
87 | ERROR | [ ] Missing parameter comment
89 | ERROR | [ ] Description for the @return value is missing
106 | ERROR | [x] Expected 1 space after ELSEIF keyword; 0 found
-------------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------------------------------------

FILE: /Users/jahan/projects/githubdrupal10/drupal10/web/modules/contrib/profile_manager/src/ProfileManagerInterface.php
-----------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 6 LINES
-----------------------------------------------------------------------------------------------------------------------
9 | ERROR | [x] Missing interface doc comment
11 | ERROR | [x] Missing function doc comment
13 | ERROR | [x] Missing function doc comment
15 | ERROR | [x] Missing function doc comment
17 | ERROR | [x] Missing function doc comment
19 | ERROR | [x] Missing function doc comment
-----------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 6 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------

Time: 724ms; Memory: 10MB

šŸ“Œ Task
Status

RTBC

Version

1.0

Component

Code

Created by

šŸ‡®šŸ‡³India jahanaraS Bangalore

Live updates comments and jobs are added and updated live.
  • Coding standards

    It involves compliance with, or the content of coding standards. Requires broad community agreement.

Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @jahanaraS
  • Status changed to Needs review 5 months ago
  • šŸ‡®šŸ‡³India jahanaraS Bangalore

    Fixed issues reported by PHPcs
    attached patch and the screenshots.

  • Issue was unassigned.
  • šŸ‡®šŸ‡³India jahanaraS Bangalore
  • Status changed to Needs work 5 months ago
  • šŸ‡µšŸ‡­Philippines clarkssquared

    Hi

    I applied your patch #2 and there are many PHPCS issues that PHPCS flagged.

    āžœ  profile_manager git:(1.0.x)  curl https://www.drupal.org/files/issues/2024-01-25/fix-php-issue-3416993-10.patch | patch -p1
      % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                     Dload  Upload   Total   Spent    Left  Speed
    100 24267  100 24267    0     0  45231      0 --:--:-- --:--:-- --:--:-- 45786
    patching file 'js/closeOnHome.js'
    patching file 'js/toolbar.js'
    patching file 'js/toolbar.menu.js'
    patching file profile_manager.module
    patching file 'src/Annotation/ProfileManager.php'
    patching file 'src/Annotation/ProfileManagerDefinition.php'
    patching file 'src/Annotation/ProfileManagerRoute.php'
    patching file 'src/Commands/ProfileConfigCommands.php'
    patching file 'src/EventSubscriber/HandleOptionalModulesCoreExtensions.php'
    patching file 'src/EventSubscriber/MergeOptionalModuleConfigPartials.php'
    patching file 'src/Form/ProfileManagerInstallOptionalModulesForm.php'
    patching file 'src/Form/ProfileManagerModulesForm.php'
    patching file 'src/Form/ProfileManagerSettingsForm.php'
    patching file 'src/OptionalModulesTrait.php'
    patching file 'src/Plugin/ProfileManager/ProfileManagerBase.php'
    patching file 'src/ProfileManagerInterface.php'
    patching file 'src/ProfileManagerPluginManager.php'
    patching file 'src/Routing/RouteSubscriber.php'
    patching file 'src/ToolbarController.php'
    āžœ  profile_manager git:(1.0.x) āœ— ..
    āžœ  contrib git:(master) āœ— phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml profile_manager
    
    FILE: ...cts/d9/d9-local/web/modules/contrib/profile_manager/profile_manager.module
    --------------------------------------------------------------------------------
    FOUND 4 ERRORS AND 5 WARNINGS AFFECTING 9 LINES
    --------------------------------------------------------------------------------
       3 | ERROR   | [ ] Missing short description in doc comment
      15 | WARNING | [x] Unused use statement
      16 | WARNING | [x] Unused use statement
      17 | WARNING | [x] Unused use statement
      18 | WARNING | [x] Unused use statement
      29 | WARNING | [ ] Line exceeds 80 characters; contains 87 characters
     146 | ERROR   | [ ] Doc comment is empty
     171 | ERROR   | [ ] Doc comment is empty
     180 | ERROR   | [ ] Doc comment is empty
    --------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    --------------------------------------------------------------------------------
    
    
    FILE: .../d9-local/web/modules/contrib/profile_manager/src/OptionalModulesTrait.php
    --------------------------------------------------------------------------------
    FOUND 9 ERRORS AFFECTING 9 LINES
    --------------------------------------------------------------------------------
      17 | ERROR | Missing short description in doc comment
      43 | ERROR | Missing short description in doc comment
      44 | ERROR | Missing parameter comment
      45 | ERROR | Missing parameter comment
      46 | ERROR | Missing parameter comment
      47 | ERROR | Missing parameter comment
      59 | ERROR | Description for the @return value is missing
      74 | ERROR | Doc comment is empty
     108 | ERROR | Description for the @return value is missing
    --------------------------------------------------------------------------------
    
    
    FILE: ...web/modules/contrib/profile_manager/src/Form/ProfileManagerModulesForm.php
    --------------------------------------------------------------------------------
    FOUND 10 ERRORS AND 1 WARNING AFFECTING 11 LINES
    --------------------------------------------------------------------------------
      13 | ERROR   | Doc comment is empty
      32 | ERROR   | Missing short description in doc comment
      37 | ERROR   | Doc comment is empty
      49 | ERROR   | Doc comment is empty
      73 | ERROR   | Doc comment is empty
     100 | ERROR   | Doc comment is empty
     106 | WARNING | Unused variable $package.
     115 | ERROR   | Doc comment is empty
     125 | ERROR   | Doc comment is empty
     137 | ERROR   | Doc comment is empty
     162 | ERROR   | Doc comment is empty
    --------------------------------------------------------------------------------
    
    
    FILE: ...eb/modules/contrib/profile_manager/src/Form/ProfileManagerSettingsForm.php
    --------------------------------------------------------------------------------
    FOUND 1 ERROR AFFECTING 1 LINE
    --------------------------------------------------------------------------------
     9 | ERROR | Doc comment is empty
    --------------------------------------------------------------------------------
    
    
    FILE: ...trib/profile_manager/src/Form/ProfileManagerInstallOptionalModulesForm.php
    --------------------------------------------------------------------------------
    FOUND 14 ERRORS AFFECTING 14 LINES
    --------------------------------------------------------------------------------
      13 | ERROR | Doc comment is empty
      46 | ERROR | Doc comment is empty
      56 | ERROR | Missing short description in doc comment
      57 | ERROR | Missing parameter comment
      70 | ERROR | Missing short description in doc comment
      71 | ERROR | Description for the @return value is missing
      77 | ERROR | Missing short description in doc comment
      78 | ERROR | Missing parameter comment
      79 | ERROR | Missing parameter comment
      81 | ERROR | Description for the @return value is missing
     114 | ERROR | Missing short description in doc comment
     115 | ERROR | Missing parameter comment
     116 | ERROR | Missing parameter comment
     118 | ERROR | Description for the @return value is missing
    --------------------------------------------------------------------------------
    
    
    FILE: ...al/web/modules/contrib/profile_manager/src/ProfileManagerPluginManager.php
    --------------------------------------------------------------------------------
    FOUND 5 ERRORS AND 1 WARNING AFFECTING 6 LINES
    --------------------------------------------------------------------------------
     10 | ERROR   | Doc comment is empty
     15 | ERROR   | Missing short description in doc comment
     20 | ERROR   | Doc comment is empty
     31 | ERROR   | Doc comment is empty
     35 | WARNING | Line exceeds 80 characters; contains 98 characters
     53 | ERROR   | Doc comment is empty
    --------------------------------------------------------------------------------
    
    
    FILE: ...modules/contrib/profile_manager/src/Plugin/ProfileManager/SiteSettings.php
    --------------------------------------------------------------------------------
    FOUND 6 ERRORS AND 1 WARNING AFFECTING 7 LINES
    --------------------------------------------------------------------------------
      7 | ERROR   | [ ] Missing short description in doc comment
     18 | ERROR   | [ ] Missing short description in doc comment
     19 | ERROR   | [ ] Description for the @return value is missing
     25 | ERROR   | [ ] Missing short description in doc comment
     26 | ERROR   | [ ] Missing parameter comment
     28 | ERROR   | [ ] Description for the @return value is missing
     32 | WARNING | [x] A comma should follow the last multiline array item. Found:
        |         |     'access profile manager site settings'
    --------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    --------------------------------------------------------------------------------
    
    
    FILE: ...ules/contrib/profile_manager/src/Plugin/ProfileManager/OptionalModules.php
    --------------------------------------------------------------------------------
    FOUND 1 ERROR AFFECTING 1 LINE
    --------------------------------------------------------------------------------
     7 | ERROR | Missing short description in doc comment
    --------------------------------------------------------------------------------
    
    
    FILE: .../modules/contrib/profile_manager/src/Plugin/ProfileManager/SiteSection.php
    --------------------------------------------------------------------------------
    FOUND 1 ERROR AFFECTING 1 LINE
    --------------------------------------------------------------------------------
     7 | ERROR | Missing short description in doc comment
    --------------------------------------------------------------------------------
    
    
    FILE: ...s/contrib/profile_manager/src/Plugin/ProfileManager/ProfileManagerBase.php
    --------------------------------------------------------------------------------
    FOUND 9 ERRORS AFFECTING 9 LINES
    --------------------------------------------------------------------------------
       9 | ERROR | Doc comment is empty
      92 | ERROR | Description for the @return value is missing
     105 | ERROR | Description for the @return value is missing
     121 | ERROR | Description for the @return value is missing
     136 | ERROR | Description for the @return value is missing
     151 | ERROR | Description for the @return value is missing
     165 | ERROR | Description for the @return value is missing
     179 | ERROR | Description for the @return value is missing
     193 | ERROR | Description for the @return value is missing
    --------------------------------------------------------------------------------
    
    
    FILE: ...web/modules/contrib/profile_manager/src/Annotation/ProfileManagerRoute.php
    --------------------------------------------------------------------------------
    FOUND 4 ERRORS AND 1 WARNING AFFECTING 5 LINES
    --------------------------------------------------------------------------------
      6 | WARNING | [x] Unused use statement
      9 | ERROR   | [ ] Missing short description in doc comment
     28 | ERROR   | [ ] Missing short description in doc comment
     33 | ERROR   | [ ] Doc comment is empty
     43 | ERROR   | [ ] Doc comment is empty
    --------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    --------------------------------------------------------------------------------
    
    
    FILE: ...ocal/web/modules/contrib/profile_manager/src/Annotation/ProfileManager.php
    --------------------------------------------------------------------------------
    FOUND 2 ERRORS AFFECTING 2 LINES
    --------------------------------------------------------------------------------
      7 | ERROR | Missing short description in doc comment
     12 | ERROR | Doc comment is empty
    --------------------------------------------------------------------------------
    
    
    FILE: ...odules/contrib/profile_manager/src/Annotation/ProfileManagerDefinition.php
    --------------------------------------------------------------------------------
    FOUND 5 ERRORS AND 1 WARNING AFFECTING 6 LINES
    --------------------------------------------------------------------------------
       8 | WARNING | [x] Unused use statement
      10 | ERROR   | [ ] Doc comment is empty
      68 | ERROR   | [ ] Missing short description in doc comment
      69 | ERROR   | [ ] Description for the @return value is missing
      99 | ERROR   | [ ] Missing short description in doc comment
     100 | ERROR   | [ ] Description for the @return value is missing
    --------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    --------------------------------------------------------------------------------
    
    
    FILE: .../d9/d9-local/web/modules/contrib/profile_manager/src/ToolbarController.php
    --------------------------------------------------------------------------------
    FOUND 1 ERROR AFFECTING 1 LINE
    --------------------------------------------------------------------------------
     8 | ERROR | Doc comment is empty
    --------------------------------------------------------------------------------
    
    
    FILE: ...web/modules/contrib/profile_manager/src/Commands/ProfileConfigCommands.php
    --------------------------------------------------------------------------------
    FOUND 9 ERRORS AFFECTING 8 LINES
    --------------------------------------------------------------------------------
      59 | ERROR | Doc comment is empty
     155 | ERROR | Doc comment is empty
     171 | ERROR | Doc comment is empty
     190 | ERROR | Doc comment is empty
     197 | ERROR | Doc comment is empty
     216 | ERROR | Missing parameter comment
     216 | ERROR | Missing parameter type
     217 | ERROR | Missing parameter comment
     218 | ERROR | Missing parameter comment
    --------------------------------------------------------------------------------
    
    
    FILE: ...-local/web/modules/contrib/profile_manager/src/Routing/RouteSubscriber.php
    --------------------------------------------------------------------------------
    FOUND 9 ERRORS AND 3 WARNINGS AFFECTING 11 LINES
    --------------------------------------------------------------------------------
      11 | WARNING | [x] Unused use statement
      52 | ERROR   | [ ] Parameter $link_manager is not described in comment
      52 | ERROR   | [ ] Parameter $factory is not described in comment
      99 | ERROR   | [ ] Doc comment is empty
     109 | ERROR   | [ ] Doc comment is empty
     120 | WARNING | [x] A comma should follow the last multiline array item.
         |         |     Found: 'access profile manager overview'
     138 | ERROR   | [ ] Doc comment is empty
     149 | WARNING | [x] A comma should follow the last multiline array item.
         |         |     Found: 'access profile manager modules'
     155 | ERROR   | [ ] Doc comment is empty
     169 | ERROR   | [ ] Doc comment is empty
     208 | ERROR   | [ ] Doc comment is empty
     218 | ERROR   | [ ] Doc comment is empty
    --------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    --------------------------------------------------------------------------------
    
    
    FILE: ...rofile_manager/src/EventSubscriber/HandleOptionalModulesCoreExtensions.php
    --------------------------------------------------------------------------------
    FOUND 3 ERRORS AND 2 WARNINGS AFFECTING 5 LINES
    --------------------------------------------------------------------------------
     10 | WARNING | [x] Unused use statement
     31 | ERROR   | [ ] The array declaration extends to column 82 (the limit is
        |         |     80). The array content should be split up over multiple
        |         |     lines
     32 | ERROR   | [ ] The array declaration extends to column 82 (the limit is
        |         |     80). The array content should be split up over multiple
        |         |     lines
     83 | WARNING | [ ] Line exceeds 80 characters; contains 85 characters
     86 | ERROR   | [ ] The array declaration extends to column 100 (the limit is
        |         |     80). The array content should be split up over multiple
        |         |     lines
    --------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    --------------------------------------------------------------------------------
    
    
    FILE: ...contrib/profile_manager/src/EventSubscriber/OptionalModuleConfigImport.php
    --------------------------------------------------------------------------------
    FOUND 2 ERRORS AFFECTING 2 LINES
    --------------------------------------------------------------------------------
     25 | ERROR | The array declaration extends to column 82 (the limit is 80). The
        |       | array content should be split up over multiple lines
     62 | ERROR | The array declaration extends to column 102 (the limit is 80).
        |       | The array content should be split up over multiple lines
    --------------------------------------------------------------------------------
    
    
    FILE: .../profile_manager/src/EventSubscriber/MergeOptionalModuleConfigPartials.php
    --------------------------------------------------------------------------------
    FOUND 5 ERRORS AFFECTING 5 LINES
    --------------------------------------------------------------------------------
     32 | ERROR | The array declaration extends to column 82 (the limit is 80). The
        |       | array content should be split up over multiple lines
     33 | ERROR | The array declaration extends to column 82 (the limit is 80). The
        |       | array content should be split up over multiple lines
     86 | ERROR | Missing parameter comment
     87 | ERROR | Missing parameter comment
     89 | ERROR | Description for the @return value is missing
    --------------------------------------------------------------------------------
    
    
    FILE: ...-local/web/modules/contrib/profile_manager/src/ProfileManagerInterface.php
    --------------------------------------------------------------------------------
    FOUND 6 ERRORS AFFECTING 6 LINES
    --------------------------------------------------------------------------------
      9 | ERROR | Doc comment is empty
     14 | ERROR | Doc comment is empty
     19 | ERROR | Doc comment is empty
     24 | ERROR | Doc comment is empty
     29 | ERROR | Doc comment is empty
     34 | ERROR | Doc comment is empty
    --------------------------------------------------------------------------------
    
    Time: 706ms; Memory: 12MB
    
    āžœ  contrib git:(master) āœ—
  • First commit to issue fork.
  • Assigned to Esha_Kundu
  • Issue was unassigned.
  • Status changed to Needs review 5 months ago
  • I have fixed the issues reported by PHPCS.
    Attached patch.

  • Status changed to Needs work 5 months ago
  • šŸ‡µšŸ‡­Philippines clarkssquared

    Hi

    I applied the patch #7 and these are the PHPCS issues that remains

    āžœ  contrib git:(master) āœ— phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml profile_manager 
    
    FILE: ...web/modules/contrib/profile_manager/src/Form/ProfileManagerModulesForm.php
    --------------------------------------------------------------------------------
    FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
    --------------------------------------------------------------------------------
     108 | WARNING | Unused variable $package.
    --------------------------------------------------------------------------------
    
    
    FILE: ...rofile_manager/src/EventSubscriber/HandleOptionalModulesCoreExtensions.php
    --------------------------------------------------------------------------------
    FOUND 3 ERRORS AFFECTING 3 LINES
    --------------------------------------------------------------------------------
     30 | ERROR | The array declaration extends to column 82 (the limit is 80). The
        |       | array content should be split up over multiple lines
     31 | ERROR | The array declaration extends to column 82 (the limit is 80). The
        |       | array content should be split up over multiple lines
     86 | ERROR | The array declaration extends to column 100 (the limit is 80).
        |       | The array content should be split up over multiple lines
    --------------------------------------------------------------------------------
    
    
    FILE: ...contrib/profile_manager/src/EventSubscriber/OptionalModuleConfigImport.php
    --------------------------------------------------------------------------------
    FOUND 2 ERRORS AFFECTING 2 LINES
    --------------------------------------------------------------------------------
     25 | ERROR | The array declaration extends to column 82 (the limit is 80). The
        |       | array content should be split up over multiple lines
     62 | ERROR | The array declaration extends to column 102 (the limit is 80).
        |       | The array content should be split up over multiple lines
    --------------------------------------------------------------------------------
    
    
    FILE: .../profile_manager/src/EventSubscriber/MergeOptionalModuleConfigPartials.php
    --------------------------------------------------------------------------------
    FOUND 2 ERRORS AFFECTING 2 LINES
    --------------------------------------------------------------------------------
     32 | ERROR | The array declaration extends to column 82 (the limit is 80). The
        |       | array content should be split up over multiple lines
     33 | ERROR | The array declaration extends to column 82 (the limit is 80). The
        |       | array content should be split up over multiple lines
    --------------------------------------------------------------------------------
    
    Time: 649ms; Memory: 12MB
    
    āžœ  contrib git:(master) āœ— 
    

    This is the full snippet of PHPCS testing I applied patch #7

    āžœ  profile_manager git:(1.0.x) curl https://www.drupal.org/files/issues/2024-02-01/fix-php-issue-3416993-11_0.patch | patch -p1
      % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                     Dload  Upload   Total   Spent    Left  Speed
    100 44140  100 44140    0     0  79703      0 --:--:-- --:--:-- --:--:-- 80400
    patching file 'js/closeOnHome.js'
    patching file 'js/toolbar.js'
    patching file 'js/toolbar.menu.js'
    patching file profile_manager.module
    patching file 'src/Annotation/ProfileManager.php'
    patching file 'src/Annotation/ProfileManagerDefinition.php'
    patching file 'src/Annotation/ProfileManagerRoute.php'
    patching file 'src/Commands/ProfileConfigCommands.php'
    patching file 'src/EventSubscriber/HandleOptionalModulesCoreExtensions.php'
    patching file 'src/EventSubscriber/MergeOptionalModuleConfigPartials.php'
    patching file 'src/Form/ProfileManagerInstallOptionalModulesForm.php'
    patching file 'src/Form/ProfileManagerModulesForm.php'
    patching file 'src/Form/ProfileManagerSettingsForm.php'
    patching file 'src/OptionalModulesTrait.php'
    patching file 'src/Plugin/ProfileManager/OptionalModules.php'
    patching file 'src/Plugin/ProfileManager/ProfileManagerBase.php'
    patching file 'src/Plugin/ProfileManager/SiteSection.php'
    patching file 'src/Plugin/ProfileManager/SiteSettings.php'
    patching file 'src/ProfileManagerInterface.php'
    patching file 'src/ProfileManagerPluginManager.php'
    patching file 'src/Routing/RouteSubscriber.php'
    patching file 'src/ToolbarController.php'
    āžœ  profile_manager git:(1.0.x) āœ— ..
    āžœ  contrib git:(master) āœ— phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml profile_manager 
    
    FILE: ...web/modules/contrib/profile_manager/src/Form/ProfileManagerModulesForm.php
    --------------------------------------------------------------------------------
    FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
    --------------------------------------------------------------------------------
     108 | WARNING | Unused variable $package.
    --------------------------------------------------------------------------------
    
    
    FILE: ...rofile_manager/src/EventSubscriber/HandleOptionalModulesCoreExtensions.php
    --------------------------------------------------------------------------------
    FOUND 3 ERRORS AFFECTING 3 LINES
    --------------------------------------------------------------------------------
     30 | ERROR | The array declaration extends to column 82 (the limit is 80). The
        |       | array content should be split up over multiple lines
     31 | ERROR | The array declaration extends to column 82 (the limit is 80). The
        |       | array content should be split up over multiple lines
     86 | ERROR | The array declaration extends to column 100 (the limit is 80).
        |       | The array content should be split up over multiple lines
    --------------------------------------------------------------------------------
    
    
    FILE: ...contrib/profile_manager/src/EventSubscriber/OptionalModuleConfigImport.php
    --------------------------------------------------------------------------------
    FOUND 2 ERRORS AFFECTING 2 LINES
    --------------------------------------------------------------------------------
     25 | ERROR | The array declaration extends to column 82 (the limit is 80). The
        |       | array content should be split up over multiple lines
     62 | ERROR | The array declaration extends to column 102 (the limit is 80).
        |       | The array content should be split up over multiple lines
    --------------------------------------------------------------------------------
    
    
    FILE: .../profile_manager/src/EventSubscriber/MergeOptionalModuleConfigPartials.php
    --------------------------------------------------------------------------------
    FOUND 2 ERRORS AFFECTING 2 LINES
    --------------------------------------------------------------------------------
     32 | ERROR | The array declaration extends to column 82 (the limit is 80). The
        |       | array content should be split up over multiple lines
     33 | ERROR | The array declaration extends to column 82 (the limit is 80). The
        |       | array content should be split up over multiple lines
    --------------------------------------------------------------------------------
    
    Time: 649ms; Memory: 12MB
    
    āžœ  contrib git:(master) āœ— 
    
  • Status changed to Needs review 5 months ago
  • Fixed the phpcs issues reported #8.
    Please review the attached patch.

  • šŸ‡®šŸ‡³India Yashaswi18

    Hello, the patch provided in #9 is applying successfully.
    Ran the command phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml profile_manager/ again and there are no issues remaining.

    git apply fix-php-issue-3416993-12.patch -v
    Checking patch js/closeOnHome.js...
    Checking patch js/toolbar.js...
    Checking patch js/toolbar.menu.js...
    Checking patch profile_manager.module...
    Checking patch src/Annotation/ProfileManager.php...
    Checking patch src/Annotation/ProfileManagerDefinition.php...
    Checking patch src/Annotation/ProfileManagerRoute.php...
    Checking patch src/Commands/ProfileConfigCommands.php...
    Checking patch src/EventSubscriber/HandleOptionalModulesCoreExtensions.php...
    Checking patch src/EventSubscriber/MergeOptionalModuleConfigPartials.php...
    Checking patch src/EventSubscriber/OptionalModuleConfigImport.php...
    Checking patch src/Form/ProfileManagerInstallOptionalModulesForm.php...
    Checking patch src/Form/ProfileManagerModulesForm.php...
    Checking patch src/Form/ProfileManagerSettingsForm.php...
    Checking patch src/OptionalModulesTrait.php...
    Checking patch src/Plugin/ProfileManager/OptionalModules.php...
    Checking patch src/Plugin/ProfileManager/ProfileManagerBase.php...
    Checking patch src/Plugin/ProfileManager/SiteSection.php...
    Checking patch src/Plugin/ProfileManager/SiteSettings.php...
    Checking patch src/ProfileManagerInterface.php...
    Checking patch src/ProfileManagerPluginManager.php...
    Checking patch src/Routing/RouteSubscriber.php...
    Checking patch src/ToolbarController.php...
    Applied patch js/closeOnHome.js cleanly.
    Applied patch js/toolbar.js cleanly.
    Applied patch js/toolbar.menu.js cleanly.
    Applied patch profile_manager.module cleanly.
    Applied patch src/Annotation/ProfileManager.php cleanly.
    Applied patch src/Annotation/ProfileManagerDefinition.php cleanly.
    Applied patch src/Annotation/ProfileManagerRoute.php cleanly.
    Applied patch src/Commands/ProfileConfigCommands.php cleanly.
    Applied patch src/EventSubscriber/HandleOptionalModulesCoreExtensions.php cleanly.
    Applied patch src/EventSubscriber/MergeOptionalModuleConfigPartials.php cleanly.
    Applied patch src/EventSubscriber/OptionalModuleConfigImport.php cleanly.
    Applied patch src/Form/ProfileManagerInstallOptionalModulesForm.php cleanly.
    Applied patch src/Form/ProfileManagerModulesForm.php cleanly.
    Applied patch src/Form/ProfileManagerSettingsForm.php cleanly.
    Applied patch src/OptionalModulesTrait.php cleanly.
    Applied patch src/Plugin/ProfileManager/OptionalModules.php cleanly.
    Applied patch src/Plugin/ProfileManager/ProfileManagerBase.php cleanly.
    Applied patch src/Plugin/ProfileManager/SiteSection.php cleanly.
    Applied patch src/Plugin/ProfileManager/SiteSettings.php cleanly.
    Applied patch src/ProfileManagerInterface.php cleanly.
    Applied patch src/ProfileManagerPluginManager.php cleanly.
    Applied patch src/Routing/RouteSubscriber.php cleanly.
    Applied patch src/ToolbarController.php cleanly.
  • I have created the MR for fixing the phpcs.
    merge request !4
    Added 1 commit

    • 12665e98 - Issue #3416993: Fix the issue reported by phpcs
  • šŸ‡®šŸ‡³India Preethy_ray

    Hi,
    Applied the MR !4. Found no phpcs issues or warnings.
    Thank you!!

  • šŸ‡®šŸ‡³India Yashaswi18

    Hello, checked out to the branch '3416993-fix-the-issue' and ran the command phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig profile_manager/. Found no errors or warnings remaining.

  • Status changed to RTBC 3 months ago
  • šŸ‡®šŸ‡³India Nitinkumar_7

    Hi,
    I have Applied the MR !4. and ran the command :
    phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml profile_manager/

    Found no phpcs issues or warnings.
    Moving to RTBC

Production build 0.69.0 2024