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
|
<?php
declare(strict_types=1);
namespace Bakame\Http\StructuredFields;
use Bakame\Http\StructuredFields\Validation\Violation;
use DateTimeImmutable;
use DateTimeInterface;
/**
* Common manipulation methods used when interacting with an object
* with a Parameters instance attached to it.
*
* @phpstan-import-type SfType from StructuredFieldProvider
* @phpstan-import-type SfItemInput from StructuredFieldProvider
*/
trait ParameterAccess
{
/**
* Returns a copy of the associated parameter instance.
*/
public function parameters(): Parameters
{
return $this->parameters;
}
/**
* Returns the member value or null if no members value exists.
*
* @param ?callable(SfType): (bool|string) $validate
*
* @throws Violation if the validation fails
*
* @return SfType|null
*/
public function parameterByKey(
string $key,
?callable $validate = null,
bool|string $required = false,
Bytes|Token|DisplayString|DateTimeImmutable|string|int|float|bool|null $default = null
): Bytes|Token|DisplayString|DateTimeImmutable|string|int|float|bool|null {
return $this->parameters->valueByKey($key, $validate, $required, $default);
}
/**
* Returns the member value and key as pair or an empty array if no members value exists.
*
* @param ?callable(SfType, string): (bool|string) $validate
* @param array{0:string, 1:SfType}|array{} $default
*
* @throws Violation if the validation fails
*
* @return array{0:string, 1:SfType}|array{}
*/
public function parameterByIndex(
int $index,
?callable $validate = null,
bool|string $required = false,
array $default = []
): array {
return $this->parameters->valueByIndex($index, $validate, $required, $default);
}
/**
* Returns a new instance with the newly associated parameter instance.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified parameter change.
*/
abstract public function withParameters(Parameters $parameters): static;
/**
* Adds a member if its key is not present at the of the associated parameter instance or update the instance at the given key.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified parameter change.
*
* @param StructuredFieldProvider|Item|SfType $member
*
* @throws SyntaxError If the string key is not a valid
*/
public function addParameter(
string $key,
StructuredFieldProvider|Item|Token|Bytes|DisplayString|DateTimeInterface|string|int|float|bool $member
): static {
return $this->withParameters($this->parameters()->add($key, $member));
}
/**
* Adds a member at the start of the associated parameter instance and deletes any previous reference to the key if present.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified parameter change.
*
* @param StructuredFieldProvider|Item|SfType $member
*
* @throws SyntaxError If the string key is not a valid
*/
public function prependParameter(
string $key,
StructuredFieldProvider|Item|Token|Bytes|DisplayString|DateTimeInterface|string|int|float|bool $member
): static {
return $this->withParameters($this->parameters()->prepend($key, $member));
}
/**
* Adds a member at the end of the associated parameter instance and deletes any previous reference to the key if present.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified parameter change.
*
* @param StructuredFieldProvider|Item|SfType $member
*
* @throws SyntaxError If the string key is not a valid
*/
public function appendParameter(
string $key,
StructuredFieldProvider|Item|Token|Bytes|DisplayString|DateTimeInterface|string|int|float|bool $member
): static {
return $this->withParameters($this->parameters()->append($key, $member));
}
/**
* Removes all parameters members associated with the list of submitted keys in the associated parameter instance.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified parameter change.
*/
public function withoutAnyParameter(): static
{
return $this->withParameters(Parameters::new());
}
/**
* Inserts pair at the end of the member list.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified parameter change.
*
* @param array{0:string, 1:SfItemInput} ...$pairs
*/
public function pushParameters(array ...$pairs): static
{
return $this->withParameters($this->parameters()->push(...$pairs));
}
/**
* Inserts pair at the beginning of the member list.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified parameter change.
*
* @param array{0:string, 1:SfItemInput} ...$pairs
*/
public function unshiftParameters(array ...$pairs): static
{
return $this->withParameters($this->parameters()->unshift(...$pairs));
}
/**
* Delete member based on their key.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified parameter change.
*/
public function withoutParameterByKeys(string ...$keys): static
{
return $this->withParameters($this->parameters()->removeByKeys(...$keys));
}
/**
* Delete member based on their offsets.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified parameter change.
*/
public function withoutParameterByIndices(int ...$indices): static
{
return $this->withParameters($this->parameters()->removeByIndices(...$indices));
}
/**
* Inserts members at the specified index.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified parameter change.
*
* @param array{0:string, 1:SfType} ...$pairs
*/
public function insertParameters(int $index, array ...$pairs): static
{
return $this->withParameters($this->parameters()->insert($index, ...$pairs));
}
/**
* Replace the member at the specified index.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified parameter change.
*
* @param array{0:string, 1:SfType} $pair
*/
public function replaceParameter(int $index, array $pair): static
{
return $this->withParameters($this->parameters()->replace($index, $pair));
}
/**
* Sort the object parameters by value using a callback.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified parameter change.
*
* @param callable(array{0:string, 1:Item}, array{0:string, 1:Item}): int $callback
*/
public function sortParameters(callable $callback): static
{
return $this->withParameters($this->parameters()->sort($callback));
}
/**
* Filter the object parameters using a callback.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified parameter change.
*
* @param callable(array{0:string, 1:Item}, int): bool $callback
*/
public function filterParameters(callable $callback): static
{
return $this->withParameters($this->parameters()->filter($callback));
}
/**
* Merges multiple instances using iterable pairs.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified changes.
*
* @param StructuredFieldProvider|Parameters|Dictionary|iterable<array{0:string, 1:SfItemInput}> ...$others
*/
public function mergeParametersByPairs(...$others): static
{
return $this->withParameters($this->parameters()->mergePairs(...$others));
}
/**
* Merges multiple instances using iterable associative.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified changes.
*
* @param StructuredFieldProvider|Dictionary|Parameters|iterable<string, SfItemInput> ...$others
*/
public function mergeParametersByAssociative(...$others): static
{
return $this->withParameters($this->parameters()->mergeAssociative(...$others));
}
}
|
