Fix the issues reported by phpcs

Created on 11 January 2023, almost 2 years ago
Updated 1 May 2023, over 1 year ago

Problem/Motivation

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels.module
------------------------------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
------------------------------------------------------------------------------------------------------------------------------------------
51 | ERROR | [ ] The array declaration extends to column 132 (the limit is 80). The array content should be split up over multiple lines
54 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/tests/modules/panels_test/panels_test.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: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/tests/modules/panels_test/src/Plugin/Layout/LayoutExampleTest.php
--------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------------------------------------
64 | ERROR | Missing short description in doc comment
--------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/tests/src/Unit/PanelsDisplayVariantTest.php
----------------------------------------------------------------------------------------------------------------
FOUND 11 ERRORS AFFECTING 11 LINES
----------------------------------------------------------------------------------------------------------------
29 | ERROR | Missing short description in doc comment
34 | ERROR | Missing short description in doc comment
39 | ERROR | Missing short description in doc comment
44 | ERROR | Missing short description in doc comment
49 | ERROR | Missing short description in doc comment
54 | ERROR | Missing short description in doc comment
59 | ERROR | Missing short description in doc comment
64 | ERROR | Missing short description in doc comment
69 | ERROR | Missing short description in doc comment
74 | ERROR | Missing short description in doc comment
79 | ERROR | Missing short description in doc comment
----------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/tests/src/Unit/PanelsStorageTest.php
---------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 5 LINES
---------------------------------------------------------------------------------------------------------
27 | ERROR | Missing short description in doc comment
32 | ERROR | Missing short description in doc comment
37 | ERROR | Missing short description in doc comment
42 | ERROR | Missing short description in doc comment
47 | ERROR | Missing short description in doc comment
---------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/tests/src/Unit/StandardDisplayBuilderTest.php
------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------------------
22 | ERROR | Missing short description in doc comment
------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/tests/src/Functional/PageManagerPanelsStorageIntegrationTest.php
--------------------------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
--------------------------------------------------------------------------------------------------------------------------------------
23 | ERROR | The array declaration extends to column 103 (the limit is 80). The array content should be split up over multiple lines
39 | ERROR | The array declaration extends to column 131 (the limit is 80). The array content should be split up over multiple lines
45 | ERROR | Public method name "PageManagerPanelsStorageIntegrationTest::testPanelsIPE" is not in lowerCamel format
--------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/tests/src/Functional/PanelsConfigSchemaTest.php
--------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------------------
24 | ERROR | Missing short description in doc comment
--------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/tests/src/Functional/PanelsTest.php
--------------------------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------------------------------
28 | ERROR | The array declaration extends to column 89 (the limit is 80). The array content should be split up over multiple lines
41 | ERROR | The array declaration extends to column 131 (the limit is 80). The array content should be split up over multiple lines
--------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/tests/src/Kernel/PanelsStorageManagerTest.php
-------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------------------------------------------------------------------------------------------------------------------------
20 | ERROR | The array declaration extends to column 94 (the limit is 80). The array content should be split up over multiple lines
-------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/tests/src/Kernel/StandardDisplayBuilderTest.php
--------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------------
24 | ERROR | [x] Missing function doc comment
111 | ERROR | [x] Missing function doc comment
--------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/panels_ipe.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: .../drupal/modules/contrib/panels/panels_ipe/tests/modules/panels_ipe_page_manager_test_config/panels_ipe_page_manager_test_config.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: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/tests/src/Unit/UpdateLayoutRequestHandlerTest.php
---------------------------------------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AFFECTING 8 LINES
---------------------------------------------------------------------------------------------------------------------------------
17 | ERROR | [x] Missing function doc comment
22 | ERROR | [x] Missing function doc comment
36 | ERROR | [x] Missing function doc comment
47 | ERROR | [ ] Missing short description in doc comment
56 | ERROR | [ ] Missing short description in doc comment
65 | ERROR | [ ] Missing short description in doc comment
77 | ERROR | [ ] Missing short description in doc comment
88 | ERROR | [ ] Missing short description in doc comment
---------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/tests/src/Unit/RequestHandlerTestBase.php
----------------------------------------------------------------------------------------------------------------------------------------------
FOUND 13 ERRORS AFFECTING 13 LINES
----------------------------------------------------------------------------------------------------------------------------------------------
18 | ERROR | [ ] Missing short description in doc comment
19 | ERROR | [x] Expected "\Drupal\panels_ipe\Helpers\RequestHandlerInterface" but found "\Drupal\panels_ipe\Helpers\RequestHandlerInterface
| | " for @var tag in member variable comment
22 | ERROR | [ ] Missing short description in doc comment
23 | ERROR | [x] Expected "\PHPUnit\Framework\MockObject\MockObject" but found "\PHPUnit\Framework\MockObject\MockObject " for @var tag in
| | member variable comment
26 | ERROR | [ ] Missing short description in doc comment
27 | ERROR | [x] Expected "\PHPUnit\Framework\MockObject\MockObject" but found "\PHPUnit\Framework\MockObject\MockObject " for @var tag in
| | member variable comment
30 | ERROR | [ ] Missing short description in doc comment
31 | ERROR | [x] Expected "\PHPUnit\Framework\MockObject\MockObject" but found "\PHPUnit\Framework\MockObject\MockObject " for @var tag in
| | member variable comment
34 | ERROR | [ ] Missing short description in doc comment
35 | ERROR | [x] Expected "\PHPUnit\Framework\MockObject\MockObject" but found "\PHPUnit\Framework\MockObject\MockObject " for @var tag in
| | member variable comment
38 | ERROR | [ ] Doc comment is empty
50 | ERROR | [x] Missing function doc comment
54 | ERROR | [ ] Missing short description in doc comment
----------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 6 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/tests/src/Unit/RemoveBlockRequestHandlerTest.php
--------------------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 4 LINES
--------------------------------------------------------------------------------------------------------------------------------
15 | ERROR | [x] Missing function doc comment
20 | ERROR | [ ] Missing short description in doc comment
29 | ERROR | [ ] Missing short description in doc comment
37 | ERROR | [ ] Missing short description in doc comment
--------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/tests/src/FunctionalJavascript/PanelsIPETestBase.php
------------------------------------------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AFFECTING 8 LINES
------------------------------------------------------------------------------------------------------------------------------------
16 | ERROR | Missing @var tag in member variable comment
17 | ERROR | Class property $test_route should use lowerCamel naming without underscores
21 | ERROR | Missing @var tag in member variable comment
22 | ERROR | Class property $window_size should use lowerCamel naming without underscores
27 | ERROR | Public method name "PanelsIPETestBase::testIPEIsLoaded" is not in lowerCamel format
36 | ERROR | Public method name "PanelsIPETestBase::testIPEAddBlock" is not in lowerCamel format
45 | ERROR | Public method name "PanelsIPETestBase::testIPEChangeLayout" is not in lowerCamel format
56 | ERROR | Protected method name "PanelsIPETestBase::visitIPERoute" is not in lowerCamel format
------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/tests/src/FunctionalJavascript/PageManagerIntegrationTest.php
---------------------------------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
---------------------------------------------------------------------------------------------------------------------------------------------
28 | ERROR | Missing short description in doc comment
33 | ERROR | Missing short description in doc comment
---------------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/tests/src/FunctionalJavascript/PanelsIPETestTrait.php
-------------------------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
-------------------------------------------------------------------------------------------------------------------------------------
16 | ERROR | Protected method name "PanelsIPETestTrait::assertIPELoaded" is not in lowerCamel format
238 | ERROR | Protected method name "PanelsIPETestTrait::getOnScreenBlockIDs" is not in lowerCamel format
-------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/panels_ipe.module
----------------------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
----------------------------------------------------------------------------------------------------------------------------------
20 | WARNING | [x] '@todo: Add useful help text for Panels In-place editor.' should match the format '@todo Fix problem X here.'
----------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/src/Form/PanelsIPEBlockContentForm.php
----------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------------------------------------------------------
93 | ERROR | Type hint "array" missing for $form
----------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/src/Form/PanelsIPEBlockPluginForm.php
--------------------------------------------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AFFECTING 8 LINES
--------------------------------------------------------------------------------------------------------------------------------------
31 | ERROR | Missing short description in doc comment
36 | ERROR | Missing short description in doc comment
41 | ERROR | Missing short description in doc comment
56 | ERROR | Missing parameter comment
57 | ERROR | Missing parameter comment
58 | ERROR | Missing parameter comment
59 | ERROR | Missing parameter comment
175 | ERROR | The array declaration extends to column 81 (the limit is 80). The array content should be split up over multiple lines
--------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/src/Form/PanelsIPELayoutForm.php
----------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 6 LINES
----------------------------------------------------------------------------------------------------------------
22 | ERROR | Missing short description in doc comment
27 | ERROR | Missing short description in doc comment
32 | ERROR | Missing short description in doc comment
54 | ERROR | Missing parameter comment
55 | ERROR | Missing parameter comment
56 | ERROR | Missing parameter comment
----------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/src/Plugin/IPEAccessInterface.php
-----------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 5 LINES
-----------------------------------------------------------------------------------------------------------------
16 | ERROR | Missing parameter comment
18 | ERROR | Description for the @return value is missing
22 | ERROR | Missing short description in doc comment
23 | ERROR | Missing parameter comment
25 | ERROR | Description for the @return value is missing
-----------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/src/Plugin/IPEAccessManagerInterface.php
------------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 6 LINES
------------------------------------------------------------------------------------------------------------------------
12 | ERROR | Missing short description in doc comment
13 | ERROR | Missing parameter comment
15 | ERROR | Description for the @return value is missing
19 | ERROR | Missing short description in doc comment
20 | ERROR | Missing parameter comment
22 | ERROR | Description for the @return value is missing
------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/src/Plugin/DisplayBuilder/InPlaceEditorDisplayBuilder.php
-----------------------------------------------------------------------------------------------------------------------------------------
FOUND 7 ERRORS AFFECTING 6 LINES
-----------------------------------------------------------------------------------------------------------------------------------------
18 | ERROR | Doc comment short description must be on a single line, further text should be a separate paragraph
27 | ERROR | Missing short description in doc comment
32 | ERROR | Missing short description in doc comment
37 | ERROR | Parameter $module_handler is not described in comment
37 | ERROR | Parameter $panels_storage is not described in comment
52 | ERROR | Missing parameter name
77 | ERROR | Parameter $locked is not described in comment
-----------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/src/Plugin/IPEAccessBase.php
------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------------
7 | ERROR | [x] Missing class doc comment
------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/src/Controller/PanelsIPEPageController.php
--------------------------------------------------------------------------------------------------------------------------
FOUND 30 ERRORS AND 1 WARNING AFFECTING 31 LINES
--------------------------------------------------------------------------------------------------------------------------
30 | ERROR | Missing short description in doc comment
35 | ERROR | Missing short description in doc comment
40 | ERROR | Missing short description in doc comment
59 | ERROR | Missing short description in doc comment
64 | ERROR | Missing short description in doc comment
72 | ERROR | Missing parameter comment
73 | ERROR | Missing parameter comment
74 | ERROR | Missing parameter comment
75 | ERROR | Missing parameter comment
76 | ERROR | Missing parameter comment
77 | ERROR | Missing parameter comment
79 | ERROR | Expected type hint "SharedTempStore"; found "SharedTempStoreFactory" for $temp_store_factory
106 | ERROR | Doc comment short description must be on a single line, further text should be a separate paragraph
113 | ERROR | Description for the @return value is missing
135 | ERROR | Description for the @return value is missing
160 | ERROR | Description for the @return value is missing
202 | ERROR | Description for the @return value is missing
222 | ERROR | Description for the @return value is missing
247 | ERROR | Description for the @return value is missing
265 | ERROR | Description for the @return value is missing
283 | ERROR | Description for the @return value is missing
300 | ERROR | Description for the @return value is missing
316 | ERROR | Description for the @return value is missing
357 | ERROR | Description for the @return value is missing
379 | ERROR | Description for the @return value is missing
410 | ERROR | Description for the @return value is missing
440 | ERROR | Description for the @return value is missing
462 | ERROR | Description for the @return value is missing
504 | WARNING | Line exceeds 80 characters; contains 81 characters
513 | ERROR | Description for the @return value is missing
557 | ERROR | Description for the @return value is missing
--------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/src/PanelsIPEBlockRendererTrait.php
-------------------------------------------------------------------------------------------------------------------
FOUND 7 ERRORS AFFECTING 6 LINES
-------------------------------------------------------------------------------------------------------------------
13 | ERROR | Missing short description in doc comment
29 | ERROR | Type hint "\Drupal\Core\Block\BlockBase" missing for $block_instance
29 | ERROR | Type hint "\Drupal\panels\Plugin\DisplayVariant\PanelsDisplayVariant" missing for $panels_display
58 | ERROR | Doc comment short description must be on a single line, further text should be a separate paragraph
60 | ERROR | The @see reference should not contain any additional text
62 | ERROR | Parameter tags must be defined first in a doc comment
65 | ERROR | Type hint "array" missing for $build
-------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/src/Helpers/RequestHandlerBase.php
----------------------------------------------------------------------------------------------------------------------------------------------
FOUND 26 ERRORS AFFECTING 25 LINES
----------------------------------------------------------------------------------------------------------------------------------------------
14 | ERROR | [x] Missing class doc comment
16 | ERROR | [ ] Missing short description in doc comment
17 | ERROR | [x] Expected "int" but found "int " for @var tag in member variable comment
20 | ERROR | [ ] Missing short description in doc comment
21 | ERROR | [x] Expected "array" but found "array " for @var tag in member variable comment
24 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [x] Expected "\Drupal\Core\TempStore\SharedTempStoreFactory" but found "\Drupal\Core\TempStore\SharedTempStoreFactory " for
| | @var tag in member variable comment
28 | ERROR | [ ] Missing short description in doc comment
29 | ERROR | [x] Expected "\Drupal\panels\Storage\PanelsStorageManagerInterface" but found
| | "\Drupal\panels\Storage\PanelsStorageManagerInterface " for @var tag in member variable comment
32 | ERROR | [ ] Missing short description in doc comment
33 | ERROR | [x] Expected "\Drupal\Core\Extension\ModuleHandlerInterface" but found "\Drupal\Core\Extension\ModuleHandlerInterface " for
| | @var tag in member variable comment
36 | ERROR | [x] Missing function doc comment
42 | ERROR | [ ] Missing short description in doc comment
59 | ERROR | [ ] Missing parameter comment
60 | ERROR | [ ] Missing parameter comment
61 | ERROR | [ ] Missing parameter comment
70 | ERROR | [ ] Missing parameter comment
72 | ERROR | [ ] Description for the @return value is missing
87 | ERROR | [ ] Missing parameter comment
87 | ERROR | [ ] Missing parameter type
88 | ERROR | [ ] Missing parameter comment
111 | ERROR | [ ] Missing parameter comment
122 | ERROR | [ ] Missing parameter comment
133 | ERROR | [ ] Description for the @return value is missing
142 | ERROR | [ ] Missing parameter comment
143 | ERROR | [ ] Missing parameter comment
----------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 7 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/src/Helpers/UpdateLayoutRequestHandler.php
--------------------------------------------------------------------------------------------------------------------------
FOUND 7 ERRORS AFFECTING 6 LINES
--------------------------------------------------------------------------------------------------------------------------
7 | ERROR | [x] Missing class doc comment
9 | ERROR | [ ] Missing short description in doc comment
19 | ERROR | [ ] Missing parameter comment
20 | ERROR | [ ] Missing parameter comment
20 | ERROR | [ ] Missing parameter type
21 | ERROR | [ ] Missing parameter comment
47 | ERROR | [ ] Description for the @return value is missing
--------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/src/Helpers/RemoveBlockRequestHandler.php
-------------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
-------------------------------------------------------------------------------------------------------------------------
7 | ERROR | [x] Missing class doc comment
9 | ERROR | [ ] Missing short description in doc comment
-------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels_ipe/src/Helpers/RequestHandlerInterface.php
-----------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 6 LINES
-----------------------------------------------------------------------------------------------------------------------
8 | ERROR | [x] Missing interface doc comment
13 | ERROR | [ ] Missing parameter comment
14 | ERROR | [ ] Missing parameter comment
15 | ERROR | [ ] Missing parameter comment
19 | ERROR | [ ] Missing short description in doc comment
20 | ERROR | [ ] Description for the @return value is missing
-----------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/panels.install
----------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
----------------------------------------------------------------------------------------------------------------------------------------------
11 | WARNING | [x] '@todo: Remove this when https://www.drupal.org/node/2641658 → is fixed.' should match the format '@todo Fix problem X
| | here.'
16 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
----------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/Form/PanelsContentForm.php
---------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 4 LINES
---------------------------------------------------------------------------------------------------
31 | ERROR | [ ] Class property $tempstore_id should use lowerCamel naming without underscores
67 | ERROR | [ ] Description for the @return value is missing
76 | ERROR | [ ] Description for the @return value is missing
222 | ERROR | [x] Use null coalesce operator instead of ternary operator.
---------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/Form/LayoutChangeSettings.php
------------------------------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 4 LINES
------------------------------------------------------------------------------------------------------------------------------------------
128 | ERROR | [ ] The array declaration extends to column 91 (the limit is 80). The array content should be split up over multiple lines
176 | ERROR | [ ] Type hint "array" missing for $cached_values
176 | ERROR | [ ] Type hint "array" missing for $configuration
177 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
200 | ERROR | [ ] The array declaration extends to column 91 (the limit is 80). The array content should be split up over multiple lines
------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/Form/PanelsDeleteBlockForm.php
-------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
-------------------------------------------------------------------------------------------------------
30 | ERROR | Class property $tempstore_id should use lowerCamel naming without underscores
32 | ERROR | Missing short description in doc comment
66 | ERROR | Description for the @return value is missing
-------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/Form/PanelsBlockConfigureFormBase.php
--------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 5 LINES
--------------------------------------------------------------------------------------------------------------
34 | ERROR | Class property $tempstore_id should use lowerCamel naming without underscores
72 | ERROR | Description for the @return value is missing
81 | ERROR | Description for the @return value is missing
109 | ERROR | Description for the @return value is missing
203 | ERROR | Description for the @return value is missing
--------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/Form/LayoutChangeRegions.php
--------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------------------------------------
92 | WARNING | [x] There must be no blank line following an inline comment
200 | ERROR | [ ] The array declaration extends to column 82 (the limit is 80). The array content should be split up over multiple lines
--------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/CachedValuesGetterTrait.php
----------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------------------------------------
29 | ERROR | Description for the @return value is missing
----------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/Plugin/DisplayVariant/PanelsDisplayVariant.php
--------------------------------------------------------------------------------------------------------------------------------------
FOUND 9 ERRORS AND 1 WARNING AFFECTING 9 LINES
--------------------------------------------------------------------------------------------------------------------------------------
222 | ERROR | [ ] Description for the @return value is missing
239 | ERROR | [ ] Missing parameter comment
239 | ERROR | [ ] Parameter type "mixed string|\Drupal\panels\Plugin\PanelsPattern\PanelsPatternInterface" must not contain spaces
281 | ERROR | [ ] Description for the @return value is missing
290 | ERROR | [ ] Description for the @return value is missing
306 | ERROR | [ ] Description for the @return value is missing
315 | ERROR | [ ] Description for the @return value is missing
496 | WARNING | [x] '@todo: Simplify this when core provides an API for this in' should match the format '@todo Fix problem X here.'
497 | ERROR | [ ] Comment indentation error, expected only 1 spaces
527 | ERROR | [ ] Description for the @return value is missing
--------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/Plugin/PanelsStorage/PageManagerPanelsStorage.php
--------------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------------------
20 | ERROR | Missing short description in doc comment
60 | ERROR | Description for the @return value is missing
--------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/Plugin/DisplayBuilder/StandardDisplayBuilder.php
--------------------------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------------------------------
138 | ERROR | The array declaration extends to column 91 (the limit is 80). The array content should be split up over multiple lines
162 | ERROR | The array declaration extends to column 89 (the limit is 80). The array content should be split up over multiple lines
--------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/Plugin/DisplayBuilder/DisplayBuilderManager.php
------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------------------------
33 | ERROR | [x] Missing function doc comment
------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/Plugin/DisplayBuilder/DisplayBuilderInterface.php
--------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------------------------
20 | ERROR | Missing parameter name
--------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/Plugin/PanelsPattern/PanelsPatternInterface.php
------------------------------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AFFECTING 8 LINES
------------------------------------------------------------------------------------------------------------------------
16 | ERROR | Missing parameter comment
18 | ERROR | Description for the @return value is missing
20 | ERROR | Type hint "array" missing for $cached_values
32 | ERROR | Description for the @return value is missing
48 | ERROR | Description for the @return value is missing
66 | ERROR | Description for the @return value is missing
82 | ERROR | Description for the @return value is missing
98 | ERROR | Description for the @return value is missing
------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/Plugin/PanelsPattern/DefaultPattern.php
---------------------------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AND 1 WARNING AFFECTING 3 LINES
---------------------------------------------------------------------------------------------------------------------------------------
13 | ERROR | Missing short description in doc comment
55 | WARNING | Line exceeds 80 characters; contains 87 characters
57 | ERROR | The array declaration extends to column 87 (the limit is 80). The array content should be split up over multiple lines
---------------------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/Storage/PanelsStorageBase.php
------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------
7 | ERROR | [x] Missing class doc comment
------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/PanelsDisplayManager.php
--------------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AND 1 WARNING AFFECTING 5 LINES
--------------------------------------------------------------------------------------------------------------------------
19 | ERROR | [ ] Missing short description in doc comment
24 | ERROR | [ ] Missing short description in doc comment
29 | ERROR | [ ] Missing short description in doc comment
29 | ERROR | [ ] Parameter $typed_config_manager is not described in comment
30 | ERROR | [ ] Missing parameter comment
44 | WARNING | [x] '@todo: load the defaults from config somewhere.' should match the format '@todo Fix problem X here.'
--------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------------

FILE: /Applications/MAMP/htdocs/10.1.x/drupal/modules/contrib/panels/src/PanelsDisplayManagerInterface.php
----------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
----------------------------------------------------------------------------------------------------------
22 | ERROR | Description for the @return value is missing
37 | ERROR | Description for the @return value is missing
----------------------------------------------------------------------------------------------------------

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

Closed: won't fix

Version

4.0

Component

Code

Created by

🇮🇳India sahil.goyal

Live updates comments and jobs are added and updated live.
  • Coding standards

    It involves compliance with, or the content of coding standards. Requires broad community agreement.

  • Needs issue summary update

    Issue summaries save everyone time if they are kept up-to-date. See Update issue summary task instructions.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • First commit to issue fork.
  • Assigned to urvashi_vora
  • 🇮🇳India urvashi_vora Madhya Pradesh, India
  • @urvashi_vora opened merge request.
  • 🇮🇳India urvashi_vora Madhya Pradesh, India

    Created an MR for few coding standard fixes. Please review.

  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    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.

  • Issue was unassigned.
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
  • Status changed to Closed: won't fix over 1 year ago
  • 🇨🇦Canada joelpittet Vancouver

    Sorry, these Coding standard fixes are too disruptive to the issue queue. Small changes across lots of files like this tend to for re-rolls on real bugs in the software that are way higher priority wise. I'll close this as won't fix. Sometimes we do these before/after a major release, but they don't need a specific issue attached as it's something the maintainer who is releasing will do to limit the surface area of the changes for the other issues in the queue.

Production build 0.71.5 2024