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

Breadcrumb

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

class Response

Same name in this branch
  1. 11.1.x vendor/guzzlehttp/psr7/src/Response.php \GuzzleHttp\Psr7\Response
  2. 11.1.x vendor/symfony/browser-kit/Response.php \Symfony\Component\BrowserKit\Response
  3. 11.1.x vendor/symfony/http-foundation/Response.php \Symfony\Component\HttpFoundation\Response

@phpstan-type Request array{url: non-empty-string, options?: mixed[], copyTo?: string|null}

Hierarchy

  • class \Composer\Util\Http\Response

Expanded class hierarchy of Response

9 files declare their use of Response
ComposerRepository.php in vendor/composer/composer/src/Composer/Repository/ComposerRepository.php
FileDownloader.php in vendor/composer/composer/src/Composer/Downloader/FileDownloader.php
GitBitbucketDriver.php in vendor/composer/composer/src/Composer/Repository/Vcs/GitBitbucketDriver.php
GitHubDriver.php in vendor/composer/composer/src/Composer/Repository/Vcs/GitHubDriver.php
GitLabDriver.php in vendor/composer/composer/src/Composer/Repository/Vcs/GitLabDriver.php

... See full list

3 string references to 'Response'
DynamicPageCacheSubscriber::onRequest in core/modules/dynamic_page_cache/src/EventSubscriber/DynamicPageCacheSubscriber.php
Sets a response in case of a Dynamic Page Cache hit.
DynamicPageCacheSubscriber::onResponse in core/modules/dynamic_page_cache/src/EventSubscriber/DynamicPageCacheSubscriber.php
Stores a response in case of a Dynamic Page Cache miss, if cacheable.
MessageFormatter::format in vendor/guzzlehttp/guzzle/src/MessageFormatter.php
Returns a formatted message string.

File

vendor/composer/composer/src/Composer/Util/Http/Response.php, line 22

Namespace

Composer\Util\Http
View source
class Response {
    
    /** @var Request */
    private $request;
    
    /** @var int */
    private $code;
    
    /** @var list<string> */
    private $headers;
    
    /** @var ?string */
    private $body;
    
    /**
     * @param Request $request
     * @param list<string> $headers
     */
    public function __construct(array $request, ?int $code, array $headers, ?string $body) {
        if (!isset($request['url'])) {
            throw new \LogicException('url key missing from request array');
        }
        $this->request = $request;
        $this->code = (int) $code;
        $this->headers = $headers;
        $this->body = $body;
    }
    public function getStatusCode() : int {
        return $this->code;
    }
    public function getStatusMessage() : ?string {
        $value = null;
        foreach ($this->headers as $header) {
            if (Preg::isMatch('{^HTTP/\\S+ \\d+}i', $header)) {
                // In case of redirects, headers contain the headers of all responses
                // so we can not return directly and need to keep iterating
                $value = $header;
            }
        }
        return $value;
    }
    
    /**
     * @return string[]
     */
    public function getHeaders() : array {
        return $this->headers;
    }
    
    /**
     * @return ?string
     */
    public function getHeader(string $name) : ?string {
        return self::findHeaderValue($this->headers, $name);
    }
    
    /**
     * @return ?string
     */
    public function getBody() : ?string {
        return $this->body;
    }
    
    /**
     * @return mixed
     */
    public function decodeJson() {
        return JsonFile::parseJson($this->body, $this->request['url']);
    }
    
    /**
     * @phpstan-impure
     */
    public function collect() : void {
        unset($this->request, $this->code, $this->headers, $this->body);
    }
    
    /**
     * @param  string[]    $headers array of returned headers like from getLastHeaders()
     * @param  string      $name    header name (case insensitive)
     */
    public static function findHeaderValue(array $headers, string $name) : ?string {
        $value = null;
        foreach ($headers as $header) {
            if (Preg::isMatch('{^' . preg_quote($name) . ':\\s*(.+?)\\s*$}i', $header, $match)) {
                $value = $match[1];
            }
        }
        return $value;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
Response::$body private property @var ?string
Response::$code private property @var int
Response::$headers private property @var list&lt;string&gt;
Response::$request private property @var Request
Response::collect public function @phpstan-impure
Response::decodeJson public function
Response::findHeaderValue public static function
Response::getBody public function
Response::getHeader public function
Response::getHeaders public function
Response::getStatusCode public function
Response::getStatusMessage public function
Response::__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