RickyNRoses87 / almendra-psr7

src/Psr/Messages/Message.php

<?php

namespace Almendra\Http\Psr\Messages;

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

class Message implements MessageInterface
{
    protected $_protocolVersion = '1.1';

    protected $_headers = [];

    protected $_body;

    /**
     * @var array The headers which are accepted.
     */
    protected $_validHeaders = [
        'Content-Type',
        'Connection',
        'Accept',
        'Accept-Encoding',
        'Accept-Language',
        'Cache-Control',
        'Cookie',
        'Host',
        'User-Agent',
        'Remote Address',
        // ...
        ];

    /**
     * @var array Valid/Supported HTTP Protocol versions .
     */
    protected $_validVersions = [
        '1.0',
        '1.1',
        '2.0',
        ];


    public function __construct(StreamInterface $stream = null)
    {
        if (isset($stream) && null !== $stream) {
            $this -> _body = $stream;
        } else {
            // bad practice: to be remove
            $this -> _body = new \Almendra\Http\Psr\Messages\Stream;

The call to Stream::__construct() misses a required argument $stream.

        }
    }
    
    /**
     * Returns the message's protocol version.
     *
     * @return string
     */
    public function getProtocolVersion()
    {
        return $this -> _protocolVersion;
    }

    /**
     * Returns an instance of the message with the specified protocol version.
     *
     * @param string $version 		The protocol version.
     * @return \Almendra\Http\Psr\Messages\Message
     * @throws InvalidArgumentException
     */
    public function withProtocolVersion($version)
    {
        if (!in_array($version, $this -> _validVersions)) {
            throw new \InvalidArgumentException("Invalid or unsupported HTTP version.");
        }

        $this -> _protocolVersion = $version;

        return $this;
    }

    /**
     * Returns the headers.
     *
     * @return array 				An associative array of string values.
     */
    public function getHeaders()
    {
        return $this -> _headers;
    }

    /**
     * Check if a header exists.
     *
     * @param string $name 		The name of the header.
     * @return boolean
     */
    public function hasHeader($name)
    {
        if (!$this -> isArrayKeyLowercase($name, $this -> _headers)) {
            return false;
        }

        return true;
    }

    /**
     * Checks if a key name exists in a given array using a case-insensitive string comparision.
     *
     * @param string $name         The key name
     * @param array $values         The array of values
     * @return boolean
     */
    protected function isArrayKeyLowercase($name, array $values)
    {
        $name = strtolower($name);
        foreach ($values as $key => $value) {
            $lowerCaseName = strtolower($key);
            if ($lowerCaseName === $name) {
                return isset($values[$lowerCaseName]);
            }
        }

        return false;
    }

    /**
     * Returns a header.
     *
     * @param string $name 		The header's name.
     * @return array
     */
    public function getHeader($name)
    {
        $name = strtolower($name);
        if ($this -> hasHeader($name)) {
            return is_array($this -> _headers[$name]) ?
                $this -> _headers[$name] :
                [$this -> _headers[$name]];
        }

        return [];
    }

    /**
     * Returns a comma-separated header.
     *
     * @param string $name 		The header's name.
     * @return string
     */
    public function getHeaderLine($name)
    {
        if (!$this -> hasHeader($name)) {
            return '';
        }

        if (!is_array($header = $this -> getHeader($name))) {
            return $header;
        }

        $header = implode(', ', $this -> getHeader($name));

        return $header;
    }

    /**
     * Returns a message instance with the specified header
     * Replaces the header if it exists.
     *
     * @param string $name 		The header's name
     * @param string $value 	The header's value
     * @return \Almendra\Http\Psr\Messages\Message
     */
    public function withHeader($name, $value)
    {
        if (!$this -> isHeaderValid($name)) {
            throw new \InvalidArgumentException("Invalid header name provided.");
        }

        $clone = clone $this;
        $clone -> setHeader($name, $value); // replace if exists

        return $clone;
    }

    /**
     * Returns a message instance with the an added header.
     * Does not replace the it if it exists already.
     *
     * @param string $name 		The header's name
     * @param string $value 	The header's value
     * @return \Almendra\Http\Psr\Messages\Message
     */
    public function withAddedHeader($name, $value)
    {
        if (!$this -> isHeaderValid($name)) {
            throw new \InvalidArgumentException("Invalid header name provided.");
        }

        // append only
        $clone = clone $this;
        $clone -> hasHeader($name) ?
            $clone -> setHeader($name, $value) :
            $clone -> addHeader($name, $value);

        return $clone;
    }

    /**
     * Checks whather a header is valid.
     *
     * @param string $name 		The header's name
     * @return boolean			true if supported
     */
    public function isHeaderValid($name)
    {
        if (!is_string($name)) {
            return false;
        }

        $name = strtolower($name);

$name is not used, you could remove the assignment.

        

        return true;
    }

    /**
     * Sets a header, by name.
     *
     * @param string $name 		The header's name
     * @param string $name 		The header's value
     * @return void
     * @throws \InvalidArgumentException	!
     */
    public function setHeader($name, $value)
    {
        if (!$this -> isHeaderValid($name)) {
            throw new \InvalidArgumentException("Invalid header name provided.");
        }

        if (!is_array($value)) {
            $value = [$value];
        }
        
        $this -> _headers[strtolower($name)] = $value;
    }

    /**
     * Adds a header. Does not replace the value if it already exists.
     *
     * @param string $name         The header's name
    * @param mixed $value         The header's value
     * @return void
     */
    public function addHeader($name, $value)
    {
        if (!is_array($value)) {
            $value = [$value];
        }

        $header = $this -> getHeader($name);
        $this -> setHeader($name, array_merge($header, $value));
    }

    /**
     * Returns an instance of the message without the specified header.
     *
     * @param string $name 		The header's name
     * @return \Almendra\Http\Psr\Messages\Message
     */
    public function withoutHeader($name)
    {
        $clone = clone $this;
        if ($clone -> hasHeader($name)) {
            $clone -> unsetHeader($name);
        }

        return $clone;
    }

    /**
     * Unsets a header.
     *
     * @param string $name 		The header's name.
     * @return void
     */
    public function unsetHeader($name)
    {
        unset($this -> _headers[$name]);
    }

    /**
     * Returns the message's body.
     *
     * @return Psr\Http\Message\StreamInterface
     */
    public function getBody()
    {
        return $this -> _body;
    }

    /**
     * Returns an instance of the message with the specified body.
     *
     * @param \Psr\Http\Message\StreamInterface $body 		The body to be added
     * @return \Almendra\Http\Psr\Messages\Message
     * @throws \InvalidArgumentException
     */
    public function withBody(StreamInterface $body)
    {
        $clone = clone $this;
        $clone -> _body = $body;

        return $clone;
    }
}