wellrested/src/pjdietz/WellRESTed/Message.php

<?php

/**
 * @author PJ Dietz <pj@pjdietz.com>
 * @copyright Copyright 2013 by PJ Dietz
 * @license MIT
 */

namespace pjdietz\WellRESTed;

/**
 * Common base class for the Request and Response classes.
 *
 * @property string body  Entity body of the message
 * @property-read array headers  Associative array of HTTP headers
 * @property string protocol  The protocol, e.g. HTTP
 * @property string protocolVersion  The version of the protocol
 */
abstract class Message
{
    /**
     * Entity body of the message
     *
     * @var string
     */
    protected $body;

    /**
     * Associative array of HTTP headers
     *
     * @var array
     */
    protected $headers;

    /**
     * Associative array of lowercase header field names as keys with
     * corresponding case sensitive field names from the $headers array as
     * values.
     *
     * @var array
     */
    protected $headerLookup;

    /**
     * Name of the protocol to use.
     *
     * @var string
     */
    protected $protocol = 'HTTP';

    /**
     * Version of the protocol to use.
     *
     * @var string
     */
    protected $protocolVersion = '1.1';

    // -------------------------------------------------------------------------
    // !Accessors

    /**
     * @param string $propertyName
     * @return mixed
     */
    public function __get($propertyName)
    {
        $method = 'get' . ucfirst($propertyName);
        if (method_exists($this, $method)) {
            return $this->{$method}();
        }
    }

    /**
     * @param string $propertyName
     * @param $value
     */
    public function __set($propertyName, $value)
    {
        $method = 'set' . ucfirst($propertyName);
        if (method_exists($this, $method)) {
            $this->{$method}($value);
        }
    }

    /**
     * @param string $propertyName
     * @return mixed
     */
    public function __isset($propertyName)
    {
        $method = 'isset' . ucfirst($propertyName);
        if (method_exists($this, $method)) {
            return $this->{$method}();
        }
    }

    /**
     * @param string $propertyName
     */
    public function __unset($propertyName)
    {
        $method = 'unset' . ucfirst($propertyName);
        if (method_exists($this, $method)) {
            $this->{$method}();
        }
    }

    /**
     * Return the body payload of the instance.
     *
     * @return string
     */
    public function getBody()
    {
        return $this->body;
    }

    /**
     * Set the body for the request.
     *
     * @param string $body
     */
    public function setBody($body)
    {
        $this->body = $body;
    }

    /**
     * @return bool
     */
    public function issetBody()
    {
        return isset($this->body);
    }

    public function unsetBody()
    {
        unset($this->body);
    }

    /**
     * Return an associative array of all set headers.
     *
     * @return array
     */
    public function getHeaders()
    {
        return $this->headers;
    }

    /**
     * Return an array containing one string for each header as "field: value"
     *
     * @return string
     */
    public function getHeaderLines()
    {
        $lines = array();
        foreach ($this->headers as $field => $value) {
            $lines[] = sprintf('%s: %s', $field, $value);
        }
        return $lines;
    }

    /**
     * Return the value of a given header, or false if it does not exist.
     *
     * @param string $name
     * @return string|bool
     */
    public function getHeader($name)
    {
        $lowerName = strtolower($name);

        if (isset($this->headerLookup[$lowerName])) {

            $realName = $this->headerLookup[$lowerName];

            if (isset($this->headers[$realName])) {
                return $this->headers[$realName];
            }

        }

        return false;
    }

    /**
     * Add or update a header to a given value
     *
     * @param string $name
     * @param $value
     * @param string $value
     */
    public function setHeader($name, $value)
    {
        $lowerName = strtolower($name);

        // Check if a mapping already exists for this header.
        // Remove it, if needed.
        if (isset($this->headerLookup[$lowerName])
            && $this->headerLookup[$lowerName] !== $name
        ) {
            unset($this->headers[$this->headerLookup[$lowerName]]);
        }

        // Store the actual header.
        $this->headers[$name] = $value;

        // Store a mapping to the user's prefered case.
        $this->headerLookup[$lowerName] = $name;
    }

    /**
     * Return if the response contains a header with the given key.
     *
     * @param $name
     * @return bool
     */
    public function issetHeader($name)
    {
        $lowerName = strtolower($name);
        return isset($this->headerLookup[$lowerName]);
    }

    /**
     * Remove a header. This method does nothing if the header does not exist.
     *
     * @param string $name
     */
    public function unsetHeader($name)
    {
        $lowerName = strtolower($name);

        if (isset($this->headerLookup[$lowerName])) {

            $realName = $this->headerLookup[$lowerName];

            if (isset($this->headers[$realName])) {
                unset($this->headers[$realName]);
            }

            unset($this->headerLookup[$lowerName]);

        }
    }

    /**
     * @return string
     */
    public function getProtocol()
    {
        return $this->protocol;
    }

    /**
     * Set the protocol for the message.
     *
     * The value is expected to be the name of the protocol only. If the
     * version is included, the version is striped and set as the
     * protocolVersion property.
     *
     * <code>
     * $instance->protocol = 'HTTP1/1';
     * print $instance->protocol; // 'HTTP';
     * print $instance->protocolVersion; // '1.1';
     * </code>
     *
     * @param $protocol
     */
    public function setProtocol($protocol)
    {
        if (strpos($protocol, '/') === false) {
            list($this->protocol, $this->protocolVersion) = explode('/', $protocol, 2);
        } else {
            $this->protocol = $protocol;
        }
    }

    /**
     * @return bool
     */
    public function issetProtocol()
    {
        return isset($this->protocol);
    }

    public function unsetProtocol()
    {
        unset($this->protocol);
    }

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

    /**
     * @param string $protocolVersion
     */
    public function setProtocolVersion($protocolVersion)
    {
        $this->protocolVersion = $protocolVersion;
    }

    /**
     * @return bool
     */
    public function issetProtocolVersion()
    {
        return isset($this->protocolVersion);
    }

    public function unsetProtocolVersion()
    {
        unset($this->protocolVersion);
    }
}