>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #3339626. --> Reported by: [ptmkenny](https://www.drupal.org/user/97885) Related to !3 !4 >>> <h3 id="summary-problem-motivation">Problem/Motivation</h3> <p>A scan of this module identifies some coding standards issues:</p> <pre>&gt; ./vendor/bin/phpcs -p --colors --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,info,txt,md --ignore=node_modules,vendor ./web/modules/contrib/jsonapi_resources<br>...W..EE.WEEEEEEEEEE.E.EEEEEEEEE 32 / 32 (100%)<br><br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/tests/modules/jsonapi_resources_test/src/Resource/CurrentUserInfo.php<br>----------------------------------------------------------------------------------------------------------------------------------<br>FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES<br>----------------------------------------------------------------------------------------------------------------------------------<br> 122 | WARNING | [x] '@todo: convert this to a ResourceTypeRelationship.' should match the format '@todo Fix problem X here.'<br> 127 | WARNING | [x] '@todo: Add role entities as a relatable resource type.' should match the format '@todo Fix problem X here.'<br>----------------------------------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>----------------------------------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/tests/src/Kernel/Routing/ResourceEnhancerTest.php<br>-----------------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>-----------------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>-----------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>-----------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/tests/src/Unit/Routing/ResourceRoutesTest.php<br>--------------------------------------------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>--------------------------------------------------------------------------------------------------------------------------------------<br> 38 | ERROR | The array declaration extends to column 149 (the limit is 80). The array content should be split up over multiple lines<br>--------------------------------------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/README.md<br>----------------------------------------------------------------------<br>FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES<br>----------------------------------------------------------------------<br> 3 | WARNING | Line exceeds 80 characters; contains 119 characters<br> 4 | WARNING | Line exceeds 80 characters; contains 116 characters<br>----------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Exception/ResourceImplementationException.php<br>-----------------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>-----------------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>-----------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>-----------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Exception/RouteDefinitionException.php<br>----------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>----------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>----------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>----------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Entity/Query/PaginatorInterface.php<br>-------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>-------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>-------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>-------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Entity/Query/PaginatorMetadata.php<br>------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Resource/ResourceBase.php<br>-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES<br>-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------<br>&nbsp;&nbsp; 1 | ERROR&nbsp;&nbsp; | [x] The PHP open tag must be followed by exactly one blank line<br> 118 | WARNING | [x] '@todo: try to move this exception into Drupal\jsonapi_resources\Routing\ResourceRoutes::ensureResourceImplementationValid().' should match the format '@todo<br>&nbsp;&nbsp;&nbsp;&nbsp; |&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |&nbsp;&nbsp;&nbsp;&nbsp; Fix problem X here.'<br>-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Resource/EntityQueryResourceBase.php<br>--------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>--------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>--------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>--------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Resource/EntityResourceBase.php<br>---------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>---------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>---------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>---------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Unstable/DependencyInjection/JsonapiResourceClassResolver.php<br>---------------------------------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>---------------------------------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>---------------------------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>---------------------------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Unstable/DocumentExtractor.php<br>-------------------------------------------------------------------------------------------------------------------------------------------<br>FOUND 2 ERRORS AFFECTING 2 LINES<br>-------------------------------------------------------------------------------------------------------------------------------------------<br>&nbsp;&nbsp; 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br> 122 | ERROR | [ ] The array declaration extends to column 100 (the limit is 80). The array content should be split up over multiple lines<br>-------------------------------------------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>-------------------------------------------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Unstable/Routing/Enhancer/ResourceEnhancer.php<br>------------------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>------------------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>------------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>------------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Unstable/ResourceResponseFactory.php<br>--------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>--------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>--------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>--------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Unstable/Value/NewResourceObject.php<br>--------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>--------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>--------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>--------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Unstable/Entity/ResourceObjectToEntityMapperAwareTrait.php<br>------------------------------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>------------------------------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>------------------------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>------------------------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Unstable/Entity/Query/CacheabilityCapturingExecutor.php<br>---------------------------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>---------------------------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>---------------------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>---------------------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Unstable/Entity/Query/Pagination/OffsetLimitPaginator.php<br>-----------------------------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>-----------------------------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>-----------------------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>-----------------------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Unstable/Entity/ResourceObjectToEntityMapperAwareInterface.php<br>----------------------------------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>----------------------------------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>----------------------------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>----------------------------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Unstable/Entity/EntityCreationTrait.php<br>------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES<br>------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------<br>&nbsp; 1 | ERROR&nbsp;&nbsp; | [x] The PHP open tag must be followed by exactly one blank line<br> 62 | WARNING | [x] '@todo: remove the assignment of the entity type manager to a variable when an "Aware" interface is added.' should match the format '@todo Fix problem X here.'<br>------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Unstable/Entity/ResourceObjectToEntityMapper.php<br>--------------------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>--------------------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>--------------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>--------------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Unstable/Controller/ArgumentResolver/DocumentResolver.php<br>-----------------------------------------------------------------------------------------------------------------------<br>FOUND 1 ERROR AFFECTING 1 LINE<br>-----------------------------------------------------------------------------------------------------------------------<br> 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br>-----------------------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>-----------------------------------------------------------------------------------------------------------------------<br><br><br>FILE: /var/www/html/web/modules/contrib/jsonapi_resources/src/Unstable/Controller/JsonapiResourceController.php<br>-----------------------------------------------------------------------------------------------------------------------------------------<br>FOUND 2 ERRORS AFFECTING 2 LINES<br>-----------------------------------------------------------------------------------------------------------------------------------------<br>&nbsp; 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line<br> 64 | ERROR | [ ] The array declaration extends to column 82 (the limit is 80). The array content should be split up over multiple lines<br>-----------------------------------------------------------------------------------------------------------------------------------------<br>PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY<br>-----------------------------------------------------------------------------------------------------------------------------------------</pre> > Related issue: [Issue #3428278](https://www.drupal.org/node/3428278)