Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Request.php

class Request

Same name in this branch
  1. 11.1.x vendor/composer/composer/src/Composer/DependencyResolver/Request.php \Composer\DependencyResolver\Request
  2. 11.1.x vendor/symfony/browser-kit/Request.php \Symfony\Component\BrowserKit\Request
  3. 11.1.x vendor/symfony/http-foundation/Request.php \Symfony\Component\HttpFoundation\Request

PSR-7 request implementation.

Hierarchy

  • class \GuzzleHttp\Psr7\Request implements \Psr\Http\Message\RequestInterface uses \GuzzleHttp\Psr7\MessageTrait

Expanded class hierarchy of Request

1 file declares its use of Request
CommonClassesStrategy.php in vendor/php-http/discovery/src/Strategy/CommonClassesStrategy.php
9 string references to 'Request'
CompiledUrlMatcherDumper::compileRoute in vendor/symfony/routing/Matcher/Dumper/CompiledUrlMatcherDumper.php
Compiles a single Route to PHP code used to match it against the path info.
FileProfilerStorage::createProfileFromData in vendor/symfony/http-kernel/Profiler/FileProfilerStorage.php
FileProfilerStorage::find in vendor/symfony/http-kernel/Profiler/FileProfilerStorage.php
Finds profiler tokens for the given criteria.
FileProfilerStorage::write in vendor/symfony/http-kernel/Profiler/FileProfilerStorage.php
GetRequestDataSniff::process in vendor/drupal/coder/coder_sniffer/DrupalPractice/Sniffs/Variables/GetRequestDataSniff.php
Processes this test, when one of its tokens is encountered.

... See full list

File

vendor/guzzlehttp/psr7/src/Request.php, line 15

Namespace

GuzzleHttp\Psr7
View source
class Request implements RequestInterface {
    use MessageTrait;
    
    /** @var string */
    private $method;
    
    /** @var string|null */
    private $requestTarget;
    
    /** @var UriInterface */
    private $uri;
    
    /**
     * @param string                               $method  HTTP method
     * @param string|UriInterface                  $uri     URI
     * @param (string|string[])[]                  $headers Request headers
     * @param string|resource|StreamInterface|null $body    Request body
     * @param string                               $version Protocol version
     */
    public function __construct(string $method, $uri, array $headers = [], $body = null, string $version = '1.1') {
        $this->assertMethod($method);
        if (!$uri instanceof UriInterface) {
            $uri = new Uri($uri);
        }
        $this->method = strtoupper($method);
        $this->uri = $uri;
        $this->setHeaders($headers);
        $this->protocol = $version;
        if (!isset($this->headerNames['host'])) {
            $this->updateHostFromUri();
        }
        if ($body !== '' && $body !== null) {
            $this->stream = Utils::streamFor($body);
        }
    }
    public function getRequestTarget() : string {
        if ($this->requestTarget !== null) {
            return $this->requestTarget;
        }
        $target = $this->uri
            ->getPath();
        if ($target === '') {
            $target = '/';
        }
        if ($this->uri
            ->getQuery() != '') {
            $target .= '?' . $this->uri
                ->getQuery();
        }
        return $target;
    }
    public function withRequestTarget($requestTarget) : RequestInterface {
        if (preg_match('#\\s#', $requestTarget)) {
            throw new InvalidArgumentException('Invalid request target provided; cannot contain whitespace');
        }
        $new = clone $this;
        $new->requestTarget = $requestTarget;
        return $new;
    }
    public function getMethod() : string {
        return $this->method;
    }
    public function withMethod($method) : RequestInterface {
        $this->assertMethod($method);
        $new = clone $this;
        $new->method = strtoupper($method);
        return $new;
    }
    public function getUri() : UriInterface {
        return $this->uri;
    }
    public function withUri(UriInterface $uri, $preserveHost = false) : RequestInterface {
        if ($uri === $this->uri) {
            return $this;
        }
        $new = clone $this;
        $new->uri = $uri;
        if (!$preserveHost || !isset($this->headerNames['host'])) {
            $new->updateHostFromUri();
        }
        return $new;
    }
    private function updateHostFromUri() : void {
        $host = $this->uri
            ->getHost();
        if ($host == '') {
            return;
        }
        if (($port = $this->uri
            ->getPort()) !== null) {
            $host .= ':' . $port;
        }
        if (isset($this->headerNames['host'])) {
            $header = $this->headerNames['host'];
        }
        else {
            $header = 'Host';
            $this->headerNames['host'] = 'Host';
        }
        // Ensure Host is the first header.
        // See: https://datatracker.ietf.org/doc/html/rfc7230#section-5.4
        $this->headers = [
            $header => [
                $host,
            ],
        ] + $this->headers;
    }
    
    /**
     * @param mixed $method
     */
    private function assertMethod($method) : void {
        if (!is_string($method) || $method === '') {
            throw new InvalidArgumentException('Method must be a non-empty string.');
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
MessageTrait::$headerNames private property @var string[] Map of lowercase header name => original name at registration
MessageTrait::$headers private property @var string[][] Map of all registered headers, as original name => array of values
MessageTrait::$protocol private property @var string
MessageTrait::$stream private property @var StreamInterface|null
MessageTrait::assertHeader private function
MessageTrait::assertValue private function field-value = *( field-content / obs-fold )
field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ]
field-vchar = VCHAR / obs-text
VCHAR = %x21-7E
obs-text = %x80-FF
obs-fold = CRLF 1*( SP / HTAB )
MessageTrait::getBody public function
MessageTrait::getHeader public function
MessageTrait::getHeaderLine public function
MessageTrait::getHeaders public function
MessageTrait::getProtocolVersion public function
MessageTrait::hasHeader public function
MessageTrait::normalizeHeaderValue private function
MessageTrait::setHeaders private function
MessageTrait::trimAndValidateHeaderValues private function Trims whitespace from the header values.
MessageTrait::withAddedHeader public function
MessageTrait::withBody public function
MessageTrait::withHeader public function
MessageTrait::withoutHeader public function
MessageTrait::withProtocolVersion public function
Request::$method private property @var string
Request::$requestTarget private property @var string|null
Request::$uri private property @var UriInterface
Request::assertMethod private function
Request::getMethod public function Retrieves the HTTP method of the request. Overrides RequestInterface::getMethod
Request::getRequestTarget public function Retrieves the message's request target. Overrides RequestInterface::getRequestTarget
Request::getUri public function Retrieves the URI instance. Overrides RequestInterface::getUri
Request::updateHostFromUri private function
Request::withMethod public function Return an instance with the provided HTTP method. Overrides RequestInterface::withMethod
Request::withRequestTarget public function Return an instance with the specific request-target. Overrides RequestInterface::withRequestTarget
Request::withUri public function Returns an instance with the provided URI. Overrides RequestInterface::withUri
Request::__construct public function 1

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal