Fix the issues reported by phpcs

The issue summary should always describe what the issue is trying to fix and, in the case, of coding standards issues, show which command has been used, which arguments have been used, and which report that command shown.

The patch does not fix everything that has been reported and the MR is empty.

Updated patch. Fixed most of the coding issues. Please review.

Hi the patch #13 applied cleanly. However running phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml . returns the following error:

FILE: /home/arpitkayare/drupal_9.5/web/modules/contrib/email_content_templates/.docksal/docksal.yml
---------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------
30 | ERROR | [x] Expected 1 newline at end of file; 2 found

I have updated the patch. Please review.

Thanks!

Hi,

I have reviewed patch #15, it applied cleanly:

Checking patch .docksal/docksal.yml...
Checking patch email_content_templates.module...
Checking patch src/Controller/PreviewController.php...
Checking patch src/EmailContentTemplatesInfoInterface.php...
Checking patch src/EmailContentTemplatesInfoPluginBase.php...
Checking patch src/EmailContentTemplatesService.php...
Checking patch src/EmailContentTemplatesServiceInterface.php...
Checking patch src/Form/EmailContentTemplateTestForm.php...
Applied patch .docksal/docksal.yml cleanly.
Applied patch email_content_templates.module cleanly.
Applied patch src/Controller/PreviewController.php cleanly.
Applied patch src/EmailContentTemplatesInfoInterface.php cleanly.
Applied patch src/EmailContentTemplatesInfoPluginBase.php cleanly.
Applied patch src/EmailContentTemplatesService.php cleanly.
Applied patch src/EmailContentTemplatesServiceInterface.php cleanly.
Applied patch src/Form/EmailContentTemplateTestForm.php cleanly.

And fixed all the phpcs errors/warnings as mentioned above in the issue description.
So, for me, it is RTBC.

Thanks & Regards,
Mrinalini

+/**
+ * Controller class to preview email body.
+ */

There is no need to say that is a controller class.

+  /**
+   * Constructs a new PreviewController object.
+   *
+   * @param \Drupal\email_content_templates\EmailContentTemplatesInfoPluginManager $email_info_manager
+   *   The EmailContentTemplatesInfo plugin manager.
+   * @param \Drupal\email_content_templates\EmailContentTemplatesServiceInterface $email_content_temlates_service
+   *   The EmailContentTemplatesServiceInterface service.

The description for a constructor must start with Constructs a new followed by the class name (including its namespace), and end with object.
Parameter descriptions must describe the parameter without repeating which class instance that parameter is.

+  /**
+   * {@inheritdoc}
+   */
   public function preview(EmailContentTemplateInterface $email_content_template, Request $request) {

That is not a method defined in the parent class or in an interface.

+/**
+ * Service provider class.
+ */

The description should say more than just that.

Patch updated.
Still these two warnings are showing up because of the class namespace in constructor description, assuming this can be ignored.
Please review.

FILE: /Users/specbee/Sites/Projects/email_content_templates/src/Controller/PreviewController.php
------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
------------------------------------------------------------------------------------------------
 41 | WARNING | Line exceeds 80 characters; contains 90 characters
------------------------------------------------------------------------------------------------


FILE: /Users/specbee/Sites/Projects/email_content_templates/src/EmailContentTemplatesService.php
------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
------------------------------------------------------------------------------------------------
 40 | WARNING | Line exceeds 80 characters; contains 90 characters
------------------------------------------------------------------------------------------------

Time: 341ms; Memory: 12MB

Christian.wiedemann → made their first commit to this issue’s fork.

Thanks all!

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