├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
├── composer.json
└── lib
    └── Doctrine
        └── ruleset.xml


/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 | 
3 | See https://www.doctrine-project.org/projects/doctrine-coding-standard/en/stable/reference/index.html#contributing
4 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2013 Steve Müller
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of
 6 | this software and associated documentation files (the "Software"), to deal in
 7 | the Software without restriction, including without limitation the rights to
 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 9 | the Software, and to permit persons to whom the Software is furnished to do so,
10 | subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | SHELL := /bin/bash
 2 | 
 3 | .PHONY: test test-report test-fix update-compatibility-patch
 4 | 
 5 | test: test-report test-fix
 6 | 
 7 | test-report: vendor
 8 | 	./bin/test-report
 9 | 
10 | test-fix: vendor
11 | 	./bin/test-fix
12 | 
13 | update-compatibility-patch-74:
14 | 	@git apply tests/php74-compatibility.patch
15 | 	@printf "Please open your editor and apply your changes\n"
16 | 	@until [ "$${compatibility_resolved}" == "y" ]; do read -p "Have finished your changes (y|n)? " compatibility_resolved; done && compatibility_resolved=
17 | 	@git diff -- tests/expected_report.txt tests/fixed tests/input > .tmp-patch && mv .tmp-patch tests/php74-compatibility.patch && git apply -R tests/php74-compatibility.patch
18 | 	@git commit -m 'Update compatibility patch' tests/php74-compatibility.patch
19 | 
20 | update-compatibility-patch-80:
21 | 	@git apply tests/php80-compatibility.patch
22 | 	@printf "Please open your editor and apply your changes\n"
23 | 	@until [ "$${compatibility_resolved}" == "y" ]; do read -p "Have finished your changes (y|n)? " compatibility_resolved; done && compatibility_resolved=
24 | 	@git diff -- tests/expected_report.txt tests/fixed tests/input > .tmp-patch && mv .tmp-patch tests/php80-compatibility.patch && git apply -R tests/php80-compatibility.patch
25 | 	@git commit -m 'Update compatibility patch' tests/php80-compatibility.patch
26 | 
27 | update-compatibility-patch-81:
28 | 	@git apply tests/php81-compatibility.patch --allow-empty
29 | 	@printf "Please open your editor and apply your changes\n"
30 | 	@until [ "$${compatibility_resolved}" == "y" ]; do read -p "Have finished your changes (y|n)? " compatibility_resolved; done && compatibility_resolved=
31 | 	@git diff -- tests/expected_report.txt tests/fixed tests/input > .tmp-patch && mv .tmp-patch tests/php81-compatibility.patch && git apply -R tests/php81-compatibility.patch --allow-empty
32 | 	@git commit -m 'Update compatibility patch' tests/php81-compatibility.patch
33 | 
34 | update-compatibility-patch-82:
35 | 	@git apply tests/php82-compatibility.patch --allow-empty
36 | 	@printf "Please open your editor and apply your changes\n"
37 | 	@until [ "$${compatibility_resolved}" == "y" ]; do read -p "Have finished your changes (y|n)? " compatibility_resolved; done && compatibility_resolved=
38 | 	@git diff -- tests/expected_report.txt tests/fixed tests/input > .tmp-patch && mv .tmp-patch tests/php82-compatibility.patch && git apply -R tests/php82-compatibility.patch --allow-empty
39 | 	@git commit -m 'Update compatibility patch' tests/php82-compatibility.patch
40 | 
41 | vendor: composer.json
42 | 	composer update
43 | 	touch -c vendor
44 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Doctrine Coding Standard
 2 | 
 3 | [![Build Status](https://github.com/doctrine/coding-standard/workflows/Continuous%20Integration/badge.svg)](https://github.com/doctrine/coding-standard/actions?query=workflow%3A%22Continuous+Integration%22+)
 4 | [![Continuous Integration](https://github.com/doctrine/coding-standard/workflows/Continuous%20Integration/badge.svg?branch=8.2.x)](https://github.com/doctrine/coding-standard/actions)
 5 | [![Total Downloads](https://img.shields.io/packagist/dt/doctrine/coding-standard.svg?style=flat-square)](https://packagist.org/packages/doctrine/coding-standard)
 6 | [![Latest Stable Version](https://img.shields.io/packagist/v/doctrine/coding-standard.svg?style=flat-square)](https://packagist.org/packages/doctrine/coding-standard)
 7 | 
 8 | The Doctrine Coding Standard is a set of [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) rules applied to all Doctrine projects. Doctrine Coding Standard is heavily based on [Slevomat Coding Standard](https://github.com/slevomat/coding-standard).
 9 | 
10 | ## More resources:
11 | 
12 | * [Website](https://www.doctrine-project.org/)
13 | * [Documentation](https://www.doctrine-project.org/projects/coding-standard.html)
14 | * [Downloads](https://github.com/doctrine/coding-standard/coding-standard)
15 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "doctrine/coding-standard",
 3 |     "type": "phpcodesniffer-standard",
 4 |     "description": "The Doctrine Coding Standard is a set of PHPCS rules applied to all Doctrine projects.",
 5 |     "keywords": [
 6 |         "doctrine",
 7 |         "coding",
 8 |         "standard",
 9 |         "dev",
10 |         "cs",
11 |         "code",
12 |         "style",
13 |         "sniffer",
14 |         "rules",
15 |         "sniffs",
16 |         "checks"
17 |     ],
18 |     "homepage": "https://www.doctrine-project.org/projects/coding-standard.html",
19 |     "license": "MIT",
20 |     "authors": [
21 |         {"name": "Benjamin Eberlei", "email": "kontakt@beberlei.de"},
22 |         {"name": "Steve Müller", "email": "st.mueller@dzh-online.de"}
23 |     ],
24 |     "require": {
25 |         "php": "^7.4 || ^8.0",
26 |         "dealerdirect/phpcodesniffer-composer-installer": "^0.6.2 || ^0.7 || ^1.0.0",
27 |         "slevomat/coding-standard": "^8.16",
28 |         "squizlabs/php_codesniffer": "^3.7"
29 |     },
30 |     "config": {
31 |         "allow-plugins": {
32 |             "dealerdirect/phpcodesniffer-composer-installer": true
33 |         },
34 |         "sort-packages": true
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/lib/Doctrine/ruleset.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0"?>
  2 | <ruleset
  3 |     name="Doctrine"
  4 |     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  5 |     xsi:noNamespaceSchemaLocation="../../vendor/squizlabs/php_codesniffer/phpcs.xsd"
  6 | >
  7 |     <description>The Doctrine coding standard.</description>
  8 | 
  9 |     <!-- Import PSR-12 coding standard (base) -->
 10 |     <rule ref="PSR12">
 11 |         <!-- checked by SlevomatCodingStandard.Namespaces.UseSpacing -->
 12 |         <exclude name="PSR2.Namespaces.UseDeclaration.SpaceAfterLastUse"/>
 13 |         <exclude name="PSR12.Files.FileHeader"/>
 14 |         <!-- checked by SlevomatCodingStandard.Namespaces.NamespaceSpacing -->
 15 |         <exclude name="PSR2.Namespaces.NamespaceDeclaration.BlankLineAfter"/>
 16 |         <!-- checked by SlevomatCodingStandard.Operators.SpreadOperatorSpacing -->
 17 |         <exclude name="Squiz.Functions.FunctionDeclarationArgumentSpacing.SpacingAfterVariadic"/>
 18 |         <!-- checked by SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing -->
 19 |         <exclude name="PSR12.Functions.ReturnTypeDeclaration"/>
 20 |         <!-- checked by SlevomatCodingStandard.Classes.TraitUseSpacing -->
 21 |         <exclude name="PSR12.Traits.UseDeclaration"/>
 22 |         <!-- checked by SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing.WhitespaceAfterNullabilitySymbol -->
 23 |         <exclude name="PSR12.Functions.NullableTypeDeclaration.WhitespaceFound"/>
 24 |         <!-- checked by PSR12.ControlStructures.ControlStructureSpacing -->
 25 |         <exclude name="PSR2.ControlStructures.ControlStructureSpacing.SpacingAfterOpenBrace"/>
 26 |     </rule>
 27 | 
 28 |     <!-- Force array element indentation with 4 spaces -->
 29 |     <rule ref="Generic.Arrays.ArrayIndent"/>
 30 |     <!-- Forbid `array(...)` -->
 31 |     <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
 32 |     <!-- Forbid duplicate classes -->
 33 |     <rule ref="Generic.Classes.DuplicateClassName"/>
 34 |     <!-- Forbid empty statements -->
 35 |     <rule ref="Generic.CodeAnalysis.EmptyStatement">
 36 |         <!-- But allow empty catch -->
 37 |         <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedCatch"/>
 38 |     </rule>
 39 |     <!-- Forbid final methods in final classes -->
 40 |     <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier"/>
 41 |     <!-- Forbid useless empty method overrides -->
 42 |     <rule ref="Generic.CodeAnalysis.UselessOverridingMethod"/>
 43 |     <!-- Forbid inline HTML in PHP code -->
 44 |     <rule ref="Generic.Files.InlineHTML"/>
 45 |     <!-- Align corresponding assignment statement tokens -->
 46 |     <rule ref="Generic.Formatting.MultipleStatementAlignment">
 47 |         <properties>
 48 |             <property name="error" value="true"/>
 49 |         </properties>
 50 |     </rule>
 51 |     <!-- Force whitespace after a type cast -->
 52 |     <rule ref="Generic.Formatting.SpaceAfterCast">
 53 |         <properties>
 54 |             <property name="spacing" value="1"/>
 55 |         </properties>
 56 |     </rule>
 57 |     <!-- Force whitespace after `!` -->
 58 |     <rule ref="Generic.Formatting.SpaceAfterNot"/>
 59 |     <!-- Forbid PHP 4 constructors -->
 60 |     <rule ref="Generic.NamingConventions.ConstructorName"/>
 61 |     <!-- Forbid any content before opening tag -->
 62 |     <rule ref="Generic.PHP.CharacterBeforePHPOpeningTag"/>
 63 |     <!-- Forbid deprecated functions -->
 64 |     <rule ref="Generic.PHP.DeprecatedFunctions"/>
 65 |     <!-- Forbid alias functions, i.e. `sizeof()`, `delete()` -->
 66 |     <rule ref="Generic.PHP.ForbiddenFunctions">
 67 |         <properties>
 68 |             <property name="forbiddenFunctions" type="array">
 69 |                 <element key="chop" value="rtrim"/>
 70 |                 <element key="close" value="closedir"/>
 71 |                 <element key="compact" value="null"/>
 72 |                 <element key="delete" value="unset"/>
 73 |                 <element key="doubleval" value="floatval"/>
 74 |                 <element key="extract" value="null"/>
 75 |                 <element key="fputs" value="fwrite"/>
 76 |                 <element key="ini_alter" value="ini_set"/>
 77 |                 <element key="is_double" value="is_float"/>
 78 |                 <element key="is_integer" value="is_int"/>
 79 |                 <element key="is_long" value="is_int"/>
 80 |                 <element key="is_null" value="null"/>
 81 |                 <element key="is_real" value="is_float"/>
 82 |                 <element key="is_writeable" value="is_writable"/>
 83 |                 <element key="join" value="implode"/>
 84 |                 <element key="key_exists" value="array_key_exists"/>
 85 |                 <element key="pos" value="current"/>
 86 |                 <element key="settype" value="null"/>
 87 |                 <element key="show_source" value="highlight_file"/>
 88 |                 <element key="sizeof" value="count"/>
 89 |                 <element key="strchr" value="strstr"/>
 90 |                 <element key="user_error" value="trigger_error"/>
 91 |             </property>
 92 |         </properties>
 93 |     </rule>
 94 |     <!-- Forbid useless inline string concatenation -->
 95 |     <rule ref="Generic.Strings.UnnecessaryStringConcat">
 96 |         <!-- But multiline is useful for readability -->
 97 |         <properties>
 98 |             <property name="allowMultiline" value="true"/>
 99 |         </properties>
100 |     </rule>
101 |     <!-- Forbid backtick operator -->
102 |     <rule ref="Generic.PHP.BacktickOperator"/>
103 |     <!-- Force PHP 7 param and return types to be lowercased -->
104 |     <rule ref="Generic.PHP.LowerCaseType"/>
105 |     <!-- Forbid `php_sapi_name()` function -->
106 |     <rule ref="Generic.PHP.SAPIUsage"/>
107 |     <!-- Forbid comments starting with # -->
108 |     <rule ref="PEAR.Commenting.InlineComment"/>
109 |     <!-- Disallow else if in favor of elseif -->
110 |     <rule ref="PSR2.ControlStructures.ElseIfDeclaration.NotAllowed">
111 |         <type>error</type>
112 |     </rule>
113 |     <!-- Disallow multiple attributes inside one #[] -->
114 |     <rule ref="SlevomatCodingStandard.Attributes.DisallowAttributesJoining"/>
115 |     <!-- Require only one attribute per line -->
116 |     <rule ref="SlevomatCodingStandard.Attributes.DisallowMultipleAttributesPerLine"/>
117 |     <!-- Attributes should be adjoined to the PHP element they belong to -->
118 |     <rule ref="SlevomatCodingStandard.Attributes.AttributeAndTargetSpacing"/>
119 |     <!-- Require PHPDoc always before attributes -->
120 |     <rule ref="SlevomatCodingStandard.Attributes.RequireAttributeAfterDocComment"/>
121 |     <!-- Require that single line arrays have the correct spacing: no space around brackets and one space after comma -->
122 |     <rule ref="SlevomatCodingStandard.Arrays.SingleLineArrayWhitespace"/>
123 |     <!-- Require comma after last element in multi-line array -->
124 |     <rule ref="SlevomatCodingStandard.Arrays.TrailingArrayComma"/>
125 |     <!-- Require no space before : and 1 space before Enum type -->
126 |     <rule ref="SlevomatCodingStandard.Classes.BackedEnumTypeSpacing"/>
127 |     <!-- Require presence of constant visibility -->
128 |     <rule ref="SlevomatCodingStandard.Classes.ClassConstantVisibility">
129 |         <properties>
130 |             <property name="fixable" value="true"/>
131 |         </properties>
132 |     </rule>
133 |     <!-- Enforce consistent constant spacing -->
134 |     <rule ref="SlevomatCodingStandard.Classes.ConstantSpacing"/>
135 |     <!-- Forbid LSB for constants (static::FOO) -->
136 |     <rule ref="SlevomatCodingStandard.Classes.DisallowLateStaticBindingForConstants"/>
137 |     <!-- Forbid more than one constant declared per statement -->
138 |     <rule ref="SlevomatCodingStandard.Classes.DisallowMultiConstantDefinition"/>
139 |     <!-- Forbid string expression property fetch ($foo->{'bar'}) -->
140 |     <rule ref="SlevomatCodingStandard.Classes.DisallowStringExpressionPropertyFetch"/>
141 |     <!-- Forbid empty lines around type declarations -->
142 |     <rule ref="SlevomatCodingStandard.Classes.EmptyLinesAroundClassBraces">
143 |         <properties>
144 |             <property name="linesCountAfterOpeningBrace" value="0"/>
145 |             <property name="linesCountBeforeClosingBrace" value="0"/>
146 |         </properties>
147 |     </rule>
148 |     <!-- Enforce consistent enum case spacing -->
149 |     <rule ref="SlevomatCodingStandard.Classes.EnumCaseSpacing" />
150 |     <!-- Add one line around parent call in order to improve readability -->
151 |     <rule ref="SlevomatCodingStandard.Classes.ParentCallSpacing"/>
152 |     <!-- Ensure that there are consistent blank lines between properties. -->
153 |     <rule ref="SlevomatCodingStandard.Classes.PropertySpacing">
154 |         <properties>
155 |             <property name="minLinesCountBeforeWithComment" value="0" />
156 |         </properties>
157 |     </rule>
158 |     <!-- Require usage of ::class instead of __CLASS__, get_class(), get_class($this), get_called_class() and get_parent_class() -->
159 |     <rule ref="SlevomatCodingStandard.Classes.ModernClassNameReference"/>
160 |     <!-- https://github.com/slevomat/coding-standard#slevomatcodingstandardclassespropertydeclaration- -->
161 |     <rule ref="SlevomatCodingStandard.Classes.PropertyDeclaration">
162 |         <properties>
163 |             <property name="checkPromoted" value="true"/>
164 |             <property name="enableMultipleSpacesBetweenModifiersCheck" value="true"/>
165 |         </properties>
166 |     </rule>
167 |     <!-- Require usage of constructor property promotion -->
168 |     <rule ref="SlevomatCodingStandard.Classes.RequireConstructorPropertyPromotion"/>
169 |     <!-- Forbid uses of multiple traits separated by comma -->
170 |     <rule ref="SlevomatCodingStandard.Classes.TraitUseDeclaration"/>
171 |     <!-- Require no spaces before trait use, between trait uses and one space after trait uses -->
172 |     <rule ref="SlevomatCodingStandard.Classes.TraitUseSpacing">
173 |         <properties>
174 |             <property name="linesCountAfterLastUse" value="1"/>
175 |             <property name="linesCountAfterLastUseWhenLastInClass" value="0"/>
176 |             <property name="linesCountBeforeFirstUse" value="0"/>
177 |             <property name="linesCountBetweenUses" value="0"/>
178 |         </properties>
179 |     </rule>
180 |     <!-- Forbid prefix and suffix "Abstract" for abstract classes -->
181 |     <rule ref="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming"/>
182 |     <!-- Forbid prefix and suffix "Exception" for exception classes -->
183 |     <rule ref="SlevomatCodingStandard.Classes.SuperfluousExceptionNaming"/>
184 |     <!-- Forbid prefix and suffix "Interface" for interfaces -->
185 |     <rule ref="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming"/>
186 |     <!-- Forbid suffix "Trait" for traits -->
187 |     <rule ref="SlevomatCodingStandard.Classes.SuperfluousTraitNaming"/>
188 |     <!-- Forbid invalid annotation names in standard PHPDoc tags -->
189 |     <rule ref="SlevomatCodingStandard.Commenting.AnnotationName"/>
190 |     <!-- Require specific order of phpDoc annotations with empty newline between specific groups -->
191 |     <rule ref="SlevomatCodingStandard.Commenting.DocCommentSpacing">
192 |         <properties>
193 |             <property name="linesCountBeforeFirstContent" value="0"/>
194 |             <property name="linesCountAfterLastContent" value="0"/>
195 |             <property name="linesCountBetweenDescriptionAndAnnotations" value="1"/>
196 |             <property name="linesCountBetweenAnnotationsGroups" value="1"/>
197 |             <property name="annotationsGroups" type="array">
198 |                 <element value="
199 |                     @internal,
200 |                     @deprecated,
201 |                 "/>
202 |                 <element value="
203 |                     @link,
204 |                     @see,
205 |                     @uses,
206 |                 "/>
207 |                 <element value="
208 |                     @ORM\,
209 |                     @ODM\,
210 |                     @PHPCR\,
211 |                 "/>
212 |                 <element value="
213 |                     @param,
214 |                     @psalm-param,
215 |                     @phpstan-param,
216 |                 "/>
217 |                 <element value="
218 |                     @return,
219 |                     @psalm-return,
220 |                     @phpstan-return,
221 |                 "/>
222 |                 <element value="@throws"/>
223 |             </property>
224 |         </properties>
225 |     </rule>
226 |     <!-- Forbid useless annotations - Git and LICENCE file provide more accurate information -->
227 |     <rule ref="SlevomatCodingStandard.Commenting.ForbiddenAnnotations">
228 |         <properties>
229 |             <property name="forbiddenAnnotations" type="array">
230 |                 <element value="@api"/>
231 |                 <element value="@author"/>
232 |                 <element value="@category"/>
233 |                 <element value="@copyright"/>
234 |                 <element value="@created"/>
235 |                 <element value="@license"/>
236 |                 <element value="@package"/>
237 |                 <element value="@since"/>
238 |                 <element value="@subpackage"/>
239 |                 <element value="@version"/>
240 |             </property>
241 |         </properties>
242 |     </rule>
243 |     <!-- Forbid empty comments -->
244 |     <rule ref="SlevomatCodingStandard.Commenting.EmptyComment"/>
245 |     <!-- Forbid useless comments -->
246 |     <rule ref="SlevomatCodingStandard.Commenting.ForbiddenComments">
247 |         <properties>
248 |             <property name="forbiddenCommentPatterns" type="array">
249 |                 <element value="~^(?:(?!private|protected|static)\S+ )?(?:con|de)structor\.\z~i"/>
250 |                 <element value="~^Created by .+\.\z~i"/>
251 |                 <element value="~^(User|Date|Time): \S+\z~i"/>
252 |                 <element value="~^\S+ [gs]etter\.\z~i"/>
253 |                 <element value="~^(Class|Interface|Trait) \S+\z~i"/>
254 |             </property>
255 |         </properties>
256 |     </rule>
257 |     <!-- Report invalid format of inline phpDocs with @var -->
258 |     <rule ref="SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration"/>
259 |     <!-- Forbid assignments in conditions -->
260 |     <rule ref="SlevomatCodingStandard.ControlStructures.AssignmentInCondition"/>
261 |     <!-- Require consistent spacing for block structures -->
262 |     <rule ref="SlevomatCodingStandard.ControlStructures.BlockControlStructureSpacing">
263 |         <exclude name="SlevomatCodingStandard.ControlStructures.BlockControlStructureSpacing.IncorrectLinesCountBeforeControlStructure" />
264 |         <exclude name="SlevomatCodingStandard.ControlStructures.BlockControlStructureSpacing.IncorrectLinesCountBeforeFirstControlStructure" />
265 |         <properties>
266 |             <property name="controlStructures" type="array">
267 |                 <element value="if" />
268 |                 <element value="do" />
269 |                 <element value="while" />
270 |                 <element value="for" />
271 |                 <element value="foreach" />
272 |                 <element value="switch" />
273 |                 <element value="try" />
274 |                 <element value="default" />
275 |             </property>
276 |         </properties>
277 |     </rule>
278 |     <!-- Forbid fancy yoda conditions -->
279 |     <rule ref="SlevomatCodingStandard.ControlStructures.DisallowYodaComparison"/>
280 |     <!-- Require usage of early exit -->
281 |     <rule ref="SlevomatCodingStandard.ControlStructures.EarlyExit"/>
282 |     <!-- Require consistent spacing for jump statements -->
283 |     <rule ref="SlevomatCodingStandard.ControlStructures.JumpStatementsSpacing">
284 |         <properties>
285 |             <property name="linesCountBeforeWhenFirstInCaseOrDefault" value="0"/>
286 |             <property name="linesCountAfterWhenLastInCaseOrDefault" value="1"/>
287 |             <property name="linesCountAfterWhenLastInLastCaseOrDefault" value="0"/>
288 |             <property name="jumpStatements" type="array">
289 |                 <element value="return" />
290 |                 <element value="throw" />
291 |                 <element value="yield" />
292 |                 <element value="yield_from" />
293 |             </property>
294 |         </properties>
295 |     </rule>
296 |     <!-- Require language constructs without parentheses -->
297 |     <rule ref="SlevomatCodingStandard.ControlStructures.LanguageConstructWithParentheses"/>
298 |     <!-- Require usage of null coalesce operator equal operator when possible -->
299 |     <rule ref="SlevomatCodingStandard.ControlStructures.RequireNullCoalesceEqualOperator"/>
300 |     <!-- Require usage of null coalesce operator when possible -->
301 |     <rule ref="SlevomatCodingStandard.ControlStructures.RequireNullCoalesceOperator"/>
302 |     <!-- Require usage of null safe operator when possible -->
303 |     <rule ref="SlevomatCodingStandard.ControlStructures.RequireNullSafeObjectOperator"/>
304 |     <!-- Forbid usage of conditions when a simple return can be used -->
305 |     <rule ref="SlevomatCodingStandard.ControlStructures.UselessIfConditionWithReturn"/>
306 |     <!-- Forbid usage of boolean-only ternary operator usage (e.g. $foo ? true : false) -->
307 |     <rule ref="SlevomatCodingStandard.ControlStructures.UselessTernaryOperator"/>
308 |     <!-- Forbid useless unreachable catch blocks -->
309 |     <rule ref="SlevomatCodingStandard.Exceptions.DeadCatch"/>
310 |     <!-- Require using Throwable instead of Exception -->
311 |     <rule ref="SlevomatCodingStandard.Exceptions.ReferenceThrowableOnly"/>
312 |     <!-- Require non-capturing catch when the variable with exception is not used. -->
313 |     <rule ref="SlevomatCodingStandard.Exceptions.RequireNonCapturingCatch" />
314 |     <!-- Ensure Arrow Functions declaration format -->
315 |     <rule ref="SlevomatCodingStandard.Functions.ArrowFunctionDeclaration">
316 |         <properties>
317 |             <property name="spacesCountAfterKeyword" value="1"/>
318 |             <property name="spacesCountBeforeArrow" value="1"/>
319 |             <property name="spacesCountAfterArrow" value="1"/>
320 |         </properties>
321 |     </rule>
322 |     <!-- Disallow trailing commas in single line function calls -->
323 |     <rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInCall">
324 |         <properties>
325 |             <property name="onlySingleLine" value="true" />
326 |         </properties>
327 |     </rule>
328 |     <!-- Disallow trailing commas in single line closure use -->
329 |     <rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInClosureUse">
330 |         <properties>
331 |             <property name="onlySingleLine" value="true" />
332 |         </properties>
333 |     </rule>
334 |     <!-- Disallow trailing commas in single line function declarations -->
335 |     <rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInDeclaration">
336 |         <properties>
337 |             <property name="onlySingleLine" value="true" />
338 |         </properties>
339 |     </rule>
340 |     <!-- Require trailing commas in multiline function calls -->
341 |     <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInCall"/>
342 |     <!-- Require trailing commas in multiline closure use -->
343 |     <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInClosureUse"/>
344 |     <!-- Require trailing commas in multiline function declarations -->
345 |     <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration"/>
346 |     <!-- Require closures not referencing $this be static -->
347 |     <rule ref="SlevomatCodingStandard.Functions.StaticClosure"/>
348 |     <!-- Forbid unused variables passed to closures via `use` -->
349 |     <rule ref="SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure"/>
350 |     <!-- Require use statements to be alphabetically sorted -->
351 |     <rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses"/>
352 |     <!-- Forbid fancy group uses -->
353 |     <rule ref="SlevomatCodingStandard.Namespaces.DisallowGroupUse"/>
354 |     <!-- Forbid multiple use statements on same line -->
355 |     <rule ref="SlevomatCodingStandard.Namespaces.MultipleUsesPerLine"/>
356 |     <!-- Require newlines around namespace declaration -->
357 |     <rule ref="SlevomatCodingStandard.Namespaces.NamespaceSpacing"/>
358 |     <!-- Forbid using absolute class name references (except global ones) -->
359 |     <rule ref="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly">
360 |         <properties>
361 |             <property name="allowFallbackGlobalConstants" value="false"/>
362 |             <property name="allowFallbackGlobalFunctions" value="false"/>
363 |             <property name="allowFullyQualifiedGlobalClasses" value="false"/>
364 |             <property name="allowFullyQualifiedGlobalConstants" value="false"/>
365 |             <property name="allowFullyQualifiedGlobalFunctions" value="false"/>
366 |             <property name="allowFullyQualifiedNameForCollidingClasses" value="true"/>
367 |             <property name="allowFullyQualifiedNameForCollidingConstants" value="true"/>
368 |             <property name="allowFullyQualifiedNameForCollidingFunctions" value="true"/>
369 |             <property name="searchAnnotations" value="true"/>
370 |         </properties>
371 |     </rule>
372 |     <!-- Forbid unused use statements -->
373 |     <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
374 |         <properties>
375 |             <property name="searchAnnotations" value="true"/>
376 |         </properties>
377 |     </rule>
378 |     <!-- Forbid superfluous leading backslash in use statements -->
379 |     <rule ref="SlevomatCodingStandard.Namespaces.UseDoesNotStartWithBackslash"/>
380 |     <!-- Forbid useless uses of the same namespace -->
381 |     <rule ref="SlevomatCodingStandard.Namespaces.UseFromSameNamespace"/>
382 |     <!-- Require empty newlines before and after uses -->
383 |     <rule ref="SlevomatCodingStandard.Namespaces.UseSpacing">
384 |         <properties>
385 |             <property name="linesCountAfterLastUse" value="1"/>
386 |             <property name="linesCountBeforeFirstUse" value="1"/>
387 |             <property name="linesCountBetweenUseTypes" value="1"/>
388 |         </properties>
389 |     </rule>
390 |     <!-- Forbid useless alias for classes, constants and functions -->
391 |     <rule ref="SlevomatCodingStandard.Namespaces.UselessAlias"/>
392 |     <!-- Forbid weak comparisons -->
393 |     <rule ref="SlevomatCodingStandard.Operators.DisallowEqualOperators"/>
394 |     <!-- Forbid spacing before the negative operator `-` -->
395 |     <rule ref="SlevomatCodingStandard.Operators.NegationOperatorSpacing"/>
396 |     <!-- Require the usage of assignment operators, eg `+=`, `.=` when possible -->
397 |     <rule ref="SlevomatCodingStandard.Operators.RequireCombinedAssignmentOperator"/>
398 |     <!-- Require no spacing after spread operator -->
399 |     <rule ref="SlevomatCodingStandard.Operators.SpreadOperatorSpacing"/>
400 |     <!-- Forbid argument unpacking for functions specialized by PHP VM -->
401 |     <rule ref="SlevomatCodingStandard.PHP.OptimizedFunctionsWithoutUnpacking"/>
402 |     <!-- Forbid `list(...)` syntax -->
403 |     <rule ref="SlevomatCodingStandard.PHP.ShortList"/>
404 |     <!-- Forbid use of longhand cast operators -->
405 |     <rule ref="SlevomatCodingStandard.PHP.TypeCast"/>
406 |     <!-- Check for missing typehints in case they can be declared natively. Report useless @var annotation (or whole documentation comment) because the type of constant is always clear. -->
407 |     <rule ref="SlevomatCodingStandard.TypeHints.ClassConstantTypeHint"/>
408 |     <!-- Require presence of declare(strict_types=1) -->
409 |     <rule ref="SlevomatCodingStandard.TypeHints.DeclareStrictTypes">
410 |         <properties>
411 |             <property
412 |                 name="declareOnFirstLine"
413 |                 value="false"
414 |             />
415 |             <property
416 |                 name="linesCountBeforeDeclare"
417 |                 value="1"
418 |             />
419 |             <property
420 |                 name="spacesCountAroundEqualsSign"
421 |                 value="0"
422 |             />
423 |             <property
424 |                 name="linesCountAfterDeclare"
425 |                 value="1"
426 |             />
427 |         </properties>
428 |     </rule>
429 |     <!-- Forbid useless parentheses -->
430 |     <rule ref="SlevomatCodingStandard.PHP.UselessParentheses"/>
431 |     <!-- Forbid useless semicolon `;` -->
432 |     <rule ref="SlevomatCodingStandard.PHP.UselessSemicolon"/>
433 |     <!-- Require /* @var type $foo */ and similar simple inline annotations to be replaced by assert() -->
434 |     <rule ref="SlevomatCodingStandard.PHP.RequireExplicitAssertion">
435 |         <properties>
436 |             <property name="enableAdvancedStringTypes" value="true"/>
437 |             <property name="enableIntegerRanges" value="true"/>
438 |         </properties>
439 |     </rule>
440 |     <!-- Require use of short versions of scalar types (i.e. int instead of integer) -->
441 |     <rule ref="SlevomatCodingStandard.TypeHints.LongTypeHints"/>
442 |     <!-- Require the `null` type hint to be in the last position of annotations -->
443 |     <rule ref="SlevomatCodingStandard.TypeHints.NullTypeHintOnLastPosition"/>
444 |     <!-- Require ? when default value is null -->
445 |     <rule ref="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue"/>
446 |     <!-- Require one space between typehint and variable, require no space between nullability sign and typehint -->
447 |     <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHintSpacing"/>
448 |     <!-- Require space around colon in return types -->
449 |     <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing">
450 |         <properties>
451 |             <property name="spacesCountBeforeColon" value="0"/>
452 |         </properties>
453 |     </rule>
454 |     <!-- Require types to be written as natively if possible;
455 |          require iterable types to specify phpDoc with their content;
456 |          forbid useless/duplicated information in phpDoc -->
457 |     <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint">
458 |         <properties>
459 |             <property name="traversableTypeHints" type="array">
460 |                 <element value="Traversable"/>
461 |                 <element value="Iterator"/>
462 |                 <element value="IteratorAggregate"/>
463 |                 <element value="Doctrine\Common\Collections\Collection"/>
464 |             </property>
465 |         </properties>
466 |     </rule>
467 |     <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint">
468 |         <properties>
469 |             <property name="traversableTypeHints" type="array">
470 |                 <element value="Traversable"/>
471 |                 <element value="Iterator"/>
472 |                 <element value="IteratorAggregate"/>
473 |                 <element value="Doctrine\Common\Collections\Collection"/>
474 |             </property>
475 |         </properties>
476 |     </rule>
477 |     <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint">
478 |         <properties>
479 |             <property name="traversableTypeHints" type="array">
480 |                 <element value="Traversable"/>
481 |                 <element value="Iterator"/>
482 |                 <element value="IteratorAggregate"/>
483 |                 <element value="Doctrine\Common\Collections\Collection"/>
484 |             </property>
485 |         </properties>
486 |     </rule>
487 |     <!-- Define DNF style -->
488 |     <rule ref="SlevomatCodingStandard.TypeHints.DNFTypeHintFormat">
489 |         <properties>
490 |             <property name="withSpacesAroundOperators" value="no" />
491 |             <property name="withSpacesInsideParentheses" value="no" />
492 |             <property name="shortNullable" value="no" />
493 |             <property name="nullPosition" value="last" />
494 |         </properties>
495 |     </rule>
496 |     <!-- Forbid useless @var for constants -->
497 |     <rule ref="SlevomatCodingStandard.TypeHints.UselessConstantTypeHint"/>
498 |     <!-- Require One Line Doc Comment where there's only 1 annotation present -->
499 |     <rule ref="SlevomatCodingStandard.Commenting.RequireOneLineDocComment"/>
500 |     <!-- Forbid useless phpDocs for functions -->
501 |     <rule ref="SlevomatCodingStandard.Commenting.UselessFunctionDocComment">
502 |         <properties>
503 |             <property name="traversableTypeHints" type="array">
504 |                 <element value="Traversable"/>
505 |                 <element value="Iterator"/>
506 |                 <element value="IteratorAggregate"/>
507 |                 <element value="Doctrine\Common\Collections\Collection"/>
508 |             </property>
509 |         </properties>
510 |     </rule>
511 |     <!-- Forbid useless inherit doc comment -->
512 |     <rule ref="SlevomatCodingStandard.Commenting.UselessInheritDocComment"/>
513 |     <!-- Forbid duplicated variables assignments -->
514 |     <rule ref="SlevomatCodingStandard.Variables.DuplicateAssignmentToVariable"/>
515 |     <!-- Forbid useless variables -->
516 |     <rule ref="SlevomatCodingStandard.Variables.UselessVariable"/>
517 |     <!-- Require nowdoc syntax instead of heredoc when possible -->
518 |     <rule ref="SlevomatCodingStandard.PHP.RequireNowdoc" />
519 |     <!-- Forbid spaces around square brackets -->
520 |     <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
521 |     <!-- Force array declaration structure -->
522 |     <rule ref="Squiz.Arrays.ArrayDeclaration">
523 |         <!-- Disable arrow alignment -->
524 |         <exclude name="Squiz.Arrays.ArrayDeclaration.DoubleArrowNotAligned"/>
525 |         <!-- Uses indentation of only single space -->
526 |         <exclude name="Squiz.Arrays.ArrayDeclaration.KeyNotAligned"/>
527 |         <!-- Allow multiple values on a single line -->
528 |         <exclude name="Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed"/>
529 |         <!-- Disable alignment of braces -->
530 |         <exclude name="Squiz.Arrays.ArrayDeclaration.CloseBraceNotAligned"/>
531 |         <!-- Disable alignment of values with opening brace -->
532 |         <exclude name="Squiz.Arrays.ArrayDeclaration.ValueNotAligned"/>
533 |         <!-- Checked by SlevomatCodingStandard.Arrays.TrailingArrayComma.MissingTrailingComma -->
534 |         <exclude name="Squiz.Arrays.ArrayDeclaration.NoCommaAfterLast"/>
535 |         <exclude name="Squiz.Arrays.ArrayDeclaration.NoComma"/>
536 |     </rule>
537 |     <!-- Forbid class being in a file with different name -->
538 |     <rule ref="Squiz.Classes.ClassFileName"/>
539 |     <!-- Force `self::` for self-reference, force lower-case self, forbid spaces around `::` -->
540 |     <rule ref="Squiz.Classes.SelfMemberReference"/>
541 |     <!-- Force phpDoc alignment -->
542 |     <rule ref="Squiz.Commenting.DocCommentAlignment">
543 |         <!-- Allow extra spaces after star, i.e. for indented annotations -->
544 |         <exclude name="Squiz.Commenting.DocCommentAlignment.SpaceAfterStar"/>
545 |     </rule>
546 |     <!-- Force rules for function phpDoc -->
547 |     <rule ref="Squiz.Commenting.FunctionComment">
548 |         <!-- Allow `@throws` without description -->
549 |         <exclude name="Squiz.Commenting.FunctionComment.EmptyThrows"/>
550 |         <!-- Does not work properly with PHP 7 / short-named types -->
551 |         <exclude name="Squiz.Commenting.FunctionComment.IncorrectParamVarName"/>
552 |         <!-- Does not support collections, i.e. `string[]` -->
553 |         <exclude name="Squiz.Commenting.FunctionComment.IncorrectTypeHint"/>
554 |         <!-- Forces incorrect types -->
555 |         <exclude name="Squiz.Commenting.FunctionComment.InvalidReturn"/>
556 |         <!-- Breaks with compound return types, i.e. `string|null` -->
557 |         <exclude name="Squiz.Commenting.FunctionComment.InvalidReturnNotVoid"/>
558 |         <!-- Breaks when all params are not documented -->
559 |         <exclude name="Squiz.Commenting.FunctionComment.InvalidTypeHint"/>
560 |         <!-- Doc comment is not required for every method -->
561 |         <exclude name="Squiz.Commenting.FunctionComment.Missing"/>
562 |         <!-- Do not require comments for `@param` -->
563 |         <exclude name="Squiz.Commenting.FunctionComment.MissingParamComment"/>
564 |         <!-- Do not require `@param` for all parameters -->
565 |         <exclude name="Squiz.Commenting.FunctionComment.MissingParamTag"/>
566 |         <!-- Do not require `@return` for void methods -->
567 |         <exclude name="Squiz.Commenting.FunctionComment.MissingReturn"/>
568 |         <!-- Comments don't have to be sentences -->
569 |         <exclude name="Squiz.Commenting.FunctionComment.ParamCommentFullStop"/>
570 |         <!-- Comments don't have to be sentences -->
571 |         <exclude name="Squiz.Commenting.FunctionComment.ParamCommentNotCapital"/>
572 |         <!-- Breaks when all params are not documented -->
573 |         <exclude name="Squiz.Commenting.FunctionComment.ParamNameNoMatch"/>
574 |         <!-- Doesn't respect inheritance -->
575 |         <exclude name="Squiz.Commenting.FunctionComment.ScalarTypeHintMissing"/>
576 |         <!-- `@throws` lines can often be read as a sentence,
577 |              i.e. `@throws RuntimeException if the file could not be written.` -->
578 |         <exclude name="Squiz.Commenting.FunctionComment.ThrowsNotCapital"/>
579 |         <!-- Doesn't work with self as typehint -->
580 |         <exclude name="Squiz.Commenting.FunctionComment.TypeHintMissing"/>
581 |     </rule>
582 |     <!-- Forbid global functions -->
583 |     <rule ref="Squiz.Functions.GlobalFunction"/>
584 |     <!-- Force camelCase variables -->
585 |     <rule ref="Squiz.NamingConventions.ValidVariableName">
586 |         <exclude name="Squiz.NamingConventions.ValidVariableName.PrivateNoUnderscore" />
587 |     </rule>
588 |     <!-- Forbid `AND` and `OR`, require `&&` and `||` -->
589 |     <rule ref="Squiz.Operators.ValidLogicalOperators"/>
590 |     <!-- Forbid `global` -->
591 |     <rule ref="Squiz.PHP.GlobalKeyword"/>
592 |     <!-- Forbid functions inside functions -->
593 |     <rule ref="Squiz.PHP.InnerFunctions"/>
594 |     <!-- Require PHP function calls in lowercase -->
595 |     <rule ref="Squiz.PHP.LowercasePHPFunctions"/>
596 |     <!-- Forbid dead code -->
597 |     <rule ref="Squiz.PHP.NonExecutableCode"/>
598 |     <!-- Forbid `$this` inside static function -->
599 |     <rule ref="Squiz.Scope.StaticThisUsage"/>
600 |     <!-- Force whitespace before and after concatenation -->
601 |     <rule ref="Squiz.Strings.ConcatenationSpacing">
602 |         <properties>
603 |             <property name="spacing" value="1"/>
604 |             <property name="ignoreNewlines" value="true"/>
605 |         </properties>
606 |     </rule>
607 |     <!-- Forbid strings in `"` unless necessary -->
608 |     <rule ref="Squiz.Strings.DoubleQuoteUsage"/>
609 |     <!-- Forbid braces around string in `echo` -->
610 |     <rule ref="Squiz.Strings.EchoedStrings"/>
611 |     <!-- Forbid spaces in type casts -->
612 |     <rule ref="Squiz.WhiteSpace.CastSpacing"/>
613 |     <!-- Forbid blank line after function opening brace -->
614 |     <rule ref="Squiz.WhiteSpace.FunctionOpeningBraceSpace"/>
615 |     <!-- Require 1 line before and after function, except at the top and bottom -->
616 |     <rule ref="Squiz.WhiteSpace.FunctionSpacing">
617 |         <properties>
618 |             <property name="spacing" value="1" />
619 |             <property name="spacingBeforeFirst" value="0"/>
620 |             <property name="spacingAfterLast" value="0"/>
621 |         </properties>
622 |     </rule>
623 |     <!-- Require there be no space between increment/decrement operator and its operand -->
624 |     <rule ref="Generic.WhiteSpace.IncrementDecrementSpacing"/>
625 |     <!-- Require space after language constructs -->
626 |     <rule ref="Generic.WhiteSpace.LanguageConstructSpacing"/>
627 |     <!-- Require space around logical operators -->
628 |     <rule ref="Squiz.WhiteSpace.LogicalOperatorSpacing"/>
629 |     <!-- Forbid spaces around `->` operator -->
630 |     <rule ref="Squiz.WhiteSpace.ObjectOperatorSpacing">
631 |         <properties>
632 |             <property name="ignoreNewlines" value="true"/>
633 |         </properties>
634 |     </rule>
635 |     <!-- Forbid spaces before semicolon `;` -->
636 |     <rule ref="Squiz.WhiteSpace.SemicolonSpacing"/>
637 |     <!-- Forbid superfluous whitespaces -->
638 |     <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace">
639 |         <properties>
640 |             <!-- turned on by PSR-12 -> turning back off -->
641 |             <property name="ignoreBlankLines" value="false"/>
642 |         </properties>
643 |     </rule>
644 |     <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.EmptyLines">
645 |         <!-- turned off by PSR-12 -> turning back on -->
646 |         <severity>5</severity>
647 |     </rule>
648 | </ruleset>
649 | 


--------------------------------------------------------------------------------