-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
PhpdocNoEmptyReturnFixer.php
113 lines (100 loc) · 2.61 KB
/
PhpdocNoEmptyReturnFixer.php
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
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
<?php
/*
* This file is part of PHP CS Fixer.
*
* (c) Fabien Potencier <fabien@symfony.com>
* Dariusz Rumiński <dariusz.ruminski@gmail.com>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace PhpCsFixer\Fixer\Phpdoc;
use PhpCsFixer\AbstractFixer;
use PhpCsFixer\DocBlock\Annotation;
use PhpCsFixer\DocBlock\DocBlock;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
/**
* @author Graham Campbell <graham@alt-three.com>
*/
final class PhpdocNoEmptyReturnFixer extends AbstractFixer
{
/**
* {@inheritdoc}
*/
public function isCandidate(Tokens $tokens)
{
return $tokens->isTokenKindFound(T_DOC_COMMENT);
}
/**
* {@inheritdoc}
*/
public function getDefinition()
{
return new FixerDefinition(
'`@return void` and `@return null` annotations should be omitted from PHPDoc.',
[
new CodeSample(
'<?php
/**
* @return null
*/
function foo() {}
'
),
new CodeSample(
'<?php
/**
* @return void
*/
function foo() {}
'
),
]
);
}
/**
* {@inheritdoc}
*/
public function getPriority()
{
// must be run before the PhpdocSeparationFixer, PhpdocOrderFixer
// must be run after the PhpdocAddMissingParamAnnotationFixer
return 10;
}
/**
* {@inheritdoc}
*/
protected function applyFix(\SplFileInfo $file, Tokens $tokens)
{
foreach ($tokens as $index => $token) {
if (!$token->isGivenKind(T_DOC_COMMENT)) {
continue;
}
$doc = new DocBlock($token->getContent());
$annotations = $doc->getAnnotationsOfType('return');
if (empty($annotations)) {
continue;
}
foreach ($annotations as $annotation) {
$this->fixAnnotation($doc, $annotation);
}
$tokens[$index] = new Token([T_DOC_COMMENT, $doc->getContent()]);
}
}
/**
* Remove return void or return null annotations..
*
* @param DocBlock $doc
* @param Annotation $annotation
*/
private function fixAnnotation(DocBlock $doc, Annotation $annotation)
{
$types = $annotation->getNormalizedTypes();
if (1 === count($types) && ('null' === $types[0] || 'void' === $types[0])) {
$annotation->remove();
}
}
}