4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\HttpFoundation;
15 * Response represents an HTTP response in JSON format.
17 * Note that this class does not force the returned JSON content to be an
18 * object. It is however recommended that you do return an object as it
19 * protects yourself against XSSI and JSON-JavaScript Hijacking.
21 * @see https://www.owasp.org/index.php/OWASP_AJAX_Security_Guidelines#Always_return_JSON_with_an_Object_on_the_outside
23 * @author Igor Wiedler <igor@wiedler.ch>
25 class JsonResponse extends Response
30 // Encode <, >, ', &, and " characters in the JSON, making it also safe to be embedded into HTML.
31 // 15 === JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT
32 const DEFAULT_ENCODING_OPTIONS = 15;
34 protected $encodingOptions = self::DEFAULT_ENCODING_OPTIONS;
37 * @param mixed $data The response data
38 * @param int $status The response status code
39 * @param array $headers An array of response headers
40 * @param bool $json If the data is already a JSON string
42 public function __construct($data = null, $status = 200, $headers = array(), $json = false)
44 parent::__construct('', $status, $headers);
47 $data = new \ArrayObject();
50 $json ? $this->setJson($data) : $this->setData($data);
54 * Factory method for chainability.
58 * return JsonResponse::create($data, 200)
59 * ->setSharedMaxAge(300);
61 * @param mixed $data The json response data
62 * @param int $status The response status code
63 * @param array $headers An array of response headers
67 public static function create($data = null, $status = 200, $headers = array())
69 return new static($data, $status, $headers);
73 * Make easier the creation of JsonResponse from raw json.
75 public static function fromJsonString($data = null, $status = 200, $headers = array())
77 return new static($data, $status, $headers, true);
81 * Sets the JSONP callback.
83 * @param string|null $callback The JSONP callback or null to use none
87 * @throws \InvalidArgumentException When the callback name is not valid
89 public function setCallback($callback = null)
91 if (null !== $callback) {
92 // partially taken from http://www.geekality.net/2011/08/03/valid-javascript-identifier/
93 // partially taken from https://github.com/willdurand/JsonpCallbackValidator
94 // JsonpCallbackValidator is released under the MIT License. See https://github.com/willdurand/JsonpCallbackValidator/blob/v1.1.0/LICENSE for details.
95 // (c) William Durand <william.durand1@gmail.com>
96 $pattern = '/^[$_\p{L}][$_\p{L}\p{Mn}\p{Mc}\p{Nd}\p{Pc}\x{200C}\x{200D}]*(?:\[(?:"(?:\\\.|[^"\\\])*"|\'(?:\\\.|[^\'\\\])*\'|\d+)\])*?$/u';
98 'break', 'do', 'instanceof', 'typeof', 'case', 'else', 'new', 'var', 'catch', 'finally', 'return', 'void', 'continue', 'for', 'switch', 'while',
99 'debugger', 'function', 'this', 'with', 'default', 'if', 'throw', 'delete', 'in', 'try', 'class', 'enum', 'extends', 'super', 'const', 'export',
100 'import', 'implements', 'let', 'private', 'public', 'yield', 'interface', 'package', 'protected', 'static', 'null', 'true', 'false',
102 $parts = explode('.', $callback);
103 foreach ($parts as $part) {
104 if (!preg_match($pattern, $part) || \in_array($part, $reserved, true)) {
105 throw new \InvalidArgumentException('The callback name is not valid.');
110 $this->callback = $callback;
112 return $this->update();
116 * Sets a raw string containing a JSON document to be sent.
118 * @param string $json
122 * @throws \InvalidArgumentException
124 public function setJson($json)
128 return $this->update();
132 * Sets the data to be sent as JSON.
138 * @throws \InvalidArgumentException
140 public function setData($data = array())
142 if (\defined('HHVM_VERSION')) {
143 // HHVM does not trigger any warnings and let exceptions
144 // thrown from a JsonSerializable object pass through.
145 // If only PHP did the same...
146 $data = json_encode($data, $this->encodingOptions);
148 if (!interface_exists('JsonSerializable', false)) {
149 set_error_handler(function () { return false; });
151 $data = @json_encode($data, $this->encodingOptions);
153 restore_error_handler();
157 $data = json_encode($data, $this->encodingOptions);
158 } catch (\Exception $e) {
159 if ('Exception' === \get_class($e) && 0 === strpos($e->getMessage(), 'Failed calling ')) {
160 throw $e->getPrevious() ?: $e;
167 if (JSON_ERROR_NONE !== json_last_error()) {
168 throw new \InvalidArgumentException(json_last_error_msg());
171 return $this->setJson($data);
175 * Returns options used while encoding data to JSON.
179 public function getEncodingOptions()
181 return $this->encodingOptions;
185 * Sets options used while encoding data to JSON.
187 * @param int $encodingOptions
191 public function setEncodingOptions($encodingOptions)
193 $this->encodingOptions = (int) $encodingOptions;
195 return $this->setData(json_decode($this->data));
199 * Updates the content and headers according to the JSON data and callback.
203 protected function update()
205 if (null !== $this->callback) {
206 // Not using application/javascript for compatibility reasons with older browsers.
207 $this->headers->set('Content-Type', 'text/javascript');
209 return $this->setContent(sprintf('/**/%s(%s);', $this->callback, $this->data));
212 // Only set the header when there is none or when it equals 'text/javascript' (from a previous update with callback)
213 // in order to not overwrite a custom definition.
214 if (!$this->headers->has('Content-Type') || 'text/javascript' === $this->headers->get('Content-Type')) {
215 $this->headers->set('Content-Type', 'application/json');
218 return $this->setContent($this->data);