|
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071 |
- <?php
- /**
- * @link http://www.yiiframework.com/
- * @copyright Copyright (c) 2008 Yii Software LLC
- * @license http://www.yiiframework.com/license/
- */
-
- namespace yii\web;
-
- use Yii;
- use yii\base\Component;
- use yii\helpers\Json;
-
- /**
- * JsonResponseFormatter formats the given data into a JSON or JSONP response content.
- *
- * It is used by [[Response]] to format response data.
- *
- * @author Qiang Xue <qiang.xue@gmail.com>
- * @since 2.0
- */
- class JsonResponseFormatter extends Component implements ResponseFormatterInterface
- {
- /**
- * @var boolean whether to use JSONP response format. When this is true, the [[Response::data|response data]]
- * must be an array consisting of `data` and `callback` members. The latter should be a JavaScript
- * function name while the former will be passed to this function as a parameter.
- */
- public $useJsonp = false;
-
-
- /**
- * Formats the specified response.
- * @param Response $response the response to be formatted.
- */
- public function format($response)
- {
- if ($this->useJsonp) {
- $this->formatJsonp($response);
- } else {
- $this->formatJson($response);
- }
- }
-
- /**
- * Formats response data in JSON format.
- * @param Response $response
- */
- protected function formatJson($response)
- {
- $response->getHeaders()->set('Content-Type', 'application/json; charset=UTF-8');
- if ($response->data !== null) {
- $response->content = Json::encode($response->data);
- }
- }
-
- /**
- * Formats response data in JSONP format.
- * @param Response $response
- */
- protected function formatJsonp($response)
- {
- $response->getHeaders()->set('Content-Type', 'application/javascript; charset=UTF-8');
- if (is_array($response->data) && isset($response->data['data'], $response->data['callback'])) {
- $response->content = sprintf('%s(%s);', $response->data['callback'], Json::encode($response->data['data']));
- } elseif ($response->data !== null) {
- $response->content = '';
- Yii::warning("The 'jsonp' response requires that the data be an array consisting of both 'data' and 'callback' elements.", __METHOD__);
- }
- }
- }
|