HtmlResponse.php in Zircon Profile 8.0

Namespace

Zend\Diactoros\Response

File

vendor/zendframework/zend-diactoros/src/Response/HtmlResponse.php

<?php

/**
 * Zend Framework (http://framework.zend.com/)
 *
 * @see       http://github.com/zendframework/zend-diactoros for the canonical source repository
 * @copyright Copyright (c) 2015 Zend Technologies USA Inc. (http://www.zend.com)
 * @license   https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
 */
namespace Zend\Diactoros\Response;

use InvalidArgumentException;
use Psr\Http\Message\StreamInterface;
use Zend\Diactoros\Response;
use Zend\Diactoros\Stream;

/**
 * HTML response.
 *
 * Allows creating a response by passing an HTML string to the constructor;
 * by default, sets a status code of 200 and sets the Content-Type header to
 * text/html.
 */
class HtmlResponse extends Response {
  use InjectContentTypeTrait;

  /**
   * Create an HTML response.
   *
   * Produces an HTML response with a Content-Type of text/html and a default
   * status of 200.
   *
   * @param string|StreamInterface $html HTML or stream for the message body.
   * @param int $status Integer status code for the response; 200 by default.
   * @param array $headers Array of headers to use at initialization.
   * @throws InvalidArgumentException if $html is neither a string or stream.
   */
  public function __construct($html, $status = 200, array $headers = []) {
    parent::__construct($this
      ->createBody($html), $status, $this
      ->injectContentType('text/html', $headers));
  }

  /**
   * Create the message body.
   *
   * @param string|StreamInterface $html
   * @return StreamInterface
   * @throws InvalidArgumentException if $html is neither a string or stream.
   */
  private function createBody($html) {
    if ($html instanceof StreamInterface) {
      return $html;
    }
    if (!is_string($html)) {
      throw new InvalidArgumentException(sprintf('Invalid content (%s) provided to %s', is_object($html) ? get_class($html) : gettype($html), __CLASS__));
    }
    $body = new Stream('php://temp', 'wb+');
    $body
      ->write($html);
    return $body;
  }

}

Classes

Name	Description
HtmlResponse	HTML response.