forked from UnionOfRAD/lithium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Controller.php
333 lines (303 loc) · 12.9 KB
/
Controller.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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
<?php
/**
* Lithium: the most rad php framework
*
* @copyright Copyright 2011, Union of RAD (http://union-of-rad.org)
* @license http://opensource.org/licenses/bsd-license.php The BSD License
*/
namespace lithium\action;
use lithium\util\Inflector;
use lithium\action\DispatchException;
/**
* The `Controller` class is the fundamental building block of your application's request/response
* cycle. Controllers are organized around a single logical entity, usually one or more model
* classes (i.e. `lithium\data\Model`) and are tasked with performing operations against that
* entity.
*
* Each controller has a series of 'actions' which are defined as class methods of the `Controller`
* classes. Each action has a specific responsibility, such as listing a set of objects, updating an
* object, or deleting an object.
*
* A controller object is instantiated by the `Dispatcher` (`lithium\action\Dispatcher`), and is
* given an instance of the `lithium\action\Request` class, which contains all necessary request
* state, including routing information, `GET` & `POST` data, and server variables. The controller
* is then invoked (using PHP's magic `__invoke()` syntax), and the proper action is called,
* according to the routing information stored in the `Request` object.
*
* A controller then returns a response (i.e. using `redirect()` or `render()`) which includes HTTP
* headers, and/or a serialized data response (JSON or XML, etc.) or HTML webpage.
*
* For more information on returning serialized data responses for web services, or manipulating
* template rendering from within your controllers, see the settings in `$_render` and the
* `lithium\net\http\Media` class.
*
* @see lithium\net\http\Media
* @see lithium\action\Dispatcher
* @see lithium\action\Controller::$_render
*/
class Controller extends \lithium\core\Object {
/**
* Contains an instance of the `Request` object with all the details of the HTTP request that
* was dispatched to the controller object. Any parameters captured in routing, such as
* controller or action name are accessible as properties of this object, i.e.
* `$this->request->controller` or `$this->request->action`.
*
* @see lithium\action\Request
* @var object
*/
public $request = null;
/**
* Contains an instance of the `Response` object which aggregates the headers and body content
* to be written back to the client (browser) when the result of the request is rendered.
*
* @see lithium\action\Response
* @var object
*/
public $response = null;
/**
* Used for restricting media types on a per-action basis. Media types not defined in this list
* will have the request terminated.
* The list is formatted as `'action' => array('type1', 'type2'), 'action2' => array('html')`
* @var array
*/
public $_allowedTypes = array();
/**
* Lists the rendering control options for responses generated by this controller.
*
* - The `'type'` key is the content type that will be rendered by default, unless another is
* explicitly specified (defaults to `'html'`).
* - The `'data'` key contains an associative array of variables to be sent to the view,
* including any variables created in `set()`, or if an action returns any variables (as an
* associative array).
* - When an action is invoked, it will by default attempt to render a response, set the
* `'auto'` key to `false` to prevent this behavior.
* - If you manually call `render()` within an action, the `'hasRendered'` key stores this
* state, so that responses are not rendered multiple times, either manually or automatically.
* - The `'layout'` key specifies the name of the layout to be used (defaults to `'default'`).
* Typically, layout files are looked up as
* `<app-path>/views/layouts/<layout-name>.<type>.php`. Based on the default settings, the
* actual path would be `app/views/layouts/default.html.php`.
* - Though typically introspected from the action that is executed, the `'template'` key can be
* manually specified. This sets the template to be rendered, and is looked up (by default) as
* `<app-path>/views/<controller>/<action>.<type>.php`, i.e.:
* `app/views/posts/index.html.php`.
* - To enable automatic content-type negotiation (i.e. determining the content type of the
* response based on the value of the
* [HTTP Accept header](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html)), set the
* `'negotiate'` flag to `true`. Otherwise, the response will only be based on the `type`
* parameter of the request object (defaulting to `'html'` if no type is present in the
* `Request` parameters).
*
* Keep in mind that most of these settings may be passed to `Controller::render()` as well. To
* change how these settings operate (i.e. template paths, default render settings for
* individual media types), see the `Media` class.
*
* @var array
* @see lithium\action\Controller::render()
* @see lithium\net\http\Media::type()
* @see lithium\net\http\Media::render()
*/
protected $_render = array(
'type' => null,
'data' => array(),
'auto' => true,
'layout' => 'default',
'template' => null,
'hasRendered' => false,
'negotiate' => false
);
/**
* Lists `Controller`'s class dependencies. For details on extending or replacing a class,
* please refer to that class's API.
*
* @var array
*/
protected $_classes = array(
'media' => 'lithium\net\http\Media',
'router' => 'lithium\net\http\Router',
'response' => 'lithium\action\Response'
);
/**
* Auto configuration properties.
*
* @var array
*/
protected $_autoConfig = array('render' => 'merge', 'classes' => 'merge');
public function __construct(array $config = array()) {
$defaults = array(
'request' => null, 'response' => array(), 'render' => array(), 'classes' => array()
);
parent::__construct($config + $defaults);
}
protected function _init() {
parent::_init();
$this->request = $this->request ?: $this->_config['request'];
$this->response = $this->_instance('response', $this->_config['response']);
if (!$this->request || $this->_render['type']) {
return;
}
if ($this->_render['negotiate']) {
$this->_render['type'] = $this->request->accepts();
return;
}
$this->_render['type'] = $this->request->type ?: 'html';
}
/**
* Called by the Dispatcher class to invoke an action.
*
* @param object $request The request object with URL and HTTP info for dispatching this action.
* @param array $dispatchParams The array of parameters that will be passed to the action.
* @param array $options The dispatch options for this action.
* @return object Returns the response object associated with this controller.
* @todo Implement proper exception catching/throwing
* @filter This method can be filtered.
*/
public function __invoke($request, $dispatchParams, array $options = array()) {
$render =& $this->_render;
$params = compact('request', 'dispatchParams', 'options');
return $this->_filter(__METHOD__, $params, function($self, $params) use (&$render) {
$request = $params['request'];
$dispatchParams = $params['dispatchParams'];
$options = $params['options'];
$action = isset($dispatchParams['action']) ? $dispatchParams['action'] : 'index';
$args = isset($dispatchParams['args']) ? $dispatchParams['args'] : array();
$result = null;
if (substr($action, 0, 1) == '_' || method_exists(__CLASS__, $action)) {
throw new DispatchException('Attempted to invoke a private method.');
}
if (!method_exists($self, $action)) {
throw new DispatchException("Action `{$action}` not found.");
}
$render['template'] = $render['template'] ?: $action;
if ($result = $self->invokeMethod($action, $args)) {
if (is_string($result)) {
$self->render(array('text' => $result));
return $self->response;
}
if (is_array($result)) {
$self->set($result);
}
}
if (!$render['hasRendered'] && $render['auto']) {
$self->render();
}
return $self->response;
});
}
/**
* This method is used to pass along any data from the controller to the view and layout
*
* @param array $data sets of <variable name> => <variable value> to pass to view layer.
* @return void
*/
public function set($data = array()) {
$this->_render['data'] = (array) $data + $this->_render['data'];
}
/**
* Uses results (typically coming from a controller action) to generate content and headers for
* a `Response` object.
*
* @see lithium\action\Controller::$_render
* @param array $options An array of options, as follows:
* - `'data'`: An associative array of variables to be assigned to the template. These
* are merged on top of any variables set in `Controller::set()`.
* - `'head'`: If true, only renders the headers of the response, not the body. Defaults
* to `false`.
* - `'template'`: The name of a template, which usually matches the name of the action.
* By default, this template is looked for in the views directory of the current
* controller, i.e. given a `PostsController` object, if template is set to `'view'`,
* the template path would be `views/posts/view.html.php`. Defaults to the name of the
* action being rendered.
*
* The options specified here are merged with the values in the `Controller::$_render`
* property. You may refer to it for other options accepted by this method.
* @return void
*/
public function render(array $options = array()) {
$media = $this->_classes['media'];
$class = get_class($this);
$name = preg_replace('/Controller$/', '', substr($class, strrpos($class, '\\') + 1));
$key = key($options);
if (isset($options['data'])) {
$this->set($options['data']);
unset($options['data']);
}
$defaults = array(
'status' => null,
'location' => false,
'data' => null,
'head' => false,
'controller' => Inflector::underscore($name)
);
$options += $this->_render + $defaults;
if (!$this->_validMediaType()) {
$type = $this->_render['type'];
throw new DispatchException("Media type `{$type}` not permitted for this request.");
}
if ($key && $media::type($key)) {
$options['type'] = $key;
$this->set($options[$key]);
unset($options[$key]);
}
$this->_render['hasRendered'] = true;
$this->response->type($options['type']);
$this->response->status($options['status']);
$this->response->headers('Location', $options['location']);
if ($options['head']) {
return;
}
$data = $this->_render['data'];
$data = (isset($data[0]) && count($data) == 1) ? $data[0] : $data;
$media::render($this->response, $data, $options + array('request' => $this->request));
}
protected function _validMediaType() {
if (!is_object($this->request)) {
return true;
}
$action = $this->request->params['action'];
$type = $this->_render['type'];
$allowedTypes = &$this->_allowedTypes;
$allowedArray = isset($allowedTypes[$action]) ? $allowedTypes[$action] : array('html');
if(in_array($type, $allowedArray)) {
return true;
}
return false;
}
/**
* Creates a redirect response by calling `render()` and providing a `'location'` parameter.
*
* @see lithium\net\http\Router::match()
* @see lithium\action\Controller::$response
* @param mixed $url The location to redirect to, provided as a string relative to the root of
* the application, a fully-qualified URL, or an array of routing parameters to be
* resolved to a URL. Post-processed by `Router::match()`.
* @param array $options Options when performing the redirect. Available options include:
* - `'status'` _integer_: The HTTP status code associated with the redirect.
* Defaults to `302`.
* - `'head'` _boolean_: Determines whether only headers are returned with the
* response. Defaults to `true`, in which case only headers and no body are
* returned. Set to `false` to render a body as well.
* - `'exit'` _boolean_: Exit immediately after rendering. Defaults to `false`.
* Because `redirect()` does not exit by default, you should always prefix calls
* with a `return` statement, so that the action is always immedately exited.
* @return object Returns the instance of the `Response` object associated with this controller.
* @filter This method can be filtered.
*/
public function redirect($url, array $options = array()) {
$router = $this->_classes['router'];
$defaults = array('location' => null, 'status' => 302, 'head' => true, 'exit' => false);
$options += $defaults;
$params = compact('url', 'options');
$this->_filter(__METHOD__, $params, function($self, $params) use ($router) {
$options = $params['options'];
$location = $options['location'] ?: $router::match($params['url'], $self->request);
$self->render(compact('location') + $options);
});
if ($options['exit']) {
$this->response->render();
$this->_stop();
}
return $this->response;
}
}
?>