Chris@0: <?php
Chris@0: /**
Chris@0:  * Zend Framework (http://framework.zend.com/)
Chris@0:  *
Chris@0:  * @see       http://github.com/zendframework/zend-diactoros for the canonical source repository
Chris@0:  * @copyright Copyright (c) 2015-2016 Zend Technologies USA Inc. (http://www.zend.com)
Chris@0:  * @license   https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
Chris@0:  */
Chris@0: 
Chris@0: namespace Zend\Diactoros\Response;
Chris@0: 
Chris@0: use InvalidArgumentException;
Chris@0: use Zend\Diactoros\Response;
Chris@0: use Zend\Diactoros\Stream;
Chris@0: 
Chris@0: /**
Chris@0:  * JSON response.
Chris@0:  *
Chris@0:  * Allows creating a response by passing data to the constructor; by default,
Chris@0:  * serializes the data to JSON, sets a status code of 200 and sets the
Chris@0:  * Content-Type header to application/json.
Chris@0:  */
Chris@0: class JsonResponse extends Response
Chris@0: {
Chris@0:     use InjectContentTypeTrait;
Chris@0: 
Chris@0:     /**
Chris@0:      * Default flags for json_encode; value of:
Chris@0:      *
Chris@0:      * <code>
Chris@0:      * JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_SLASHES
Chris@0:      * </code>
Chris@0:      *
Chris@0:      * @const int
Chris@0:      */
Chris@0:     const DEFAULT_JSON_FLAGS = 79;
Chris@0: 
Chris@0:     /**
Chris@0:      * Create a JSON response with the given data.
Chris@0:      *
Chris@0:      * Default JSON encoding is performed with the following options, which
Chris@0:      * produces RFC4627-compliant JSON, capable of embedding into HTML.
Chris@0:      *
Chris@0:      * - JSON_HEX_TAG
Chris@0:      * - JSON_HEX_APOS
Chris@0:      * - JSON_HEX_AMP
Chris@0:      * - JSON_HEX_QUOT
Chris@0:      * - JSON_UNESCAPED_SLASHES
Chris@0:      *
Chris@0:      * @param mixed $data Data to convert to JSON.
Chris@0:      * @param int $status Integer status code for the response; 200 by default.
Chris@0:      * @param array $headers Array of headers to use at initialization.
Chris@0:      * @param int $encodingOptions JSON encoding options to use.
Chris@0:      * @throws InvalidArgumentException if unable to encode the $data to JSON.
Chris@0:      */
Chris@0:     public function __construct(
Chris@0:         $data,
Chris@0:         $status = 200,
Chris@0:         array $headers = [],
Chris@0:         $encodingOptions = self::DEFAULT_JSON_FLAGS
Chris@0:     ) {
Chris@0:         $body = new Stream('php://temp', 'wb+');
Chris@0:         $body->write($this->jsonEncode($data, $encodingOptions));
Chris@0:         $body->rewind();
Chris@0: 
Chris@0:         $headers = $this->injectContentType('application/json', $headers);
Chris@0: 
Chris@0:         parent::__construct($body, $status, $headers);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Encode the provided data to JSON.
Chris@0:      *
Chris@0:      * @param mixed $data
Chris@0:      * @param int $encodingOptions
Chris@0:      * @return string
Chris@0:      * @throws InvalidArgumentException if unable to encode the $data to JSON.
Chris@0:      */
Chris@0:     private function jsonEncode($data, $encodingOptions)
Chris@0:     {
Chris@0:         if (is_resource($data)) {
Chris@0:             throw new InvalidArgumentException('Cannot JSON encode resources');
Chris@0:         }
Chris@0: 
Chris@0:         // Clear json_last_error()
Chris@0:         json_encode(null);
Chris@0: 
Chris@0:         $json = json_encode($data, $encodingOptions);
Chris@0: 
Chris@0:         if (JSON_ERROR_NONE !== json_last_error()) {
Chris@0:             throw new InvalidArgumentException(sprintf(
Chris@0:                 'Unable to encode data to JSON in %s: %s',
Chris@0:                 __CLASS__,
Chris@0:                 json_last_error_msg()
Chris@0:             ));
Chris@0:         }
Chris@0: 
Chris@0:         return $json;
Chris@0:     }
Chris@0: }