>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #3328490. --> Reported by: [samitk](https://www.drupal.org/user/961934) Related to !24 >>> <h3 id="summary-problem-motivation">Problem/Motivation</h3> <p>Getting following error/warnings</p> <p>FILE: /app/modules/contrib/workbench_email/src/EventSubscriber/ContentModerationStateChangedEvent.php<br> -----------------------------------------------------------------------------------------------------------<br> FOUND 1 ERROR AFFECTING 1 LINE<br> -----------------------------------------------------------------------------------------------------------<br> 32 | ERROR | [x] Expected "string|false" but found "string|FALSE" for @var tag in member variable comment<br> -----------------------------------------------------------------------------------------------------------<br> PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br> -----------------------------------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/src/EventSubscriber/WorkbenchTransitionEventSubscriber.php<br> -----------------------------------------------------------------------------------------------------------------<br> FOUND 1 ERROR AFFECTING 1 LINE<br> -----------------------------------------------------------------------------------------------------------------<br> 57 | ERROR | Type hint "\Drupal\content_moderation\Event\ContentModerationStateChangedEvent" missing for $event<br> -----------------------------------------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/src/Form/TemplateForm.php<br> ------------------------------------------------------------------------------------------------------------------------<br> FOUND 3 ERRORS AND 3 WARNINGS AFFECTING 5 LINES<br> ------------------------------------------------------------------------------------------------------------------------<br> 18 | WARNING | [x] Unused use statement<br> 26 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name<br> 71 | ERROR | [ ] Parameter $module_handler is not described in comment<br> 71 | ERROR | [ ] Parameter $messenger is not described in comment<br> 83 | ERROR | [ ] Type hint "\Drupal\content_moderation\ModerationInformationInterface" missing for $moderation_info<br> 285 | WARNING | [ ] Workflow::loadMultiple calls should be avoided in classes, use dependency injection instead<br> ------------------------------------------------------------------------------------------------------------------------<br> PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br> ------------------------------------------------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/src/Plugin/Derivative/WorkbenchEmailDeriver.php<br> -----------------------------------------------------------------------------------------------------------------------------<br> FOUND 2 ERRORS AFFECTING 2 LINES<br> -----------------------------------------------------------------------------------------------------------------------------<br> 28 | ERROR | [x] Do not append variable name "$moderation_information" to the type declaration in a member variable comment<br> 40 | ERROR | [ ] Type hint "\Drupal\content_moderation\ModerationInformationInterface" missing for $moderation_info<br> -----------------------------------------------------------------------------------------------------------------------------<br> PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br> -----------------------------------------------------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/src/Plugin/QueueWorker/WorkbenchEmailProcessor.php<br> ---------------------------------------------------------------------------------------------<br> FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE<br> ---------------------------------------------------------------------------------------------<br> 126 | WARNING | [x] Inline @var declarations should use the /** */ delimiters<br> ---------------------------------------------------------------------------------------------<br> PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br> ---------------------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/src/Plugin/RecipientType/EmailField.php<br> ----------------------------------------------------------------------------------------------------------------------<br> FOUND 4 ERRORS AFFECTING 4 LINES<br> ----------------------------------------------------------------------------------------------------------------------<br> 69 | ERROR | [ ] Type hint "\Drupal\content_moderation\ModerationInformationInterface" missing for $moderation_info<br> 141 | ERROR | [x] list(...) is forbidden, use [...] instead.<br> 145 | ERROR | [x] list(...) is forbidden, use [...] instead.<br> 168 | ERROR | [x] list(...) is forbidden, use [...] instead.<br> ----------------------------------------------------------------------------------------------------------------------<br> PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br> ----------------------------------------------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/src/Plugin/RecipientType/FixedEmail.php<br> ----------------------------------------------------------------------------------<br> FOUND 1 ERROR AND 5 WARNINGS AFFECTING 6 LINES<br> ----------------------------------------------------------------------------------<br> 5 | WARNING | [x] Unused use statement<br> 7 | WARNING | [x] Unused use statement<br> 9 | WARNING | [x] Unused use statement<br> 10 | WARNING | [x] Unused use statement<br> 13 | WARNING | [x] Unused use statement<br> 16 | ERROR | [x] Doc comment short description must end with a full stop<br> ----------------------------------------------------------------------------------<br> PHPCBF CAN FIX THE 6 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br> ----------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/src/Plugin/RecipientType/RolesWithAccess.php<br> ----------------------------------------------------------------------------------------<br> FOUND 4 ERRORS AND 3 WARNINGS AFFECTING 7 LINES<br> ----------------------------------------------------------------------------------------<br> 6 | WARNING | [x] Unused use statement<br> 8 | WARNING | [x] Unused use statement<br> 9 | WARNING | [x] Unused use statement<br> 10 | ERROR | [x] There must be one blank line after the last USE statement; 2 found;<br> 24 | ERROR | [x] There must be exactly one newline after the class comment<br> 53 | ERROR | [x] Expected 1 blank line after function; 0 found<br> 54 | ERROR | [x] The closing brace for the class must have an empty line before it<br> ----------------------------------------------------------------------------------------<br> PHPCBF CAN FIX THE 7 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br> ----------------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/src/Plugin/RecipientTypeBase.php<br> ---------------------------------------------------------------------------<br> FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE<br> ---------------------------------------------------------------------------<br> 38 | WARNING | Line exceeds 80 characters; contains 84 characters<br> ---------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/src/Plugin/RecipientTypeInterface.php<br> -------------------------------------------------------------------------------------<br> FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE<br> -------------------------------------------------------------------------------------<br> 17 | WARNING | [x] 'TODO Docs.' should match the format '@todo Fix problem X here.'<br> -------------------------------------------------------------------------------------<br> PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br> -------------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/src/RecipientTypePluginCollection.php<br> --------------------------------------------------------------------------------<br> FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE<br> --------------------------------------------------------------------------------<br> 26 | WARNING | Possible useless method overriding detected<br> --------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/src/TemplateInterface.php<br> ----------------------------------------------------------------------<br> FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE<br> ----------------------------------------------------------------------<br> 99 | WARNING | Line exceeds 80 characters; contains 104 characters<br> ----------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/tests/src/Functional/WorkbenchEmailTest.php<br> ------------------------------------------------------------------------------------------------------------------------------------------<br> FOUND 0 ERRORS AND 4 WARNINGS AFFECTING 4 LINES<br> ------------------------------------------------------------------------------------------------------------------------------------------<br> 302 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this-&gt;t() instead<br> 336 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this-&gt;t() instead<br> 348 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this-&gt;t() instead<br> 370 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this-&gt;t() instead<br> ------------------------------------------------------------------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/tests/src/Kernel/ConfigDependenciesTest.php<br> --------------------------------------------------------------------------------------<br> FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE<br> --------------------------------------------------------------------------------------<br> 67 | WARNING | Unused variable $node_type.<br> --------------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/tests/src/Kernel/RecipientTypePluginsTest.php<br> ----------------------------------------------------------------------------------------<br> FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE<br> ----------------------------------------------------------------------------------------<br> 85 | WARNING | Unused variable $node_type.<br> ----------------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/workbench_email.module<br> ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------<br> FOUND 3 ERRORS AND 2 WARNINGS AFFECTING 5 LINES<br> ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------<br> 73 | WARNING | [ ] Format should be "* Implements hook_foo().", "* Implements hook_foo_BAR_ID_bar() for xyz_bar().",, "* Implements hook_foo_BAR_ID_bar() for<br> | | xyz-bar.html.twig.", "* Implements hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.", or "* Implements hook_foo_BAR_ID_bar() for block templates."<br> 82 | WARNING | [ ] Format should be "* Implements hook_foo().", "* Implements hook_foo_BAR_ID_bar() for xyz_bar().",, "* Implements hook_foo_BAR_ID_bar() for<br> | | xyz-bar.html.twig.", "* Implements hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.", or "* Implements hook_foo_BAR_ID_bar() for block templates."<br> 100 | ERROR | [x] Additional blank lines found at end of doc comment<br> 101 | ERROR | [ ] Expected type hint "EntityInterface"; found "ContentModerationState" for $entity<br> 113 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses<br> ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------<br> PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br> ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------</p> <p>FILE: /app/modules/contrib/workbench_email/workbench_email.post_update.php<br> --------------------------------------------------------------------------<br> FOUND 3 ERRORS AFFECTING 1 LINE<br> --------------------------------------------------------------------------<br> 41 | ERROR | [x] There should be no white space after an opening "{"<br> 41 | ERROR | [x] There should be no white space before a closing "}"<br> 41 | ERROR | [x] Closing brace must be on a line by itself<br> --------------------------------------------------------------------------<br> PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br> --------------------------------------------------------------------------</p> <p>Time: 7.6 secs; Memory: 14MB</p> <h4 id="summary-steps-reproduce">Steps to reproduce</h4> <p>Run following command</p> <p>phpcs --standard="Drupal,DrupalPractice" --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml modules/contrib/workbench_email/</p> <h3 id="summary-proposed-resolution">Proposed resolution</h3> <p>Above error/warnings need to be fixed</p> <h2>Note: </h2> <p>I also removed <code>public function &amp;get($instance_id)</code> function from<br> <code>workbench_email/src/RecipientTypePluginCollection.php file</code> as it is only called it's parent get function.</p>