Issues in ServerResponse.php - All Issues - Inspection of "- removes the obsolete typecast" - kodedphp/http - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 7f192b...2c59bc )

by Mihail

created 2021-09-17 06:16 UTC

ServerResponse.php (1 issue)

Labels

Severity

Major 1

<?php

/*
 * This file is part of the Koded package.
 *
 * (c) Mihail Binev <[email protected]>
 *
 * Please view the LICENSE distributed with this source code
 * for the full copyright and license information.
 *
 */

namespace Koded\Http;

use Koded\Http\Interfaces\{HttpStatus, Request, Response};

/**
 * Class ServerResponse
 *
 */
class ServerResponse implements Response, \JsonSerializable
{
    use HeaderTrait, MessageTrait, CookieTrait, JsonSerializeTrait;

    private const E_CLIENT_RESPONSE_SEND = 'Cannot send the client response.';
    private const E_INVALID_STATUS_CODE  = 'Invalid status code %s, expected range between [100-599]';

    protected int    $statusCode   = HttpStatus::OK;
    protected string $reasonPhrase = 'OK';

    /**
     * ServerResponse constructor.
     *
     * @param mixed $content    [optional]
     * @param int   $statusCode [optional]
     * @param array $headers    [optional]
     */
    public function __construct(
        mixed $content = '',
        int $statusCode = HttpStatus::OK,
        array $headers = [])
    {
        $this->setStatus($this, $statusCode);
        $this->setHeaders($headers);
        $this->stream = create_stream($content);
    }

    public function getStatusCode(): int
    {
        return $this->statusCode;
    }

    public function withStatus($code, $reasonPhrase = ''): static
    {
        return $this->setStatus(clone $this, (int)$code, (string)$reasonPhrase);
    }

    public function getReasonPhrase(): string
    {
        return (string)$this->reasonPhrase;
    }

    public function getContentType(): string
    {
        return $this->getHeaderLine('Content-Type') ?: 'text/html';
    }

    public function sendHeaders(): void
    {
        $this->prepareResponse();
        if (false === headers_sent()) {
            foreach ($this->getHeaders() as $name => $values) {
                header($name . ':' . \join(',', (array)$values), false, $this->statusCode);
            }
            // Status header
            header(\sprintf('HTTP/%s %d %s',
                $this->getProtocolVersion(),
                $this->getStatusCode(),
                $this->getReasonPhrase()),
                true,
                $this->statusCode);
        }
    }

    public function sendBody(): string
    {
        try {
            return (string)$this->stream;
        } finally {
            $this->stream->close();
        }
    }

    public function send(): string
    {
        $this->sendHeaders();
        return $this->sendBody();
    }

    protected function setStatus(ServerResponse $instance, int $statusCode, string $reasonPhrase = ''): ServerResponse
    {
        if ($statusCode < 100 || $statusCode > 599) {
            throw new \InvalidArgumentException(
                \sprintf(self::E_INVALID_STATUS_CODE, $statusCode), HttpStatus::UNPROCESSABLE_ENTITY
            );
        }
        $instance->statusCode   = (int)$statusCode;
        $instance->reasonPhrase = $reasonPhrase ?: HttpStatus::CODE[$statusCode];
        return $instance;
    }

    protected function prepareResponse(): void
    {
        if (\in_array($this->getStatusCode(), [100, 101, 102, 204, 304])) {
            $this->stream = create_stream(null);
            unset($this->headersMap['content-length'], $this->headers['Content-Length']);
            unset($this->headersMap['content-type'], $this->headers['Content-Type']);
            return;
        }
        if ($size = $this->stream->getSize()) {
            $this->normalizeHeader('Content-Length', (string)$size, true);
        }
        $method = \strtoupper($_SERVER['REQUEST_METHOD'] ?? '');
        if (Request::HEAD === $method || Request::OPTIONS === $method) {
            $this->stream = create_stream(null);
        }
        if ($this->hasHeader('Transfer-Encoding') || !$size) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            unset($this->headersMap['content-length'], $this->headers['Content-Length']);
        }
    }
}


1		<?php
2
3		/*
4		* This file is part of the Koded package.
5		*
6		* (c) Mihail Binev <[email protected]>
7		*
8		* Please view the LICENSE distributed with this source code
9		* for the full copyright and license information.
10		*
11		*/
12
13		namespace Koded\Http;
14
15		use Koded\Http\Interfaces\{HttpStatus, Request, Response};
16
17		/**
18		* Class ServerResponse
19		*
20		*/
21		class ServerResponse implements Response, \JsonSerializable
22		{
23		use HeaderTrait, MessageTrait, CookieTrait, JsonSerializeTrait;
24
25		private const E_CLIENT_RESPONSE_SEND = 'Cannot send the client response.';
26		private const E_INVALID_STATUS_CODE = 'Invalid status code %s, expected range between [100-599]';
27
28		protected int $statusCode = HttpStatus::OK;
29		protected string $reasonPhrase = 'OK';
30
31		/**
32		* ServerResponse constructor.
33		*
34		* @param mixed $content [optional]
35		* @param int $statusCode [optional]
36		* @param array $headers [optional]
37		*/
38		public function __construct(
39		mixed $content = '',
40	51	int $statusCode = HttpStatus::OK,
41		array $headers = [])
42	51	{
43	51	$this->setStatus($this, $statusCode);
44	51	$this->setHeaders($headers);
45	51	$this->stream = create_stream($content);
46		}
47	33
48		public function getStatusCode(): int
49	33	{
50		return $this->statusCode;
51		}
52	6
53		public function withStatus($code, $reasonPhrase = ''): static
54	6	{
55		return $this->setStatus(clone $this, (int)$code, (string)$reasonPhrase);
56		}
57	9
58		public function getReasonPhrase(): string
59	9	{
60		return (string)$this->reasonPhrase;
61		}
62	2
63		public function getContentType(): string
64	2	{
65		return $this->getHeaderLine('Content-Type') ?: 'text/html';
66		}
67	4
68		public function sendHeaders(): void
69	4	{
70		$this->prepareResponse();
71	4	if (false === headers_sent()) {
72	1	foreach ($this->getHeaders() as $name => $values) {
73		header($name . ':' . \join(',', (array)$values), false, $this->statusCode);
74		}
75		// Status header
76	3	header(\sprintf('HTTP/%s %d %s',
77	2	$this->getProtocolVersion(),
78		$this->getStatusCode(),
79		$this->getReasonPhrase()),
80		true,
81	3	$this->statusCode);
82	3	}
83		}
84
85	3	public function sendBody(): string
86		{
87		try {
88	51	return (string)$this->stream;
89		} finally {
90	51	$this->stream->close();
91	1	}
92	1	}
93
94		public function send(): string
95		{
96	51	$this->sendHeaders();
97	51	return $this->sendBody();
98		}
99	51
100		protected function setStatus(ServerResponse $instance, int $statusCode, string $reasonPhrase = ''): ServerResponse
101		{
102	4	if ($statusCode < 100 \|\| $statusCode > 599) {
103		throw new \InvalidArgumentException(
104	4	\sprintf(self::E_INVALID_STATUS_CODE, $statusCode), HttpStatus::UNPROCESSABLE_ENTITY
105	1	);
106	1	}
107	1	$instance->statusCode = (int)$statusCode;
108		$instance->reasonPhrase = $reasonPhrase ?: HttpStatus::CODE[$statusCode];
109	1	return $instance;
110		}
111
112	3	protected function prepareResponse(): void
113	3	{
114		if (\in_array($this->getStatusCode(), [100, 101, 102, 204, 304])) {
115		$this->stream = create_stream(null);
116	3	unset($this->headersMap['content-length'], $this->headers['Content-Length']);
117	2	unset($this->headersMap['content-type'], $this->headers['Content-Type']);
118		return;
119		}
120	3	if ($size = $this->stream->getSize()) {
121	1	$this->normalizeHeader('Content-Length', (string)$size, true);
122		}
123	3	$method = \strtoupper($_SERVER['REQUEST_METHOD'] ?? '');
124		if (Request::HEAD === $method \|\| Request::OPTIONS === $method) {
125		$this->stream = create_stream(null);
126		}
127		if ($this->hasHeader('Transfer-Encoding') \|\| !$size) {
		0 ignored issues – show Bug Best Practice introduced 2020-03-25 16:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$size` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be 0. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
128		unset($this->headersMap['content-length'], $this->headers['Content-Length']);
129		}
130		}
131		}
132

kodedphp / http

Push — master ( 7f192b...2c59bc )

ServerResponse.php (1 issue)

Labels

Severity

Introduced By

Duplication Side-by-Side

Filter issues like