Imports emitters from zend-diactoros

Imports the `EmitterInterface` and emitter implementations from
zend-diactoros, to allow them to be used with any PSR-7 implementation.

Adds psr/http-message-implementation as a required dependency, and
zend-diactoros as a development dependency to allow testing accurately.

Author: weierophinney

composer.json

@@ -1,12 +1,13 @@
 {
     "name": "zendframework/zend-serverhandler-runner",
-    "description": "<package description; should match repository description>",
+    "description": "Execute PSR-15 RequestHandlerInterface instances and emit responses they generate.",
     "license": "BSD-3-Clause",
     "keywords": [
         "components",
         "zf",
         "zendframework",
-        "<individual keywords for current package>"
+        "psr-7",
+        "psr-15"
     ],
     "support": {
         "docs": "https://docs.zendframework.com/zend-serverhandler-runner/",
@@ -17,11 +18,15 @@
         "forum": "https://discourse.zendframework.com/c/questions/components"
     },
     "require": {
-        "php": "^7.1"
+        "php": "^7.1",
+        "psr/http-message": "^1.0",
+        "psr/http-message-implementation": "^1.0",
+        "psr/http-server-handler": "^1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^6.3",
-        "zendframework/zend-coding-standard": "~1.0.0"
+        "zendframework/zend-coding-standard": "~1.0.0",
+        "zendframework/zend-diactoros": "^1.7"
     },
     "autoload": {
         "psr-4": {
@@ -31,7 +36,11 @@
     "autoload-dev": {
         "psr-4": {
             "ZendTest\\ServerHandler\\Runner\\": "test/"
-        }
+        },
+        "files": [
+            "test/TestAsset/Functions.php",
+            "test/TestAsset/SapiResponse.php"
+        ]
     },
     "config": {
         "sort-packages": true

composer.lock

@@ -0,0 +1,30 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-serverhandler-runner for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-serverhandler-runner/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace Zend\ServerHandler\Runner\Emitter;
+
+use Psr\Http\Message\ResponseInterface;
+
+interface EmitterInterface
+{
+    /**
+     * Emit a response.
+     *
+     * Emits a response, including status line, headers, and the message body,
+     * according to the environment.
+     *
+     * Implementations of this method may be written in such a way as to have
+     * side effects, such as usage of header() or pushing output to the
+     * output buffer.
+     *
+     * Implementations MAY raise exceptions if they are unable to emit the
+     * response; e.g., if headers have already been sent.
+     */
+    public function emit(ResponseInterface $response) : void;
+}

src/Emitter/EmitterInterface.php

@@ -0,0 +1,40 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-serverhandler-runner for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-serverhandler-runner/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace Zend\ServerHandler\Runner\Emitter;
+
+use Psr\Http\Message\ResponseInterface;
+
+class SapiEmitter implements EmitterInterface
+{
+    use SapiEmitterTrait;
+
+    /**
+     * Emits a response for a PHP SAPI environment.
+     *
+     * Emits the status line and headers via the header() function, and the
+     * body content via the output buffer.
+     */
+    public function emit(ResponseInterface $response) : void
+    {
+        $this->assertNoPreviousOutput();
+
+        $this->emitHeaders($response);
+        $this->emitStatusLine($response);
+        $this->emitBody($response);
+    }
+
+    /**
+     * Emit the message body.
+     */
+    private function emitBody(ResponseInterface $response) : void
+    {
+        echo $response->getBody();
+    }
+}

src/Emitter/SapiEmitter.php

@@ -0,0 +1,97 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-serverhandler-runner for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-serverhandler-runner/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace Zend\ServerHandler\Runner\Emitter;
+
+use Psr\Http\Message\ResponseInterface;
+use Zend\ServerHandler\Runner\Exception\EmitterException;
+
+trait SapiEmitterTrait
+{
+    /**
+     * Checks to see if content has previously been sent.
+     *
+     * If either headers have been sent or the output buffer contains content,
+     * raises an exception.
+     *
+     * @throws EmitterException if headers have already been sent.
+     * @throws EmitterException if output is present in the output buffer.
+     */
+    private function assertNoPreviousOutput()
+    {
+        if (headers_sent()) {
+            throw EmitterException::forHeadersSent();
+        }
+
+        if (ob_get_level() > 0 && ob_get_length() > 0) {
+            throw EmitterException::forOutputSent();
+        }
+    }
+
+    /**
+     * Emit the status line.
+     *
+     * Emits the status line using the protocol version and status code from
+     * the response; if a reason phrase is available, it, too, is emitted.
+     *
+     * It is important to mention that this method should be called after
+     * `emitHeaders()` in order to prevent PHP from changing the status code of
+     * the emitted response.
+     *
+     * @see \Zend\ServerHandler\Runner\Emitter\SapiEmitterTrait::emitHeaders()
+     */
+    private function emitStatusLine(ResponseInterface $response) : void
+    {
+        $reasonPhrase = $response->getReasonPhrase();
+        $statusCode   = $response->getStatusCode();
+
+        header(sprintf(
+            'HTTP/%s %d%s',
+            $response->getProtocolVersion(),
+            $statusCode,
+            ($reasonPhrase ? ' ' . $reasonPhrase : '')
+        ), true, $statusCode);
+    }
+
+    /**
+     * Emit response headers.
+     *
+     * Loops through each header, emitting each; if the header value
+     * is an array with multiple values, ensures that each is sent
+     * in such a way as to create aggregate headers (instead of replace
+     * the previous).
+     */
+    private function emitHeaders(ResponseInterface $response) : void
+    {
+        $statusCode = $response->getStatusCode();
+
+        foreach ($response->getHeaders() as $header => $values) {
+            $name  = $this->filterHeader($header);
+            $first = $name === 'Set-Cookie' ? false : true;
+            foreach ($values as $value) {
+                header(sprintf(
+                    '%s: %s',
+                    $name,
+                    $value
+                ), $first, $statusCode);
+                $first = false;
+            }
+        }
+    }
+
+    /**
+     * Filter a header name to wordcase
+     */
+    private function filterHeader(string $header) : string
+    {
+        $filtered = str_replace('-', ' ', $header);
+        $filtered = ucwords($filtered);
+        return str_replace(' ', '-', $filtered);
+    }
+}