Drupal Coding Standards Issues | phpcs

 /**
- * Class FormManglerService.
+ * The Class FormManglerService.
  *

That description is still repeating the class name without describing what the class does.

Please review.

 /**
- * Class FormManglerService.
+ * Service provider class.

That is a service class, not a service provider class.
Service class is too generic; the description must say what the class does.

Hi

I change the #9 comment on class description please review.

Thanks

Reviewed! MR! 1 applied, all errors and warnings are fixed.

Hi,

Confirmed no PHPCS errors after applying Patch #2 and the latest MR! to the Token Content Access module with version 3.0.x-dev on Drupal core version 9.5.8.

Marking this now as RTBC.
Kindly refer to the attached screenshots, please.

 /**
- * Class FormManglerService.
+ * Defines FormManglerService class.

The description just repeats the class name; it does not say what the class does.

The report shows errors/warnings for eight files, but the MR changes just 6 files.

 /**
- * Class FormManglerService.
+ * The form mengler service.
  *
  * @package Drupal\tca
  */
 class FormManglerService {

There is a typo in the description.

+  /**
+   * Constructs a new Drupal\tca\FormManglerService object.
    */
   public function __construct(
     EntityTypeManagerInterface $etm,
     EntityTypeBundleInfo $etbi,
     TcaPluginManager $tca_plugin_manager,
     TcaSettingsManager $tca_settings_manager,
-    TranslationInterface $translation) {
+    TranslationInterface $translation,
+    ModuleHandlerInterface $module_handler,
+    MessengerInterface $messenger) {

+  /**
+   * Constructs a new \Drupal\tca\TcaSettingsManager object.
    */
   public function __construct(
     EntityTypeManagerInterface $etm,
-    ConfigFactory $config_factory) {
+    ConfigFactory $config_factory,
+    PrivateKey $private_key) {

The parameters must be described, in the documentation comment.

Hi,

After reviewing and applying the MR!1 to the Token Content Access module with 3.0.x-dev on Drupal 10, not all of the PHPCS errors were resolved.
Please see below:

FILE: /Users/roberttabigue/Project/DrupalOrg/drupalorgissues/web/modules/contrib/tca/tca.module
-----------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------------------------------------------------------------------------------------------------------------------
 9 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Form\FormStateInterface.
-----------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------------


FILE: /Users/roberttabigue/Project/DrupalOrg/drupalorgissues/web/modules/contrib/tca/modules/tca_commerce_product/tca_commerce_product.module
---------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------------------------------------------
 11 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\views\Plugin\views\query\QueryPluginBase.
---------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------------------------


FILE: /Users/roberttabigue/Project/DrupalOrg/drupalorgissues/web/modules/contrib/tca/modules/tca_node/tca_node.module
------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------------------------------------------
 10 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\views\Plugin\views\query\QueryPluginBase.
------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------------------


FILE: /Users/roberttabigue/Project/DrupalOrg/drupalorgissues/web/modules/contrib/tca/src/TcaSettingsManager.php
--------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------------------------
 6 | 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: /Users/roberttabigue/Project/DrupalOrg/drupalorgissues/web/modules/contrib/tca/src/FormManglerService.php
---------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------------
 139 | ERROR | [x] Multi-line function declarations must have a trailing comma after the last parameter
---------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------


FILE: /Users/roberttabigue/Project/DrupalOrg/drupalorgissues/web/modules/contrib/tca/src/Access/TcaAccessCheck.php
-------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------------------------------------------------------------------------------------------------------------
 7 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Access\AccessResult.
-------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------------


FILE: /Users/roberttabigue/Project/DrupalOrg/drupalorgissues/web/modules/contrib/tca/src/Entity/TcaSettings.php
-----------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------------------------------------------------------------------------------------------------------------------------------
 7 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\tca\Exception\InvalidTcaSettingException.
-----------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------------------------


FILE: /Users/roberttabigue/Project/DrupalOrg/drupalorgissues/web/modules/contrib/tca/src/Plugin/TcaPluginManager.php
---------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------------------------------
 6 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Cache\CacheBackendInterface.
---------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------------


FILE: /Users/roberttabigue/Project/DrupalOrg/drupalorgissues/web/modules/contrib/tca/src/TcaPermissionGenerator.php
-----------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------------------------------------------------------------------------------------------------------------------------------------------
 6 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\DependencyInjection\ContainerInjectionInterface.
-----------------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------------------------------------

I ran this command on the module:
phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml tca/

I'm moving this to ‘Needs work’ for now.

Thank you!

I had worked and solved the phpcs issues.

Hi,

I have applied the MR!1 again and confirmed all PHPCS errors have been fixed.

Please see the attached file for reference.

I'm moving this now to ‘RTBC’.

Thank you!

avpaderno → changed the visibility of the branch 3333680-gitlab-ci-reports to hidden.

There are no PHP_CodeSniffer errors/warnings reported for MR !1.

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

Good job guys.