Response.php

<?php

declare (strict_types=1);

/*
 * This file is part of Composer.
 *
 * (c) Nils Adermann <naderman@naderman.de>
 *     Jordi Boggiano <j.boggiano@seld.be>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Composer\Util\Http;

use Composer\Json\JsonFile;
use Composer\Pcre\Preg;
use Composer\Util\HttpDownloader;

/**
 * @phpstan-type Request array{url: non-empty-string, options?: mixed[], copyTo?: string|null}
 */
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;
    }

}