- Issue created by @fougere
- 🇮🇳India vishal.kadam Mumbai
Thank you for applying!
Please read Review process for security advisory coverage: What to expect → for more details and Security advisory coverage application checklist → to understand what reviewers look for. Tips for ensuring a smooth review → gives some hints for a smoother review.
The important notes are the following.
- If you have not done it yet, you should run
phpcs --standard=Drupal,DrupalPracticeon the project, which alone fixes most of what reviewers would report. - For the time this application is open, only your commits are allowed.
- The purpose of this application is giving you a new drupal.org role that allows you to opt projects into security advisory coverage, either projects you already created, or projects you will create. The project status won't be changed by this application and no other user will be able to opt projects into security advisory policy.
- We only accept an application per user. If you change your mind about the project to use for this application, or it is necessary to use a different project for the application, please update the issue summary with the link to the correct project and the issue title with the project name and the branch to review.
To the reviewers
Please read How to review security advisory coverage applications → , Application workflow → , What to cover in an application review → , and Tools to use for reviews → .
The important notes are the following.
- It is preferable to wait for a Code Review Administrator before commenting on newly created applications. Code Review Administrators will do some preliminary checks that are necessary before any change on the project files is suggested.
- Reviewers should show the output of a CLI tool → only once per application.
- It may be best to have the applicant fix things before further review.
For new reviewers, I would also suggest to first read In which way the issue queue for coverage applications is different from other project queues → .
- If you have not done it yet, you should run
- Status changed to Needs work
over 1 year ago 3:25pm 25 August 2023 - 🇮🇳India vishal.kadam Mumbai
Fix PHPCS issues.
phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml commerce_shipping_colissimo/ FILE: commerce_shipping_colissimo/README.md --------------------------------------------------------------------------- FOUND 1 ERROR AND 2 WARNINGS AFFECTING 2 LINES --------------------------------------------------------------------------- 6 | WARNING | [ ] Line exceeds 80 characters; contains 90 characters 18 | WARNING | [ ] Line exceeds 80 characters; contains 96 characters 18 | ERROR | [x] Expected 1 newline at end of file; 2 found --------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY --------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/commerce_shipping_colissimo.module -------------------------------------------------------------------------------- FOUND 3 ERRORS AFFECTING 3 LINES -------------------------------------------------------------------------------- 3 | ERROR | [ ] Missing short description in doc comment 54 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses 65 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/MobilePhoneNumber.php -------------------------------------------------------------------------------- FOUND 4 ERRORS AFFECTING 4 LINES -------------------------------------------------------------------------------- 10 | ERROR | [ ] Missing member variable doc comment 12 | ERROR | [x] Missing function doc comment 16 | ERROR | [x] Missing function doc comment 20 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Plugin/Commerce/ShippingMethod/Colissimo.php -------------------------------------------------------------------------------- FOUND 12 ERRORS AFFECTING 12 LINES -------------------------------------------------------------------------------- 32 | ERROR | [ ] Missing member variable doc comment 34 | ERROR | [ ] Missing member variable doc comment 36 | ERROR | [x] Missing function doc comment 87 | ERROR | [x] Missing function doc comment 112 | ERROR | [ ] Missing short description in doc comment 113 | ERROR | [ ] Description for the @return value must be on the next line 119 | ERROR | [x] Missing function doc comment 123 | ERROR | [x] Missing function doc comment 130 | ERROR | [x] Missing function doc comment 134 | ERROR | [x] Missing function doc comment 138 | ERROR | [x] Missing function doc comment 148 | ERROR | [x] You must use "/**" style comments for a function comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 8 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Plugin/Commerce/InlineForm/ColissimoRelayProfile.php -------------------------------------------------------------------------------- FOUND 14 ERRORS AFFECTING 14 LINES -------------------------------------------------------------------------------- 29 | ERROR | [ ] Doc comment short description must be on a single line, further text should be a separate paragraph 33 | ERROR | [ ] Missing member variable doc comment 35 | ERROR | [ ] Missing member variable doc comment 37 | ERROR | [ ] Missing member variable doc comment 39 | ERROR | [ ] Missing member variable doc comment 41 | ERROR | [ ] Missing member variable doc comment 43 | ERROR | [x] Missing function doc comment 176 | ERROR | [x] Missing function doc comment 181 | ERROR | [x] Missing function doc comment 234 | ERROR | [x] Missing function doc comment 240 | ERROR | [x] Missing function doc comment 245 | ERROR | [ ] Missing short description in doc comment 246 | ERROR | [ ] Description for the @return value is missing 257 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 6 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Plugin/Commerce/CheckoutPane/ColissimoShippingInformation.php -------------------------------------------------------------------------------- FOUND 7 ERRORS AFFECTING 7 LINES -------------------------------------------------------------------------------- 20 | ERROR | [ ] Doc comment short description must be on a single line, further text should be a separate paragraph 24 | ERROR | [ ] Missing member variable doc comment 26 | ERROR | [ ] Missing member variable doc comment 28 | ERROR | [x] Missing function doc comment 50 | ERROR | [x] Missing function doc comment 79 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses 117 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Setting.php -------------------------------------------------------------------------------- FOUND 35 ERRORS AFFECTING 35 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 6 | ERROR | [ ] Missing member variable doc comment 7 | ERROR | [ ] Missing member variable doc comment 8 | ERROR | [ ] Missing member variable doc comment 9 | ERROR | [ ] Missing member variable doc comment 10 | ERROR | [ ] Missing member variable doc comment 11 | ERROR | [ ] Missing member variable doc comment 12 | ERROR | [ ] Missing member variable doc comment 13 | ERROR | [ ] Missing member variable doc comment 14 | ERROR | [ ] Missing member variable doc comment 15 | ERROR | [ ] Missing member variable doc comment 16 | ERROR | [ ] Missing member variable doc comment 18 | ERROR | [x] Missing function doc comment 22 | ERROR | [x] Missing function doc comment 26 | ERROR | [x] Missing function doc comment 30 | ERROR | [x] Missing function doc comment 34 | ERROR | [x] Missing function doc comment 38 | ERROR | [x] Missing function doc comment 42 | ERROR | [x] Missing function doc comment 46 | ERROR | [x] Missing function doc comment 50 | ERROR | [x] Missing function doc comment 54 | ERROR | [x] Missing function doc comment 58 | ERROR | [x] Missing function doc comment 65 | ERROR | [x] Missing function doc comment 69 | ERROR | [x] Missing function doc comment 76 | ERROR | [x] Missing function doc comment 80 | ERROR | [x] Missing function doc comment 85 | ERROR | [x] Missing function doc comment 89 | ERROR | [x] Missing function doc comment 94 | ERROR | [x] Missing function doc comment 98 | ERROR | [x] Missing function doc comment 102 | ERROR | [x] Missing function doc comment 106 | ERROR | [x] Missing function doc comment 111 | ERROR | [x] Missing function doc comment 115 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 24 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/RelayFormHelper.php -------------------------------------------------------------------------------- FOUND 8 ERRORS AFFECTING 8 LINES -------------------------------------------------------------------------------- 21 | ERROR | [x] Missing class doc comment 22 | ERROR | [ ] Missing member variable doc comment 24 | ERROR | [ ] Missing member variable doc comment 26 | ERROR | [x] Missing function doc comment 31 | ERROR | [x] Missing function doc comment 43 | ERROR | [x] Missing function doc comment 74 | ERROR | [ ] Doc comment short description must be on a single line, further text should be a separate paragraph 93 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Form/SettingsForm.php -------------------------------------------------------------------------------- FOUND 5 ERRORS AFFECTING 5 LINES -------------------------------------------------------------------------------- 15 | ERROR | [x] Missing class doc comment 17 | ERROR | [ ] Missing member variable doc comment 19 | ERROR | [ ] Missing member variable doc comment 21 | ERROR | [x] Missing function doc comment 151 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/LabelSenderParcelIdSource.php -------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE -------------------------------------------------------------------------------- 7 | ERROR | [x] Missing class doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/LabelFormat.php -------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE -------------------------------------------------------------------------------- 7 | ERROR | [x] Missing class doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Labels.php -------------------------------------------------------------------------------- FOUND 18 ERRORS AND 3 WARNINGS AFFECTING 21 LINES -------------------------------------------------------------------------------- 29 | ERROR | [x] Missing class doc comment 32 | ERROR | [ ] Missing member variable doc comment 34 | ERROR | [ ] Missing member variable doc comment 36 | ERROR | [ ] Missing member variable doc comment 38 | ERROR | [ ] Missing member variable doc comment 40 | ERROR | [ ] Missing member variable doc comment 42 | ERROR | [x] Missing function doc comment 54 | ERROR | [ ] Missing short description in doc comment 70 | WARNING | [ ] Exceptions should not be translated 75 | WARNING | [ ] Exceptions should not be translated 89 | ERROR | [x] Missing function doc comment 98 | ERROR | [x] Missing function doc comment 106 | ERROR | [x] Missing function doc comment 122 | ERROR | [x] Missing function doc comment 138 | ERROR | [x] Missing function doc comment 144 | ERROR | [x] Missing function doc comment 162 | ERROR | [x] Missing function doc comment 171 | WARNING | [ ] Exceptions should not be translated 194 | ERROR | [x] Missing function doc comment 208 | ERROR | [x] Missing function doc comment 222 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 12 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/LabelSize.php -------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE -------------------------------------------------------------------------------- 7 | ERROR | [x] Missing class doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/CustomerProfileWrapper.php -------------------------------------------------------------------------------- FOUND 12 ERRORS AFFECTING 12 LINES -------------------------------------------------------------------------------- 8 | ERROR | [x] Missing class doc comment 9 | ERROR | [ ] Missing member variable doc comment 11 | ERROR | [x] Missing function doc comment 15 | ERROR | [x] Missing function doc comment 19 | ERROR | [x] Missing function doc comment 23 | ERROR | [x] Missing function doc comment 32 | ERROR | [x] Missing function doc comment 36 | ERROR | [x] Missing function doc comment 40 | ERROR | [x] Missing function doc comment 44 | ERROR | [x] Missing function doc comment 49 | ERROR | [x] Missing function doc comment 56 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 11 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Settings.php -------------------------------------------------------------------------------- FOUND 5 ERRORS AFFECTING 5 LINES -------------------------------------------------------------------------------- 7 | ERROR | [x] Missing class doc comment 32 | ERROR | [ ] Missing member variable doc comment 34 | ERROR | [x] Missing function doc comment 38 | ERROR | [x] Missing function doc comment 57 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/LabelGenerationPayload.php -------------------------------------------------------------------------------- FOUND 5 ERRORS AFFECTING 3 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 6 | ERROR | [x] The open comment tag must be the only content on the line 6 | ERROR | [ ] Missing short description in doc comment 9 | ERROR | [x] The open comment tag must be the only content on the line 9 | ERROR | [ ] Missing short description in doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/LabelGenerationLetter.php -------------------------------------------------------------------------------- FOUND 9 ERRORS AFFECTING 5 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 6 | ERROR | [x] The open comment tag must be the only content on the line 6 | ERROR | [ ] Missing short description in doc comment 8 | ERROR | [x] The open comment tag must be the only content on the line 8 | ERROR | [ ] Missing short description in doc comment 10 | ERROR | [x] The open comment tag must be the only content on the line 10 | ERROR | [ ] Missing short description in doc comment 12 | ERROR | [x] The open comment tag must be the only content on the line 12 | ERROR | [ ] Missing short description in doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/UrlEncodedClient.php -------------------------------------------------------------------------------- FOUND 15 ERRORS AFFECTING 11 LINES -------------------------------------------------------------------------------- 14 | ERROR | [x] Missing class doc comment 15 | ERROR | [ ] Missing member variable doc comment 17 | ERROR | [ ] Missing member variable doc comment 19 | ERROR | [ ] Missing member variable doc comment 21 | ERROR | [ ] Missing member variable doc comment 23 | ERROR | [x] Missing function doc comment 27 | ERROR | [ ] Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead 36 | ERROR | [ ] Missing short description in doc comment 36 | ERROR | [ ] Parameter $path is not described in comment 36 | ERROR | [ ] Parameter $payload is not described in comment 38 | ERROR | [ ] Missing parameter comment 38 | ERROR | [x] Expected "class-string<T>|null" but found "class-string<T>|NULL" for parameter type 39 | ERROR | [x] Expected "T|null" but found "T|NULL" for function return type 39 | ERROR | [ ] Description for the @return value is missing 85 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/LabelGenerationAddressee.php -------------------------------------------------------------------------------- FOUND 7 ERRORS AFFECTING 4 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 6 | ERROR | [x] The open comment tag must be the only content on the line 6 | ERROR | [ ] Missing short description in doc comment 8 | ERROR | [x] The open comment tag must be the only content on the line 8 | ERROR | [ ] Missing short description in doc comment 10 | ERROR | [x] The open comment tag must be the only content on the line 10 | ERROR | [ ] Missing short description in doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/LabelGenerationMessage.php -------------------------------------------------------------------------------- FOUND 7 ERRORS AFFECTING 4 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 6 | ERROR | [x] The open comment tag must be the only content on the line 6 | ERROR | [ ] Missing short description in doc comment 8 | ERROR | [x] The open comment tag must be the only content on the line 8 | ERROR | [ ] Missing short description in doc comment 10 | ERROR | [x] The open comment tag must be the only content on the line 10 | ERROR | [ ] Missing short description in doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/WidgetAuthenticationResponse.php -------------------------------------------------------------------------------- FOUND 3 ERRORS AFFECTING 2 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 6 | ERROR | [x] The open comment tag must be the only content on the line 6 | ERROR | [ ] Missing short description in doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/LabelGenerationSender.php -------------------------------------------------------------------------------- FOUND 5 ERRORS AFFECTING 3 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 6 | ERROR | [x] The open comment tag must be the only content on the line 6 | ERROR | [ ] Missing short description in doc comment 8 | ERROR | [x] The open comment tag must be the only content on the line 8 | ERROR | [ ] Missing short description in doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/LabelGenerationAddress.php -------------------------------------------------------------------------------- FOUND 37 ERRORS AFFECTING 19 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 7 | ERROR | [x] The open comment tag must be the only content on the line 7 | ERROR | [ ] Missing short description in doc comment 10 | ERROR | [x] The open comment tag must be the only content on the line 10 | ERROR | [ ] Missing short description in doc comment 13 | ERROR | [x] The open comment tag must be the only content on the line 13 | ERROR | [ ] Missing short description in doc comment 16 | ERROR | [x] The open comment tag must be the only content on the line 16 | ERROR | [ ] Missing short description in doc comment 19 | ERROR | [x] The open comment tag must be the only content on the line 19 | ERROR | [ ] Missing short description in doc comment 22 | ERROR | [x] The open comment tag must be the only content on the line 22 | ERROR | [ ] Missing short description in doc comment 25 | ERROR | [x] The open comment tag must be the only content on the line 25 | ERROR | [ ] Missing short description in doc comment 28 | ERROR | [x] The open comment tag must be the only content on the line 28 | ERROR | [ ] Missing short description in doc comment 31 | ERROR | [x] The open comment tag must be the only content on the line 31 | ERROR | [ ] Missing short description in doc comment 34 | ERROR | [x] The open comment tag must be the only content on the line 34 | ERROR | [ ] Missing short description in doc comment 37 | ERROR | [x] The open comment tag must be the only content on the line 37 | ERROR | [ ] Missing short description in doc comment 40 | ERROR | [x] The open comment tag must be the only content on the line 40 | ERROR | [ ] Missing short description in doc comment 43 | ERROR | [x] The open comment tag must be the only content on the line 43 | ERROR | [ ] Missing short description in doc comment 46 | ERROR | [x] The open comment tag must be the only content on the line 46 | ERROR | [ ] Missing short description in doc comment 49 | ERROR | [x] The open comment tag must be the only content on the line 49 | ERROR | [ ] Missing short description in doc comment 52 | ERROR | [x] The open comment tag must be the only content on the line 52 | ERROR | [ ] Missing short description in doc comment 55 | ERROR | [x] The open comment tag must be the only content on the line 55 | ERROR | [ ] Missing short description in doc comment 58 | ERROR | [x] The open comment tag must be the only content on the line 58 | ERROR | [ ] Missing short description in doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 19 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/LabelGenerationResponse.php -------------------------------------------------------------------------------- FOUND 6 ERRORS AFFECTING 4 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 6 | ERROR | [x] The open comment tag must be the only content on the line 6 | ERROR | [ ] Missing short description in doc comment 9 | ERROR | [x] The open comment tag must be the only content on the line 9 | ERROR | [ ] Missing short description in doc comment 12 | ERROR | [ ] Missing member variable doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/LabelGenerationLabelV2.php -------------------------------------------------------------------------------- FOUND 3 ERRORS AFFECTING 2 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 6 | ERROR | [x] The open comment tag must be the only content on the line 6 | ERROR | [ ] Missing short description in doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/LabelGenerationService.php -------------------------------------------------------------------------------- FOUND 7 ERRORS AFFECTING 4 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 6 | ERROR | [x] The open comment tag must be the only content on the line 6 | ERROR | [ ] Missing short description in doc comment 8 | ERROR | [x] The open comment tag must be the only content on the line 8 | ERROR | [ ] Missing short description in doc comment 10 | ERROR | [x] The open comment tag must be the only content on the line 10 | ERROR | [ ] Missing short description in doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/MultipartRestClient.php -------------------------------------------------------------------------------- FOUND 10 ERRORS AFFECTING 10 LINES -------------------------------------------------------------------------------- 16 | ERROR | [x] Missing class doc comment 17 | ERROR | [ ] Missing member variable doc comment 19 | ERROR | [ ] Missing member variable doc comment 21 | ERROR | [ ] Missing member variable doc comment 23 | ERROR | [ ] Missing member variable doc comment 25 | ERROR | [x] Missing function doc comment 36 | ERROR | [ ] Missing short description in doc comment 77 | ERROR | [x] Missing function doc comment 84 | ERROR | [x] Missing function doc comment 128 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/LabelGenerationParcel.php -------------------------------------------------------------------------------- FOUND 5 ERRORS AFFECTING 3 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 6 | ERROR | [x] The open comment tag must be the only content on the line 6 | ERROR | [ ] Missing short description in doc comment 8 | ERROR | [x] The open comment tag must be the only content on the line 8 | ERROR | [ ] Missing short description in doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/WidgetApi.php -------------------------------------------------------------------------------- FOUND 7 ERRORS AFFECTING 7 LINES -------------------------------------------------------------------------------- 8 | ERROR | [x] Missing class doc comment 10 | ERROR | [ ] Missing member variable doc comment 12 | ERROR | [ ] Missing member variable doc comment 14 | ERROR | [ ] Missing member variable doc comment 16 | ERROR | [x] Missing function doc comment 22 | ERROR | [x] Missing function doc comment 26 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/MultipartResponse.php -------------------------------------------------------------------------------- FOUND 7 ERRORS AFFECTING 7 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 7 | ERROR | [ ] Missing member variable doc comment 9 | ERROR | [ ] Missing member variable doc comment 11 | ERROR | [x] Missing function doc comment 16 | ERROR | [ ] Missing short description in doc comment 17 | ERROR | [ ] Description for the @return value is missing 23 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/ColissimoApiException.php -------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/LabelGenerationOutputFormat.php -------------------------------------------------------------------------------- FOUND 7 ERRORS AFFECTING 4 LINES -------------------------------------------------------------------------------- 5 | ERROR | [x] Missing class doc comment 6 | ERROR | [x] The open comment tag must be the only content on the line 6 | ERROR | [ ] Missing short description in doc comment 9 | ERROR | [x] The open comment tag must be the only content on the line 9 | ERROR | [ ] Missing short description in doc comment 12 | ERROR | [x] The open comment tag must be the only content on the line 12 | ERROR | [ ] Missing short description in doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Api/LabelApi.php -------------------------------------------------------------------------------- FOUND 4 ERRORS AFFECTING 4 LINES -------------------------------------------------------------------------------- 7 | ERROR | [x] Missing class doc comment 9 | ERROR | [ ] Missing member variable doc comment 11 | ERROR | [x] Missing function doc comment 15 | ERROR | [ ] Missing short description in doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/ColissimoProfileFieldCopy.php -------------------------------------------------------------------------------- FOUND 3 ERRORS AFFECTING 3 LINES -------------------------------------------------------------------------------- 11 | ERROR | [ ] Doc comment short description must be on a single line, further text should be a separate paragraph 15 | ERROR | [ ] Missing member variable doc comment 17 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/Label.php ------------------------------------------------------------------------------- FOUND 6 ERRORS AFFECTING 6 LINES ------------------------------------------------------------------------------- 8 | ERROR | [x] Missing class doc comment 10 | ERROR | [ ] Missing member variable doc comment 12 | ERROR | [ ] Missing member variable doc comment 14 | ERROR | [x] Missing function doc comment 19 | ERROR | [x] Missing function doc comment 23 | ERROR | [x] Missing function doc comment ------------------------------------------------------------------------------- PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/src/ColissimoType.php -------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE -------------------------------------------------------------------------------- 7 | ERROR | [x] Missing class doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/tests/src/Functional/ColissimoApiTest.php -------------------------------------------------------------------------------- FOUND 5 ERRORS AFFECTING 5 LINES -------------------------------------------------------------------------------- 10 | ERROR | [ ] Missing short description in doc comment 14 | ERROR | [ ] Missing member variable doc comment 16 | ERROR | [ ] Missing member variable doc comment 18 | ERROR | [ ] Missing member variable doc comment 20 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/tests/src/Functional/SettingsFormTest.php -------------------------------------------------------------------------------- FOUND 7 ERRORS AFFECTING 7 LINES -------------------------------------------------------------------------------- 13 | ERROR | [ ] Missing short description in doc comment 17 | ERROR | [ ] Missing member variable doc comment 19 | ERROR | [ ] Missing member variable doc comment 21 | ERROR | [ ] Missing member variable doc comment 23 | ERROR | [x] Missing function doc comment 28 | ERROR | [x] Missing function doc comment 33 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/tests/src/FunctionalJavascript/ColissimoRelayCheckoutTest.php -------------------------------------------------------------------------------- FOUND 7 ERRORS AFFECTING 7 LINES -------------------------------------------------------------------------------- 18 | ERROR | Doc comment short description must be on a single line, further text should be a separate paragraph 23 | ERROR | Missing member variable doc comment 29 | ERROR | Missing member variable doc comment 31 | ERROR | Missing member variable doc comment 33 | ERROR | Missing member variable doc comment 192 | ERROR | Missing short description in doc comment 193 | ERROR | Description for the @return value is missing -------------------------------------------------------------------------------- FILE: commerce_shipping_colissimo/tests/src/Unit/MobilePhoneNumberTest.php -------------------------------------------------------------------------------- FOUND 6 ERRORS AFFECTING 6 LINES -------------------------------------------------------------------------------- 8 | ERROR | [ ] Missing short description in doc comment 13 | ERROR | [x] Missing function doc comment 19 | ERROR | [x] Missing function doc comment 25 | ERROR | [x] Missing function doc comment 30 | ERROR | [x] Missing function doc comment 35 | ERROR | [x] Missing function doc comment -------------------------------------------------------------------------------- PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------- - Status changed to Needs review
over 1 year ago 8:36am 28 August 2023 - 🇮🇳India vishal.kadam Mumbai
Rest looks fine to me.
Let’s wait for other reviewers to take a look and if everything goes fine, you will get the role.
- Status changed to Needs work
about 1 year ago 4:29pm 21 September 2023 - 🇮🇹Italy apaderno Brescia, 🇮🇹
- What follows is a quick review of the project; it doesn't mean to be complete
- For each point, the review usually shows some lines that should be fixed (except in the case the point is about the full content of a file); it doesn't show all the lines that need to be changed for the same reason
- A review is about code that doesn't follow the coding standards, contains possible security issue, or doesn't correctly use the Drupal API; the single points aren't ordered, not even by importance
Since there are similar projects, the project page must describe what the difference with those projects is, to allow people who are interested in the module to better decide which module they should use.
src/RelayFormHelper.php
Since it is possible to install the module on any Drupal 8 and 9 release, it cannot use PHP features that requires at least PHP 7.4 to work without explicitly require PHP 7.4 or any higher version.
/** * EntityTypeManager. */ private EntityTypeManagerInterface $entityTypeManager; /** * PackerManager. */ private PackerManagerInterface $packerManager; /** * Constructor. */ public function __construct(EntityTypeManagerInterface $entityTypeManager, PackerManagerInterface $packerManager) { $this->entityTypeManager = $entityTypeManager; $this->packerManager = $packerManager; } /** * Is colissimo relay. */ public function isColissimoRelay(FormStateInterface $formState): bool { $shippingMethod = $this->extractSelectedShippingMethod($formState); if (!($shippingMethod instanceof ShippingMethod)) { return FALSE; } $plugin = $shippingMethod->getPlugin(); if (!($plugin instanceof Colissimo)) { return FALSE; } return $plugin->isRelay(); }The documentation comment for properties must contain a description and a
@varline.
The documentation comment for methods must describe parameters and return value. - Status changed to Needs review
about 1 year ago 10:25am 22 September 2023 - 🇫🇷France fougere
Since there are similar projects, the project page must describe what the difference with those projects is, to allow people who are interested in the module to better decide which module they should use.
Done.
Since it is possible to install the module on any Drupal 8 and 9 release, it cannot use PHP features that requires at least PHP 7.4 to work without explicitly require PHP 7.4 or any higher version.
Thank you for picking that up!
I've dropped support for drupal 8 in the .info.yml.
I'll bump the major version for the next release.The documentation comment for properties must contain a description and a @var line. The documentation comment for methods must describe parameters and return value.Done.
I can't help but think this adds a lot of boilerplate. Ex:
/** * Get password. * * @return string|null * Password. */ public function getPassword(): ?string { return $this->password; }The comment is redundant.
- Status changed to Needs work
about 1 year ago 6:37pm 22 September 2023 - 🇮🇹Italy apaderno Brescia, 🇮🇹
commerce_shipping_colissimo.info
core_version_requirement: ^9 || ^10PHP 7.4 is required starting from Drupal 9.4, as described in PHP requirements → . For Drupal releases before Drypal 9.4, PHP 7.4 must be explicitly required.
src/CustomerProfileWrapper.php
/** * Constructor. * * @var \Drupal\profile\Entity\ProfileInterface */The documentation comment for constructors is not anymore mandatory, but if it is provided it must use Constructs a new [class name and namespace] object. as short description and give a description for each parameter.
@varis not used in a documentation comment for methods.* @return array|null * Address field value.Since the returned value can be
NULL, the description must say whenNULLis returned.Not all the files follow the Drupal coding standards since:
- There are class descriptions that merely repeat the class name
- There are property descriptions that merely repeat the property name or the name of the class used for the property
- The documentation description for constructors merely says Constructor (See the previous point about the CustomerProfileWrapper.php file.)
- Some of the documentation comments for methods do not describe the parameters those methods accept
- Some of the documentation comments for properties are missing the
@varline - Some of the descriptions for return values do not say when NULL or another value is returned
- Some lines are not correctly indented with an indentation of two spaces
- In some cases, empty lines are missing between a documentation comment and the previous line
- There are method declarations that are split on more than one line, when the Drupal coding standards say that method and function declarations go on a single line
The project page contains link to the similar projects, but it does not describe what the difference between those projects and this project is.
- 🇮🇹Italy apaderno Brescia, 🇮🇹
I am changing priority as per Issue priorities → .
- 🇮🇳India rushiraval
This thread has been idle, in the needs work state with no activity for several months. Therefore, I am assuming that you are no longer pursuing this application. If you are no longer pursuing this application and I markit as Closed (won't fix).
If this is incorrect, and you are still pursuing this application, then please feel free to set the issue status to Needs work or Needs review, depending on the current status of your code.
- Status changed to Closed: won't fix
5 months ago 7:06am 22 July 2024 - 🇫🇷France fougere
Sorry about that, I will no longer be pursuing application.
The reasons are a lack of time, and disagreement with the last requested changes.
Ex: I find that enforcing that method declaration fit on a single line makes code less readable.
I also could not find this in the Drupal coding standard documentation.