Repository navigation
Expand file tree
/
Copy pathUriTemplate.php
More file actions
331 lines (292 loc) · 12.8 KB
/
Copy pathUriTemplate.php
File metadata and controls
331 lines (292 loc) · 12.8 KB
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
<?php
/**
* League.Uri (https://uri.thephpleague.com)
*
* (c) Ignace Nyamagana Butera <nyamsprod@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace League\Uri;
use BackedEnum;
use Deprecated;
use League\Uri\Contracts\UriException;
use League\Uri\Contracts\UriInterface;
use League\Uri\Exceptions\MissingFeature;
use League\Uri\Exceptions\SyntaxError;
use League\Uri\UriTemplate\ExtractionResult;
use League\Uri\UriTemplate\Template;
use League\Uri\UriTemplate\TemplateCanNotBeExpanded;
use League\Uri\UriTemplate\VariableBag;
use League\Uri\UriTemplate\VariableCanNotBeExtracted;
use Psr\Http\Message\UriFactoryInterface;
use Psr\Http\Message\UriInterface as Psr7UriInterface;
use Stringable;
use Uri\InvalidUriException;
use Uri\Rfc3986\Uri as Rfc3986Uri;
use Uri\WhatWg\InvalidUrlException;
use Uri\WhatWg\Url as WhatWgUrl;
use Uri\WhatWg\UrlValidationError;
use function array_fill_keys;
use function array_key_exists;
use function class_exists;
/**
* Defines the URI Template syntax and the process for expanding a URI Template into a URI reference.
*
* @link https://tools.ietf.org/html/rfc6570
* @package League\Uri
* @author Ignace Nyamagana Butera <nyamsprod@gmail.com>
* @since 6.1.0
*
* @phpstan-import-type InputValue from VariableBag
*/
final class UriTemplate implements Stringable
{
private readonly Template $template;
private readonly VariableBag $defaultVariables;
/**
* @throws SyntaxError if the template syntax is invalid
* @throws TemplateCanNotBeExpanded if the template or the variables are invalid
*/
public function __construct(BackedEnum|Stringable|string $template, iterable|ExtractionResult $defaultVariables = [])
{
$this->template = $template instanceof Template ? $template : Template::new($template);
$this->defaultVariables = $this->filterVariables($defaultVariables);
}
private function filterVariables(iterable|ExtractionResult $variables): VariableBag
{
if (!$variables instanceof VariableBag) {
$variables = new VariableBag($variables);
}
return $variables
->filter(fn ($value, string|int $name) => array_key_exists(
$name,
array_fill_keys($this->template->variableNames, 1)
));
}
/**
* Returns the string representation of the UriTemplate.
*/
public function __toString(): string
{
return $this->template->value;
}
/**
* Returns the distinct variables placeholders used in the template.
*
* @return array<string>
*/
public function getVariableNames(): array
{
return $this->template->variableNames;
}
/**
* @return array<string, InputValue>
*/
public function getDefaultVariables(): array
{
return iterator_to_array($this->defaultVariables);
}
/**
* Tells whether the UriTemplate contains variables.
*/
public function hasVariable(): bool
{
return 0 < count($this->template->variableNames);
}
/**
* Returns a new instance with the updated default variables.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the modified default variables.
*
* If present, variables whose name is not part of the current template
* possible variable names are removed.
*
* @throws TemplateCanNotBeExpanded if the variables are invalid
*/
public function withDefaultVariables(iterable|ExtractionResult $defaultVariables): self
{
$defaultVariables = $this->filterVariables($defaultVariables);
if ($this->defaultVariables->equals($defaultVariables)) {
return $this;
}
return new self($this->template, $defaultVariables);
}
private function templateExpanded(iterable|ExtractionResult $variables = []): string
{
return $this->template->expand($this->filterVariables($variables)->replace($this->defaultVariables));
}
private function templateExpandedOrFail(iterable|ExtractionResult $variables = []): string
{
return $this->template->expandOrFail($this->filterVariables($variables)->replace($this->defaultVariables));
}
/**
* @throws TemplateCanNotBeExpanded if the variables are invalid
* @throws UriException if the resulting expansion cannot be converted to a UriInterface instance
*/
public function expand(iterable|ExtractionResult $variables = [], Rfc3986Uri|WhatWgUrl|BackedEnum|Stringable|string|null $baseUri = null): UriInterface
{
$expanded = $this->templateExpanded($variables);
return null === $baseUri ? Uri::new($expanded) : (Uri::parse($expanded, $baseUri) ?? throw new SyntaxError('Unable to expand URI'));
}
/**
* @throws MissingFeature if no Uri\Rfc3986\Uri class is found
* @throws TemplateCanNotBeExpanded if the variables are invalid
* @throws InvalidUriException if the base URI cannot be converted to a Uri\Rfc3986\Uri instance
* @throws InvalidUriException if the resulting expansion cannot be converted to a Uri\Rfc3986\Uri instance
*/
public function expandToUri(iterable|ExtractionResult $variables = [], Rfc3986Uri|WhatWgUrl|BackedEnum|Stringable|string|null $baseUri = null): Rfc3986Uri
{
class_exists(Rfc3986Uri::class) || throw new MissingFeature('Support for '.Rfc3986Uri::class.' requires PHP8.5+ or a polyfill. Run "composer require league/uri-polyfill" or use you own polyfill.');
return new Rfc3986Uri($this->templateExpanded($variables), $this->newRfc3986Uri($baseUri));
}
/**
* @param list<UrlValidationError>|null $errors
*
* @throws TemplateCanNotBeExpanded if the variables are invalid
* @throws InvalidUrlException if the base URI cannot be converted to a Uri\Whatwg\Url instance
* @throws InvalidUrlException if the resulting expansion cannot be converted to a Uri\Whatwg\Url instance
* @throws MissingFeature if no Uri\Whatwg\Url class is found
*/
public function expandToUrl(iterable|ExtractionResult $variables = [], Rfc3986Uri|WhatWgUrl|BackedEnum|Stringable|string|null $baseUrl = null, array|null &$errors = []): WhatWgUrl
{
class_exists(WhatWgUrl::class) || throw new MissingFeature('Support for '.WhatWgUrl::class.' requires PHP8.5+ or a polyfill. Run "composer require league/uri-polyfill" or use you own polyfill.');
return new WhatWgUrl($this->templateExpanded($variables), $this->newWhatWgUrl($baseUrl), $errors);
}
/**
* @throws TemplateCanNotBeExpanded if the variables are invalid
* @throws UriException if the resulting expansion cannot be converted to a UriInterface instance
*/
public function expandToPsr7Uri(
iterable|ExtractionResult $variables = [],
Rfc3986Uri|WhatWgUrl|BackedEnum|Stringable|string|null $baseUrl = null,
UriFactoryInterface $uriFactory = new HttpFactory()
): Psr7UriInterface {
$expanded = $this->templateExpanded($variables);
return $uriFactory->createUri(
null === $baseUrl
? $expanded
: UriString::resolve($expanded, match (true) {
$baseUrl instanceof Rfc3986Uri => $baseUrl->toRawString(),
$baseUrl instanceof WhatWgUrl => $baseUrl->toUnicodeString(),
default => $baseUrl,
})
);
}
/**
* @throws TemplateCanNotBeExpanded if the variables are invalid or missing
* @throws UriException if the resulting expansion cannot be converted to a UriInterface instance
*/
public function expandOrFail(iterable|ExtractionResult $variables = [], Rfc3986Uri|WhatWgUrl|BackedEnum|Stringable|string|null $baseUri = null): UriInterface
{
$expanded = $this->templateExpandedOrFail($variables);
return null === $baseUri ? Uri::new($expanded) : (Uri::parse($expanded, $baseUri) ?? throw new SyntaxError('Unable to expand URI'));
}
/**
* @throws MissingFeature if no Uri\Rfc3986\Uri class is found
* @throws TemplateCanNotBeExpanded if the variables are invalid
* @throws InvalidUriException if the base URI cannot be converted to a Uri\Rfc3986\Uri instance
* @throws InvalidUriException if the resulting expansion cannot be converted to a Uri\Rfc3986\Uri instance
*/
public function expandToUriOrFail(iterable|ExtractionResult $variables = [], Rfc3986Uri|WhatWgUrl|BackedEnum|Stringable|string|null $baseUri = null): Rfc3986Uri
{
class_exists(Rfc3986Uri::class) || throw new MissingFeature('Support for '.Rfc3986Uri::class.' requires PHP8.5+ or a polyfill. Run "composer require league/uri-polyfill" or use you own polyfill.');
return new Rfc3986Uri($this->templateExpandedOrFail($variables), $this->newRfc3986Uri($baseUri));
}
/**
* @param list<UrlValidationError>|null $errors
*
* @throws MissingFeature if no Uri\Whatwg\Url class is found
* @throws TemplateCanNotBeExpanded if the variables are invalid
* @throws InvalidUrlException if the base URI cannot be converted to a Uri\Whatwg\Url instance
* @throws InvalidUrlException if the resulting expansion cannot be converted to a Uri\Whatwg\Url instance
*/
public function expandToUrlOrFail(iterable|ExtractionResult $variables = [], Rfc3986Uri|WhatWgUrl|BackedEnum|Stringable|string|null $baseUrl = null, array|null &$errors = []): WhatWgUrl
{
class_exists(WhatWgUrl::class) || throw new MissingFeature('Support for '.WhatWgUrl::class.' requires PHP8.5+ or a polyfill. Run "composer require league/uri-polyfill" or use you own polyfill.');
return new WhatWgUrl($this->templateExpandedOrFail($variables), $this->newWhatWgUrl($baseUrl), $errors);
}
/**
* @throws TemplateCanNotBeExpanded if the variables are invalid
* @throws UriException if the resulting expansion cannot be converted to a UriInterface instance
*/
public function expandToPsr7UriOrFail(
iterable|ExtractionResult $variables = [],
Rfc3986Uri|WhatWgUrl|BackedEnum|Stringable|string|null $baseUrl = null,
UriFactoryInterface $uriFactory = new HttpFactory()
): Psr7UriInterface {
$expanded = $this->templateExpandedOrFail($variables);
return $uriFactory->createUri(
null === $baseUrl
? $expanded
: UriString::resolve($expanded, match (true) {
$baseUrl instanceof Rfc3986Uri => $baseUrl->toRawString(),
$baseUrl instanceof WhatWgUrl => $baseUrl->toUnicodeString(),
default => $baseUrl,
})
);
}
/**
* @throws InvalidUrlException
*/
private function newWhatWgUrl(Rfc3986Uri|WhatWgUrl|BackedEnum|Stringable|string|null $url = null): ?WhatWgUrl
{
return match (true) {
null === $url => null,
$url instanceof WhatWgUrl => $url,
$url instanceof Rfc3986Uri => new WhatWgUrl($url->toRawString()),
$url instanceof BackedEnum => new WhatWgUrl((string) $url->value),
default => new WhatWgUrl((string) $url),
};
}
/**
* @throws InvalidUriException
*/
private function newRfc3986Uri(Rfc3986Uri|WhatWgUrl|BackedEnum|Stringable|string|null $uri = null): ?Rfc3986Uri
{
return match (true) {
null === $uri => null,
$uri instanceof Rfc3986Uri => $uri,
$uri instanceof WhatWgUrl => new Rfc3986Uri($uri->toAsciiString()),
$uri instanceof BackedEnum => new Rfc3986Uri((string) $uri->value),
default => new Rfc3986Uri((string) $uri),
};
}
/**
* Extracts the variables from a URI using the template.
*/
public function extract(Rfc3986Uri|WhatWgUrl|BackedEnum|Stringable|string $uri): ExtractionResult
{
return $this->template->extract($uri);
}
/**
* @throws VariableCanNotBeExtracted if the URI cannot be extracted using the template
*/
public function extractOrFail(Rfc3986Uri|WhatWgUrl|BackedEnum|Stringable|string $uri): ExtractionResult
{
return $this->template->extractOrFail($uri);
}
/**
* Returns whether the URI matches the template.
*/
public function match(Rfc3986Uri|WhatWgUrl|BackedEnum|Stringable|string $uri): bool
{
return $this->template->match($uri);
}
/**
* DEPRECATION WARNING! This method will be removed in the next major point release.
*
* @deprecated Since version 7.6.0
* @codeCoverageIgnore
* @see UriTemplate::toString()
*
* Create a new instance from the environment.
*/
#[Deprecated(message:'use League\Uri\UriTemplate::__toString() instead', since:'league/uri:7.6.0')]
public function getTemplate(): string
{
return $this->__toString();
}
}