1 | <?php |
||
14 | class RedundantNullPropertyValueReview implements FileTool { |
||
15 | |||
16 | |||
17 | /** |
||
18 | * Return unique string of the tool |
||
19 | * You can set any name but we suggest to use following rules: |
||
20 | * - Allowed chars [a-z0-9_]+ |
||
21 | * - Review tools should have ending `_review` |
||
22 | * - Fixer tools should have ending `_fixer` |
||
23 | * |
||
24 | * @codeCoverageIgnore |
||
25 | * @return string |
||
26 | */ |
||
27 | public function getName() { |
||
30 | |||
31 | |||
32 | /** |
||
33 | * @return string |
||
34 | */ |
||
35 | public function getDescription() { |
||
38 | |||
39 | |||
40 | /** |
||
41 | * Check if we can process file by this tool |
||
42 | * Called before file process |
||
43 | * |
||
44 | * @param File $file |
||
45 | * @return boolean |
||
46 | */ |
||
47 | public function canProcess(File $file) { |
||
50 | |||
51 | |||
52 | /** |
||
53 | * @param File $file |
||
54 | * @param Report $report |
||
55 | */ |
||
56 | 4 | public function process(File $file, Report $report) { |
|
72 | |||
73 | } |
This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.
In this case you can add the
@ignore
PhpDoc annotation to the duplicate definition and it will be ignored.