132 lines
3.9 KiB
PHP
132 lines
3.9 KiB
PHP
<?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 League\Uri\Contracts\UriException;
|
|
use League\Uri\Contracts\UriInterface;
|
|
use League\Uri\Exceptions\SyntaxError;
|
|
use League\Uri\Exceptions\TemplateCanNotBeExpanded;
|
|
use League\Uri\UriTemplate\Template;
|
|
use League\Uri\UriTemplate\VariableBag;
|
|
use Stringable;
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* Based on GuzzleHttp\UriTemplate class in Guzzle v6.5.
|
|
* @link https://github.com/guzzle/guzzle/blob/6.5/src/UriTemplate.php
|
|
*/
|
|
final class UriTemplate
|
|
{
|
|
public readonly Template $template;
|
|
public readonly VariableBag $defaultVariables;
|
|
|
|
/**
|
|
* @throws SyntaxError if the template syntax is invalid
|
|
* @throws TemplateCanNotBeExpanded if the template variables are invalid
|
|
*/
|
|
public function __construct(Template|Stringable|string $template, VariableBag|array $defaultVariables = [])
|
|
{
|
|
$this->template = $template instanceof Template ? $template : Template::createFromString($template);
|
|
$this->defaultVariables = $this->filterVariables($defaultVariables);
|
|
}
|
|
|
|
public static function __set_state(array $properties): self
|
|
{
|
|
return new self($properties['template'], $properties['defaultVariables']);
|
|
}
|
|
|
|
/**
|
|
* Filters out variables for the given template.
|
|
*
|
|
* @param array<string,string|array<string>> $variables
|
|
*/
|
|
private function filterVariables(VariableBag|array $variables): VariableBag
|
|
{
|
|
return array_reduce(
|
|
$this->template->variableNames,
|
|
function (VariableBag $curry, string $name) use ($variables): VariableBag {
|
|
if (isset($variables[$name])) {
|
|
$curry[$name] = $variables[$name];
|
|
}
|
|
|
|
return $curry;
|
|
},
|
|
new VariableBag()
|
|
);
|
|
}
|
|
|
|
/**
|
|
* The template string.
|
|
*/
|
|
public function getTemplate(): string
|
|
{
|
|
return $this->template->value;
|
|
}
|
|
|
|
/**
|
|
* Returns the names of the variables in the template, in order.
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public function getVariableNames(): array
|
|
{
|
|
return $this->template->variableNames;
|
|
}
|
|
|
|
/**
|
|
* Returns the default values used to expand the template.
|
|
*
|
|
* The returned list only contains variables whose name is part of the current template.
|
|
*
|
|
* @return array<string,string|array>
|
|
*/
|
|
public function getDefaultVariables(): array
|
|
{
|
|
return $this->defaultVariables->all();
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
public function withDefaultVariables(VariableBag|array $defaultDefaultVariables): self
|
|
{
|
|
return new self($this->template, $defaultDefaultVariables);
|
|
}
|
|
|
|
/**
|
|
* @throws TemplateCanNotBeExpanded if the variable contains nested array values
|
|
* @throws UriException if the resulting expansion can not be converted to a UriInterface instance
|
|
*/
|
|
public function expand(VariableBag|array $variables = []): UriInterface
|
|
{
|
|
return Uri::createFromString(
|
|
$this->template->expand(
|
|
$this->filterVariables($variables)->replace($this->defaultVariables)
|
|
)
|
|
);
|
|
}
|
|
}
|