URLBuilder.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI;

use ILIAS\Data\URI;

class URLBuilder
{
    public const URL_MAX_LENGTH = 2048;
    public const SEPARATOR = '_';
    private URI $uri;
    private ?string $fragment = null;
    private array $params = [];
    private array $tokens = [];

    public function __construct(URI $uri)
    {
        $this->uri = $uri;
    }

    public function withURI(URI $uri): self
    {
        $clone = clone $this;
        $clone->uri = $uri;
        return $clone;
    }

    public function withFragment(?string $fragment): self
    {
        $clone = clone $this;
        $clone->fragment = $fragment;
        return $clone;
    }

    public function acquireParameter(array $namespace, string $name, ?string $initial_value = null): array
    {
        if ($name === '' || empty($namespace)) {
            throw new \InvalidArgumentException("Parameter name or namespace not set");
        }

        $parameter = implode(self::SEPARATOR, $namespace) . self::SEPARATOR . $name;
        if ($this->parameterExists($parameter)) {
            throw new \ilException("Parameter '" . $parameter . "' already reserved in URL");
        }

        $token = new URLBuilderToken($namespace, $name);
        $clone = clone $this;
        $clone->params[$parameter] = ($initial_value) ?? '';
        $clone->tokens[$parameter] = $token;

        return [$clone, $token];
    }

    public function acquireParameters(array $namespace, string ...$names): array
    {
        $tokens = [];
        $builder = $this;
        foreach ($names as $name) {
            list($builder, $token) = $builder->acquireParameter($namespace, $name);
            $tokens[] = $token;
        }
        array_unshift($tokens, $builder);
        return $tokens;
    }

    public function deleteParameter(URLBuilderToken $token): self
    {
        $this->checkToken($token);
        $clone = clone $this;
        unset($clone->params[$token->getName()]);
        unset($clone->tokens[$token->getName()]);

        return $clone;
    }

    public function withParameter(URLBuilderToken $token, string|array $value): self
    {
        $this->checkToken($token);
        $clone = clone $this;
        $clone->params[$token->getName()] = $value;

        return $clone;
    }

    public function renderTokens(array $tokens): string
    {
        $token_render = [];
        foreach ($tokens as $token) {
            $token_render[] = '["' . $token->getName() . '",' . $token->render() . ']';
        }
        $output = 'new Map([' . implode(',', $token_render) . '])';
        return $output;
    }

    public function renderObject(array $tokens): string
    {
        $output = 'new il.UI.core.URLBuilder(new URL("' . $this->buildURI() . '"), ' . $this->renderTokens($tokens) . ')';
        return $output;
    }

    public function buildURI(): URI
    {
        $uri = new URI($this->uri->getBaseURI() . $this->buildQuery() . $this->buildFragment());
        $this->checkLength($uri);
        return $uri;
    }

    private function buildQuery(): string
    {
        $params = array_merge($this->uri->getParameters(), $this->params);
        $query = (! empty($params)) ? '?' . http_build_query($params) : '';
        $query = preg_replace('/%5B[0-9]+%5D/simU', '%5B%5D', $query);
        return $query;
    }

    private function buildFragment(): string
    {
        if ($this->fragment !== null) {
            return ($this->fragment !== '') ? '#' . $this->fragment : '';
        }
        $fragment = ($this->uri->getFragment()) ? '#' . $this->uri->getFragment() : '';
        return $fragment;
    }

    private function parameterExists(string $name): bool
    {
        return array_key_exists($name, $this->params);
    }

    private function checkToken(URLBuilderToken $token): void
    {
        if (! in_array($token, $this->tokens)
        || $this->tokens[$token->getName()]->getToken() !== $token->getToken()) {
            throw new \DomainException("Token for '" . $token->getName() . "' is not valid");
        }
        if (! $this->parameterExists($token->getName())) {
            throw new \ilException("Parameter '" . $token->getName() . "' does not exist in URL");
        }
    }

    private function checkLength(URI $uri): void
    {
        if (! (strlen((string) $uri) <= self::URL_MAX_LENGTH)) {
            throw new \LengthException("The final URL is longer than " . self::URL_MAX_LENGTH . " and will not be valid.");
        }
    }
}