/
TypeAlternationTransformer.php
134 lines (109 loc) · 3.52 KB
/
TypeAlternationTransformer.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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?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\Tokenizer\Transformer;
use PhpCsFixer\Tokenizer\AbstractTransformer;
use PhpCsFixer\Tokenizer\CT;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
/**
* Transform `|` operator into CT::T_TYPE_ALTERNATION in `function foo(Type1 | Type2 $x) {`
* or `} catch (ExceptionType1 | ExceptionType2 $e) {`.
*
* @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
*
* @internal
*/
final class TypeAlternationTransformer extends AbstractTransformer
{
/**
* {@inheritdoc}
*/
public function getPriority()
{
// needs to run after ArrayTypehintTransformer and TypeColonTransformer
return -15;
}
/**
* {@inheritdoc}
*/
public function getRequiredPhpVersionId()
{
return 70100;
}
/**
* {@inheritdoc}
*/
public function process(Tokens $tokens, Token $token, $index)
{
if (!$token->equals('|')) {
return;
}
$prevIndex = $tokens->getPrevMeaningfulToken($index);
if (!$tokens[$prevIndex]->isGivenKind([T_STRING, CT::T_ARRAY_TYPEHINT])) {
return;
}
do {
$prevIndex = $tokens->getPrevMeaningfulToken($prevIndex);
if (null === $prevIndex) {
return;
}
if (!$tokens[$prevIndex]->isGivenKind([T_NS_SEPARATOR, T_STRING])) {
break;
}
} while (true);
/** @var Token $prevToken */
$prevToken = $tokens[$prevIndex];
if ($prevToken->isGivenKind([
CT::T_TYPE_COLON, // `:` is part of a function return type `foo(): A`
CT::T_TYPE_ALTERNATION, // `|` is part of a union (chain) `X | Y`
T_STATIC, T_VAR, T_PUBLIC, T_PROTECTED, T_PRIVATE, // `var $a;`, `private $a` or `public static $a`
])) {
$this->replaceToken($tokens, $index);
return;
}
if (!$prevToken->equals('(')) {
return;
}
$prevPrevTokenIndex = $tokens->getPrevMeaningfulToken($prevIndex);
/** @var Token $prePrevToken */
$prePrevToken = $tokens[$prevPrevTokenIndex];
if ($prePrevToken->isGivenKind([
T_CATCH, // `|` is part of catch `catch(X |`
T_FUNCTION, // `|` is part of an anonymous function variable `static function (X|Y`
])) {
$this->replaceToken($tokens, $index);
return;
}
if (\PHP_VERSION_ID >= 70400 && $prePrevToken->isGivenKind(T_FN)) {
$this->replaceToken($tokens, $index); // `|` is part of an array function variable `fn(int|null`
return;
}
if (
$prePrevToken->isGivenKind(T_STRING)
&& $tokens[$tokens->getPrevMeaningfulToken($prevPrevTokenIndex)]->isGivenKind(T_FUNCTION)
) {
// `|` is part of function variable `function Foo (X|Y`
$this->replaceToken($tokens, $index);
return;
}
}
/**
* {@inheritdoc}
*/
public function getCustomTokens()
{
return [CT::T_TYPE_ALTERNATION];
}
private function replaceToken(Tokens $tokens, $index)
{
$tokens[$index] = new Token([CT::T_TYPE_ALTERNATION, '|']);
}
}