-
Notifications
You must be signed in to change notification settings - Fork 2
/
ReadOnlySniff.php
80 lines (68 loc) · 1.88 KB
/
ReadOnlySniff.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
<?php
/**
* @author BaBeuloula
*/
declare(strict_types=1);
namespace BaBeuloula\PhpCS\Sniffs\CodeAnalysis;
use PHP_CodeSniffer\{
Files\File,
Sniffs\Sniff
};
/**
* Reorder readonly
*/
class ReadOnlySniff implements Sniff
{
protected const TOKEN_VISIBILITY = ['T_PUBLIC', 'T_PRIVATE', 'T_PROTECTED'];
/** @return int[] */
public function register(): array
{
return [T_READONLY];
}
/** @param int $stackPtr */
public function process(File $phpcsFile, $stackPtr): void
{
$previous = $phpcsFile->getTokens()[$stackPtr - 2];
$next = $phpcsFile->getTokens()[$stackPtr + 2];
if (true === \in_array($previous['type'], static::TOKEN_VISIBILITY, true)
|| 'T_STRING' === $next['type']
) {
return;
}
$isFixable = $phpcsFile->addFixableError(
'readonly must be after the property visibility.',
$stackPtr + 2,
'ReadOnlyAfterVisibility'
);
if (false === $isFixable) {
return;
}
$phpcsFile->fixer->beginChangeset();
$phpcsFile->fixer->replaceToken(
$stackPtr,
''
);
$phpcsFile->fixer->replaceToken(
$stackPtr + 1,
''
);
$phpcsFile->fixer->replaceToken(
$stackPtr + 2,
$this->getVisibility($next['type']) . ' readonly'
);
$phpcsFile->fixer->endChangeset();
}
protected function getVisibility(string $tokenVisibility): string
{
switch ($tokenVisibility) {
case 'T_PUBLIC':
return 'public';
case 'T_PRIVATE':
return 'private';
case 'T_PROTECTED':
return 'protected';
default:
throw new \InvalidArgumentException("Unknown visibility: $tokenVisibility.");
}
}
}