/
ForbiddenPublicPropertySniff.php
69 lines (57 loc) · 1.87 KB
/
ForbiddenPublicPropertySniff.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
<?php declare(strict_types=1);
namespace ObjectCalisthenics\Sniffs\Classes;
use Nette\Utils\Strings;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Util\Tokens;
use SlevomatCodingStandard\Helpers\PropertyHelper;
final class ForbiddenPublicPropertySniff implements Sniff
{
/**
* @var string
*/
private const ERROR_MESSAGE = 'Do not use public properties. Use method access instead.';
/**
* @return int[]
*/
public function register(): array
{
return [T_VARIABLE];
}
/**
* @param File $file
* @param int $position
*/
public function process(File $file, $position): void
{
if (! PropertyHelper::isProperty($file, $position)) {
return;
}
// skip Sniff classes, they have public properties for configuration (unfortunately)
if ($this->isSniffClass($file, $position)) {
return;
}
$scopeModifierToken = $this->getPropertyScopeModifier($file, $position);
if ($scopeModifierToken['code'] === T_PUBLIC) {
$file->addError(self::ERROR_MESSAGE, $position, self::class);
}
}
private function isSniffClass(File $file, int $position): bool
{
$classTokenPosition = (int) $file->findPrevious(T_CLASS, $position);
$classNameTokenPosition = $file->findNext(T_STRING, $classTokenPosition);
$classNameToken = $file->getTokens()[$classNameTokenPosition];
if (Strings::endsWith($classNameToken['content'], 'Sniff')) {
return true;
}
return false;
}
/**
* @return mixed[]
*/
private function getPropertyScopeModifier(File $file, int $position): array
{
$scopeModifierPosition = $file->findPrevious(Tokens::$scopeModifiers, ($position - 1));
return $file->getTokens()[$scopeModifierPosition];
}
}