ServerRequest.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\Http;
 
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UploadedFileInterface;
use Psr\Http\Message\UriInterface;
 
class ‪ServerRequest extends ‪Request implements ServerRequestInterface
{
    protected array ‪$attributes = [];
    protected array ‪$cookieParams = [];
    protected array ‪$queryParams = [];
    protected array ‪$serverParams = [];
    protected array ‪$uploadedFiles = [];
 
    protected ‪$parsedBody;
 
    public function ‪__construct(string|UriInterface|null ‪$uri = null, ‪$method = null, ‪$body = 'php://input', array ‪$headers = [], array ‪$serverParams = [], array ‪$uploadedFiles = null)
    {
        if (‪$uploadedFiles !== null) {
            $this->‪validateUploadedFiles($uploadedFiles);
        }
 
        parent::__construct(‪$uri, ‪$method ?? 'GET', ‪$body, ‪$headers);
 
        $this->serverParams = ‪$serverParams;
        $this->uploadedFiles = ‪$uploadedFiles ?? [];
    }
 
    public function ‪getServerParams(): array
    {
        return ‪$this->serverParams;
    }
 
    public function ‪getCookieParams(): array
    {
        return ‪$this->cookieParams;
    }
 
    public function ‪withCookieParams(array $cookies): ServerRequestInterface
    {
        $clonedObject = clone $this;
        $clonedObject->cookieParams = $cookies;
        return $clonedObject;
    }
 
    public function ‪getQueryParams(): array
    {
        return ‪$this->queryParams;
    }
 
    public function ‪withQueryParams(array $query): ServerRequestInterface
    {
        $clonedObject = clone $this;
        $clonedObject->queryParams = $query;
        return $clonedObject;
    }
 
    public function ‪getUploadedFiles(): array
    {
        return ‪$this->uploadedFiles;
    }
 
    public function ‪withUploadedFiles(array ‪$uploadedFiles): ServerRequestInterface
    {
        $this->‪validateUploadedFiles($uploadedFiles);
        $clonedObject = clone $this;
        $clonedObject->uploadedFiles = ‪$uploadedFiles;
        return $clonedObject;
    }
 
    public function ‪getParsedBody()
    {
        return ‪$this->parsedBody;
    }
 
    public function ‪withParsedBody($data): ServerRequestInterface
    {
        $clonedObject = clone $this;
        $clonedObject->parsedBody = $data;
        return $clonedObject;
    }
 
    public function ‪getAttributes(): array
    {
        return ‪$this->attributes;
    }
 
    public function ‪getAttribute(string $name, $default = null)
    {
        return $this->attributes[$name] ?? $default;
    }
 
    public function ‪withAttribute(string $name, $value): ServerRequestInterface
    {
        $clonedObject = clone $this;
        $clonedObject->attributes[$name] = $value;
        return $clonedObject;
    }
 
    public function ‪withoutAttribute(string $name): ServerRequestInterface
    {
        $clonedObject = clone $this;
        if (!isset($clonedObject->attributes[$name])) {
            return $clonedObject;
        }
        unset($clonedObject->attributes[$name]);
        return $clonedObject;
    }
 
    protected function ‪validateUploadedFiles(array ‪$uploadedFiles): void
    {
        foreach (‪$uploadedFiles as $file) {
            if (is_array($file)) {
                $this->‪validateUploadedFiles($file);
                continue;
            }
            if (!$file instanceof UploadedFileInterface) {
                throw new \InvalidArgumentException('Invalid file in uploaded files structure.', 1436717281);
            }
        }
    }
}