|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Funivan\Cs\Tools\Php\RedundantNullPropertyValue; |
|
4
|
|
|
|
|
5
|
|
|
use Funivan\Cs\FileTool\FileTool; |
|
6
|
|
|
use Funivan\Cs\Fs\File; |
|
7
|
|
|
use Funivan\Cs\Fs\FileFilter; |
|
8
|
|
|
use Funivan\Cs\Report\Report; |
|
9
|
|
|
use Funivan\PhpTokenizer\Collection; |
|
10
|
|
|
|
|
11
|
|
|
/** |
|
12
|
|
|
* |
|
13
|
|
|
*/ |
|
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() { |
|
28
|
|
|
return 'redundant_null_property_value_review'; |
|
29
|
|
|
} |
|
30
|
|
|
|
|
31
|
|
|
|
|
32
|
|
|
/** |
|
33
|
|
|
* @return string |
|
34
|
|
|
*/ |
|
35
|
|
|
public function getDescription() { |
|
36
|
|
|
return 'Detect properties defined with null values'; |
|
37
|
|
|
} |
|
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) { |
|
48
|
|
|
return (new FileFilter($file))->notDeleted()->extension(['php'])->isValid($file); |
|
|
|
|
|
|
49
|
|
|
} |
|
50
|
|
|
|
|
51
|
|
|
|
|
52
|
|
|
/** |
|
53
|
|
|
* @param File $file |
|
54
|
|
|
* @param Report $report |
|
55
|
|
|
*/ |
|
56
|
4 |
|
public function process(File $file, Report $report) { |
|
57
|
4 |
|
$collection = Collection::createFromString($file->getContent()->get()); |
|
58
|
|
|
|
|
59
|
|
|
|
|
60
|
4 |
|
$invalidProperties = InvalidPropertyFinder::find($collection); |
|
61
|
4 |
|
if (count($invalidProperties) == 0) { |
|
62
|
2 |
|
return; |
|
63
|
|
|
} |
|
64
|
|
|
|
|
65
|
|
|
|
|
66
|
2 |
|
foreach ($invalidProperties as $property) { |
|
67
|
2 |
|
$variable = $property->getVariable(); |
|
68
|
2 |
|
$report->addMessage($file, $this, 'Invalid property. Redundant NULL value for the property: '.$variable->getValue(), $variable->getLine()); |
|
69
|
|
|
} |
|
70
|
|
|
|
|
71
|
2 |
|
} |
|
72
|
|
|
|
|
73
|
|
|
} |
funivan /
Cs
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
@ignorePhpDoc annotation to the duplicate definition and it will be ignored.