Initial import

Author: Phil Sturgeon

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 PHP Framework Interoperability Group
+
+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.

README.md

@@ -0,0 +1,13 @@
+PSR Http Message
+================
+
+This repository holds all interfaces/classes/traits related to
+[PSR-7](http://www.php-fig.org/psr/psr-7/).
+
+Note that this is not a HTTP message implementation of its own. It is merely an
+interface that describes a HTTP message. See the specification for more details.
+
+Usage
+-----
+
+We'll certainly need some stuff in here.

composer.json

@@ -0,0 +1,22 @@
+{
+    "name": "psr/http-message",
+    "description": "Common interface for HTTP messages",
+    "keywords": ["psr", "psr-7", "http", "http-message", "request", "response"],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "PHP-FIG",
+            "homepage": "http://www.php-fig.org/"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "Psr\\HttpMessage\\": "src"
+        }
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0.x-dev"
+        }
+    }
+}

src/InvalidArgumentException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Psr\HttpMessage;
+
+class InvalidArgumentException extends \InvalidArgumentException
+{
+}

src/MessageInterface.php

@@ -0,0 +1,147 @@
+<?php
+
+namespace Psr\HttpMessage;
+
+/**
+ * HTTP messages consist of requests from a client to a server and responses
+ * from a server to a client.
+ */
+interface MessageInterface
+{
+    /**
+     * Gets the HTTP protocol version as a string containing only the HTTP
+     * version (e.g., "1.1", "1.0").
+     *
+     * @return string HTTP protocol version.
+     */
+    public function getProtocolVersion();
+
+    /**
+     * Gets the body of the message.
+     *
+     * @return StreamInterface|null Returns the body, or null if not set.
+     */
+    public function getBody();
+
+    /**
+     * Sets the body of the message.
+     *
+     * The body MUST be a StreamInterface object. Setting the body to null MUST
+     * remove the existing body.
+     *
+     * @param StreamInterface|null $body Body.
+     *
+     * @return self Returns the message.
+     */
+    public function setBody(StreamInterface $body = null);
+
+    /**
+     * Gets all message headers.
+     *
+     * The keys represent the header name as it will be sent over the wire, and
+     * each value is an array of strings associated with the header.
+     *
+     *     // Represent the headers as a string
+     *     foreach ($message->getHeaders() as $name => $values) {
+     *         echo $name . ": " . implode(", ", $values);
+     *     }
+     *
+     * @return array Returns an associative array of the message's headers.
+     */
+    public function getHeaders();
+
+    /**
+     * Checks if a header exists by the given case-insensitive name.
+     *
+     * @param string $header Case-insensitive header name.
+     *
+     * @return bool Returns true if any header names match the given header
+     *     name using a case-insensitive string comparison. Returns false if
+     *     no matching header name is found in the message.
+     */
+    public function hasHeader($header);
+
+    /**
+     * Retrieve a header by the given case-insensitive name as a string.
+     *
+     * This method returns all of the header values of the given
+     * case-insensitive header name as a string concatenated together using
+     * a comma.
+     *
+     * @param string $header Case-insensitive header name.
+     *
+     * @return string
+     */
+    public function getHeader($header);
+
+    /**
+     * Retrieve a header by the given case-insensitive name as an array of
+     * strings.
+     *
+     * @param string $header Case-insensitive header name.
+     *
+     * @return array
+     */
+    public function getHeaderAsArray($header);
+
+    /**
+     * Sets a header, replacing any existing values of any headers with the
+     * same case-insensitive name.
+     *
+     * The header values MUST be a string or an array of strings.
+     *
+     * @param string       $header Header name
+     * @param string|array $value  Header value(s)
+     *
+     * @return self Returns the message.
+     */
+    public function setHeader($header, $value);
+
+    /**
+     * Sets headers, replacing any headers that have already been set on the
+     * message.
+     *
+     * The array keys MUST be a string. The array values must be either a
+     * string or an array of strings.
+     *
+     * @param array $headers Headers to set.
+     *
+     * @return self Returns the message.
+     */
+    public function setHeaders(array $headers);
+
+    /**
+     * Appends a header value to any existing values associated with the
+     * given header name.
+     *
+     * @param string $header Header name to add
+     * @param string $value  Value of the header
+     *
+     * @return self
+     */
+    public function addHeader($header, $value);
+
+    /**
+     * Merges in an associative array of headers.
+     *
+     * Each array key MUST be a string representing the case-insensitive name
+     * of a header. Each value MUST be either a string or an array of strings.
+     * For each value, the value is appended to any existing header of the same
+     * name, or, if a header does not already exist by the given name, then the
+     * header is added.
+     *
+     * @param array $headers Associative array of headers to add to the message
+     *
+     * @return self
+     */
+    public function addHeaders(array $headers);
+
+    /**
+     * Remove a specific header by case-insensitive name.
+     *
+     * @param string $header HTTP header to remove
+     *
+     * @return self
+     */
+    public function removeHeader($header);
+}

src/RequestInterface.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Psr\HttpMessage;
+
+/**
+ * A HTTP request message.
+ * @link http://tools.ietf.org/html/rfc2616#section-5
+ */
+interface RequestInterface extends MessageInterface
+{
+    /**
+     * Gets the HTTP method of the request.
+     *
+     * @return string Returns the request method.
+     */
+    public function getMethod();
+
+    /**
+     * Sets the method to be performed on the resource identified by the
+     * Request-URI.
+     *
+     * While HTTP method names are typically all uppercase characters, HTTP
+     * method names are case-sensitive and thus implementations SHOULD NOT
+     * modify the given string.
+     *
+     * @param string $method Case-insensitive method.
+     *
+     * @return self Returns the request.
+     */
+    public function setMethod($method);
+
+    /**
+     * Gets the absolute request URL.
+     *
+     * @return string Returns the URL as a string.
+     */
+    public function getUrl();
+
+    /**
+     * Sets the request URL.
+     *
+     * The URL MUST be a string, or an object that implements the
+     * `__toString()` method. The URL must be an absolute URI as specified
+     * in RFC 3986.
+     *
+     * @param string $url Request URL.
+     *
+     * @return self Reference to the request.
+     * @throws \InvalidArgumentException If the URL is invalid.
+     * @link http://tools.ietf.org/html/rfc3986#section-4.3
+     */
+    public function setUrl($url);
+}

src/ResponseInterface.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Psr\HttpMessage;
+
+/**
+ * A HTTP response message.
+ * @link http://tools.ietf.org/html/rfc2616#section-6
+ */
+interface ResponseInterface extends MessageInterface
+{
+    /**
+     * Gets the response Status-Code, a 3-digit integer result code of the
+     * server's attempt to understand and satisfy the request.
+     *
+     * @return integer Status code.
+     */
+    public function getStatusCode();
+
+    /**
+     * Gets the response Reason-Phrase, a short textual description of the
+     * Status-Code.
+     *
+     * Because a Reason-Phrase is not a required element in response
+     * Status-Line, the Reason-Phrase value MAY be null. Implementations MAY
+     * choose to return the default RFC 2616 recommended reason phrase for the
+     * response's Status-Code.
+     *
+     * @return string|null Reason phrase, or null if unknown.
+     */
+    public function getReasonPhrase();
+}