This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
symfony/src/Symfony/Component/HttpFoundation/JsonResponse.php

102 lines
2.5 KiB
PHP
Raw Normal View History

<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\HttpFoundation;
/**
* Response represents an HTTP response in JSON format.
*
* @author Igor Wiedler <igor@wiedler.ch>
*/
class JsonResponse extends Response
{
protected $data;
protected $callback;
/**
* Constructor.
*
* @param mixed $data The response data
* @param integer $status The response status code
* @param array $headers An array of response headers
2012-03-19 17:27:08 +00:00
* @param string $jsonp A JSONP callback name
*/
2012-03-19 17:27:08 +00:00
public function __construct($data = array(), $status = 200, $headers = array(), $jsonp = '')
{
parent::__construct('', $status, $headers);
$this->setData($data);
$this->setCallback($jsonp);
}
/**
* {@inheritDoc}
*
* @param string $jsonp A JSONP callback name.
*/
static public function create($data = array(), $status = 200, $headers = array(), $jsonp = '')
{
return new static($data, $status, $headers, $jsonp = '');
}
/**
* Sets the JSONP callback.
*
* @param string $callback
*
* @return JsonResponse
*/
public function setCallback($callback)
{
$this->callback = $callback;
return $this->update();
}
/**
* Sets the data to be sent as json.
*
* @param mixed $data
*
* @return JsonResponse
*/
public function setData($data = array())
{
// root should be JSON object, not array
if (is_array($data) && 0 === count($data)) {
$data = new \ArrayObject();
}
$this->data = json_encode($data);
2012-03-19 17:27:08 +00:00
return $this->update();
}
/**
* Updates the content and headers according to the json data and callback.
2012-03-19 17:27:08 +00:00
*
* @return JsonResponse
*/
protected function update()
{
$content = $this->data;
$this->headers->set('Content-Type', 'application/json', false);
if (!empty($this->callback)) {
$content = sprintf('%s(%s);', $this->callback, $content);
// Not using application/javascript for compatibility reasons with older browsers.
$this->headers->set('Content-Type', 'text/javascript', true);
}
return $this->setContent($content);
}
}