platine-php / http

src/Message.php

<?php

/**
 * Platine HTTP
 *
 * Platine HTTP Message is the implementation of PSR 7
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine HTTP
 * Copyright (c) 2019 Dion Chaika
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file Message.php
 *
 *  The default or base HTTP Message
 *
 *  @package    Platine\Http
 *  @author Platine Developers Team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\Http;

/**
 * @class Message
 * @package Platine\Http
 */
abstract class Message implements MessageInterface
{
    /**
     * The message protocol version.
     * @var string
     */
    protected string $protocolVersion = '1.1';

    /**
     * The array of message headers
     * @var array<string, array<string>>
     */
    protected array $headers = [];

    /**
     * The message body.
     * @var StreamInterface|null
     */
    protected ?StreamInterface $body = null;

    /**
     * {@inheritdoc}
     */
    public function getProtocolVersion(): string
    {
        return $this->protocolVersion;
    }

    /**
     * {@inheritdoc}
     * @return $this
     */
    public function withProtocolVersion(string $version): self
    {
        $that = clone $this;
        $that->protocolVersion = $version;

        return $that;
    }

    /**
     * {@inheritdoc}
     */
    public function getHeaders(): array
    {
        $headers = [];
        foreach ($this->headers as $name => $values) {
            $name = implode('-', array_map('ucfirst', explode('-', strtolower($name))));
            $headers[$name] = $values;
        }

        return $headers;
    }

    /**
     * {@inheritdoc}
     */
    public function hasHeader(string $name): bool
    {
        $lowerName = strtolower($name);

        return isset($this->headers[$lowerName]);
    }

    /**
     * {@inheritdoc}
     */
    public function getHeader(string $name): array
    {
        $lowerName = strtolower($name);

        return $this->headers[$lowerName] ?? [];
    }

    /**
     * {@inheritdoc}
     */
    public function getHeaderLine(string $name): string
    {
        $lowerName = strtolower($name);
        return isset($this->headers[$lowerName])
                ? implode(', ', $this->headers[$lowerName])
                : '';
    }

    /**
     * {@inheritdoc}
     * @return $this
     */
    public function withHeader(string $name, string|array $value): self
    {
        $that = clone $this;
        $lowerName = strtolower($name);
        $that->headers[$lowerName] = is_array($value) ? $value : [$value];

The condition is_array($value) is always true.

        return $that;
    }

    /**
     * {@inheritdoc}
     */
    public function withAddedHeader(string $name, string|array $value): self
    {
        $that = clone $this;
        $lowerName = strtolower($name);
        if (is_array($value)) {

The condition is_array($value) is always true.

            $value = array_values($value);
            $that->headers[$lowerName] = isset($that->headers[$lowerName])
                                        ? array_merge(
                                            $that->headers[$lowerName],
                                            $value
                                        )
                                        : $value;
        } else {
            $that->headers[$lowerName][] = $value;
        }
        return $that;
    }

    /**
     * {@inheritdoc}
     */
    public function withoutHeader(string $name): self
    {
        $that = clone $this;
        $lowerName = strtolower($name);
        unset($that->headers[$lowerName]);

        return $that;
    }

    /**
     * {@inheritdoc}
     */
    public function getBody(): StreamInterface
    {
        if ($this->body === null) {
            $this->body = new Stream();
        }
        return $this->body;

The expression return $this->body could return the type null which is incompatible with the type-hinted return Platine\Http\StreamInterface. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritdoc}
     */
    public function withBody(StreamInterface $body): self
    {
        $that = clone $this;
        $that->body = $body;
        $size = $body->getSize();

        if ($size === null) {
            $that = $that->withHeader('Transfer-Encoding', 'chunked')
                         ->withoutHeader('Content-Length');
        } else {
            $that = $that->withHeader('Content-Length', (string) $size)
                         ->withoutHeader('Transfer-Encoding');
        }

        return $that;
    }
}