-
-
Notifications
You must be signed in to change notification settings - Fork 671
/
AbstractValuesAwareNode.php
263 lines (217 loc) · 6.15 KB
/
AbstractValuesAwareNode.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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<?php
declare(strict_types=1);
namespace Rector\BetterPhpDocParser\ValueObject\PhpDoc\DoctrineAnnotation;
use Nette\Utils\Strings;
use PHPStan\PhpDocParser\Ast\Node;
use PHPStan\PhpDocParser\Ast\NodeAttributes;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagValueNode;
use Rector\BetterPhpDocParser\ValueObject\PhpDocAttributeKey;
abstract class AbstractValuesAwareNode implements PhpDocTagValueNode
{
use NodeAttributes;
/**
* @var string
* @see https://regex101.com/r/H6JjOG/3
*/
private const UNQUOTED_VALUE_REGEX = '#^("|\')(?<content>.*?)("|\')$#';
protected bool $hasChanged = false;
/**
* @var mixed[]
*/
private array $originalValues = [];
/**
* @param mixed[] $values Must be public so node traverser can go through them
*/
public function __construct(
public array $values = [],
protected ?string $originalContent = null,
protected ?string $silentKey = null
) {
$this->originalValues = $values;
}
public function removeValue(string $key): void
{
$quotedKey = '"' . $key . '"';
// isset?
if (! isset($this->values[$key]) && ! isset($this->values[$quotedKey])) {
return;
}
unset($this->values[$key]);
unset($this->values[$quotedKey]);
// invoke reprint
$this->setAttribute(PhpDocAttributeKey::ORIG_NODE, null);
}
/**
* @return mixed[]
*/
public function getValues(): array
{
return $this->values;
}
/**
* @return mixed|Node|null
*/
public function getValue(string | int $key)
{
// to allow false as default
if (! array_key_exists($key, $this->values)) {
return null;
}
return $this->values[$key];
}
/**
* @param mixed $value
*/
public function changeValue(string $key, $value): void
{
// is quoted?
if (isset($this->values[$key]) && is_string($this->values[$key])) {
$isQuoted = (bool) Strings::match($this->values[$key], self::UNQUOTED_VALUE_REGEX);
if ($isQuoted) {
$value = '"' . $value . '"';
}
}
$this->values[$key] = $value;
// invoke reprint
$this->setAttribute(PhpDocAttributeKey::ORIG_NODE, null);
}
/**
* @return mixed|null
*/
public function getValueWithoutQuotes(string | int $key)
{
$value = $this->getValue($key);
if ($value === null) {
return null;
}
return $this->removeQuotes($value);
}
/**
* @param mixed $value
*/
public function changeSilentValue($value): void
{
// is quoted?
$isQuoted = (bool) Strings::match($this->values[0], self::UNQUOTED_VALUE_REGEX);
if ($isQuoted) {
$value = '"' . $value . '"';
}
$this->values[0] = $value;
$this->hasChanged = true;
// invoke reprint
$this->setAttribute(PhpDocAttributeKey::ORIG_NODE, null);
}
/**
* @return mixed|null
*/
public function getSilentValue()
{
$value = $this->values[0] ?? null;
if ($value === null) {
return null;
}
return $this->removeQuotes($value);
}
/**
* Useful for attributes
* @return array<int|string, mixed>
*/
public function getValuesWithExplicitSilentAndWithoutQuotes(): array
{
$explicitKeysValues = [];
foreach (array_keys($this->values) as $key) {
$valueWithoutQuotes = $this->getValueWithoutQuotes($key);
if (is_int($key) && $this->silentKey !== null) {
$explicitKeysValues[$this->silentKey] = $valueWithoutQuotes;
} else {
$explicitKeysValues[$this->removeQuotes($key)] = $valueWithoutQuotes;
}
}
return $explicitKeysValues;
}
public function markAsChanged(): void
{
$this->hasChanged = true;
}
/**
* @return mixed[]
*/
public function getOriginalValues(): array
{
return $this->originalValues;
}
/**
* @param mixed|string $value
* @return mixed|string
*/
protected function removeQuotes($value)
{
if (\is_array($value)) {
return $this->removeQuotesFromArray($value);
}
if (! is_string($value)) {
return $value;
}
$matches = Strings::match($value, self::UNQUOTED_VALUE_REGEX);
if ($matches === null) {
return $value;
}
return $matches['content'];
}
/**
* @param mixed[] $values
* @return array<int|string, mixed>
*/
protected function removeQuotesFromArray(array $values): array
{
$unquotedArray = [];
foreach ($values as $key => $value) {
$unquotedKey = $this->removeQuotes($key);
$unquotedValue = $this->removeQuotes($value);
$unquotedArray[$unquotedKey] = $unquotedValue;
}
return $unquotedArray;
}
/**
* @param mixed[] $values
*/
protected function printValuesContent(array $values): string
{
$itemContents = '';
$lastItemKey = array_key_last($values);
foreach ($values as $key => $value) {
if (is_int($key)) {
$itemContents .= $this->stringifyValue($value);
} else {
$itemContents .= $key . '=' . $this->stringifyValue($value);
}
if ($lastItemKey !== $key) {
$itemContents .= ', ';
}
}
return $itemContents;
}
/**
* @param mixed $value
*/
private function stringifyValue($value): string
{
// @todo resolve original casing
if ($value === false) {
return 'false';
}
if ($value === true) {
return 'true';
}
if (is_int($value)) {
return (string) $value;
}
if (is_float($value)) {
return (string) $value;
}
if (is_array($value)) {
return $this->printValuesContent($value);
}
return (string) $value;
}
}