Chris@12: <?php
Chris@12: /**
Chris@12:  * @see       https://github.com/zendframework/zend-diactoros for the canonical source repository
Chris@12:  * @copyright Copyright (c) 2015-2017 Zend Technologies USA Inc. (http://www.zend.com)
Chris@12:  * @license   https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
Chris@12:  */
Chris@12: 
Chris@12: namespace Zend\Diactoros\Response;
Chris@12: 
Chris@12: use InvalidArgumentException;
Chris@12: use Psr\Http\Message\StreamInterface;
Chris@12: use Zend\Diactoros\Response;
Chris@12: use Zend\Diactoros\Stream;
Chris@12: 
Chris@16: use function get_class;
Chris@16: use function gettype;
Chris@16: use function is_object;
Chris@16: use function is_string;
Chris@16: use function sprintf;
Chris@16: 
Chris@12: /**
Chris@12:  * XML response.
Chris@12:  *
Chris@12:  * Allows creating a response by passing an XML string to the constructor; by default,
Chris@12:  * sets a status code of 200 and sets the Content-Type header to application/xml.
Chris@12:  */
Chris@12: class XmlResponse extends Response
Chris@12: {
Chris@12:     use InjectContentTypeTrait;
Chris@12: 
Chris@12:     /**
Chris@12:      * Create an XML response.
Chris@12:      *
Chris@12:      * Produces an XML response with a Content-Type of application/xml and a default
Chris@12:      * status of 200.
Chris@12:      *
Chris@12:      * @param string|StreamInterface $xml String or stream for the message body.
Chris@12:      * @param int $status Integer status code for the response; 200 by default.
Chris@12:      * @param array $headers Array of headers to use at initialization.
Chris@12:      * @throws InvalidArgumentException if $text is neither a string or stream.
Chris@12:      */
Chris@12:     public function __construct(
Chris@12:         $xml,
Chris@12:         $status = 200,
Chris@12:         array $headers = []
Chris@12:     ) {
Chris@12:         parent::__construct(
Chris@12:             $this->createBody($xml),
Chris@12:             $status,
Chris@12:             $this->injectContentType('application/xml; charset=utf-8', $headers)
Chris@12:         );
Chris@12:     }
Chris@12: 
Chris@12:     /**
Chris@12:      * Create the message body.
Chris@12:      *
Chris@12:      * @param string|StreamInterface $xml
Chris@12:      * @return StreamInterface
Chris@12:      * @throws InvalidArgumentException if $xml is neither a string or stream.
Chris@12:      */
Chris@12:     private function createBody($xml)
Chris@12:     {
Chris@12:         if ($xml instanceof StreamInterface) {
Chris@12:             return $xml;
Chris@12:         }
Chris@12: 
Chris@12:         if (! is_string($xml)) {
Chris@12:             throw new InvalidArgumentException(sprintf(
Chris@12:                 'Invalid content (%s) provided to %s',
Chris@12:                 (is_object($xml) ? get_class($xml) : gettype($xml)),
Chris@12:                 __CLASS__
Chris@12:             ));
Chris@12:         }
Chris@12: 
Chris@12:         $body = new Stream('php://temp', 'wb+');
Chris@12:         $body->write($xml);
Chris@12:         $body->rewind();
Chris@12:         return $body;
Chris@12:     }
Chris@12: }