/
JsonView.php
193 lines (176 loc) · 5.95 KB
/
JsonView.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 2.1.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\View;
use Cake\Core\Configure;
use Cake\Event\EventManager;
use Cake\Network\Request;
use Cake\Network\Response;
/**
* A view class that is used for JSON responses.
*
* It allows you to omit templates if you just need to emit JSON string as response.
*
* In your controller, you could do the following:
*
* ```
* $this->set(['posts' => $posts]);
* $this->set('_serialize', true);
* ```
*
* When the view is rendered, the `$posts` view variable will be serialized
* into JSON.
*
* You can also set multiple view variables for serialization. This will create
* a top level object containing all the named view variables:
*
* ```
* $this->set(compact('posts', 'users', 'stuff'));
* $this->set('_serialize', true);
* ```
*
* The above would generate a JSON object that looks like:
*
* `{"posts": [...], "users": [...]}`
*
* You can also set `'_serialize'` to a string or array to serialize only the
* specified view variables.
*
* If you don't use the `_serialize`, you will need a view template. You can use
* extended views to provide layout-like functionality.
*
* You can also enable JSONP support by setting parameter `_jsonp` to true or a
* string to specify custom query string parameter name which will contain the
* callback function name.
*/
class JsonView extends SerializedView
{
/**
* JSON layouts are located in the json sub directory of `Layouts/`
*
* @var string
*/
public $layoutPath = 'json';
/**
* JSON views are located in the 'json' sub directory for controllers' views.
*
* @var string
*/
public $subDir = 'json';
/**
* Response type.
*
* @var string
*/
protected $_responseType = 'json';
/**
* List of special view vars.
*
* @var array
*/
protected $_specialVars = ['_serialize', '_jsonOptions', '_jsonp'];
/**
* Render a JSON view.
*
* ### Special parameters
* `_serialize` To convert a set of view variables into a JSON response.
* Its value can be a string for single variable name or array for multiple
* names. If true all view variables will be serialized. It unset normal
* view template will be rendered.
* `_jsonp` Enables JSONP support and wraps response in callback function
* provided in query string.
* - Setting it to true enables the default query string parameter "callback".
* - Setting it to a string value, uses the provided query string parameter
* for finding the JSONP callback name.
*
* @param string|null $view The view being rendered.
* @param string|null $layout The layout being rendered.
* @return string|null The rendered view.
*/
public function render($view = null, $layout = null)
{
$return = parent::render($view, $layout);
if (!empty($this->viewVars['_jsonp'])) {
$jsonpParam = $this->viewVars['_jsonp'];
if ($this->viewVars['_jsonp'] === true) {
$jsonpParam = 'callback';
}
if (isset($this->request->query[$jsonpParam])) {
$return = sprintf('%s(%s)', h($this->request->query[$jsonpParam]), $return);
$this->response->type('js');
}
}
return $return;
}
/**
* Serialize view vars
*
* ### Special parameters
* `_jsonOptions` You can set custom options for json_encode() this way,
* e.g. `JSON_HEX_TAG | JSON_HEX_APOS`.
*
* @param array|string|bool $serialize The name(s) of the view variable(s)
* that need(s) to be serialized. If true all available view variables.
* @return string The serialized data
*/
protected function _serialize($serialize)
{
$data = $this->_dataToSerialize($serialize);
$jsonOptions = JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT;
if (isset($this->viewVars['_jsonOptions'])) {
if ($this->viewVars['_jsonOptions'] === false) {
$jsonOptions = 0;
} else {
$jsonOptions = $this->viewVars['_jsonOptions'];
}
}
if (Configure::read('debug')) {
$jsonOptions = $jsonOptions | JSON_PRETTY_PRINT;
}
return json_encode($data, $jsonOptions);
}
/**
* Returns data to be serialized.
*
* @param array|string|bool $serialize The name(s) of the view variable(s) that
* need(s) to be serialized. If true all available view variables will be used.
* @return mixed The data to serialize.
*/
protected function _dataToSerialize($serialize = true)
{
if ($serialize === true) {
$data = array_diff_key(
$this->viewVars,
array_flip($this->_specialVars)
);
if (empty($data)) {
return null;
}
return $data;
}
if (is_array($serialize)) {
$data = [];
foreach ($serialize as $alias => $key) {
if (is_numeric($alias)) {
$alias = $key;
}
if (array_key_exists($key, $this->viewVars)) {
$data[$alias] = $this->viewVars[$key];
}
}
return !empty($data) ? $data : null;
}
return isset($this->viewVars[$serialize]) ? $this->viewVars[$serialize] : null;
}
}