├── ide-config
└── .idea
│ ├── fileTemplates
│ ├── includes
│ │ ├── PHP Class Doc Comment.php
│ │ ├── PHP Trait Doc Comment.php
│ │ ├── PHP Interface Doc Comment.php
│ │ ├── PHP Property Doc Comment.php
│ │ ├── PHP Field Doc Comment.php
│ │ ├── PHP File Header.php
│ │ └── PHP Function Doc Comment.php
│ ├── internal
│ │ ├── PHP File.php
│ │ ├── PHP Class.php
│ │ ├── PHP Trait.php
│ │ ├── PHP Interface.php
│ │ ├── Codeception Functional Test.php
│ │ ├── Codeception Unit Test.php
│ │ ├── PHPUnit 6 Test.php
│ │ ├── PHPSpec Specification.php
│ │ ├── PHPUnit Test.php
│ │ ├── composer.json.json
│ │ └── Doctrine Entity Repository.php
│ └── code
│ │ ├── PHP Overridden Method Body.php
│ │ ├── PHPSpec Test Method.php
│ │ ├── PHPUnit Test Method.php
│ │ ├── Codeception Unit Test Method.php
│ │ ├── PHPUnit SetUp Method.php
│ │ ├── PHPUnit TearDown Method.php
│ │ ├── Codeception Functional Test Method.php
│ │ ├── PHP Constructor.php
│ │ ├── PHP Fluent Setter Method.php
│ │ ├── PHP Getter Method.php
│ │ └── PHP Setter Method.php
│ └── php-code-style.xml
├── src
├── ruleset-7.2.xml
├── ruleset-7.3.xml
├── ruleset-7.4.xml
├── ruleset-8.0.xml
├── ruleset-8.1.xml
├── ruleset-8.2.xml
├── ruleset-8.3.xml
├── ruleset-8.4.xml
└── ruleset-base.xml
├── composer.json
├── CHANGELOG.md
└── LICENSE
/ide-config/.idea/fileTemplates/includes/PHP Class Doc Comment.php:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/ide-config/.idea/fileTemplates/includes/PHP Trait Doc Comment.php:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/ide-config/.idea/fileTemplates/includes/PHP Interface Doc Comment.php:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/ide-config/.idea/fileTemplates/includes/PHP Property Doc Comment.php:
--------------------------------------------------------------------------------
1 | /** @var ${TYPE_HINT} */
--------------------------------------------------------------------------------
/ide-config/.idea/fileTemplates/internal/PHP File.php:
--------------------------------------------------------------------------------
1 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
--------------------------------------------------------------------------------
/ide-config/.idea/fileTemplates/code/PHP Fluent Setter Method.php:
--------------------------------------------------------------------------------
1 | /**
2 | * @param #if(${TYPE_HINT} == 'array')array#else${TYPE_HINT}#end $${PARAM_NAME}
3 | * @return $this
4 | */
5 | public function set${NAME}(#if (${SCALAR_TYPE_HINT})${SCALAR_TYPE_HINT} #else#end$${PARAM_NAME})#if(${RETURN_TYPE}): self#else#end
6 | {
7 | $this->${FIELD_NAME} = $${PARAM_NAME};
8 | return $this;
9 | }
--------------------------------------------------------------------------------
/ide-config/.idea/fileTemplates/code/PHP Getter Method.php:
--------------------------------------------------------------------------------
1 | #if(${RETURN_TYPE})
2 | /**
3 | * @return #if(${TYPE_HINT} == 'array')array#else${TYPE_HINT}#end
4 | */
5 | #end
6 | public ${STATIC} function ${GET_OR_IS}${NAME}()#if(${RETURN_TYPE}): ${RETURN_TYPE}#else#end
7 | {
8 | #if (${STATIC} == "static")
9 | return self::$${FIELD_NAME};
10 | #else
11 | return $this->${FIELD_NAME};
12 | #end
13 | }
--------------------------------------------------------------------------------
/ide-config/.idea/fileTemplates/code/PHP Setter Method.php:
--------------------------------------------------------------------------------
1 | /**
2 | * @param #if(${TYPE_HINT} == 'array')array#else${TYPE_HINT}#end $${PARAM_NAME}
3 | */
4 | public ${STATIC} function set${NAME}(#if (${SCALAR_TYPE_HINT})${SCALAR_TYPE_HINT} #end$${PARAM_NAME})#if (${VOID_RETURN_TYPE}):void #end
5 | {
6 | #if (${STATIC} == "static")
7 | self::$${FIELD_NAME} = $${PARAM_NAME};
8 | #else
9 | $this->${FIELD_NAME} = $${PARAM_NAME};
10 | #end
11 | }
--------------------------------------------------------------------------------
/ide-config/.idea/fileTemplates/internal/composer.json.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "#[[$vendor_name$]]#/#[[$package_name$]]#",
3 | "description": "#[[$description$]]#",
4 | "keywords": [],
5 | "type": "library",
6 | "license": "#[[$license$]]#",
7 | "homepage": "#[[$homepage$]]#",
8 | "authors": [
9 | {
10 | "name": "#[[$author$]]#",
11 | "homepage": "#[[$author_homepage$]]#"
12 | }
13 | ],
14 | "require": {},
15 | "minimum-stability": "dev",
16 | "prefer-stable": true,
17 | "config": {
18 | "sort-packages": true
19 | }
20 | }
21 |
--------------------------------------------------------------------------------
/ide-config/.idea/fileTemplates/internal/Doctrine Entity Repository.php:
--------------------------------------------------------------------------------
1 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "orisai/coding-standard",
3 | "description": "Strict PHP coding standard",
4 | "keywords": [
5 | "dev",
6 | "coding standard",
7 | "orisai",
8 | "phpcs",
9 | "standards",
10 | "static analysis"
11 | ],
12 | "type": "library",
13 | "license": "MPL-2.0",
14 | "homepage": "https://github.com/orisai/coding-standard-php",
15 | "authors": [
16 | {
17 | "name": "Marek Bartoš",
18 | "homepage": "https://github.com/mabar"
19 | }
20 | ],
21 | "require": {
22 | "php": "7.4 - 8.4",
23 | "dealerdirect/phpcodesniffer-composer-installer": "^0.6.2 || ^0.7 || ^1.0",
24 | "slevomat/coding-standard": "^8.16.0",
25 | "squizlabs/php_codesniffer": "^3.12.0"
26 | },
27 | "minimum-stability": "dev",
28 | "prefer-stable": true,
29 | "config": {
30 | "sort-packages": true,
31 | "allow-plugins": {
32 | "dealerdirect/phpcodesniffer-composer-installer": true
33 | }
34 | }
35 | }
36 |
--------------------------------------------------------------------------------
/src/ruleset-7.4.xml:
--------------------------------------------------------------------------------
1 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
--------------------------------------------------------------------------------
/src/ruleset-8.0.xml:
--------------------------------------------------------------------------------
1 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
--------------------------------------------------------------------------------
/src/ruleset-8.1.xml:
--------------------------------------------------------------------------------
1 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
--------------------------------------------------------------------------------
/src/ruleset-8.2.xml:
--------------------------------------------------------------------------------
1 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
--------------------------------------------------------------------------------
/src/ruleset-8.3.xml:
--------------------------------------------------------------------------------
1 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
--------------------------------------------------------------------------------
/src/ruleset-8.4.xml:
--------------------------------------------------------------------------------
1 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
--------------------------------------------------------------------------------
/ide-config/.idea/php-code-style.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 | true
54 | true
55 |
56 |
57 |
58 |
59 |
60 | true
61 |
62 |
63 |
64 |
65 |
66 | true
67 | true
68 |
69 |
70 |
71 |
72 |
73 | true
74 |
75 |
76 |
77 |
78 |
79 | true
80 | true
81 |
82 |
83 |
84 |
85 |
86 | true
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
95 | true
96 |
97 |
98 |
99 |
100 | true
101 |
102 |
103 |
104 |
105 | true
106 |
107 |
108 |
109 |
110 |
111 |
112 |
113 | GETTERS_AND_SETTERS
114 | KEEP
115 |
116 |
117 |
118 |
119 |
120 |
121 | true
122 |
123 |
124 |
125 |
126 |
127 |
128 |
129 | true
130 |
131 |
132 |
133 |
134 |
135 |
136 |
137 |
138 | true
139 |
140 |
141 |
142 |
143 |
144 |
145 | true
146 |
147 |
148 |
149 |
150 |
151 |
152 | true
153 |
154 |
155 |
156 |
157 |
158 |
159 | true
160 |
161 |
162 |
163 |
164 |
165 |
166 | true
167 |
168 |
169 |
170 |
171 |
172 |
173 |
174 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 |
3 | All notable changes to this project will be documented in this file, in reverse chronological order by release.
4 |
5 | The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6 | and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7 |
8 | ## [Unreleased](https://github.com/orisai/coding-standard-php/compare/3.11.0...v3.x)
9 |
10 | ## [3.11.0](https://github.com/orisai/coding-standard-php/compare/3.10.3...3.11.0) - 2025-04-07
11 |
12 | ### Added
13 |
14 | - `SlevomatCodingStandard.TypeHints.ClassConstantTypeHint` sniff
15 | - require typed class constants on PHP 8.3+
16 |
17 | ### Changed
18 |
19 | - `slevomat/coding-standard` upgraded to `^8.16.0`
20 | - `squizlabs/php_codesniffer` upgraded to `^3.12.0`
21 | - Replaced `SlevomatCodingStandard.TypeHints.UnionTypeHintFormat` sniff with
22 | `SlevomatCodingStandard.TypeHints.DNFTypeHintFormat` sniff
23 |
24 | ### Removed
25 |
26 | - Support for PHP 7.2 and 7.3 (rulesets are still available for BC)
27 |
28 | ## [3.10.3](https://github.com/orisai/coding-standard-php/compare/3.10.2...3.10.3) - 2025-02-23
29 |
30 | ### Fixed
31 |
32 | - Compatibility with slevomat/coding-standard:^8.16.0
33 |
34 | ## [3.10.2](https://github.com/orisai/coding-standard-php/compare/3.10.1...3.10.2) - 2024-06-19
35 |
36 | ### Added
37 |
38 | - Support for PHP 8.4
39 |
40 | ### Removed
41 |
42 | - `SlevomatCodingStandard.Arrays.DisallowImplicitArrayCreation` - superseded by PHPStan (strict rules)
43 | - `Squiz.Commenting.FunctionComment.InvalidReturnVoid` - superseded by PHPStan
44 |
45 | ## [3.10.1](https://github.com/orisai/coding-standard-php/compare/3.10.0...3.10.1) - 2024-02-20
46 |
47 | ### Removed
48 |
49 | - `Squiz.Commenting.FunctionComment.MissingParamType` - superseded by PHPStan
50 |
51 | ## [3.10.0](https://github.com/orisai/coding-standard-php/compare/3.9.1...3.10.0) - 2023-12-10
52 |
53 | ### Added
54 |
55 | - Support for PHP 8.3
56 | - Rulesets for PHP 8.2 and 8.3
57 |
58 | ### Changed
59 |
60 | - `squizlabs/php_codesniffer` upgraded to `^3.8.0`
61 |
62 | ## [3.9.1](https://github.com/orisai/coding-standard-php/compare/3.9.0...3.9.1) - 2023-12-09
63 |
64 | ### Fixed
65 |
66 | - `JumpStatements` property `controlStructures` renamed to `jumpStatements`
67 | - Fixes `ERROR: Ruleset invalid. Property "controlStructures" does not exist on sniff SlevomatCodingStandard.ControlStructures.JumpStatementsSpacing`
68 |
69 | ## [3.9.0](https://github.com/orisai/coding-standard-php/compare/3.8.0...3.9.0) - 2023-10-14
70 |
71 | ### Added
72 |
73 | - `Generic.VersionControl.GitMergeConflict`
74 | - checks whether unresolved git conflict is in the file
75 | - `SlevomatCodingStandard.Functions.NamedArgumentSpacing`
76 | - checks spacing in named argument
77 |
78 | ### Changed
79 |
80 | - `slevomat/coding-standard` upgraded to `^8.14.0`
81 |
82 | ## [3.8.0](https://github.com/orisai/coding-standard-php/compare/3.7.1...3.8.0) - 2023-06-26
83 |
84 | ### Added
85 |
86 | - `SlevomatCodingStandard.Files.TypeNameMatchesFileName`
87 | - just to ensure match between file and (non fully qualified) class name
88 | - it can still be overridden by custom settings
89 |
90 | ### Removed
91 |
92 | - `Squiz.Commenting.FunctionComment.MissingParamName`
93 | - superseded by PHPStan
94 | - `SlevomatCodingStandard.ControlStructures.DisallowShortTernaryOperator`
95 | - superseded by PHPStan
96 |
97 | ## [3.7.1](https://github.com/orisai/coding-standard-php/compare/3.7.0...3.7.1) - 2023-06-08
98 |
99 | ### Removed
100 |
101 | - `PSR1.Classes.ClassDeclaration` sniff
102 | - superseded by optional `SlevomatCodingStandard.Files.TypeNameMatchesFileName` sniff
103 | - `Generic.PHP.DeprecatedFunctions`
104 | - use `phpstan/phpstan-deprecation-rules` instead
105 | - `SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingAnyTypeHint`
106 | - use `phpstan/phpstan` instead
107 |
108 | ## [3.7.0](https://github.com/orisai/coding-standard-php/compare/3.6.0...3.7.0) - 2023-05-14
109 |
110 | ### Added
111 |
112 | - `SlevomatCodingStandard.Arrays.ArrayAccess` sniff
113 |
114 | ### Changed
115 |
116 | - `slevomat/coding-standard` upgraded to `^8.12.0`
117 |
118 | ## [3.6.0](https://github.com/orisai/coding-standard-php/compare/3.5.0...3.6.0) - 2023-04-24
119 |
120 | ### Added
121 |
122 | - `SlevomatCodingStandard.Commenting.AnnotationName` sniff
123 |
124 | ### Changed
125 |
126 | - `slevomat/coding-standard` upgraded to `^8.11.0`
127 |
128 | ### Removed
129 |
130 | - `SlevomatCodingStandard.Functions.StrictCall`
131 | - Use `phpstan/phpstan-strict-rules` instead
132 |
133 | ## [3.5.0](https://github.com/orisai/coding-standard-php/compare/3.4.0...3.5.0) - 2023-04-10
134 |
135 | ### Added
136 |
137 | - `SlevomatCodingStandard.Classes.DisallowStringExpressionPropertyFetch` sniff
138 | - `SlevomatCodingStandard.Strings.DisallowVariableParsing` sniff
139 | - New Composer keywords to suggest --dev during require
140 | - Forbidden function aliases:
141 | - `diskfreespace()` -> `disk_free_space()`
142 | - `ftp_quit` -> `ftp_close`
143 | - `get_required_files` -> `get_included_files`
144 | - `gzputs` -> `gzwrite`
145 | - `ldap_close` -> `ldap_unbind`
146 | - `ldap_modify` -> `ldap_mod_replace`
147 | - `msgpack_pack` -> `msgpack_serialize`
148 | - `msgpack_unpack` -> `msgpack_unserialize`
149 | - `odbc_do` -> `odbc_exec`
150 | - `odbc_field_precision` -> `odbc_field_len`
151 | - `openssl_get_privatekey` -> `openssl_pkey_get_private`
152 | - `openssl_get_publickey` -> `openssl_pkey_get_public`
153 | - `imap_create` -> `imap_createmailbox`
154 | - `imap_fetchtext` -> `imap_body`
155 | - `imap_header` -> `imap_headerinfo`
156 | - `imap_listmailbox` -> `imap_list`
157 | - `imap_listsubscribed` -> `imap_lsub`
158 | - `imap_rename` -> `imap_renamemailbox`
159 | - `imap_scan` -> `imap_listscan`
160 | - `imap_scanmailbox` -> `imap_listscan`
161 | - `pcntl_errno` -> `pcntl_get_last_error`
162 | - `posix_errno` -> `posix_get_last_error`
163 | - `read_exif_data` -> `exif_read_data`
164 | - `session_commit` -> `session_write_close`
165 | - `set_file_buffer` -> `stream_set_write_buffer`
166 | - `socket_getopt` -> `socket_get_option`
167 | - `socket_setopt` -> `socket_set_option`
168 | - `srand` -> `mt_srand`
169 | - `user_error` -> `trigger_error`
170 |
171 | ### Changed
172 |
173 | - `slevomat/coding-standard` upgraded to `^8.10.0`
174 |
175 | ### Removed
176 |
177 | - `delete()` as an alias of `unset()`, because it does not exist
178 |
179 | ## [3.4.0](https://github.com/orisai/coding-standard-php/compare/3.3.5...3.4.0) - 2023-03-28
180 |
181 | ### Added
182 |
183 | - `SlevomatCodingStandard.Classes.EnumCaseSpacing` sniff
184 | - `SlevomatCodingStandard.Classes.RequireSelfReference` sniff
185 | - `SlevomatCodingStandard.ControlStructures.DisallowTrailingMultiLineTernaryOperator` sniff
186 |
187 | ### Changed
188 |
189 | - `slevomat/coding-standard` upgraded to `^8.9.0`
190 |
191 | ## [3.3.5](https://github.com/orisai/coding-standard-php/compare/3.3.4...3.3.5) - 2023-02-07
192 |
193 | ### Changed
194 |
195 | - Moved IntelliJ files from src/.idea to ide-config/.idea to prevent them being picked up by static analysis tools
196 |
197 | ## [3.3.4](https://github.com/orisai/coding-standard-php/compare/3.3.3...3.3.4) - 2022-12-12
198 |
199 | ### Removed
200 |
201 | - `Squiz.Commenting.VariableComment.VarOrder` error
202 | - redundant and colliding with
203 | superfluous `SlevomatCodingStandard.Commenting.DocCommentSpacing.IncorrectAnnotationsGroup`
204 |
205 | ## [3.3.3](https://github.com/orisai/coding-standard-php/compare/3.3.2...3.3.3) - 2022-12-09
206 |
207 | ### Changed
208 |
209 | - Composer
210 | - allows PHP 8.2
211 |
212 | ## [3.3.2](https://github.com/orisai/coding-standard-php/compare/3.3.1...3.3.2) - 2022-11-04
213 |
214 | ### Added
215 |
216 | - `SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration` allows `@var` above `return`
217 |
218 | ## [3.3.1](https://github.com/orisai/coding-standard-php/compare/3.3.0...3.3.1) - 2022-11-03
219 |
220 | ### Added
221 |
222 | - `SlevomatCodingStandard.Commenting.DocCommentSpacing` supports sorting of `assert`, `param-out`, `this-out`
223 | and `self-out` and their `phpstan-` and `psalm-` prefixed variants
224 |
225 | ### Removed
226 | - `Generic.Commenting.DocComment`
227 | - redundant functions of superfluous `Squiz.WhiteSpace.SuperfluousWhitespace` and `SlevomatCodingStandard.Commenting.DocCommentSpacing`
228 |
229 | ## [3.3.0](https://github.com/orisai/coding-standard-php/compare/3.2.1...3.3.0) - 2022-10-05
230 |
231 | ### Added
232 |
233 | - `SlevomatCodingStandard.Attributes.AttributeAndTargetSpacing` sniff
234 | - `SlevomatCodingStandard.Attributes.DisallowAttributesJoining` sniff
235 | - `SlevomatCodingStandard.Attributes.DisallowMultipleAttributesPerLine` sniff
236 | - `SlevomatCodingStandard.Attributes.RequireAttributeAfterDocComment` sniff
237 |
238 | ### Changed
239 |
240 | - `slevomat/coding-standard` upgraded to `^8.6.0`
241 |
242 | ## [3.2.1](https://github.com/orisai/coding-standard-php/compare/3.2.0...3.2.1) - 2022-10-05
243 |
244 | ### Changed
245 |
246 | - `SlevomatCodingStandard.Files.LineLength`
247 | - ignores comments
248 |
249 | ## [3.2.0](https://github.com/orisai/coding-standard-php/compare/3.1.2...3.2.0) - 2022-09-22
250 |
251 | ### Added
252 |
253 | - `SlevomatCodingStandard.PHP.RequireExplicitAssertion`
254 | - Option `enableIntegerRanges` is enabled
255 | - Option `enableAdvancedStringTypes` is enabled
256 |
257 | ### Changed
258 |
259 | - `slevomat/coding-standard` upgraded to `^8.5.0`
260 |
261 | ## [3.1.2](https://github.com/orisai/coding-standard-php/compare/3.1.1...3.1.2) - 2022-07-17
262 |
263 | ### Removed
264 |
265 | - `SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingAnyTypeHint`
266 | - use `phpstan/phpstan` instead
267 | - PHPStan does the same check *and* respects inheritance
268 | - `SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingAnyTypeHint`
269 | - use `phpstan/phpstan` instead
270 | - PHPStan does the same check *and* respects inheritance
271 |
272 | ## [3.1.1](https://github.com/orisai/coding-standard-php/compare/3.1.0...3.1.1) - 2022-07-10
273 |
274 | ### Removed
275 |
276 | - `SlevomatCodingStandard.Operators.DisallowEqualOperators` sniff
277 | - use `phpstan/phpstan-strict-rules` with bleeding edge instead
278 |
279 | ## [3.1.0](https://github.com/orisai/coding-standard-php/compare/3.0.0...3.1.0) - 2022-07-08
280 |
281 | ### Added
282 |
283 | - `SlevomatCodingStandard.Classes.BackedEnumTypeSpacing` sniff
284 | - Checks number of spaces before `:` and before type.
285 |
286 | ### Changed
287 |
288 | - `slevomat/coding-standard` upgraded to `^8.2.0`
289 | - `SlevomatCodingStandard.Classes.PropertyDeclaration` sniff
290 | - Checks promoted properties
291 | - Checks number of spaces between property modifiers
292 |
293 | ## [3.0.0](https://github.com/orisai/coding-standard-php/compare/2.4.1...3.0.0) - 2022-06-17
294 |
295 | ### Added
296 |
297 | - PHP 8.1 support
298 |
299 | ### Changed
300 |
301 | - `slevomat/coding-standard` upgraded to `^8.0.0`
302 |
303 | ### Removed
304 |
305 | - PHP 7.1 support
306 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Mozilla Public License Version 2.0
2 | ==================================
3 |
4 | 1. Definitions
5 | --------------
6 |
7 | 1.1. "Contributor"
8 | means each individual or legal entity that creates, contributes to
9 | the creation of, or owns Covered Software.
10 |
11 | 1.2. "Contributor Version"
12 | means the combination of the Contributions of others (if any) used
13 | by a Contributor and that particular Contributor's Contribution.
14 |
15 | 1.3. "Contribution"
16 | means Covered Software of a particular Contributor.
17 |
18 | 1.4. "Covered Software"
19 | means Source Code Form to which the initial Contributor has attached
20 | the notice in Exhibit A, the Executable Form of such Source Code
21 | Form, and Modifications of such Source Code Form, in each case
22 | including portions thereof.
23 |
24 | 1.5. "Incompatible With Secondary Licenses"
25 | means
26 |
27 | (a) that the initial Contributor has attached the notice described
28 | in Exhibit B to the Covered Software; or
29 |
30 | (b) that the Covered Software was made available under the terms of
31 | version 1.1 or earlier of the License, but not also under the
32 | terms of a Secondary License.
33 |
34 | 1.6. "Executable Form"
35 | means any form of the work other than Source Code Form.
36 |
37 | 1.7. "Larger Work"
38 | means a work that combines Covered Software with other material, in
39 | a separate file or files, that is not Covered Software.
40 |
41 | 1.8. "License"
42 | means this document.
43 |
44 | 1.9. "Licensable"
45 | means having the right to grant, to the maximum extent possible,
46 | whether at the time of the initial grant or subsequently, any and
47 | all of the rights conveyed by this License.
48 |
49 | 1.10. "Modifications"
50 | means any of the following:
51 |
52 | (a) any file in Source Code Form that results from an addition to,
53 | deletion from, or modification of the contents of Covered
54 | Software; or
55 |
56 | (b) any new file in Source Code Form that contains any Covered
57 | Software.
58 |
59 | 1.11. "Patent Claims" of a Contributor
60 | means any patent claim(s), including without limitation, method,
61 | process, and apparatus claims, in any patent Licensable by such
62 | Contributor that would be infringed, but for the grant of the
63 | License, by the making, using, selling, offering for sale, having
64 | made, import, or transfer of either its Contributions or its
65 | Contributor Version.
66 |
67 | 1.12. "Secondary License"
68 | means either the GNU General Public License, Version 2.0, the GNU
69 | Lesser General Public License, Version 2.1, the GNU Affero General
70 | Public License, Version 3.0, or any later versions of those
71 | licenses.
72 |
73 | 1.13. "Source Code Form"
74 | means the form of the work preferred for making modifications.
75 |
76 | 1.14. "You" (or "Your")
77 | means an individual or a legal entity exercising rights under this
78 | License. For legal entities, "You" includes any entity that
79 | controls, is controlled by, or is under common control with You. For
80 | purposes of this definition, "control" means (a) the power, direct
81 | or indirect, to cause the direction or management of such entity,
82 | whether by contract or otherwise, or (b) ownership of more than
83 | fifty percent (50%) of the outstanding shares or beneficial
84 | ownership of such entity.
85 |
86 | 2. License Grants and Conditions
87 | --------------------------------
88 |
89 | 2.1. Grants
90 |
91 | Each Contributor hereby grants You a world-wide, royalty-free,
92 | non-exclusive license:
93 |
94 | (a) under intellectual property rights (other than patent or trademark)
95 | Licensable by such Contributor to use, reproduce, make available,
96 | modify, display, perform, distribute, and otherwise exploit its
97 | Contributions, either on an unmodified basis, with Modifications, or
98 | as part of a Larger Work; and
99 |
100 | (b) under Patent Claims of such Contributor to make, use, sell, offer
101 | for sale, have made, import, and otherwise transfer either its
102 | Contributions or its Contributor Version.
103 |
104 | 2.2. Effective Date
105 |
106 | The licenses granted in Section 2.1 with respect to any Contribution
107 | become effective for each Contribution on the date the Contributor first
108 | distributes such Contribution.
109 |
110 | 2.3. Limitations on Grant Scope
111 |
112 | The licenses granted in this Section 2 are the only rights granted under
113 | this License. No additional rights or licenses will be implied from the
114 | distribution or licensing of Covered Software under this License.
115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a
116 | Contributor:
117 |
118 | (a) for any code that a Contributor has removed from Covered Software;
119 | or
120 |
121 | (b) for infringements caused by: (i) Your and any other third party's
122 | modifications of Covered Software, or (ii) the combination of its
123 | Contributions with other software (except as part of its Contributor
124 | Version); or
125 |
126 | (c) under Patent Claims infringed by Covered Software in the absence of
127 | its Contributions.
128 |
129 | This License does not grant any rights in the trademarks, service marks,
130 | or logos of any Contributor (except as may be necessary to comply with
131 | the notice requirements in Section 3.4).
132 |
133 | 2.4. Subsequent Licenses
134 |
135 | No Contributor makes additional grants as a result of Your choice to
136 | distribute the Covered Software under a subsequent version of this
137 | License (see Section 10.2) or under the terms of a Secondary License (if
138 | permitted under the terms of Section 3.3).
139 |
140 | 2.5. Representation
141 |
142 | Each Contributor represents that the Contributor believes its
143 | Contributions are its original creation(s) or it has sufficient rights
144 | to grant the rights to its Contributions conveyed by this License.
145 |
146 | 2.6. Fair Use
147 |
148 | This License is not intended to limit any rights You have under
149 | applicable copyright doctrines of fair use, fair dealing, or other
150 | equivalents.
151 |
152 | 2.7. Conditions
153 |
154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155 | in Section 2.1.
156 |
157 | 3. Responsibilities
158 | -------------------
159 |
160 | 3.1. Distribution of Source Form
161 |
162 | All distribution of Covered Software in Source Code Form, including any
163 | Modifications that You create or to which You contribute, must be under
164 | the terms of this License. You must inform recipients that the Source
165 | Code Form of the Covered Software is governed by the terms of this
166 | License, and how they can obtain a copy of this License. You may not
167 | attempt to alter or restrict the recipients' rights in the Source Code
168 | Form.
169 |
170 | 3.2. Distribution of Executable Form
171 |
172 | If You distribute Covered Software in Executable Form then:
173 |
174 | (a) such Covered Software must also be made available in Source Code
175 | Form, as described in Section 3.1, and You must inform recipients of
176 | the Executable Form how they can obtain a copy of such Source Code
177 | Form by reasonable means in a timely manner, at a charge no more
178 | than the cost of distribution to the recipient; and
179 |
180 | (b) You may distribute such Executable Form under the terms of this
181 | License, or sublicense it under different terms, provided that the
182 | license for the Executable Form does not attempt to limit or alter
183 | the recipients' rights in the Source Code Form under this License.
184 |
185 | 3.3. Distribution of a Larger Work
186 |
187 | You may create and distribute a Larger Work under terms of Your choice,
188 | provided that You also comply with the requirements of this License for
189 | the Covered Software. If the Larger Work is a combination of Covered
190 | Software with a work governed by one or more Secondary Licenses, and the
191 | Covered Software is not Incompatible With Secondary Licenses, this
192 | License permits You to additionally distribute such Covered Software
193 | under the terms of such Secondary License(s), so that the recipient of
194 | the Larger Work may, at their option, further distribute the Covered
195 | Software under the terms of either this License or such Secondary
196 | License(s).
197 |
198 | 3.4. Notices
199 |
200 | You may not remove or alter the substance of any license notices
201 | (including copyright notices, patent notices, disclaimers of warranty,
202 | or limitations of liability) contained within the Source Code Form of
203 | the Covered Software, except that You may alter any license notices to
204 | the extent required to remedy known factual inaccuracies.
205 |
206 | 3.5. Application of Additional Terms
207 |
208 | You may choose to offer, and to charge a fee for, warranty, support,
209 | indemnity or liability obligations to one or more recipients of Covered
210 | Software. However, You may do so only on Your own behalf, and not on
211 | behalf of any Contributor. You must make it absolutely clear that any
212 | such warranty, support, indemnity, or liability obligation is offered by
213 | You alone, and You hereby agree to indemnify every Contributor for any
214 | liability incurred by such Contributor as a result of warranty, support,
215 | indemnity or liability terms You offer. You may include additional
216 | disclaimers of warranty and limitations of liability specific to any
217 | jurisdiction.
218 |
219 | 4. Inability to Comply Due to Statute or Regulation
220 | ---------------------------------------------------
221 |
222 | If it is impossible for You to comply with any of the terms of this
223 | License with respect to some or all of the Covered Software due to
224 | statute, judicial order, or regulation then You must: (a) comply with
225 | the terms of this License to the maximum extent possible; and (b)
226 | describe the limitations and the code they affect. Such description must
227 | be placed in a text file included with all distributions of the Covered
228 | Software under this License. Except to the extent prohibited by statute
229 | or regulation, such description must be sufficiently detailed for a
230 | recipient of ordinary skill to be able to understand it.
231 |
232 | 5. Termination
233 | --------------
234 |
235 | 5.1. The rights granted under this License will terminate automatically
236 | if You fail to comply with any of its terms. However, if You become
237 | compliant, then the rights granted under this License from a particular
238 | Contributor are reinstated (a) provisionally, unless and until such
239 | Contributor explicitly and finally terminates Your grants, and (b) on an
240 | ongoing basis, if such Contributor fails to notify You of the
241 | non-compliance by some reasonable means prior to 60 days after You have
242 | come back into compliance. Moreover, Your grants from a particular
243 | Contributor are reinstated on an ongoing basis if such Contributor
244 | notifies You of the non-compliance by some reasonable means, this is the
245 | first time You have received notice of non-compliance with this License
246 | from such Contributor, and You become compliant prior to 30 days after
247 | Your receipt of the notice.
248 |
249 | 5.2. If You initiate litigation against any entity by asserting a patent
250 | infringement claim (excluding declaratory judgment actions,
251 | counter-claims, and cross-claims) alleging that a Contributor Version
252 | directly or indirectly infringes any patent, then the rights granted to
253 | You by any and all Contributors for the Covered Software under Section
254 | 2.1 of this License shall terminate.
255 |
256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257 | end user license agreements (excluding distributors and resellers) which
258 | have been validly granted by You or Your distributors under this License
259 | prior to termination shall survive termination.
260 |
261 | ************************************************************************
262 | * *
263 | * 6. Disclaimer of Warranty *
264 | * ------------------------- *
265 | * *
266 | * Covered Software is provided under this License on an "as is" *
267 | * basis, without warranty of any kind, either expressed, implied, or *
268 | * statutory, including, without limitation, warranties that the *
269 | * Covered Software is free of defects, merchantable, fit for a *
270 | * particular purpose or non-infringing. The entire risk as to the *
271 | * quality and performance of the Covered Software is with You. *
272 | * Should any Covered Software prove defective in any respect, You *
273 | * (not any Contributor) assume the cost of any necessary servicing, *
274 | * repair, or correction. This disclaimer of warranty constitutes an *
275 | * essential part of this License. No use of any Covered Software is *
276 | * authorized under this License except under this disclaimer. *
277 | * *
278 | ************************************************************************
279 |
280 | ************************************************************************
281 | * *
282 | * 7. Limitation of Liability *
283 | * -------------------------- *
284 | * *
285 | * Under no circumstances and under no legal theory, whether tort *
286 | * (including negligence), contract, or otherwise, shall any *
287 | * Contributor, or anyone who distributes Covered Software as *
288 | * permitted above, be liable to You for any direct, indirect, *
289 | * special, incidental, or consequential damages of any character *
290 | * including, without limitation, damages for lost profits, loss of *
291 | * goodwill, work stoppage, computer failure or malfunction, or any *
292 | * and all other commercial damages or losses, even if such party *
293 | * shall have been informed of the possibility of such damages. This *
294 | * limitation of liability shall not apply to liability for death or *
295 | * personal injury resulting from such party's negligence to the *
296 | * extent applicable law prohibits such limitation. Some *
297 | * jurisdictions do not allow the exclusion or limitation of *
298 | * incidental or consequential damages, so this exclusion and *
299 | * limitation may not apply to You. *
300 | * *
301 | ************************************************************************
302 |
303 | 8. Litigation
304 | -------------
305 |
306 | Any litigation relating to this License may be brought only in the
307 | courts of a jurisdiction where the defendant maintains its principal
308 | place of business and such litigation shall be governed by laws of that
309 | jurisdiction, without reference to its conflict-of-law provisions.
310 | Nothing in this Section shall prevent a party's ability to bring
311 | cross-claims or counter-claims.
312 |
313 | 9. Miscellaneous
314 | ----------------
315 |
316 | This License represents the complete agreement concerning the subject
317 | matter hereof. If any provision of this License is held to be
318 | unenforceable, such provision shall be reformed only to the extent
319 | necessary to make it enforceable. Any law or regulation which provides
320 | that the language of a contract shall be construed against the drafter
321 | shall not be used to construe this License against a Contributor.
322 |
323 | 10. Versions of the License
324 | ---------------------------
325 |
326 | 10.1. New Versions
327 |
328 | Mozilla Foundation is the license steward. Except as provided in Section
329 | 10.3, no one other than the license steward has the right to modify or
330 | publish new versions of this License. Each version will be given a
331 | distinguishing version number.
332 |
333 | 10.2. Effect of New Versions
334 |
335 | You may distribute the Covered Software under the terms of the version
336 | of the License under which You originally received the Covered Software,
337 | or under the terms of any subsequent version published by the license
338 | steward.
339 |
340 | 10.3. Modified Versions
341 |
342 | If you create software not governed by this License, and you want to
343 | create a new license for such software, you may create and use a
344 | modified version of this License if you rename the license and remove
345 | any references to the name of the license steward (except to note that
346 | such modified license differs from this License).
347 |
348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary
349 | Licenses
350 |
351 | If You choose to distribute Source Code Form that is Incompatible With
352 | Secondary Licenses under the terms of this version of the License, the
353 | notice described in Exhibit B of this License must be attached.
354 |
355 | Exhibit A - Source Code Form License Notice
356 | -------------------------------------------
357 |
358 | This Source Code Form is subject to the terms of the Mozilla Public
359 | License, v. 2.0. If a copy of the MPL was not distributed with this
360 | file, You can obtain one at http://mozilla.org/MPL/2.0/.
361 |
362 | If it is not possible or desirable to put the notice in a particular
363 | file, then You may include the notice in a location (such as a LICENSE
364 | file in a relevant directory) where a recipient would be likely to look
365 | for such a notice.
366 |
367 | You may add additional accurate notices of copyright ownership.
368 |
369 | Exhibit B - "Incompatible With Secondary Licenses" Notice
370 | ---------------------------------------------------------
371 |
372 | This Source Code Form is "Incompatible With Secondary Licenses", as
373 | defined by the Mozilla Public License, v. 2.0.
374 |
--------------------------------------------------------------------------------
/src/ruleset-base.xml:
--------------------------------------------------------------------------------
1 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
107 |
108 |
109 |
110 |
111 |
112 |
113 |
114 |
115 |
116 |
117 |
118 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
136 |
137 |
138 |
139 |
140 |
141 |
142 |
143 |
144 |
147 |
148 |
149 |
150 |
151 |
152 |
153 |
154 |
155 |
156 |
157 |
158 |
159 |
160 |
161 |
162 |
163 |
164 |
165 |
166 |
167 |
168 |
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 |
185 |
186 |
187 |
188 |
189 |
190 |
191 |
192 | Function has more @param annotations than params
193 |
194 |
195 | Exception type missing for @throws tag in function comment
196 |
197 |
198 |
199 |
200 |
201 |
202 |
203 |
204 |
205 |
206 |
207 |
208 |
209 |
210 |
211 |
222 |
273 |
281 |
289 |
293 |
297 |
298 |
299 |
300 |
301 |
302 |
303 |
304 |
305 |
306 |
307 |
308 |
309 |
310 |
311 |
312 |
313 |
314 |
315 |
316 |
317 |
318 |
319 |
320 |
321 |
322 |
323 |
324 |
325 |
326 |
327 |
328 |
329 |
330 |
331 |
332 |
333 |
334 |
335 |
336 |
337 |
338 |
339 |
340 |
343 |
344 |
345 |
346 |
347 |
350 |
351 |
352 |
353 |
354 |
355 |
356 |
357 |
358 |
359 |
360 | error
361 |
362 |
363 |
364 |
365 |
366 |
367 |
368 |
369 |
370 |
371 |
372 |
373 |
374 |
375 |
376 |
377 |
378 |
379 |
380 |
381 |
382 |
383 |
384 |
385 |
386 |
387 |
388 |
389 |
390 |
391 |
392 |
393 |
394 |
395 |
396 |
397 |
398 |
399 |
400 |
401 |
402 |
403 |
404 |
405 |
406 |
407 |
408 |
409 |
410 |
411 |
412 |
413 |
414 |
415 |
416 |
417 |
418 |
419 |
420 |
421 |
422 |
423 |
424 |
425 |
426 |
427 |
430 |
431 |
432 |
433 |
434 |
437 |
438 |
439 |
440 |
441 |
442 |
443 |
444 |
445 |
446 |
447 |
448 |
449 |
450 |
451 |
452 |
453 |
454 |
455 |
456 |
457 |
460 |
461 |
462 |
463 |
464 |
465 |
466 |
467 |
468 |
469 |
470 |
471 |
474 |
475 |
476 |
477 |
478 |
479 |
480 |
481 |
482 |
483 |
484 |
485 |
486 |
487 |
488 |
489 |
490 |
491 |
492 |
493 |
494 |
495 |
496 |
497 |
498 |
499 |
500 |
501 |
502 |
503 |
504 |
505 |
508 |
509 |
510 |
511 |
512 |
513 |
514 |
515 |
516 |
519 |
520 |
521 |
522 |
523 |
524 |
525 |
526 |
527 |
528 |
529 |
530 |
531 |
532 |
533 |
534 |
535 |
536 |
537 |
538 |
539 |
540 |
541 |
542 |
543 |
544 |
545 |
546 |
547 |
548 |
549 |
550 |
551 |
552 |
553 |
554 |
555 |
556 |
557 |
558 |
559 |
560 |
561 |
562 |
563 |
564 |
565 |
566 |
567 |
568 |
569 |
570 |
571 |
572 |
573 |
574 |
575 |
576 |
577 |
578 |
579 |
580 |
581 |
582 |
585 |
586 |
587 |
588 |
589 |
590 |
591 |
592 |
593 |
596 |
597 |
598 |
599 |
600 |
601 |
602 |
603 |
604 |
605 |
606 |
609 |
610 |
611 |
612 |
613 |
614 |
615 |
616 |
617 |
618 |
619 |
620 |
621 |
622 |
623 |
624 |
625 |
626 |
627 |
628 |
629 |
630 |
631 |
632 |
633 |
634 |
635 |
636 |
637 |
638 |
639 |
640 |
641 |
642 |
643 |
644 |
645 |
646 |
647 |
648 |
649 |
650 |
651 |
652 |
653 |
654 |
655 |
656 |
657 |
658 |
659 |
660 |
661 |
662 |
663 |
664 |
665 |
666 |
667 |
668 |
669 |
670 |
671 |
672 |
673 |
674 |
675 |
676 |
677 |
678 |
679 |
680 |
681 |
682 |
683 |
684 |
685 |
686 |
687 |
688 |
689 |
690 |
691 |
694 |
695 |
696 |
697 |
698 |
701 |
702 |
703 |
704 |
705 |
706 |
707 |
708 |
709 |
710 |
711 |
712 |
713 |
714 |
715 |
716 |
717 |
718 |
719 |
722 |
723 |
724 |
725 |
726 |
727 |
728 |
729 |
730 |
731 |
732 |
733 |
734 |
735 |
736 |
737 |
738 |
739 |
740 |
741 |
742 |
743 |
744 |
745 |
746 |
747 |
748 |
749 |
750 |
751 |
752 |
753 |
754 |
755 |
756 |
757 |
758 |
759 |
760 |
761 |
762 |
763 |
764 |
765 |
766 |
767 |
768 |
769 |
770 |
771 |
772 |
773 |
774 |
775 |
776 |
779 |
780 |
781 |
782 |
783 |
784 |
785 |
786 |
787 |
788 |
791 |
792 |
793 |
794 |
797 |
798 |
799 |
800 |
801 |
802 |
803 |
804 |
805 |
806 |
807 |
808 |
809 |
810 |
811 |
812 |
813 |
814 |
815 |
816 |
817 |
818 |
819 |
820 |
821 |
822 |
823 |
824 |
825 |
826 |
827 |
828 |
829 |
830 |
831 |
832 |
833 |
834 |
835 |
836 |
837 |
838 |
839 |
840 |
841 |
842 |
843 |
844 |
845 |
846 |
847 |
--------------------------------------------------------------------------------