Hi, While reviewing the module for best practices and standards. I have found several issues with the help of PHPCS.
phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml content_snapshot/
FILE: /var/www/html/dContri/content_snapshot/content_snapshot.module
------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 4 LINES
------------------------------------------------------------------------------------------------
3 | ERROR | [ ] Missing short description in doc comment
5 | ERROR | [x] There must be exactly one blank line after the file comment
11 | ERROR | [x] Expected 1 blank line before function; 2 found
12 | ERROR | [x] Namespaced classes/interfaces/traits should be referenced with use statements
------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/tests/src/Traits/BlockContentTrait.php
---------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AND 1 WARNING AFFECTING 4 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
13 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
16 | ERROR | [ ] Parameter $id is not described in comment
24 | ERROR | [x] Parameter comment must end with a full stop
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/tests/src/Functional/UserTest.php
------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
------------------------------------------------------------------------------
14 | ERROR | [ ] Missing member variable doc comment
40 | ERROR | [x] Expected 1 space after "="; 2 found
------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/tests/src/Functional/LayoutBuilderTest.php
------------------------------------------------------------------------------------------------------
FOUND 13 ERRORS AFFECTING 11 LINES
------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
29 | ERROR | [ ] Missing member variable doc comment
36 | ERROR | [ ] Missing short description in doc comment
41 | ERROR | [ ] Missing short description in doc comment
90 | ERROR | [x] Data types in @var tags need to be fully namespaced
94 | ERROR | [x] Data types in @var tags need to be fully namespaced
94 | ERROR | [x] Data types in @var tags need to be fully namespaced
100 | ERROR | [x] Expected 1 blank line after function; 2 found
124 | ERROR | [ ] Description for the @return value is missing
125 | ERROR | [x] Separate the @return and @throws sections by a blank line.
145 | ERROR | [ ] Missing parameter comment
147 | ERROR | [ ] Description for the @return value is missing
------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/tests/src/Functional/BasicTest.php
-----------------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 5 LINES
-----------------------------------------------------------------------------------------------------------------------------
19 | ERROR | [ ] Missing member variable doc comment
26 | ERROR | [ ] Missing short description in doc comment
89 | ERROR | [ ] Doc comment short description must be on a single line, further text should be a separate paragraph
135 | ERROR | [ ] Missing short description in doc comment
154 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
-----------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/tests/src/Functional/AbstractFunctional.php
-----------------------------------------------------------------------------------------------------------------------------------------------
FOUND 13 ERRORS AND 3 WARNINGS AFFECTING 12 LINES
-----------------------------------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
17 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
22 | ERROR | [ ] Missing member variable doc comment
24 | ERROR | [ ] Missing short description in doc comment
29 | ERROR | [x] The open comment tag must be the only content on the line
29 | ERROR | [ ] Missing short description in doc comment
29 | ERROR | [x] Expected "\Drupal\Core\Entity\EntityTypeManagerInterface" but found "\Drupal\Core\Entity\EntityTypeManagerInterface " for
| | @var tag in member variable comment
32 | ERROR | [ ] Missing short description in doc comment
82 | ERROR | [ ] Missing parameter comment
82 | ERROR | [ ] Missing parameter type
87 | WARNING | [ ] Unused variable $snapshotFilesPath.
95 | ERROR | [x] Expected newline after closing brace
103 | ERROR | [ ] Doc comment short description must be on a single line, further text should be a separate paragraph
110 | WARNING | [ ] Unused variable $snapshotFilesPath.
135 | ERROR | [x] Expected 1 blank line after function; 2 found
-----------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/tests/src/Functional/modules/paragraphs/ParagraphsTest.php
-------------------------------------------------------------------------------------------------------------------------
FOUND 11 ERRORS AND 3 WARNINGS AFFECTING 12 LINES
-------------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
26 | ERROR | [x] PHP keywords must be lowercase; expected "const" but found "CONST"
28 | ERROR | [ ] Missing member variable doc comment
34 | ERROR | [ ] Missing short description in doc comment
55 | WARNING | [x] A comma should follow the last multiline array item. Found: 'Test paragraph'
75 | WARNING | [x] There must be no blank line following an inline comment
75 | WARNING | [ ] There must be no blank line following an inline comment
77 | ERROR | [x] Short array syntax must be used to define arrays
78 | ERROR | [x] Array indentation error, expected 6 spaces but found 4
79 | ERROR | [x] Array indentation error, expected 6 spaces but found 4
80 | ERROR | [x] Array indentation error, expected 6 spaces but found 4
81 | ERROR | [x] Array indentation error, expected 6 spaces but found 4
137 | ERROR | [ ] Doc comment short description must be on a single line, further text should be a separate paragraph
-------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 9 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/tests/src/Functional/OverrideTest.php
---------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AND 1 WARNING AFFECTING 3 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
15 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
18 | ERROR | [ ] Missing member variable doc comment
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/tests/src/Functional/MenusTest.php
-------------------------------------------------------------------------------------------------------------------------------
FOUND 15 ERRORS AND 1 WARNING AFFECTING 14 LINES
-------------------------------------------------------------------------------------------------------------------------------
7 | WARNING | [x] Unused use statement
21 | ERROR | [ ] Missing member variable doc comment
28 | ERROR | [ ] Missing short description in doc comment
29 | ERROR | [x] Data types in @var tags need to be fully namespaced
29 | ERROR | [x] Data types in @var tags need to be fully namespaced
45 | ERROR | [x] Line indented incorrectly; expected 6 spaces, found 4
45 | ERROR | [x] Object operator not indented correctly; expected 6 spaces but found 4
121 | ERROR | [ ] Missing parameter comment
122 | ERROR | [ ] Missing parameter comment
152 | ERROR | [ ] Missing parameter comment
180 | ERROR | [ ] Missing short description in doc comment
181 | ERROR | [ ] Missing parameter comment
182 | ERROR | [ ] Missing parameter comment
187 | ERROR | [x] Expected 1 space after FOREACH keyword; 0 found
212 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
225 | ERROR | [x] Missing function doc comment
-------------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Plugin/Field/FieldType/FreezableChangedItem.php
---------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
6 | ERROR | [x] Doc comment short description must be on the first line
7 | ERROR | [ ] Doc comment short description must be on a single line, further text should be a separate paragraph
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/SnapshotReader/SnapshotReaderInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AND 1 WARNING AFFECTING 4 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
14 | ERROR | [ ] Missing short description in doc comment
15 | ERROR | [ ] Description for the @return value is missing
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/SnapshotReader/SnapshotReader.php
---------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AND 1 WARNING AFFECTING 6 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
17 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
20 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [ ] Missing short description in doc comment
30 | ERROR | [ ] Missing short description in doc comment
35 | ERROR | [x] Missing function doc comment
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Commands/Commands.php
------------------------------------------------------------------------------------------------------
FOUND 17 ERRORS AFFECTING 16 LINES
------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
21 | ERROR | [ ] Missing short description in doc comment
26 | ERROR | [ ] Missing short description in doc comment
31 | ERROR | [ ] Missing short description in doc comment
36 | ERROR | [ ] Missing short description in doc comment
41 | ERROR | [ ] Missing short description in doc comment
46 | ERROR | [ ] Missing short description in doc comment
47 | ERROR | [ ] Missing parameter comment
48 | ERROR | [ ] Missing parameter comment
49 | ERROR | [ ] Missing parameter comment
50 | ERROR | [ ] Missing parameter comment
51 | ERROR | [ ] Missing parameter comment
62 | ERROR | [ ] Missing short description in doc comment
85 | ERROR | [ ] Missing short description in doc comment
111 | ERROR | [ ] Missing short description in doc comment
128 | ERROR | [x] Missing function doc comment
------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/SnapshotWriter/SnapshotWriter.php
----------------------------------------------------------------------------------------------------------------------
FOUND 23 ERRORS AND 1 WARNING AFFECTING 18 LINES
----------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
18 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
23 | ERROR | [ ] Missing short description in doc comment
28 | ERROR | [ ] Missing short description in doc comment
33 | ERROR | [ ] Missing short description in doc comment
38 | ERROR | [ ] Missing short description in doc comment
43 | ERROR | [ ] Missing short description in doc comment
48 | 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
60 | ERROR | [ ] Missing parameter comment
63 | ERROR | [x] Expected 1 space between type hint and argument "$config"; 10 found
64 | ERROR | [x] Expected 1 space between type hint and argument "$fileSystem"; 6 found
65 | ERROR | [x] Expected 1 space between type hint and argument "$yamlEncoder"; 14 found
67 | ERROR | [x] Expected 1 space between type hint and argument "$logger"; 10 found
118 | ERROR | [x] Expected 1 space after FUNCTION keyword; 0 found
118 | ERROR | [x] Opening brace must be the last content on the line
118 | ERROR | [x] There should be no white space after an opening "{"
118 | ERROR | [x] There should be no white space before a closing "}"
118 | ERROR | [x] Closing brace must be on a line by itself
118 | ERROR | [x] Each PHP statement must be on a line by itself
----------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/SnapshotWriter/SnapshotWriterInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 17 ERRORS AND 1 WARNING AFFECTING 15 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
10 | ERROR | [x] Doc comment short description must end with a full stop
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
17 | ERROR | [ ] If there is no return value for a function, there must not be a @return tag.
17 | ERROR | [ ] Description for the @return value is missing
21 | ERROR | [ ] Missing short description in doc comment
22 | ERROR | [ ] Missing parameter comment
23 | ERROR | [ ] Missing parameter comment
24 | ERROR | [ ] Missing parameter comment
26 | ERROR | [ ] Description for the @return value is missing
30 | ERROR | [ ] Missing short description in doc comment
31 | ERROR | [ ] Missing parameter comment
33 | ERROR | [ ] Missing parameter comment
35 | ERROR | [ ] If there is no return value for a function, there must not be a @return tag.
35 | ERROR | [ ] Description for the @return value is missing
37 | ERROR | [x] Expected 1 blank line after function; 0 found
38 | ERROR | [x] The closing brace for the interface must have an empty line before it
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ContentLoader/ContentLoaderChain.php
---------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AND 1 WARNING AFFECTING 5 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
13 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
16 | ERROR | [ ] Missing short description in doc comment
21 | ERROR | [ ] Missing short description in doc comment
22 | ERROR | [ ] Missing parameter comment
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ContentLoader/ContentLoaderInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AND 1 WARNING AFFECTING 4 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
13 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
19 | ERROR | [ ] Missing parameter comment
21 | ERROR | [ ] Description for the @return value is missing
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ContentLoader/ContentEntityContentLoader.php
---------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AND 1 WARNING AFFECTING 5 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
16 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
19 | ERROR | [ ] Missing short description in doc comment
27 | ERROR | [ ] Missing parameter comment
31 | ERROR | [x] Expected 1 blank line after function; 0 found
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Importer/Importer.php
-------------------------------------------------------------------------------------------------------------------------------------
FOUND 26 ERRORS AND 4 WARNINGS AFFECTING 29 LINES
-------------------------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
26 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
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
87 | ERROR | [ ] Missing parameter comment
88 | ERROR | [ ] Missing parameter comment
89 | ERROR | [ ] Missing parameter comment
90 | ERROR | [ ] Missing parameter comment
91 | ERROR | [ ] Missing parameter comment
92 | ERROR | [ ] Missing parameter comment
93 | ERROR | [ ] Missing parameter comment
94 | ERROR | [ ] Missing parameter comment
95 | ERROR | [ ] Missing parameter comment
96 | ERROR | [ ] Missing parameter comment
97 | ERROR | [ ] Missing parameter comment
164 | ERROR | [x] Expected 1 space after FUNCTION keyword; 0 found
165 | ERROR | [x] Language constructs must be followed by a single space; expected 1 space but found "ยทยท"
168 | WARNING | [ ] Line exceeds 80 characters; contains 82 characters
191 | WARNING | [ ] Unused variable $filename.
214 | WARNING | [ ] Unused variable $filename.
-------------------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Importer/ImporterInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 7 ERRORS AND 1 WARNING AFFECTING 6 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
19 | ERROR | [ ] Missing short description in doc comment
20 | ERROR | [ ] If there is no return value for a function, there must not be a @return tag.
20 | ERROR | [ ] Description for the @return value is missing
22 | ERROR | [x] Expected 1 blank line after function; 0 found
23 | ERROR | [x] The closing brace for the interface must have an empty line before it
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/FilesRestorer/FilesRestorer.php
---------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AND 1 WARNING AFFECTING 6 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
15 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
18 | ERROR | [ ] Missing short description in doc comment
23 | ERROR | [ ] Missing short description in doc comment
31 | ERROR | [ ] Missing parameter comment
32 | ERROR | [ ] Missing parameter comment
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/FilesRestorer/FilesRestorerInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AND 1 WARNING AFFECTING 6 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
14 | ERROR | [ ] Missing short description in doc comment
15 | ERROR | [ ] Missing parameter comment
17 | ERROR | [x] Expected 1 blank line after function; 0 found
18 | ERROR | [x] The closing brace for the interface must have an empty line before it
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Event/SnapshotEvent.php
---------------------------------------------------------------------------------------------------------------------
FOUND 7 ERRORS AND 1 WARNING AFFECTING 7 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
14 | ERROR | [x] Doc comment short description must end with a full stop
15 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
30 | ERROR | [ ] Missing short description in doc comment
38 | ERROR | [ ] Missing parameter comment
44 | ERROR | [ ] Missing short description in doc comment
45 | ERROR | [ ] Description for the @return value is missing
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Event/SnapshotItemEvent.php
---------------------------------------------------------------------------------------------------------------------
FOUND 7 ERRORS AND 1 WARNING AFFECTING 7 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
15 | ERROR | [x] Doc comment short description must end with a full stop
16 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
31 | ERROR | [ ] Missing short description in doc comment
39 | ERROR | [ ] Missing parameter comment
45 | ERROR | [ ] Missing short description in doc comment
46 | ERROR | [ ] Description for the @return value is missing
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ContentWriter/ContentWriterChain.php
---------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AND 2 WARNINGS AFFECTING 6 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
9 | WARNING | [x] Unused use statement
13 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
16 | ERROR | [ ] Missing short description in doc comment
21 | ERROR | [ ] Missing short description in doc comment
22 | ERROR | [ ] Missing parameter comment
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ContentWriter/ContentWriterInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AND 2 WARNINGS AFFECTING 6 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
9 | WARNING | [x] Unused use statement
13 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
16 | ERROR | [ ] Missing short description in doc comment
17 | ERROR | [ ] Missing parameter comment
17 | ERROR | [ ] Missing parameter type
19 | ERROR | [ ] Description for the @return value is missing
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ContentWriter/EntityContentWriter.php
--------------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AND 3 WARNINGS AFFECTING 8 LINES
--------------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
20 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
46 | ERROR | [x] There should be no white space before a closing ")"
62 | WARNING | [x] 'TODO Remove this when the above issue is fixed.' should match the format '@todo Fix problem X here.'
72 | ERROR | [x] Missing function doc comment
73 | WARNING | [ ] Unused variable $fieldName.
84 | ERROR | [x] Missing function doc comment
89 | ERROR | [x] Expected newline after closing brace
--------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Compiler/ContentSnapshotExtensionPass.php
------------------------------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
------------------------------------------------------------------------------------------------------------------------------------------
12 | ERROR | [x] Missing class doc comment
32 | ERROR | [ ] The array declaration extends to column 84 (the limit is 80). The array content should be split up over multiple lines
38 | ERROR | [ ] The array declaration extends to column 189 (the limit is 80). The array content should be split up over multiple lines
------------------------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Snapshot/ContentEntitySnapshotItem.php
------------------------------------------------------------------------------------------------------------------------------
FOUND 15 ERRORS AND 3 WARNINGS AFFECTING 13 LINES
------------------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
13 | ERROR | [ ] Missing short description in doc comment
18 | ERROR | [ ] Missing short description in doc comment
26 | ERROR | [ ] Missing parameter comment
27 | ERROR | [ ] Missing parameter comment
28 | ERROR | [ ] Missing parameter comment
29 | ERROR | [ ] Missing parameter comment
30 | ERROR | [ ] Missing parameter comment
31 | ERROR | [ ] Missing parameter comment
70 | ERROR | [x] No space found before comment text; expected "// if ($translation) {" but found "//if ($translation) {"
70 | ERROR | [x] Inline comments must start with a capital letter
72 | WARNING | [x] There must be no blank line following an inline comment
72 | WARNING | [ ] There must be no blank line following an inline comment
72 | ERROR | [x] No space found before comment text; expected "// }" but found "//}"
72 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
87 | ERROR | [ ] Description for the @return value is missing
------------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Snapshot/EntitySnapshotItemInterface.php
-----------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 5 LINES
-----------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
14 | ERROR | [ ] Missing short description in doc comment
15 | ERROR | [ ] Description for the @return value is missing
19 | ERROR | [ ] Missing short description in doc comment
20 | ERROR | [ ] Description for the @return value is missing
-----------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Snapshot/ContentEntitySnapshotItemInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AND 1 WARNING AFFECTING 2 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Snapshot/EntitySnapshotItem.php
---------------------------------------------------------------------------------------------------------------------
FOUND 12 ERRORS AND 1 WARNING AFFECTING 12 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
14 | ERROR | [ ] Missing short description in doc comment
19 | ERROR | [ ] Missing short description in doc comment
24 | ERROR | [ ] Missing short description in doc comment
32 | ERROR | [ ] Missing parameter comment
33 | ERROR | [ ] Missing parameter comment
34 | ERROR | [ ] Missing parameter comment
35 | ERROR | [ ] Missing parameter comment
36 | ERROR | [ ] Missing parameter comment
70 | ERROR | [ ] Description for the @return value is missing
89 | ERROR | [x] Functions must not contain multiple empty lines in a row; found 2 empty lines
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Snapshot/SnapshotItem.php
----------------------------------------------------------------------------------------------------------------------
FOUND 20 ERRORS AND 1 WARNING AFFECTING 20 LINES
----------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
14 | ERROR | [ ] Missing short description in doc comment
24 | ERROR | [ ] Missing short description in doc comment
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
52 | ERROR | [ ] Missing parameter comment
53 | ERROR | [ ] Missing parameter comment
54 | ERROR | [ ] Missing parameter comment
133 | ERROR | [ ] Missing short description in doc comment
134 | ERROR | [ ] Missing parameter comment
136 | ERROR | [ ] Description for the @return value is missing
152 | ERROR | [x] Missing function doc comment
156 | ERROR | [x] Missing function doc comment
160 | ERROR | [x] Missing function doc comment
164 | ERROR | [x] Missing function doc comment
168 | ERROR | [x] Missing function doc comment
172 | ERROR | [x] Missing function doc comment
----------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Snapshot/SnapshotItemInterface.php
-----------------------------------------------------------------------------------------------------
FOUND 13 ERRORS AFFECTING 12 LINES
-----------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
19 | ERROR | [ ] Description for the @return value is missing
26 | ERROR | [ ] Description for the @return value is missing
33 | ERROR | [ ] Description for the @return value is missing
40 | ERROR | [ ] Description for the @return value is missing
47 | ERROR | [ ] Missing parameter comment
49 | ERROR | [ ] Description for the @return value is missing
56 | ERROR | [ ] Description for the @return value is missing
63 | ERROR | [ ] Description for the @return value is missing
67 | ERROR | [ ] Missing short description in doc comment
68 | ERROR | [ ] Missing parameter comment
75 | ERROR | [ ] Description for the @return value is missing
-----------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Snapshot/TranslatableSnapshotItemInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 9 ERRORS AND 1 WARNING AFFECTING 9 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
16 | ERROR | [ ] Missing short description in doc comment
17 | ERROR | [ ] Missing parameter comment
19 | ERROR | [ ] Description for the @return value is missing
26 | ERROR | [ ] Description for the @return value is missing
33 | ERROR | [ ] Description for the @return value is missing
35 | ERROR | [x] Expected 1 blank line after function; 0 found
36 | ERROR | [x] The closing brace for the interface must have an empty line before it
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Utils/FileSystemUtils.php
------------------------------------------------------------------------------------------------------------------------------
FOUND 12 ERRORS AND 1 WARNING AFFECTING 12 LINES
------------------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
9 | ERROR | [x] Non-namespaced classes/interfaces/traits should not be referenced with use statements
14 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
17 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [ ] Missing parameter comment
47 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
56 | ERROR | [x] Expected newline after closing brace
79 | ERROR | [x] Line indented incorrectly; expected 6 spaces, found 8
80 | ERROR | [x] Line indented incorrectly; expected 8 spaces, found 10
81 | ERROR | [x] Line indented incorrectly; expected 6 spaces, found 8
85 | ERROR | [x] Expected 1 blank line after function; 0 found
86 | ERROR | [x] The closing brace for the class must have an empty line before it
------------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Utils/FileSystemUtilsInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 15 ERRORS AND 1 WARNING AFFECTING 13 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
14 | ERROR | [ ] Missing short description in doc comment
15 | ERROR | [ ] Missing parameter comment
16 | ERROR | [ ] Missing parameter comment
17 | ERROR | [ ] Missing parameter comment
21 | ERROR | [ ] Missing short description in doc comment
22 | ERROR | [ ] Missing parameter comment
22 | ERROR | [ ] Missing parameter type
26 | ERROR | [ ] Missing short description in doc comment
27 | ERROR | [ ] Missing parameter comment
27 | ERROR | [ ] Missing parameter type
29 | ERROR | [ ] Description for the @return value is missing
31 | ERROR | [x] Expected 1 blank line after function; 0 found
32 | ERROR | [x] The closing brace for the interface must have an empty line before it
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Encoder/YamlEncoder.php
----------------------------------------------------------------------------------------------------------------------
FOUND 13 ERRORS AFFECTING 12 LINES
----------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
16 | 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
28 | ERROR | [x] Data types in @var tags need to be fully namespaced
32 | ERROR | [ ] Missing short description in doc comment
33 | ERROR | [x] Data types in @var tags need to be fully namespaced
37 | ERROR | [x] Missing function doc comment
40 | ERROR | [x] Expected 1 blank line after function; 2 found
43 | ERROR | [x] Missing function doc comment
47 | ERROR | [x] Missing function doc comment
51 | ERROR | [x] Missing function doc comment
55 | ERROR | [x] Missing function doc comment
----------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Purger/PurgerInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AND 1 WARNING AFFECTING 5 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
17 | ERROR | [ ] If there is no return value for a function, there must not be a @return tag.
17 | ERROR | [ ] Description for the @return value is missing
19 | ERROR | [x] Expected 1 blank line after function; 0 found
20 | ERROR | [x] The closing brace for the interface must have an empty line before it
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Purger/ContentEntityPurger.php
---------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AND 1 WARNING AFFECTING 4 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
13 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
16 | ERROR | [ ] Missing short description in doc comment
24 | ERROR | [ ] Missing parameter comment
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Purger/Purger.php
---------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AND 1 WARNING AFFECTING 4 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
14 | ERROR | [ ] Missing short description in doc comment
19 | ERROR | [x] Missing function doc comment
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Normalizer/PasswordFieldItemNormalizer.php
-----------------------------------------------------------------------------------------------------------------------------------------------
FOUND 15 ERRORS AND 1 WARNING AFFECTING 11 LINES
-----------------------------------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
16 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
17 | ERROR | [x] Namespaced classes/interfaces/traits should be referenced with use statements
21 | ERROR | [ ] Missing member variable doc comment
23 | ERROR | [ ] Missing member variable doc comment
25 | ERROR | [x] The open comment tag must be the only content on the line
25 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [x] Expected "\Drupal\pathauto\PathautoGeneratorInterface|null" but found "\Drupal\pathauto\PathautoGeneratorInterface|null "
| | for @var tag in member variable comment
31 | ERROR | [ ] Missing parameter comment
37 | ERROR | [ ] Missing short description in doc comment
38 | ERROR | [ ] Missing parameter comment
44 | ERROR | [ ] Parameter $format is not described in comment
44 | ERROR | [ ] Parameter $context is not described in comment
47 | ERROR | [ ] Missing parameter comment
47 | ERROR | [x] Missing parameter type
-----------------------------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Normalizer/ContentEntityNormalizer.php
----------------------------------------------------------------------------------------------------------------------
FOUND 28 ERRORS AND 4 WARNINGS AFFECTING 29 LINES
----------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
14 | WARNING | [x] Unused use statement
23 | ERROR | [x] Doc comment short description must end with a full stop
24 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
29 | ERROR | [ ] Missing member variable doc comment
31 | ERROR | [ ] Missing short description in doc comment
36 | ERROR | [ ] Missing short description in doc comment
41 | ERROR | [ ] Missing short description in doc comment
49 | ERROR | [ ] Missing parameter comment
50 | ERROR | [ ] Missing parameter comment
51 | ERROR | [ ] Missing parameter comment
52 | ERROR | [ ] Missing parameter comment
53 | ERROR | [ ] Missing parameter comment
56 | ERROR | [x] Expected 1 space between type hint and argument "$entity_type_manager"; 4 found
58 | ERROR | [x] Expected 1 space between type hint and argument "$entity_field_manager"; 3 found
59 | ERROR | [x] Expected 1 space between type hint and argument "$logger"; 15 found
60 | ERROR | [x] Expected 1 space between type hint and argument "$config"; 15 found
67 | ERROR | [ ] Parameter $format is not described in comment
67 | ERROR | [ ] Parameter $context is not described in comment
70 | ERROR | [ ] Missing parameter comment
70 | ERROR | [x] Missing parameter type
107 | WARNING | [ ] Line exceeds 80 characters; contains 99 characters
114 | WARNING | [ ] Line exceeds 80 characters; contains 83 characters
144 | ERROR | [x] Functions must not contain multiple empty lines in a row; found 2 empty lines
151 | ERROR | [x] Data types in @var tags need to be fully namespaced
162 | ERROR | [x] Data types in @var tags need to be fully namespaced
191 | ERROR | [x] Missing function doc comment
201 | ERROR | [x] Case breaking statements must be followed by a single blank line
208 | ERROR | [ ] Missing short description in doc comment
209 | ERROR | [ ] Missing parameter comment
210 | ERROR | [ ] Missing parameter comment
----------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Normalizer/layout_builder/LayoutSectionItemNormalizer.php
----------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 4 LINES
----------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
6 | ERROR | [x] Doc comment short description must be on the first line
26 | ERROR | [ ] Missing member variable doc comment
42 | ERROR | [x] Data types in @var tags need to be fully namespaced
----------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Normalizer/layout_builder/SectionDataNormalizer.php
-------------------------------------------------------------------------------------------------------------------------------------------
FOUND 17 ERRORS AND 1 WARNING AFFECTING 11 LINES
-------------------------------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
9 | WARNING | [x] Unused use statement
30 | ERROR | [ ] Missing member variable doc comment
37 | ERROR | [x] The open comment tag must be the only content on the line
37 | ERROR | [ ] Missing short description in doc comment
37 | ERROR | [x] Data types in @var tags need to be fully namespaced
37 | ERROR | [x] Expected "EntityRepositoryInterface" but found "EntityRepositoryInterface " for @var tag in member variable comment
40 | ERROR | [x] The open comment tag must be the only content on the line
40 | ERROR | [ ] Missing short description in doc comment
40 | ERROR | [x] Data types in @var tags need to be fully namespaced
40 | ERROR | [x] Expected "EntityTypeManagerInterface" but found "EntityTypeManagerInterface " for @var tag in member variable comment
43 | ERROR | [x] Missing function doc comment
67 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "NULL" but found "null"
79 | ERROR | [x] Data types in @var tags need to be fully namespaced
120 | ERROR | [x] Data types in @var tags need to be fully namespaced
140 | ERROR | [x] Expected 1 blank line after function; 0 found
141 | ERROR | [x] The closing brace for the class must have an empty line before it
-------------------------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Normalizer/PathFieldItemNormalizer.php
-----------------------------------------------------------------------------------------------------------------------------------------------
FOUND 16 ERRORS AND 1 WARNING AFFECTING 12 LINES
-----------------------------------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
16 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
17 | ERROR | [x] Namespaced classes/interfaces/traits should be referenced with use statements
21 | ERROR | [ ] Missing member variable doc comment
23 | ERROR | [ ] Missing member variable doc comment
25 | ERROR | [x] The open comment tag must be the only content on the line
25 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [x] Expected "\Drupal\pathauto\PathautoGeneratorInterface|null" but found "\Drupal\pathauto\PathautoGeneratorInterface|null "
| | for @var tag in member variable comment
31 | ERROR | [ ] Missing parameter comment
37 | ERROR | [ ] Missing short description in doc comment
38 | ERROR | [ ] Missing parameter comment
44 | ERROR | [ ] Parameter $format is not described in comment
44 | ERROR | [ ] Parameter $context is not described in comment
47 | ERROR | [ ] Missing parameter comment
47 | ERROR | [x] Missing parameter type
95 | ERROR | [x] Namespaced classes/interfaces/traits should be referenced with use statements
-----------------------------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Normalizer/ContentSnapshotNormalizerContextTrait.php
---------------------------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AND 1 WARNING AFFECTING 6 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
10 | ERROR | [x] Doc comment short description must end with a full stop
13 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
16 | ERROR | [ ] Missing member variable doc comment
16 | ERROR | [ ] Class property $CONTENT_SNAPSHOT_CONTEXT should use lowerCamel naming without underscores
18 | ERROR | [ ] Missing short description in doc comment
19 | ERROR | [ ] Missing parameter comment
19 | ERROR | [ ] Missing parameter type
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Normalizer/layout_builder_st/LayoutTranslationDataNormalizer.php
---------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AND 1 WARNING AFFECTING 4 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
16 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
21 | ERROR | [ ] Missing member variable doc comment
23 | ERROR | [ ] Missing member variable doc comment
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Normalizer/EntityReferenceFieldItemNormalizer.php
----------------------------------------------------------------------------------------------------------------------
FOUND 13 ERRORS AND 4 WARNINGS AFFECTING 13 LINES
----------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
17 | ERROR | [x] Doc comment short description must end with a full stop
18 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
23 | ERROR | [ ] Missing member variable doc comment
25 | ERROR | [ ] Missing short description in doc comment
34 | ERROR | [x] Expected 1 blank line before function; 2 found
40 | ERROR | [ ] Parameter $format is not described in comment
40 | ERROR | [ ] Parameter $context is not described in comment
43 | ERROR | [ ] Missing parameter comment
43 | ERROR | [x] Missing parameter type
81 | WARNING | [ ] Line exceeds 80 characters; contains 113 characters
94 | ERROR | [x] Expected 1 blank line after function; 2 found
97 | ERROR | [ ] Missing short description in doc comment
98 | ERROR | [ ] Missing parameter comment
102 | WARNING | [x] There must be no blank line following an inline comment
102 | WARNING | [ ] There must be no blank line following an inline comment
----------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ReferenceRestorer/ReferenceRestorerInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AND 1 WARNING AFFECTING 5 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
13 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
21 | ERROR | [ ] Missing parameter comment
22 | ERROR | [ ] Missing parameter comment
22 | ERROR | [ ] Missing parameter type
25 | ERROR | [x] Return comment indentation must be 3 spaces, found 2 spaces
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ReferenceRestorer/ReferenceRestorerChain.php
-----------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 4 LINES
-----------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
16 | ERROR | [ ] Missing short description in doc comment
21 | ERROR | [ ] Missing short description in doc comment
22 | ERROR | [ ] Missing parameter comment
-----------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ReferenceRestorer/ContentEntityReferenceRestorer.php
-------------------------------------------------------------------------------------------------------------------------------
FOUND 19 ERRORS AND 3 WARNINGS AFFECTING 19 LINES
-------------------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
10 | WARNING | [x] Unused use statement
19 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
22 | ERROR | [ ] Missing short description in doc comment
30 | ERROR | [ ] Missing parameter comment
36 | ERROR | [ ] Parameter $snapshot is not described in comment
39 | ERROR | [ ] Missing parameter comment
41 | ERROR | [ ] Type hint "\Drupal\Core\Entity\ContentEntityInterface" missing for $entity
54 | WARNING | [ ] Line exceeds 80 characters; contains 84 characters
57 | ERROR | [x] Data types in @var tags need to be fully namespaced
92 | ERROR | [ ] Missing short description in doc comment
93 | ERROR | [ ] Missing parameter comment
94 | ERROR | [ ] Missing parameter comment
96 | ERROR | [ ] Description for the @return value is missing
117 | ERROR | [ ] Missing short description in doc comment
118 | ERROR | [ ] Description for the @return value is missing
122 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
122 | ERROR | [x] Comments may not appear after statements
123 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
123 | ERROR | [x] Comments may not appear after statements
124 | ERROR | [x] Array closing indentation error, expected 4 spaces but found 6
-------------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Exporter/ExporterInterface.php
-----------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AND 1 WARNING AFFECTING 3 LINES
-----------------------------------------------------------------------------------------------------------------
7 | WARNING | The class short comment should describe what the class does and not simply repeat the class name
13 | ERROR | Missing short description in doc comment
14 | ERROR | If there is no return value for a function, there must not be a @return tag.
14 | ERROR | Description for the @return value is missing
-----------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Exporter/Exporter.php
-------------------------------------------------------------------------------------------------------------------------------
FOUND 19 ERRORS AND 1 WARNING AFFECTING 20 LINES
-------------------------------------------------------------------------------------------------------------------------------
16 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
19 | ERROR | [ ] Missing short description in doc comment
24 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [x] Data types in @var tags need to be fully namespaced
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
52 | ERROR | [ ] Missing parameter comment
53 | ERROR | [ ] Missing parameter comment
54 | ERROR | [ ] Missing parameter comment
55 | ERROR | [ ] Missing parameter comment
56 | ERROR | [ ] Missing parameter comment
57 | ERROR | [ ] Missing parameter comment
61 | ERROR | [x] Expected 1 space between type hint and argument "$contentProvider"; 9 found
62 | ERROR | [x] Expected 1 space between type hint and argument "$snapshotWriter"; 10 found
63 | ERROR | [x] Expected 1 space between type hint and argument "$logger"; 18 found
64 | ERROR | [x] Expected 1 space between type hint and argument "$config"; 18 found
65 | ERROR | [x] Expected 1 space between type hint and argument "$eventDispatcher"; 9 found
119 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
-------------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ContentSnapshotServiceProvider.php
-----------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------------------------------------------------------------------------
9 | ERROR | [x] Missing class doc comment
-----------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Configuration/Config.php
-----------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 4 LINES
-----------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
21 | ERROR | [ ] Missing short description in doc comment
26 | ERROR | [ ] Missing short description in doc comment
34 | ERROR | [ ] Missing parameter comment
-----------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Configuration/ConfigInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 10 ERRORS AND 1 WARNING AFFECTING 10 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
14 | ERROR | [ ] Missing short description in doc comment
15 | ERROR | [ ] Description for the @return value is missing
19 | ERROR | [ ] Missing short description in doc comment
20 | ERROR | [ ] Missing parameter comment
24 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [ ] Description for the @return value is missing
29 | ERROR | [ ] Missing short description in doc comment
30 | ERROR | [ ] Description for the @return value is missing
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ContentProvider/ContentEntityProviderInterface.php
-----------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 3 LINES
-----------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
14 | ERROR | [ ] Missing short description in doc comment
15 | ERROR | [ ] Description for the @return value is missing
-----------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ContentProvider/ContentProviderInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AND 1 WARNING AFFECTING 4 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
14 | ERROR | [ ] Missing short description in doc comment
15 | ERROR | [ ] Description for the @return value is missing
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ContentProvider/ContentEntityProvider.php
---------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AND 1 WARNING AFFECTING 5 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
14 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
17 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [ ] Missing parameter comment
34 | ERROR | [ ] Description for the @return value is missing
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/ContentProvider/ContentProvider.php
---------------------------------------------------------------------------------------------------------------------
FOUND 7 ERRORS AND 1 WARNING AFFECTING 7 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
14 | ERROR | [ ] Missing short description in doc comment
19 | ERROR | [ ] Missing short description in doc comment
20 | ERROR | [ ] Missing parameter comment
36 | ERROR | [x] Expected 1 blank line after function; 0 found
37 | ERROR | [x] The closing brace for the class must have an empty line before it
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/StreamWrapper/ContentSnapshotStream.php
---------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AND 3 WARNINGS AFFECTING 4 LINES
---------------------------------------------------------------------------------------------------------------------------------------------
7 | WARNING | [x] Unused use statement
27 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
34 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
43 | ERROR | [x] Language constructs must be followed by a single space; expected 1 space but found "ยทยท"
---------------------------------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Logger/Logger.php
---------------------------------------------------------------------------------------------------------------------
FOUND 15 ERRORS AND 1 WARNING AFFECTING 15 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
15 | ERROR | [ ] Missing short description in doc comment
20 | ERROR | [ ] Missing short description in doc comment
21 | ERROR | [ ] Missing parameter comment
23 | ERROR | [x] Namespaced classes/interfaces/traits should be referenced with use statements
27 | ERROR | [x] Missing function doc comment
31 | ERROR | [x] Missing function doc comment
35 | ERROR | [x] Missing function doc comment
39 | ERROR | [x] Missing function doc comment
43 | ERROR | [x] Missing function doc comment
47 | ERROR | [x] Missing function doc comment
51 | ERROR | [x] Missing function doc comment
55 | ERROR | [x] Missing function doc comment
59 | ERROR | [x] Missing function doc comment
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Logger/LoggerInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AND 1 WARNING AFFECTING 7 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
11 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
12 | ERROR | [x] Namespaced classes/interfaces/traits should be referenced with use statements
14 | ERROR | [ ] Missing short description in doc comment
15 | ERROR | [ ] Missing parameter comment
17 | ERROR | [ ] If there is no return value for a function, there must not be a @return tag.
17 | ERROR | [ ] Description for the @return value is missing
19 | ERROR | [x] Namespaced classes/interfaces/traits should be referenced with use statements
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Converter/ToSnapshotItemConverterChain.php
---------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AND 2 WARNINGS AFFECTING 6 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
9 | WARNING | [x] Unused use statement
14 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
17 | ERROR | [ ] Missing short description in doc comment
22 | ERROR | [ ] Missing short description in doc comment
23 | ERROR | [ ] Missing parameter comment
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Converter/ContentEntityToObjectConverter.php
-----------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 4 LINES
-----------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
20 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [ ] Missing short description in doc comment
30 | ERROR | [x] Missing function doc comment
-----------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Converter/ToObjectConverterInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AND 1 WARNING AFFECTING 5 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
13 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
16 | ERROR | [ ] Missing short description in doc comment
17 | ERROR | [ ] Missing parameter comment
19 | ERROR | [ ] Description for the @return value is missing
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Converter/ContentEntityToSnapshotItemConverter.php
---------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AND 1 WARNING AFFECTING 4 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
18 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
21 | ERROR | [ ] Missing short description in doc comment
26 | ERROR | [x] Missing function doc comment
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Converter/ToObjectConverterChain.php
---------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AND 2 WARNINGS AFFECTING 5 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
9 | WARNING | [x] Unused use statement
14 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
17 | ERROR | [ ] Missing short description in doc comment
22 | ERROR | [x] Missing function doc comment
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/Converter/ToSnapshotItemConverterInterface.php
---------------------------------------------------------------------------------------------------------------------
FOUND 9 ERRORS AND 1 WARNING AFFECTING 8 LINES
---------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
13 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
16 | ERROR | [ ] Missing short description in doc comment
17 | ERROR | [ ] Missing parameter comment
19 | ERROR | [ ] Description for the @return value is missing
23 | ERROR | [ ] Missing short description in doc comment
24 | ERROR | [ ] Missing parameter comment
24 | ERROR | [ ] Missing parameter type
26 | ERROR | [ ] Description for the @return value is missing
---------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/EventSubscriber/PathautoRestorerEventSubscriber.php
-----------------------------------------------------------------------------------------------------
FOUND 7 ERRORS AFFECTING 6 LINES
-----------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
20 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [x] Missing function doc comment
29 | ERROR | [x] Missing function doc comment
35 | ERROR | [x] Missing function doc comment
73 | ERROR | [x] Namespaced classes/interfaces/traits should be referenced with use statements
-----------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/EventSubscriber/FilesPrioritizerEventSubscriber.php
-----------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 3 LINES
-----------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
22 | ERROR | [x] Missing function doc comment
28 | ERROR | [x] Missing function doc comment
-----------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/EventSubscriber/MenusHierarchyFixerEventSubscriber.php
-------------------------------------------------------------------------------------------------------
FOUND 7 ERRORS AFFECTING 6 LINES
-------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
3 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [ ] Missing short description in doc comment
30 | ERROR | [ ] Missing short description in doc comment
35 | ERROR | [x] Missing function doc comment
40 | ERROR | [x] Missing function doc comment
46 | ERROR | [x] Missing function doc comment
-------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/src/EventSubscriber/UsersPrioritizerEventSubscriber.php
----------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 5 LINES
----------------------------------------------------------------------------------------------------------------------
3 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
6 | ERROR | [x] Doc comment short description must be on the first line
8 | ERROR | [ ] Doc comment short description must be on a single line, further text should be a separate paragraph
26 | ERROR | [x] Missing function doc comment
32 | ERROR | [x] Missing function doc comment
----------------------------------------------------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/content_snapshot.install
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
1 | ERROR | [x] Missing file doc comment
----------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/content_snapshot.services.yml
--------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------
188 | ERROR | [x] Expected 1 newline at end of file; 2 found
--------------------------------------------------------------------------
FILE: /var/www/html/dContri/content_snapshot/README.txt
----------------------------------------------------------------------
FOUND 0 ERRORS AND 19 WARNINGS AFFECTING 19 LINES
----------------------------------------------------------------------
13 | WARNING | Line exceeds 80 characters; contains 117 characters
16 | WARNING | Line exceeds 80 characters; contains 115 characters
17 | WARNING | Line exceeds 80 characters; contains 114 characters
20 | WARNING | Line exceeds 80 characters; contains 115 characters
21 | WARNING | Line exceeds 80 characters; contains 114 characters
22 | WARNING | Line exceeds 80 characters; contains 89 characters
28 | WARNING | Line exceeds 80 characters; contains 101 characters
34 | WARNING | Line exceeds 80 characters; contains 113 characters
37 | WARNING | Line exceeds 80 characters; contains 113 characters
38 | WARNING | Line exceeds 80 characters; contains 117 characters
42 | WARNING | Line exceeds 80 characters; contains 112 characters
43 | WARNING | Line exceeds 80 characters; contains 109 characters
44 | WARNING | Line exceeds 80 characters; contains 83 characters
49 | WARNING | Line exceeds 80 characters; contains 86 characters
50 | WARNING | Line exceeds 80 characters; contains 94 characters
59 | WARNING | Line exceeds 80 characters; contains 97 characters
62 | WARNING | Line exceeds 80 characters; contains 86 characters
71 | WARNING | Line exceeds 80 characters; contains 116 characters
72 | WARNING | Line exceeds 80 characters; contains 94 characters
----------------------------------------------------------------------