D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
proc
/
self
/
root
/
usr
/
local
/
psa
/
admin
/
plib
/
modules
/
grafana
/
vendor
/
league
/
uri
/
Filename :
UriTemplate.php
back
Copy
<?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 PleskGrafana\League\Uri; use PleskGrafana\League\Uri\Contracts\UriException; use PleskGrafana\League\Uri\Contracts\UriInterface; use PleskGrafana\League\Uri\Exceptions\SyntaxError; use PleskGrafana\League\Uri\UriTemplate\Template; use PleskGrafana\League\Uri\UriTemplate\TemplateCanNotBeExpanded; use PleskGrafana\League\Uri\UriTemplate\VariableBag; use Stringable; use function array_fill_keys; use function array_key_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 */ final class UriTemplate { 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(Stringable|string $template, iterable $defaultVariables = []) { $this->template = $template instanceof Template ? $template : Template::new($template); $this->defaultVariables = $this->filterVariables($defaultVariables); } private function filterVariables(iterable $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))); } public function getTemplate() : string { return $this->template->value; } /** * @return array<string> */ public function getVariableNames() : array { return $this->template->variableNames; } public function getDefaultVariables() : array { return \iterator_to_array($this->defaultVariables); } /** * 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 $defaultVariables) : self { $defaultVariables = $this->filterVariables($defaultVariables); if ($defaultVariables == $this->defaultVariables) { return $this; } return new self($this->template, $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 $variables = []) : UriInterface { return Uri::new($this->template->expand($this->filterVariables($variables)->replace($this->defaultVariables))); } /** * @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 $variables = []) : UriInterface { return Uri::new($this->template->expandOrFail($this->filterVariables($variables)->replace($this->defaultVariables))); } }