SiteRouteResult.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Routing;
 
use Psr\Http\Message\UriInterface;
use ‪TYPO3\CMS\Core\Site\Entity\SiteInterface;
use ‪TYPO3\CMS\Core\Site\Entity\SiteLanguage;
 
class ‪SiteRouteResult implements ‪RouteResultInterface
{
    protected ‪$validProperties = ['uri', 'site', 'language', 'tail'];
 
    protected ‪$uri;
 
    protected ‪$site;
 
    protected ‪$language;
 
    protected ‪$data;
 
    protected ‪$tail;
 
    public function ‪__construct(UriInterface ‪$uri, ‪SiteInterface ‪$site, ‪SiteLanguage ‪$language = null, string ‪$tail = '', array ‪$data = [])
    {
        $this->uri = ‪$uri;
        $this->site = ‪$site;
        $this->language = ‪$language;
        $this->tail = ‪$tail;
        $this->data = ‪$data;
    }
 
    public function ‪getUri(): UriInterface
    {
        return ‪$this->uri;
    }
 
    public function ‪getSite(): ‪SiteInterface
    {
        return ‪$this->site;
    }
 
    public function ‪getLanguage(): ?‪SiteLanguage
    {
        return ‪$this->language;
    }
 
    public function ‪getTail(): string
    {
        return ‪$this->tail;
    }
 
    public function ‪offsetExists($offset): bool
    {
        return in_array($offset, $this->validProperties, true) || isset($this->data[$offset]);
    }
 
    public function ‪withLanguage(‪SiteLanguage ‪$language): self
    {
        $clone = clone $this;
        $clone->language = ‪$language;
 
        return $clone;
    }
 
    public function ‪offsetGet($offset): mixed
    {
        switch ($offset) {
            case 'uri':
                return ‪$this->uri;
            case 'site':
                return ‪$this->site;
            case 'language':
                return ‪$this->language;
            case 'tail':
                return ‪$this->tail;
            default:
                return $this->data[$offset];
        }
    }
 
    public function ‪offsetSet($offset, $value): void
    {
        switch ($offset) {
            case 'uri':
                throw new \InvalidArgumentException('You can never replace the URI in a route result', 1535462423);
            case 'site':
                throw new \InvalidArgumentException('You can never replace the Site object in a route result', 1535462454);
            case 'language':
                throw new \InvalidArgumentException('You can never replace the Language object in a route result', 1535462452);
            case 'tail':
                $this->tail = $value;
                break;
            default:
                $this->data[$offset] = $value;
        }
    }
 
    public function ‪offsetUnset($offset): void
    {
        switch ($offset) {
            case 'uri':
                throw new \InvalidArgumentException('You can never replace the URI in a route result', 1535462429);
            case 'site':
                throw new \InvalidArgumentException('You can never replace the Site object in a route result', 1535462458);
            case 'language':
                $this->language = null;
                break;
            case 'tail':
                $this->tail = '';
                break;
            default:
                unset($this->data[$offset]);
        }
    }
}