Coding standards [#3144444]

Report from phpcs

FILE: instapage/src/Form/SettingsForm.php
--------------------------------------------------------------------------------------------------------------------
FOUND 17 ERRORS AFFECTING 17 LINES
--------------------------------------------------------------------------------------------------------------------
  19 | ERROR | Missing member variable doc comment
  24 | ERROR | Missing parameter comment
  25 | ERROR | Missing parameter comment
  32 | ERROR | Missing short description in doc comment
  33 | ERROR | Missing parameter comment
  43 | ERROR | Missing short description in doc comment
  44 | ERROR | Description for the @return value is missing
  50 | ERROR | Missing short description in doc comment
  51 | ERROR | Description for the @return value is missing
  59 | ERROR | Missing short description in doc comment
  60 | ERROR | Missing parameter comment
  61 | ERROR | Missing parameter comment
  62 | ERROR | Description for the @return value is missing
 117 | ERROR | Missing parameter comment
 118 | ERROR | Missing parameter comment
 143 | ERROR | Missing parameter comment
 144 | ERROR | Missing parameter comment
--------------------------------------------------------------------------------------------------------------------


FILE: instapage/src/Form/PageNewForm.php
-------------------------------------------------------------------------------------------------------------------
FOUND 20 ERRORS AFFECTING 20 LINES
-------------------------------------------------------------------------------------------------------------------
  21 | ERROR | Missing member variable doc comment
  22 | ERROR | Missing member variable doc comment
  23 | ERROR | Missing member variable doc comment
  24 | ERROR | Missing member variable doc comment
  26 | ERROR | Missing short description in doc comment
  27 | ERROR | Description for the @return value is missing
  36 | ERROR | Missing parameter comment
  37 | ERROR | Missing parameter comment
  38 | ERROR | Missing parameter comment
  47 | ERROR | Missing short description in doc comment
  48 | ERROR | Missing parameter comment
  59 | ERROR | Missing short description in doc comment
  60 | ERROR | Missing parameter comment
  61 | ERROR | Missing parameter comment
  62 | ERROR | Description for the @return value is missing
 112 | ERROR | Missing parameter comment
 113 | ERROR | Missing parameter comment
 115 | ERROR | Description for the @return value is missing
 127 | ERROR | Missing parameter comment
 128 | ERROR | Missing parameter comment
-------------------------------------------------------------------------------------------------------------------


FILE: instapage/src/Form/PageDeleteForm.php
----------------------------------------------------------------------------------------------------------------------
FOUND 22 ERRORS AFFECTING 22 LINES
----------------------------------------------------------------------------------------------------------------------
  22 | ERROR | Missing member variable doc comment
  23 | ERROR | Missing member variable doc comment
  24 | ERROR | Missing member variable doc comment
  25 | ERROR | Missing member variable doc comment
  26 | ERROR | Missing member variable doc comment
  28 | ERROR | Missing short description in doc comment
  29 | ERROR | Description for the @return value is missing
  35 | ERROR | Parameter $request is not described in comment
  38 | ERROR | Missing parameter comment
  39 | ERROR | Missing parameter comment
  40 | ERROR | Missing parameter comment
  50 | ERROR | Missing short description in doc comment
  51 | ERROR | Missing parameter comment
  63 | ERROR | Missing short description in doc comment
  64 | ERROR | Missing parameter comment
  65 | ERROR | Missing parameter comment
  66 | ERROR | Description for the @return value is missing
 100 | ERROR | Missing parameter comment
 101 | ERROR | Missing parameter comment
 103 | ERROR | Description for the @return value is missing
 115 | ERROR | Missing parameter comment
 116 | ERROR | Missing parameter comment
----------------------------------------------------------------------------------------------------------------------


FILE: instapage/src/Form/PageEditForm.php
--------------------------------------------------------------------------------------------------------------------
FOUND 23 ERRORS AFFECTING 23 LINES
--------------------------------------------------------------------------------------------------------------------
  22 | ERROR | Missing member variable doc comment
  23 | ERROR | Missing member variable doc comment
  24 | ERROR | Missing member variable doc comment
  25 | ERROR | Missing member variable doc comment
  26 | ERROR | Missing member variable doc comment
  27 | ERROR | Missing member variable doc comment
  29 | ERROR | Missing short description in doc comment
  30 | ERROR | Description for the @return value is missing
  36 | ERROR | Parameter $request is not described in comment
  39 | ERROR | Missing parameter comment
  40 | ERROR | Missing parameter comment
  41 | ERROR | Missing parameter comment
  51 | ERROR | Missing short description in doc comment
  52 | ERROR | Missing parameter comment
  64 | ERROR | Missing short description in doc comment
  65 | ERROR | Missing parameter comment
  66 | ERROR | Missing parameter comment
  67 | ERROR | Description for the @return value is missing
 111 | ERROR | Missing parameter comment
 112 | ERROR | Missing parameter comment
 114 | ERROR | Description for the @return value is missing
 126 | ERROR | Missing parameter comment
 127 | ERROR | Missing parameter comment
--------------------------------------------------------------------------------------------------------------------


FILE: instapage/src/Controller/PageSettingsController.php
------------------------------------------------------------------------------------------------------------------------------------
FOUND 11 ERRORS AND 2 WARNINGS AFFECTING 13 LINES
------------------------------------------------------------------------------------------------------------------------------------
 14 | ERROR   | [x] Doc comment short description must end with a full stop
 15 | ERROR   | [x] There must be exactly one blank line before the tags in a doc comment
 19 | ERROR   | [ ] Missing member variable doc comment
 20 | ERROR   | [ ] Missing member variable doc comment
 21 | ERROR   | [ ] Missing member variable doc comment
 26 | ERROR   | [ ] Missing parameter comment
 27 | ERROR   | [ ] Missing parameter comment
 35 | ERROR   | [ ] Missing short description in doc comment
 36 | ERROR   | [ ] Missing parameter comment
 49 | ERROR   | [ ] Description for the @return value is missing
 62 | WARNING | [ ] Avoid backslash escaping in translatable strings when possible, use "" quotes instead
 69 | ERROR   | [ ] If the line declaring an array spans longer than 80 characters, each element should be broken into its own line
 74 | WARNING | [ ] Avoid backslash escaping in translatable strings when possible, use "" quotes instead
------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------------


FILE: instapage/src/Controller/PageDisplayController.php
-----------------------------------------------------------------------------------------------------------------------------------
FOUND 11 ERRORS AFFECTING 9 LINES
-----------------------------------------------------------------------------------------------------------------------------------
 21 | ERROR | Missing member variable doc comment
 22 | ERROR | Missing member variable doc comment
 23 | ERROR | Missing member variable doc comment
 28 | ERROR | Missing parameter comment
 29 | ERROR | Missing parameter comment
 30 | ERROR | Missing parameter comment
 30 | ERROR | Doc comment for parameter $client does not match actual variable name <undefined>
 38 | ERROR | Missing short description in doc comment
 39 | ERROR | Missing parameter comment
 53 | ERROR | Missing parameter comment
 53 | ERROR | Missing parameter type
-----------------------------------------------------------------------------------------------------------------------------------


FILE: instapage/src/Api.php
------------------------------------------------------------------------------------------------------
FOUND 43 ERRORS AFFECTING 30 LINES
------------------------------------------------------------------------------------------------------
  22 | ERROR | Missing member variable doc comment
  23 | ERROR | Missing member variable doc comment
  24 | ERROR | Missing member variable doc comment
  31 | ERROR | Missing parameter comment
  32 | ERROR | Missing parameter comment
  43 | ERROR | Missing parameter comment
  57 | ERROR | Missing parameter comment
  58 | ERROR | Missing parameter comment
  59 | ERROR | Missing parameter comment
  61 | ERROR | Description for the @return value is missing
  63 | ERROR | Type hint "array" missing for $headers
  63 | ERROR | Type hint "array" missing for $params
  96 | ERROR | Unnecessarily gendered language in a comment
  98 | ERROR | Missing parameter comment
  98 | ERROR | Missing parameter type
  99 | ERROR | Missing parameter comment
  99 | ERROR | Missing parameter type
 111 | ERROR | Missing parameter comment
 111 | ERROR | Missing parameter type
 112 | ERROR | Missing parameter comment
 112 | ERROR | Missing parameter type
 114 | ERROR | Description for the @return value is missing
 131 | ERROR | Missing parameter comment
 131 | ERROR | Missing parameter type
 133 | ERROR | Description for the @return value is missing
 147 | ERROR | Missing parameter comment
 147 | ERROR | Missing parameter type
 149 | ERROR | Description for the @return value is missing
 180 | ERROR | Missing parameter comment
 180 | ERROR | Missing parameter type
 182 | ERROR | Description for the @return value is missing
 192 | ERROR | Parameter $publish is not described in comment
 195 | ERROR | Missing parameter comment
 195 | ERROR | Missing parameter type
 196 | ERROR | Missing parameter comment
 196 | ERROR | Missing parameter type
 197 | ERROR | Missing parameter comment
 197 | ERROR | Missing parameter type
 233 | ERROR | Missing parameter comment
 233 | ERROR | Missing parameter type
 254 | ERROR | Missing parameter comment
 254 | ERROR | Missing parameter type
 256 | ERROR | Description for the @return value is missing
------------------------------------------------------------------------------------------------------


FILE: instapage/src/Routing/PagesRoutes.php
----------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------------------------------------------------------
 15 | ERROR | Description for the @return value is missing
----------------------------------------------------------------------------------------------------------------------

Comment	File	Size	Author
#3	3144444-3.patch	25.06 KB	bcizej
#3	interdiff_2-3.txt	27.06 KB	bcizej
#2	3144444-2.patch	21.49 KB	suresh prabhu parkala

Comments

Comment #1

1 June 2020 at 15:05

benjamincizej created an issue. See original summary.

Comment #2

suresh prabhu parkala commented 2 June 2020 at 08:02

Status:

Active

» Needs review

Status	File	Size
new	3144444-2.patch	21.49 KB

Please review!

Comment #3

bcizej commented 2 June 2020 at 09:12

Status	File	Size
new	interdiff_2-3.txt	27.06 KB
new	3144444-3.patch	25.06 KB

Was already working on patch as well, rebased my patch off of @Suresh Prabhu Parkala patch. There were some incorrect typehints on properties and unneeded method comments as they are inherited.

Added a patch and interdiff.

Comment #4

kbrodej commented 5 June 2020 at 08:25

Status:

Needs review

» Reviewed & tested by the community

Reviewed the patch from #3.
Patch applied cleanly, no coding standard errors left.

Marking as RTBC.

Comment #5

5 June 2020 at 08:37

benjamincizej committed a1458b4 on 8.x-2.x

Issue #3144444 by benjamincizej, Suresh Prabhu Parkala, kbrodej: Coding...

Comment #6

bcizej commented 5 June 2020 at 08:37

Status:

Reviewed & tested by the community

» Fixed

Commited, thanks for all the contributions.

Comment #7

19 June 2020 at 08:39

Status:

Fixed

» Closed (fixed)

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

Coding standards

Comments

Comment #1

Comment #2

Comment #3

Comment #4

Comment #5

Comment #6

Comment #7

News items

Our community

Documentation

Drupal code base

Governance of community