Cakasim / php-payone-sdk-http-message

src/Message/AbstractMessage.php

<?php

declare(strict_types=1);

namespace Cakasim\Payone\Sdk\Http\Message;

use Psr\Http\Message\MessageInterface;
use Psr\Http\Message\StreamInterface;

/**
 * The base class for HTTP messages.
 *
 * @author Fabian Böttcher <me@cakasim.de>
 * @since 0.1.0
 */
abstract class AbstractMessage implements MessageInterface
{
    public const PROTOCOL_VERSION_1_0 = '1.0';
    public const PROTOCOL_VERSION_1_1 = '1.1';
    public const PROTOCOL_VERSION_2 = '2';

    /**
     * @var string The HTTP protocol version.
     */
    protected $protocolVersion;

    /**
     * @var string[][] The HTTP headers.
     */
    protected $headers = [];

    /**
     * @var StreamInterface The HTTP body.
     */
    protected $body;

    /**
     * Constructs a message.
     *
     * @param string $protocolVersion The HTTP protocol version.
     * @param StreamInterface $body The message body.
     * @param array $headers The message headers.
     */
    public function __construct(string $protocolVersion, StreamInterface $body, array $headers)
    {
        $this->setProtocolVersion($protocolVersion);
        $this->setBody($body);

        // Parse message headers to internal format.
        foreach ($headers as $name => $values) {
            $this->headers[strtolower($name)] = is_array($values)
                ? [$name, $values]
                : [$name, [$values]];
        }
    }

    /**
     * Perform deep copy of attributes.
     */
    public function __clone()
    {
        $this->body = clone $this->body;
    }

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

    /**
     * Sets the HTTP protocol version.
     *
     * @param string $protocolVersion The HTTP protocol version.
     * @return $this
     */
    protected function setProtocolVersion(string $protocolVersion): self
    {
        $this->protocolVersion = $protocolVersion;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function withProtocolVersion($version)
    {
        return (clone $this)->setProtocolVersion($version);
    }

    /**
     * @inheritDoc
     */
    public function getHeaders()
    {
        $headers = [];

        foreach ($this->headers as $header) {
            $headers[$header[0]] = $header[1];
        }

        return $headers;
    }

    /**
     * @inheritDoc
     */
    public function hasHeader($name)
    {
        return isset($this->headers[strtolower($name)]);
    }

    /**
     * @inheritDoc
     */
    public function getHeader($name)
    {
        return $this->headers[strtolower($name)][1] ?? [];

The expression return $this->headers[strtolower($name)][1] ?? array() also could return the type string which is incompatible with the return type mandated by Psr\Http\Message\MessageInterface::getHeader() of string[].

    }

    /**
     * Sets a header field.
     *
     * @param string $name The name of the header.
     * @param string[] $value The values of the header.
     * @return $this
     */
    protected function setHeader(string $name, array $value): self
    {
        $this->headers[strtolower($name)] = [$name, array_filter($value, function ($item) {
            // Filter non and empty strings.
            return is_string($item) && !empty($item);
        })];

        return $this;
    }

    /**
     * Adds a value to an existing header field.
     *
     * @param string $name The name of the existing header.
     * @param string[] $value The values to add to the existing header.
     * @return $this
     */
    protected function addHeader(string $name, array $value): self
    {
        $this->setHeader(
            $name,
            $this->hasHeader($name)
                ? array_merge($this->getHeader($name), $value)

It seems like $this->getHeader($name) can also be of type string; however, parameter $array1 of array_merge() does only seem to accept array, maybe add an additional type check?

                : $value
        );

        return $this;
    }

    /**
     * Removes an existing header field.
     *
     * @param string $name The name of the header.
     * @return $this
     */
    protected function removeHeader(string $name): self
    {
        unset($this->headers[strtolower($name)]);
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getHeaderLine($name)
    {
        return join(',', $this->getHeader($name));

It seems like $this->getHeader($name) can also be of type string; however, parameter $pieces of join() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * @inheritDoc
     */
    public function withHeader($name, $value)
    {
        return (clone $this)->setHeader(
            $name,
            is_array($value)
                ? $value
                : [$value]
        );
    }

    /**
     * @inheritDoc
     */
    public function withAddedHeader($name, $value)
    {
        return (clone $this)->addHeader(
            $name,
            is_array($value)
                ? $value
                : [$value]
        );
    }

    /**
     * @inheritDoc
     */
    public function withoutHeader($name)
    {
        return (clone $this)->removeHeader($name);
    }

    /**
     * @inheritDoc
     */
    public function getBody()
    {
        return $this->body;
    }

    /**
     * Sets the message body.
     *
     * @param StreamInterface $body The message body.
     * @return $this
     */
    protected function setBody(StreamInterface $body): self
    {
        $this->body = $body;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function withBody(StreamInterface $body)
    {
        return (clone $this)->setBody($body);
    }
}