Fix the issues reported by PHPCS

Hi urvashi_vora

I applied the patch coding-standard.patch → to the “Sendpulse: Online Marketing” module against Version 1.1.0 and the errors wasn't resolved. Please see the screenshots attached.

For your review.
Thank you.

Created a patch. Please review,

Hi sakthi_dev

I applied the patch → to the “Sendpulse: Online Marketing” module against Version 1.1.0 and there are still remaining warnings. Please see the screenshots attached.

For your review.
Thank you.

Working on this.

Patch updated.
Please review.

 /**
- *
  * For example if you would like to send custom fields.
  *
  * @see https://sendpulse.com/integrations/api
- *
  */

That comment should be removed, since it is not the documentation comment for the file, nor the documentation comment for a hook used by the module.

- * @param array $data - The data received from a sendpulse api form.
- * @param object $body - The content of the request that is sent to the Sendpulse Api API
- * @return void
+ * @param array $data
+ *   - The data received from a sendpulse api form.
+ * @param object $body
+ *   - The content of the request that is sent to the Sendpulse Api API.

Parameter descriptions must not start with hyphens or spaces.

   $body->custom_fields[] = (object) [
-    'custom_field_id' => '00000000-0000-0000-0000-0000000000',  // The UUID of the custom field
-    'value' => 'Some Value', // A value.
+  // The UUID of the custom field.
+    'custom_field_id' => '00000000-0000-0000-0000-0000000000',
+  // A value.
+    'value' => 'Some Value',

The comments are not correctly indented.

+ * @param array $form
+ *   Form.
+ * @param \Drupal\Core\Form\FormStateInterface $form_state
+ *   Form State.

The descriptions are each missing a definite article.

-  $cc = $form_state->get('sendpulse_api_service');
-
+  // $cc = $form_state->get('sendpulse_api_service');

If a line must be removed, for example because it initializes a variable that is never used, that line is deleted, not commented out.

   /**
-   * \Drupal\Core\Extension\ModuleHandlerInterface
+   * Module Handler Interface.
    *
    * @var \Drupal\Core\Extension\ModuleHandlerInterface
    *   Module handler interface
@@ -52,6 +52,8 @@ class SendpulseApiBlockForm extends FormBase {
    *   MessengerInterface.
    * @param \Drupal\sendpulse_api\Service\SendpulseApi $sendpulseApi
    *   Sendpulse ems service.
+   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
+   *   Module Handler.
    */
   public function __construct(MessengerInterface $messenger, SendpulseApi $sendpulseApi, ModuleHandlerInterface $moduleHandler) {

That short description is for a class constructor. It cannot be described as Module Handler Interface. since a method is not an interface.

-    // Custom Fields
+    // Custom Fields.
     if (isset($listConfig['custom_fields']) && is_array($listConfig['custom_fields']) && count($listConfig['custom_fields']) > 0) {

That comment can be removed, since it just repeats what the code makes already clear.

+  private $refreshToken = 0;
+  /**
+   * Boolean retry.
+   *
+   * @var bool
+   */

There must be an empty line between the comment and the previous line.

+  /**
+   * Sendpulse API constructor.
+   *
+   * @param string $userId
+   *   UserID variable.
+   * @param string $secret
+   *   Secret variable.
+   * @param TokenStorageInterface $tokenStorage
+   *   TokenStorage variable.
+   *
+   * @throws \Exception
+   *    Construct function.
+   */
+  public function __construct($userId, $secret, TokenStorageInterface $tokenStorage = NULL) {

The description for a constructor must start with Constructs a new followed by the class name (including its namespace), and ends with object.
Parameter descriptions must not end with variable. Those descriptions are also wrong.
What follows @throws is a line explaining when that exception is thrown. Construct function. does not explain that.

+   * Process errors.
+   *
+   * @param null $customMessage
+   *   customMessage variable.
+   *
+   * @return object
+   *   Returns object value.
+   */
+  protected function handleError(null $customMessage = NULL) {

null is not the type for $customMessage and null cannot be used as type-hinting for a parameter.

Addressed 9.
9.6 still needs to be addressed. Changes are committed on MR1. Please review.

+  // The UUID of the custom field.
+  // A value.
   $body->custom_fields[] = (object) [
-    'custom_field_id' => '00000000-0000-0000-0000-0000000000',  // The UUID of the custom field
-    'value' => 'Some Value', // A value.
+    'custom_field_id' => '00000000-0000-0000-0000-0000000000',
+    'value' => 'Some Value',
   ];

Those comments have been placed on the wrong line. They should be right before the line those comments are referring.

 /**
- * Validate entity forms that have sendpulse_api_list field type with subscribe_on_save setting checked.
+ * Validate entity forms.
  *
- * Make sure we have the required fields if a list value is popuplated
+ * Form that have sendpulse_api_list field type with
+ * subscribe_on_save setting checked.
  *
- * @param [type] $form
- * @param [type] $form_state
- * @return void
+ * Make sure we have the required fields if a list value is popuplated.
+ *
+ * @param array $form
+ *   An associative array containing the structure of the form.
+ * @param \Drupal\Core\Form\FormStateInterface $form_state
+ *   The current state of the form.
  */
-function _sendpulse_api_subscribe_on_save_validate($form, &$form_state) {

The documentation comment for validation form handlers do not describe parameters nor the return value. They must document for which form the validation handler is used.

-   * \Drupal\Core\Extension\ModuleHandlerInterface
+   * Module Handler Interface.

+   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
+   *   Module Handler.

In both the cases, the correct description is The module handler.

+ // $codeChallenge = NULL;

If a code line must be removed, it is removed, not commented out.

+/**
+ * ApiClient class implements ApiInterface.
+ */
+class ApiClient implements ApiInterface {
+  /**

A class description must not repeat the class name nor the interfaces that class implements. A class description describes the purpose of the class.

+   * ApiUrl harcoded.
+   *
+   * @var string

ApiUrl is not an English word, nor is it a class/interface name.

+  /**
+   * UserId of the API.
+   *
+   * @var string
+   */
+  private $userId;

UserId is not an English word. The description does not make clear what that property is.

+  /**
+   * Secret variable.
+   *
+   * @var string
+   */
+  private $secret;

There is no need to describe a property as variable.

+  /**
+   * Boolean retry.
+   *
+   * @var bool
+   */
+  private $retry = FALSE;

A property description must not say its type, but the property purpose.

+  /**
+   * Constructs a new ApiClient object.
+   *

The class name is missing the namespace.

+  /**
+   * Get token and store it.
+   *
+   * @return bool
+   *   Returns boolean value.
+   */

Verbs must use the third person singular.
That method is not storing the retrieved token, since the code doing so is commented out.
The return value description must describe what is returned and when, not repeat what the return value type is, which is already given from the @return bool line.

+  /**
+   * Form and send request to API service.
+   *
+   * @param string $path
+   *   Path variable.
+   * @param string $method
+   *   Method variable.
+   * @param array $data
+   *   Data variable.
+   * @param bool $useToken
+   *   useToken variable.
+   *
+   * @return object
+   *   Returns object value.
+   */
+  protected function sendRequest($path, $method = 'GET', array $data = [], $useToken = TRUE) {

The correct short description is Sends the request to the API service.

+  /**
+   * Change varible by user email.
+   *

varible is a typo.
That description is not much clear and it does not seem to describe what that method does.

Hi, I have tested phpcs issue and found below issues

modules/custom/sendpulse_api/

FILE: /home/addweb/Drupal8-vagrant/web/web/contribution/drupal-10-3/web/modules/custom/sendpulse_api/src/Controller/AuthenticationCallback.php
----------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------------------------------------------------------------------------------
 7 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Config\ConfigFactory.
----------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------------------------------

FILE: /home/addweb/Drupal8-vagrant/web/web/contribution/drupal-10-3/web/modules/custom/sendpulse_api/src/Plugin/ApiInterface.php
--------------------------------------------------------------------------------------------------------------------------------
FOUND 17 ERRORS AFFECTING 17 LINES
--------------------------------------------------------------------------------------------------------------------------------
 167 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 168 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 169 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 170 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 171 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 172 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 173 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 174 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 175 | ERROR | [x] Multi-line function declaration not indented correctly; expected 2 spaces but found 4
 300 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 301 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 302 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 303 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 304 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 305 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 306 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 307 | ERROR | [x] Multi-line function declaration not indented correctly; expected 2 spaces but found 4
--------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 17 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------------------

FILE: /home/addweb/Drupal8-vagrant/web/web/contribution/drupal-10-3/web/modules/custom/sendpulse_api/src/Plugin/Block/SendpulseApiBlock.php
-------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------------------------------------------------------------------------------------------------------------------------------
 10 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\sendpulse_api\Service\SendpulseApi.
-------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------------------------------

FILE: /home/addweb/Drupal8-vagrant/web/web/contribution/drupal-10-3/web/modules/custom/sendpulse_api/src/Plugin/Block/SendpulseApiMultiBlock.php
------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------------------------------------------------
 9 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Plugin\ContainerFactoryPluginInterface.
------------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------------------------

FILE: /home/addweb/Drupal8-vagrant/web/web/contribution/drupal-10-3/web/modules/custom/sendpulse_api/src/Plugin/ApiClient.php
-----------------------------------------------------------------------------------------------------------------------------
FOUND 13 ERRORS AFFECTING 13 LINES
-----------------------------------------------------------------------------------------------------------------------------
 647 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 648 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 649 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 650 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 651 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 652 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 653 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 654 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 655 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 656 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 657 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 658 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 8
 659 | ERROR | [x] Multi-line function declaration not indented correctly; expected 2 spaces but found 4
-----------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 13 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------------

FILE: /home/addweb/Drupal8-vagrant/web/web/contribution/drupal-10-3/web/modules/custom/sendpulse_api/src/Plugin/rest/resource/SendpulseApiResource.php
------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------------------------------------------------------
 8 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\rest\Plugin\ResourceBase.
------------------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------------------------------

FILE: /home/addweb/Drupal8-vagrant/web/web/contribution/drupal-10-3/web/modules/custom/sendpulse_api/src/Plugin/WebformHandler/WebformSendpulseApiHandler.php
-------------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------------------------------------------------------------------------------------------------------------------------------------------------
 11 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\sendpulse_api\Service\SendpulseApi.
-------------------------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------------------------------------------------

FILE: /home/addweb/Drupal8-vagrant/web/web/contribution/drupal-10-3/web/modules/custom/sendpulse_api/src/Service/SendpulseApi.php
---------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------------------------------
 15 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is GuzzleHttp\Exception\ClientException.
---------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------------

FILE: /home/addweb/Drupal8-vagrant/web/web/contribution/drupal-10-3/web/modules/custom/sendpulse_api/src/Form/SendpulseApiLists.php
-----------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------------------------------------------------------------------------------------------------------------------------
 6 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Config\ConfigFactoryInterface.
-----------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------------------

FILE: /home/addweb/Drupal8-vagrant/web/web/contribution/drupal-10-3/web/modules/custom/sendpulse_api/src/Form/SendpulseApiBlockForm.php
---------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------------------------------------
 10 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Extension\ModuleHandlerInterface.
---------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------------------

Time: 1 secs; Memory: 20MB

Hi, I have fix issue mention on #17. Please review it.

Hi @silvi.addweb,

Applied the changes in the MR!1, it applied successfully but still threw multiple errors/warnings, please see below:

 sendpulse_api git:(main) ✗ curl https://git.drupalcode.org/project/sendpulse_api/-/merge_requests/1.diff | patch -p1
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  211k    0  211k    0     0  56950      0 --:--:--  0:00:03 --:--:-- 57319
patching file README.md
patching file sendpulse_api.api.php
patching file sendpulse_api.links.task.yml
patching file sendpulse_api.module
patching file sendpulse_api.permissions.yml
patching file src/Controller/AuthenticationCallback.php
patching file src/Controller/CustomFieldsController.php
patching file src/Form/SendpulseApiBlockForm.php
patching file src/Form/SendpulseApiConfig.php
patching file src/Form/SendpulseApiLists.php
patching file src/Plugin/ApiClient.php
patching file src/Plugin/ApiInterface.php
patching file src/Plugin/Block/SendpulseApiBlock.php
patching file src/Plugin/Block/SendpulseApiMultiBlock.php
patching file src/Plugin/Derivative/SendpulseApiBlockDerivative.php
patching file src/Plugin/Field/FieldFormatter/SendpulseApiListDefaultFormatter.php
patching file src/Plugin/Field/FieldType/SendpulseApiListItem.php
patching file src/Plugin/Field/FieldWidget/SendpulseApiListCheckboxesWidget.php
patching file src/Plugin/Field/FieldWidget/SendpulseApiListDefaultWidget.php
patching file src/Plugin/WebformHandler/WebformSendpulseApiHandler.php
patching file src/Plugin/rest/resource/SendpulseApiResource.php
patching file src/Service/SendpulseApi.php
➜  sendpulse_api git:(main) ✗ cd ..
➜  contrib git:(main) ✗ phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig sendpulse_api

FILE: ...e/drupal-orgissue/web/modules/contrib/sendpulse_api/sendpulse_api.info.yml
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 1 LINE
--------------------------------------------------------------------------------
 1 | WARNING | Remove "project" from the info file, it will be added by
   |         | drupal.org packaging automatically
 1 | WARNING | Remove "datestamp" from the info file, it will be added by
   |         | drupal.org packaging automatically
 1 | WARNING | Remove "version" from the info file, it will be added by
   |         | drupal.org packaging automatically
--------------------------------------------------------------------------------


FILE: ...pal-orgissue/web/modules/contrib/sendpulse_api/src/Plugin/ApiInterface.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------
 174 | ERROR | [x] Multi-line function declarations must have a trailing comma
     |       |     after the last parameter
 306 | ERROR | [x] Multi-line function declarations must have a trailing comma
     |       |     after the last parameter
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------


FILE: ...drupal-orgissue/web/modules/contrib/sendpulse_api/src/Plugin/ApiClient.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 658 | ERROR | [x] Multi-line function declarations must have a trailing comma
     |       |     after the last parameter
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

Time: 2.85 secs; Memory: 20MB

Kindly check.

Thanks,
Jake

Thank you for providing the patch and the guidelines to resolve the PHPCS issues. I have applied the fix, and I'm happy to confirm that the issue has been addressed in the latest version. Thanks again for your support!

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