Rename PoolCounter_Stub to PoolCounterNull
[lhc/web/wiklou.git] / .phpcs.xml
1 <?xml version="1.0"?>
2 <ruleset name="MediaWiki">
3 <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
4 <exclude name="Generic.ControlStructures.InlineControlStructure" />
5 <exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
6 <exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
7 <exclude name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
8 <exclude name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
9 <exclude name="MediaWiki.Commenting.FunctionComment.ExtraParamComment" />
10 <exclude name="MediaWiki.Commenting.FunctionComment.WrongStyle" />
11 <exclude name="MediaWiki.Commenting.IllegalSingleLineComment.IllegalSingleLineCommentStart" />
12 <exclude name="MediaWiki.Commenting.IllegalSingleLineComment.IllegalSingleLineCommentEnd" />
13 <exclude name="MediaWiki.ControlStructures.AssignmentInControlStructures.AssignmentInControlStructures" />
14 <exclude name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
15 <exclude name="MediaWiki.Usage.DbrQueryUsage.DbrQueryFound" />
16 <exclude name="MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgContLang" />
17 <exclude name="MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgParser" />
18 <exclude name="MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgTitle" />
19 <exclude name="MediaWiki.Usage.ForbiddenFunctions.passthru" />
20 <exclude name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
21 <exclude name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.SingleSpaceBeforeSingleLineComment" />
22 <exclude name="Squiz.Scope.MethodScope.Missing" />
23 </rule>
24 <rule ref="MediaWiki.NamingConventions.PrefixedGlobalFunctions">
25 <properties>
26 <!--
27 includes/GlobalFunctions.php
28 * mimeTypeMatch
29 maintenance/cdb.php
30 * cdbShowHelp
31 maintenance/language/transstat.php
32 * showUsage
33 maintenance/mcc.php
34 * mccGetHelp
35 * mccShowUsage
36 maintenance/storage/moveToExternal.php
37 * moveToExternal
38 maintenance/storage/resolveStubs.php
39 * resolveStub
40 * resolveStubs
41 profileinfo.php
42 * compare_point
43 * getEscapedProfileUrl
44 tests/phpunit/includes/HooksTest.php
45 * NothingFunction
46 * NothingFunctionData
47 tests/qunit/data/styleTest.css.php
48 * cssfilter
49 -->
50 <property name="ignoreList" type="array" value="cdbShowHelp,compare_point,cssfilter,getEscapedProfileUrl,mccGetHelp,mccShowUsage,mimeTypeMatch,moveToExternal,NothingFunction,NothingFunctionData,resolveStub,resolveStubs,showUsage" />
51 </properties>
52 </rule>
53 <rule ref="MediaWiki.NamingConventions.ValidGlobalName">
54 <properties>
55 <property name="ignoreList" type="array" value="$IP,$messageMemc" />
56 </properties>
57 </rule>
58 <rule ref="MediaWiki.NamingConventions.ValidGlobalName.allowedPrefix">
59 <exclude-pattern>profileinfo\.php</exclude-pattern>
60 <exclude-pattern>maintenance/language/checkLanguage\.inc</exclude-pattern>
61 <exclude-pattern>maintenance/doMaintenance\.php</exclude-pattern>
62 <exclude-pattern>maintenance/mergeMessageFileList\.php</exclude-pattern>
63 <exclude-pattern>maintenance/commandLine\.inc</exclude-pattern>
64 </rule>
65 <rule ref="Generic.Files.LineLength">
66 <exclude-pattern>*/languages/messages/Messages*\.php</exclude-pattern>
67 </rule>
68 <rule ref="MediaWiki.Files.ClassMatchesFilename.NotMatch">
69 <!--
70 Whitelist existing violations, but enable the sniff to prevent
71 any new occurrences.
72 -->
73 <exclude-pattern>*/includes/Feed\.php</exclude-pattern>
74 <exclude-pattern>*/includes/installer/PhpBugTests\.php</exclude-pattern>
75 <exclude-pattern>*/includes/specials/SpecialMostinterwikis\.php</exclude-pattern>
76 <exclude-pattern>*/includes/compat/XMPReader\.php</exclude-pattern>
77 <exclude-pattern>*/includes/diff/DairikiDiff\.php</exclude-pattern>
78 <exclude-pattern>*/includes/specials/SpecialAncientpages\.php</exclude-pattern>
79 <exclude-pattern>*/includes/specials/SpecialBrokenRedirects\.php</exclude-pattern>
80 <exclude-pattern>*/includes/specials/SpecialConfirmemail\.php</exclude-pattern>
81 <exclude-pattern>*/includes/specials/SpecialDeadendpages\.php</exclude-pattern>
82 <exclude-pattern>*/includes/specials/SpecialDeletedContributions\.php</exclude-pattern>
83 <exclude-pattern>*/includes/specials/SpecialDoubleRedirects\.php</exclude-pattern>
84 <exclude-pattern>*/includes/specials/SpecialEmailInvalidate\.php</exclude-pattern>
85 <exclude-pattern>*/includes/specials/SpecialFewestrevisions\.php</exclude-pattern>
86 <exclude-pattern>*/includes/specials/SpecialFileDuplicateSearch\.php</exclude-pattern>
87 <exclude-pattern>*/includes/specials/SpecialLinkSearch\.php</exclude-pattern>
88 <exclude-pattern>*/includes/specials/SpecialListDuplicatedFiles\.php</exclude-pattern>
89 <exclude-pattern>*/includes/specials/SpecialListredirects\.php</exclude-pattern>
90 <exclude-pattern>*/includes/specials/SpecialLonelypages\.php</exclude-pattern>
91 <exclude-pattern>*/includes/specials/SpecialLongpages\.php</exclude-pattern>
92 <exclude-pattern>*/includes/specials/SpecialMIMEsearch\.php</exclude-pattern>
93 <exclude-pattern>*/includes/specials/SpecialMediaStatistics\.php</exclude-pattern>
94 <exclude-pattern>*/includes/specials/SpecialMostcategories\.php</exclude-pattern>
95 <exclude-pattern>*/includes/specials/SpecialMostimages\.php</exclude-pattern>
96 <exclude-pattern>*/includes/specials/SpecialMostlinked\.php</exclude-pattern>
97 <exclude-pattern>*/includes/specials/SpecialMostlinkedcategories\.php</exclude-pattern>
98 <exclude-pattern>*/includes/specials/SpecialMostlinkedtemplates\.php</exclude-pattern>
99 <exclude-pattern>*/includes/specials/SpecialMostrevisions\.php</exclude-pattern>
100 <exclude-pattern>*/includes/specials/SpecialMovepage\.php</exclude-pattern>
101 <exclude-pattern>*/includes/specials/SpecialNewimages\.php</exclude-pattern>
102 <exclude-pattern>*/includes/specials/SpecialRandompage\.php</exclude-pattern>
103 <exclude-pattern>*/includes/specials/SpecialShortpages\.php</exclude-pattern>
104 <exclude-pattern>*/includes/specials/SpecialUncategorizedcategories\.php</exclude-pattern>
105 <exclude-pattern>*/includes/specials/SpecialUncategorizedimages\.php</exclude-pattern>
106 <exclude-pattern>*/includes/specials/SpecialUncategorizedpages\.php</exclude-pattern>
107 <exclude-pattern>*/includes/specials/SpecialUncategorizedtemplates\.php</exclude-pattern>
108 <exclude-pattern>*/includes/specials/SpecialUnusedcategories\.php</exclude-pattern>
109 <exclude-pattern>*/includes/specials/SpecialUnusedimages\.php</exclude-pattern>
110 <exclude-pattern>*/includes/specials/SpecialUnusedtemplates\.php</exclude-pattern>
111 <exclude-pattern>*/includes/specials/SpecialUnwatchedpages\.php</exclude-pattern>
112 <exclude-pattern>*/includes/specials/SpecialUserrights\.php</exclude-pattern>
113 <exclude-pattern>*/includes/specials/SpecialWantedcategories\.php</exclude-pattern>
114 <exclude-pattern>*/includes/specials/SpecialWantedfiles\.php</exclude-pattern>
115 <exclude-pattern>*/includes/specials/SpecialWantedpages\.php</exclude-pattern>
116 <exclude-pattern>*/includes/specials/SpecialWantedtemplates\.php</exclude-pattern>
117 <exclude-pattern>*/includes/specials/SpecialWithoutinterwiki\.php</exclude-pattern>
118 <exclude-pattern>*/maintenance/7zip.inc</exclude-pattern>
119 <exclude-pattern>*/maintenance/CodeCleanerGlobalsPass.inc</exclude-pattern>
120 <exclude-pattern>*/maintenance/archives/upgradeLogging\.php</exclude-pattern>
121 <exclude-pattern>*/maintenance/benchmarks/bench_HTTP_HTTPS\.php</exclude-pattern>
122 <exclude-pattern>*/maintenance/benchmarks/bench_Wikimedia_base_convert\.php</exclude-pattern>
123 <exclude-pattern>*/maintenance/benchmarks/bench_delete_truncate\.php</exclude-pattern>
124 <exclude-pattern>*/maintenance/benchmarks/bench_if_switch\.php</exclude-pattern>
125 <exclude-pattern>*/maintenance/benchmarks/bench_utf8_title_check\.php</exclude-pattern>
126 <exclude-pattern>*/maintenance/benchmarks/bench_wfIsWindows\.php</exclude-pattern>
127 <exclude-pattern>*/maintenance/cleanupTable.inc</exclude-pattern>
128 <exclude-pattern>*/maintenance/cleanupTitles\.php</exclude-pattern>
129 <exclude-pattern>*/maintenance/commandLine.inc</exclude-pattern>
130 <exclude-pattern>*/maintenance/dumpTextPass\.php</exclude-pattern>
131 <exclude-pattern>*/maintenance/edit\.php</exclude-pattern>
132 <exclude-pattern>*/maintenance/findDeprecated\.php</exclude-pattern>
133 <exclude-pattern>*/maintenance/getText\.php</exclude-pattern>
134 <exclude-pattern>*/maintenance/hhvm/makeRepo\.php</exclude-pattern>
135 <exclude-pattern>*/maintenance/importDump\.php</exclude-pattern>
136 <exclude-pattern>*/maintenance/install\.php</exclude-pattern>
137 <exclude-pattern>*/maintenance/invalidateUserSessions\.php</exclude-pattern>
138 <exclude-pattern>*/maintenance/jsparse\.php</exclude-pattern>
139 <exclude-pattern>*/maintenance/lag\.php</exclude-pattern>
140 <exclude-pattern>*/maintenance/language/StatOutputs\.php</exclude-pattern>
141 <exclude-pattern>*/maintenance/language/checkLanguage.inc</exclude-pattern>
142 <exclude-pattern>*/maintenance/language/date-formats\.php</exclude-pattern>
143 <exclude-pattern>*/maintenance/language/languages.inc</exclude-pattern>
144 <exclude-pattern>*/maintenance/minify\.php</exclude-pattern>
145 <exclude-pattern>*/maintenance/mysql\.php</exclude-pattern>
146 <exclude-pattern>*/maintenance/parse\.php</exclude-pattern>
147 <exclude-pattern>*/maintenance/preprocessorFuzzTest\.php</exclude-pattern>
148 <exclude-pattern>*/maintenance/rebuildImages\.php</exclude-pattern>
149 <exclude-pattern>*/maintenance/renderDump\.php</exclude-pattern>
150 <exclude-pattern>*/maintenance/shell\.php</exclude-pattern>
151 <exclude-pattern>*/maintenance/sql\.php</exclude-pattern>
152 <exclude-pattern>*/maintenance/sqlite.inc</exclude-pattern>
153 <exclude-pattern>*/maintenance/sqlite\.php</exclude-pattern>
154 <exclude-pattern>*/maintenance/term/MWTerm\.php</exclude-pattern>
155 <exclude-pattern>*/maintenance/update\.php</exclude-pattern>
156 <exclude-pattern>*/maintenance/userDupes.inc</exclude-pattern>
157 <exclude-pattern>*/maintenance/userOptions\.php</exclude-pattern>
158 <exclude-pattern>*/maintenance/view\.php</exclude-pattern>
159 <exclude-pattern>*/profileinfo\.php</exclude-pattern>
160 <!-- Language converters use the pattern of 2 classes in one file -->
161 <exclude-pattern>*/languages/*\.php</exclude-pattern>
162 <!-- Skip violations in some tests for now -->
163 <exclude-pattern>*/tests/parser/*\.php</exclude-pattern>
164 <exclude-pattern>*/tests/phan/*\.php</exclude-pattern>
165 <exclude-pattern>*/tests/phpunit/maintenance/*\.php</exclude-pattern>
166 <exclude-pattern>*/tests/phpunit/bootstrap\.php</exclude-pattern>
167 <exclude-pattern>*/tests/phpunit/phpunit\.php</exclude-pattern>
168 </rule>
169 <rule ref="MediaWiki.Files.ClassMatchesFilename.WrongCase">
170 <!--
171 Whitelist existing violations, but enable the sniff to prevent
172 any new occurrences.
173 -->
174 <exclude-pattern>*/includes/specials/SpecialActiveusers\.php</exclude-pattern>
175 <exclude-pattern>*/includes/specials/SpecialBooksources\.php</exclude-pattern>
176 <exclude-pattern>*/includes/specials/SpecialEmailuser\.php</exclude-pattern>
177 <exclude-pattern>*/includes/specials/SpecialListfiles\.php</exclude-pattern>
178 <exclude-pattern>*/includes/specials/SpecialListgrants\.php</exclude-pattern>
179 <exclude-pattern>*/includes/specials/SpecialListgrouprights\.php</exclude-pattern>
180 <exclude-pattern>*/includes/specials/SpecialListusers.php</exclude-pattern>
181 <exclude-pattern>*/includes/specials/SpecialRecentchanges\.php</exclude-pattern>
182 <exclude-pattern>*/includes/specials/SpecialRecentchangeslinked\.php</exclude-pattern>
183 <exclude-pattern>*/includes/specials/SpecialRevisiondelete\.php</exclude-pattern>
184 <exclude-pattern>*/includes/specials/SpecialWhatlinkshere\.php</exclude-pattern>
185 <exclude-pattern>*/maintenance/language/alltrans\.php</exclude-pattern>
186 <exclude-pattern>*/maintenance/language/digit2html\.php</exclude-pattern>
187 <exclude-pattern>*/maintenance/language/langmemusage\.php</exclude-pattern>
188 <exclude-pattern>*/maintenance/mctest\.php</exclude-pattern>
189 <exclude-pattern>*/maintenance/mergeMessageFileList\.php</exclude-pattern>
190 <exclude-pattern>*/maintenance/mwdocgen\.php</exclude-pattern>
191 <exclude-pattern>*/maintenance/rebuildall\.php</exclude-pattern>
192 <exclude-pattern>*/maintenance/rebuildmessages\.php</exclude-pattern>
193 <exclude-pattern>*/maintenance/rebuildrecentchanges\.php</exclude-pattern>
194 <exclude-pattern>*/maintenance/rebuildtextindex\.php</exclude-pattern>
195 <exclude-pattern>*/maintenance/storage/checkStorage\.php</exclude-pattern>
196 <exclude-pattern>*/maintenance/storage/recompressTracked\.php</exclude-pattern>
197 <exclude-pattern>*/maintenance/storage/trackBlobs\.php</exclude-pattern>
198 <!-- Skip violations in some tests for now -->
199 <exclude-pattern>*/tests/phpunit/includes/GlobalFunctions/*\.php</exclude-pattern>
200 <exclude-pattern>*/tests/phpunit/maintenance/*\.php</exclude-pattern>
201 </rule>
202
203 <rule ref="Generic.Files.OneObjectStructurePerFile.MultipleFound">
204 <!--
205 Whitelist existing violations, but enable the sniff to prevent
206 any new occurrences.
207 -->
208 <exclude-pattern>*/includes/api/ApiErrorFormatter\.php</exclude-pattern>
209 <exclude-pattern>*/includes/api/ApiImport\.php</exclude-pattern>
210 <exclude-pattern>*/includes/api/ApiMessage\.php</exclude-pattern>
211 <exclude-pattern>*/includes/api/ApiOpenSearch\.php</exclude-pattern>
212 <exclude-pattern>*/includes/api/ApiRsd\.php</exclude-pattern>
213 <exclude-pattern>*/includes/compat/XMPReader\.php</exclude-pattern>
214 <exclude-pattern>*/includes/diff/DairikiDiff\.php</exclude-pattern>
215 <exclude-pattern>*/includes/Feed\.php</exclude-pattern>
216 <exclude-pattern>*/includes/filerepo/file/LocalFile\.php</exclude-pattern>
217 <exclude-pattern>*/includes/gallery/PackedOverlayImageGallery\.php</exclude-pattern>
218 <exclude-pattern>*/includes/HistoryBlob\.php</exclude-pattern>
219 <exclude-pattern>*/includes/htmlform/HTMLFormElement\.php</exclude-pattern>
220 <exclude-pattern>*/includes/libs/filebackend/FileBackendStore\.php</exclude-pattern>
221 <exclude-pattern>*/includes/libs/filebackend/FSFileBackend\.php</exclude-pattern>
222 <exclude-pattern>*/includes/libs/filebackend/SwiftFileBackend\.php</exclude-pattern>
223 <exclude-pattern>*/includes/logging/LogEntry\.php</exclude-pattern>
224 <exclude-pattern>*/includes/logging/LogFormatter\.php</exclude-pattern>
225 <exclude-pattern>*/includes/media/MediaTransformOutput\.php</exclude-pattern>
226 <exclude-pattern>*/includes/media/SVGMetadataExtractor\.php</exclude-pattern>
227 <exclude-pattern>*/includes/parser/Preprocessor_DOM\.php</exclude-pattern>
228 <exclude-pattern>*/includes/parser/Preprocessor_Hash\.php</exclude-pattern>
229 <exclude-pattern>*/includes/parser/Preprocessor\.php</exclude-pattern>
230 <exclude-pattern>*/includes/PathRouter\.php</exclude-pattern>
231 <exclude-pattern>*/includes/PrefixSearch\.php</exclude-pattern>
232 <exclude-pattern>*/includes/profiler/SectionProfiler\.php</exclude-pattern>
233 <exclude-pattern>*/includes/search/SearchEngine\.php</exclude-pattern>
234 <exclude-pattern>*/includes/specialpage/LoginSignupSpecialPage\.php</exclude-pattern>
235 <exclude-pattern>*/includes/specials/forms/PreferencesFormLegacy\.php</exclude-pattern>
236 <exclude-pattern>*/includes/StubObject\.php</exclude-pattern>
237 <exclude-pattern>*/includes/upload/UploadStash\.php</exclude-pattern>
238 <exclude-pattern>*/includes/utils/AutoloadGenerator\.php</exclude-pattern>
239 <exclude-pattern>*/maintenance/dumpIterator\.php</exclude-pattern>
240 <exclude-pattern>*/maintenance/Maintenance\.php</exclude-pattern>
241 <exclude-pattern>*/maintenance/findDeprecated\.php</exclude-pattern>
242 <exclude-pattern>*/maintenance/storage/recompressTracked\.php</exclude-pattern>
243 <exclude-pattern>*/maintenance/preprocessorFuzzTest\.php</exclude-pattern>
244 <exclude-pattern>*/maintenance/language/languages.inc</exclude-pattern>
245 <exclude-pattern>*/maintenance/language/StatOutputs\.php</exclude-pattern>
246 <exclude-pattern>*/maintenance/language/checkLanguage.inc</exclude-pattern>
247 <exclude-pattern>*/maintenance/language/generateCollationData\.php</exclude-pattern>
248 <exclude-pattern>*/maintenance/term/MWTerm\.php</exclude-pattern>
249 <!-- Language converters use the pattern of 2 classes in one file -->
250 <exclude-pattern>*/languages/*\.php</exclude-pattern>
251 <!-- We don't care that much about violations in tests -->
252 <exclude-pattern>*/tests/*\.php</exclude-pattern>
253 </rule>
254 <rule ref="PSR2.Methods.MethodDeclaration.Underscore">
255 <exclude-pattern>*/includes/StubObject\.php</exclude-pattern>
256 </rule>
257 <rule ref="MediaWiki.Usage.AssignmentInReturn.AssignmentInReturn">
258 <exclude-pattern>*/tests/phpunit/*\.php</exclude-pattern>
259 </rule>
260 <rule ref="MediaWiki.Usage.ForbiddenFunctions.escapeshellarg">
261 <!--
262 Whitelist existing violations, but enable the sniff to prevent
263 any new occurrences.
264 -->
265 <exclude-pattern>*/includes/libs/filebackend/FSFileBackend\.php</exclude-pattern>
266 <exclude-pattern>*/includes/shell/Command\.php</exclude-pattern>
267 <exclude-pattern>*/includes/shell/Shell\.php</exclude-pattern>
268 </rule>
269 <rule ref="MediaWiki.Usage.ForbiddenFunctions.popen">
270 <!--
271 Whitelist existing violations, but enable the sniff to prevent
272 any new occurrences.
273 -->
274 <exclude-pattern>*/includes/GlobalFunctions\.php</exclude-pattern>
275 <exclude-pattern>*/includes/libs/filebackend/FSFileBackend\.php</exclude-pattern>
276 <exclude-pattern>*/maintenance/7zip\.inc</exclude-pattern>
277 <exclude-pattern>*/maintenance/populateImageSha1\.php</exclude-pattern>
278 </rule>
279 <rule ref="MediaWiki.Usage.ForbiddenFunctions.proc_open">
280 <!--
281 Whitelist existing violations, but enable the sniff to prevent
282 any new occurrences.
283 -->
284 <exclude-pattern>includes/export/DumpPipeOutput\.php</exclude-pattern>
285 <exclude-pattern>includes/resourceloader/ResourceLoaderImage\.php</exclude-pattern>
286 <exclude-pattern>includes/shell/Command\.php</exclude-pattern>
287 <exclude-pattern>maintenance/dumpTextPass\.php</exclude-pattern>
288 <exclude-pattern>maintenance/mysql\.php</exclude-pattern>
289 <exclude-pattern>maintenance/storage/recompressTracked\.php</exclude-pattern>
290 <exclude-pattern>tests/parser/editTests\.php</exclude-pattern>
291 </rule>
292 <rule ref="MediaWiki.Usage.ForbiddenFunctions.shell_exec">
293 <!--
294 Whitelist existing violations, but enable the sniff to prevent
295 any new occurrences.
296 -->
297 <exclude-pattern>*/maintenance/mwdocgen\.php</exclude-pattern>
298 <exclude-pattern>*/maintenance/updateCredits\.php</exclude-pattern>
299 </rule>
300 <rule ref="MediaWiki.Usage.ForbiddenFunctions.system">
301 <!--
302 Whitelist existing violations, but enable the sniff to prevent
303 any new occurrences.
304 -->
305 <exclude-pattern>*/maintenance/mwdocgen\.php</exclude-pattern>
306 </rule>
307 <file>.</file>
308 <arg name="encoding" value="UTF-8"/>
309 <arg name="extensions" value="php,php5,inc,sample"/>
310 <exclude-pattern type="relative">^extensions/</exclude-pattern>
311 <exclude-pattern type="relative">^skins/</exclude-pattern>
312 <exclude-pattern>AdminSettings\.php</exclude-pattern>
313 <exclude-pattern>LocalSettings\.php</exclude-pattern>
314 </ruleset>