-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
Controller.php
787 lines (723 loc) · 26 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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
<?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 0.2.9
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Controller;
use Cake\Controller\Exception\MissingActionException;
use Cake\Datasource\ModelAwareTrait;
use Cake\Event\Event;
use Cake\Event\EventDispatcherInterface;
use Cake\Event\EventDispatcherTrait;
use Cake\Event\EventListenerInterface;
use Cake\Log\LogTrait;
use Cake\Network\Request;
use Cake\Network\Response;
use Cake\ORM\Locator\LocatorAwareTrait;
use Cake\Routing\RequestActionTrait;
use Cake\Routing\Router;
use Cake\Utility\MergeVariablesTrait;
use Cake\View\ViewVarsTrait;
use LogicException;
use ReflectionClass;
use ReflectionException;
use ReflectionMethod;
use RuntimeException;
/**
* Application controller class for organization of business logic.
* Provides basic functionality, such as rendering views inside layouts,
* automatic model availability, redirection, callbacks, and more.
*
* Controllers should provide a number of 'action' methods. These are public
* methods on a controller that are not inherited from `Controller`.
* Each action serves as an endpoint for performing a specific action on a
* resource or collection of resources. For example adding or editing a new
* object, or listing a set of objects.
*
* You can access request parameters, using `$this->request`. The request object
* contains all the POST, GET and FILES that were part of the request.
*
* After performing the required action, controllers are responsible for
* creating a response. This usually takes the form of a generated `View`, or
* possibly a redirection to another URL. In either case `$this->response`
* allows you to manipulate all aspects of the response.
*
* Controllers are created by `Dispatcher` based on request parameters and
* routing. By default controllers and actions use conventional names.
* For example `/posts/index` maps to `PostsController::index()`. You can re-map
* URLs using Router::connect() or RouterBuilder::connect().
*
* ### Life cycle callbacks
*
* CakePHP fires a number of life cycle callbacks during each request.
* By implementing a method you can receive the related events. The available
* callbacks are:
*
* - `beforeFilter(Event $event)`
* Called before each action. This is a good place to do general logic that
* applies to all actions.
* - `beforeRender(Event $event)`
* Called before the view is rendered.
* - `beforeRedirect(Event $event, $url, Response $response)`
* Called before a redirect is done.
* - `afterFilter(Event $event)`
* Called after each action is complete and after the view is rendered.
*
* @property \Cake\Controller\Component\AuthComponent $Auth
* @property \Cake\Controller\Component\CookieComponent $Cookie
* @property \Cake\Controller\Component\CsrfComponent $Csrf
* @property \Cake\Controller\Component\FlashComponent $Flash
* @property \Cake\Controller\Component\PaginatorComponent $Paginator
* @property \Cake\Controller\Component\RequestHandlerComponent $RequestHandler
* @property \Cake\Controller\Component\SecurityComponent $Security
* @link http://book.cakephp.org/3.0/en/controllers.html
*/
class Controller implements EventListenerInterface, EventDispatcherInterface
{
use EventDispatcherTrait;
use LocatorAwareTrait;
use LogTrait;
use MergeVariablesTrait;
use ModelAwareTrait;
use RequestActionTrait;
use ViewVarsTrait;
/**
* The name of this controller. Controller names are plural, named after the model they manipulate.
*
* Set automatically using conventions in Controller::__construct().
*
* @var string
*/
public $name = null;
/**
* An array containing the names of helpers this controller uses. The array elements should
* not contain the "Helper" part of the class name.
*
* Example:
* ```
* public $helpers = ['Form', 'Html', 'Time'];
* ```
*
* @var array
* @link http://book.cakephp.org/3.0/en/controllers.html#configuring-helpers-to-load
*/
public $helpers = [];
/**
* An instance of a Cake\Network\Request object that contains information about the current request.
* This object contains all the information about a request and several methods for reading
* additional information about the request.
*
* @var \Cake\Network\Request
* @link http://book.cakephp.org/3.0/en/controllers/request-response.html#request
*/
public $request;
/**
* An instance of a Response object that contains information about the impending response
*
* @var \Cake\Network\Response
* @link http://book.cakephp.org/3.0/en/controllers/request-response.html#response
*/
public $response;
/**
* The class name to use for creating the response object.
*
* @var string
*/
protected $_responseClass = 'Cake\Network\Response';
/**
* Settings for pagination.
*
* Used to pre-configure pagination preferences for the various
* tables your controller will be paginating.
*
* @var array
* @see \Cake\Controller\Component\PaginatorComponent
*/
public $paginate = [];
/**
* Set to true to automatically render the view
* after action logic.
*
* @var bool
*/
public $autoRender = true;
/**
* Instance of ComponentRegistry used to create Components
*
* @var \Cake\Controller\ComponentRegistry
*/
protected $_components = null;
/**
* Array containing the names of components this controller uses. Component names
* should not contain the "Component" portion of the class name.
*
* Example:
* ```
* public $components = ['RequestHandler', 'Acl'];
* ```
*
* @var array
* @link http://book.cakephp.org/3.0/en/controllers/components.html
*/
public $components = [];
/**
* Instance of the View created during rendering. Won't be set until after
* Controller::render() is called.
*
* @var \Cake\View\View
* @deprecated 3.1.0 Use viewBuilder() instead.
*/
public $View;
/**
* These Controller properties will be passed from the Controller to the View as options.
*
* @var array
* @see \Cake\View\View
*/
protected $_validViewOptions = [
'passedArgs'
];
/**
* Automatically set to the name of a plugin.
*
* @var string
*/
public $plugin = null;
/**
* Holds all passed params.
*
* @var array
* @deprecated 3.1.0 Use `$this->request->params['pass']` instead.
*/
public $passedArgs = [];
/**
* Constructor.
*
* Sets a number of properties based on conventions if they are empty. To override the
* conventions CakePHP uses you can define properties in your class declaration.
*
* @param \Cake\Network\Request|null $request Request object for this controller. Can be null for testing,
* but expect that features that use the request parameters will not work.
* @param \Cake\Network\Response|null $response Response object for this controller.
* @param string|null $name Override the name useful in testing when using mocks.
* @param \Cake\Event\EventManager|null $eventManager The event manager. Defaults to a new instance.
* @param \Cake\Controller\ComponentRegistry|null $components The component registry. Defaults to a new instance.
*/
public function __construct(Request $request = null, Response $response = null, $name = null, $eventManager = null, $components = null)
{
if ($name !== null) {
$this->name = $name;
}
if ($this->name === null && isset($request->params['controller'])) {
$this->name = $request->params['controller'];
}
if ($this->name === null) {
list(, $name) = namespaceSplit(get_class($this));
$this->name = substr($name, 0, -10);
}
$this->setRequest($request !== null ? $request : new Request);
$this->response = $response !== null ? $response : new Response;
if ($eventManager !== null) {
$this->eventManager($eventManager);
}
$this->modelFactory('Table', [$this->tableLocator(), 'get']);
$modelClass = ($this->plugin ? $this->plugin . '.' : '') . $this->name;
$this->_setModelClass($modelClass);
if ($components !== null) {
$this->components($components);
}
$this->initialize();
$this->_mergeControllerVars();
$this->_loadComponents();
$this->eventManager()->on($this);
}
/**
* Initialization hook method.
*
* Implement this method to avoid having to overwrite
* the constructor and call parent.
*
* @return void
*/
public function initialize()
{
}
/**
* Get the component registry for this controller.
*
* If called with the first parameter, it will be set as the controller $this->_components property
*
* @param \Cake\Controller\ComponentRegistry|null $components Component registry.
*
* @return \Cake\Controller\ComponentRegistry
*/
public function components($components = null)
{
if ($components === null && $this->_components === null) {
$this->_components = new ComponentRegistry($this);
}
if ($components !== null) {
$components->setController($this);
$this->_components = $components;
}
return $this->_components;
}
/**
* Add a component to the controller's registry.
*
* This method will also set the component to a property.
* For example:
*
* ```
* $this->loadComponent('Acl.Acl');
* ```
*
* Will result in a `Toolbar` property being set.
*
* @param string $name The name of the component to load.
* @param array $config The config for the component.
* @return \Cake\Controller\Component
*/
public function loadComponent($name, array $config = [])
{
list(, $prop) = pluginSplit($name);
$this->{$prop} = $this->components()->load($name, $config);
return $this->{$prop};
}
/**
* Magic accessor for model autoloading.
*
* @param string $name Property name
* @return bool|object The model instance or false
*/
public function __get($name)
{
if (in_array($name, ['layout', 'view', 'theme', 'autoLayout', 'viewPath', 'layoutPath'], true)) {
$method = $name === 'viewPath' ? 'templatePath' : $name;
trigger_error(
sprintf('Controller::$%s is deprecated. Use $this->viewBuilder()->%s() instead.', $name, $method),
E_USER_DEPRECATED
);
return $this->viewBuilder()->{$name}();
}
list($plugin, $class) = pluginSplit($this->modelClass, true);
if ($class !== $name) {
return false;
}
return $this->loadModel($plugin . $class);
}
/**
* Magic setter for removed properties.
*
* @param string $name Property name.
* @param mixed $value Value to set.
* @return void
*/
public function __set($name, $value)
{
$deprecated = [
'layout' => 'layout',
'view' => 'template',
'theme' => 'theme',
'autoLayout' => 'autoLayout',
'viewPath' => 'templatePath',
'layoutPath' => 'layoutPath',
];
if (isset($deprecated[$name])) {
$method = $deprecated[$name];
trigger_error(
sprintf(
'Controller::$%s is deprecated. Use $this->viewBuilder()->%s() instead.',
$name,
$method
),
E_USER_DEPRECATED
);
$this->viewBuilder()->{$method}($value);
return;
}
$this->{$name} = $value;
}
/**
* Sets the request objects and configures a number of controller properties
* based on the contents of the request. Controller acts as a proxy for certain View variables
* which must also be updated here. The properties that get set are:
*
* - $this->request - To the $request parameter
* - $this->plugin - To the $request->params['plugin']
* - $this->passedArgs - Same as $request->params['pass]
* - View::$plugin - $this->plugin
*
* @param \Cake\Network\Request $request Request instance.
* @return void
*/
public function setRequest(Request $request)
{
$this->request = $request;
$this->plugin = isset($request->params['plugin']) ? $request->params['plugin'] : null;
if (isset($request->params['pass'])) {
$this->passedArgs = $request->params['pass'];
}
}
/**
* Dispatches the controller action. Checks that the action
* exists and isn't private.
*
* @return mixed The resulting response.
* @throws \LogicException When request is not set.
* @throws \Cake\Controller\Exception\MissingActionException When actions are not defined or inaccessible.
*/
public function invokeAction()
{
$request = $this->request;
if (!isset($request)) {
throw new LogicException('No Request object configured. Cannot invoke action');
}
if (!$this->isAction($request->params['action'])) {
throw new MissingActionException([
'controller' => $this->name . "Controller",
'action' => $request->params['action'],
'prefix' => isset($request->params['prefix']) ? $request->params['prefix'] : '',
'plugin' => $request->params['plugin'],
]);
}
$callable = [$this, $request->params['action']];
return call_user_func_array($callable, $request->params['pass']);
}
/**
* Merge components, helpers vars from
* parent classes.
*
* @return void
*/
protected function _mergeControllerVars()
{
$this->_mergeVars(
['components', 'helpers'],
['associative' => ['components', 'helpers']]
);
}
/**
* Returns a list of all events that will fire in the controller during its lifecycle.
* You can override this function to add your own listener callbacks
*
* @return array
*/
public function implementedEvents()
{
return [
'Controller.initialize' => 'beforeFilter',
'Controller.beforeRender' => 'beforeRender',
'Controller.beforeRedirect' => 'beforeRedirect',
'Controller.shutdown' => 'afterFilter',
];
}
/**
* Loads the defined components using the Component factory.
*
* @return void
*/
protected function _loadComponents()
{
if (empty($this->components)) {
return;
}
$registry = $this->components();
$components = $registry->normalizeArray($this->components);
foreach ($components as $properties) {
$this->loadComponent($properties['class'], $properties['config']);
}
}
/**
* Perform the startup process for this controller.
* Fire the Components and Controller callbacks in the correct order.
*
* - Initializes components, which fires their `initialize` callback
* - Calls the controller `beforeFilter`.
* - triggers Component `startup` methods.
*
* @return \Cake\Network\Response|null
*/
public function startupProcess()
{
$event = $this->dispatchEvent('Controller.initialize');
if ($event->result instanceof Response) {
return $event->result;
}
$event = $this->dispatchEvent('Controller.startup');
if ($event->result instanceof Response) {
return $event->result;
}
}
/**
* Perform the various shutdown processes for this controller.
* Fire the Components and Controller callbacks in the correct order.
*
* - triggers the component `shutdown` callback.
* - calls the Controller's `afterFilter` method.
*
* @return \Cake\Network\Response|null
*/
public function shutdownProcess()
{
$event = $this->dispatchEvent('Controller.shutdown');
if ($event->result instanceof Response) {
return $event->result;
}
}
/**
* Redirects to given $url, after turning off $this->autoRender.
* Script execution is halted after the redirect.
*
* @param string|array $url A string or array-based URL pointing to another location within the app,
* or an absolute URL
* @param int $status HTTP status code (eg: 301)
* @return \Cake\Network\Response|null
* @link http://book.cakephp.org/3.0/en/controllers.html#Controller::redirect
*/
public function redirect($url, $status = 302)
{
$this->autoRender = false;
$response = $this->response;
if ($status) {
$response->statusCode($status);
}
$event = $this->dispatchEvent('Controller.beforeRedirect', [$url, $response]);
if ($event->result instanceof Response) {
return $event->result;
}
if ($event->isStopped()) {
return null;
}
if (!$response->location()) {
$response->location(Router::url($url, true));
}
return $response;
}
/**
* Internally redirects one action to another. Does not perform another HTTP request unlike Controller::redirect()
*
* Examples:
*
* ```
* setAction('another_action');
* setAction('action_with_parameters', $parameter1);
* ```
*
* @param string $action The new action to be 'redirected' to.
* Any other parameters passed to this method will be passed as parameters to the new action.
* @return mixed Returns the return value of the called action
*/
public function setAction($action)
{
$this->request->params['action'] = $action;
$args = func_get_args();
unset($args[0]);
return call_user_func_array([&$this, $action], $args);
}
/**
* Instantiates the correct view class, hands it its data, and uses it to render the view output.
*
* @param string|null $view View to use for rendering
* @param string|null $layout Layout to use
* @return \Cake\Network\Response A response object containing the rendered view.
* @link http://book.cakephp.org/3.0/en/controllers.html#rendering-a-view
*/
public function render($view = null, $layout = null)
{
$builder = $this->viewBuilder();
if (!$builder->templatePath()) {
$builder->templatePath($this->_viewPath());
}
if (!empty($this->request->params['bare'])) {
$builder->autoLayout(false);
}
$builder->className($this->viewClass);
$this->autoRender = false;
$event = $this->dispatchEvent('Controller.beforeRender');
if ($event->result instanceof Response) {
return $event->result;
}
if ($event->isStopped()) {
return $this->response;
}
if ($builder->template() === null &&
isset($this->request->params['action'])
) {
$builder->template($this->request->params['action']);
}
$this->View = $this->createView();
$this->response->body($this->View->render($view, $layout));
return $this->response;
}
/**
* Get the viewPath based on controller name and request prefix.
*
* @return string
*/
protected function _viewPath()
{
$viewPath = $this->name;
if (!empty($this->request->params['prefix'])) {
$prefixes = array_map(
'Cake\Utility\Inflector::camelize',
explode('/', $this->request->params['prefix'])
);
$viewPath = implode(DIRECTORY_SEPARATOR, $prefixes) . DIRECTORY_SEPARATOR . $viewPath;
}
return $viewPath;
}
/**
* Returns the referring URL for this request.
*
* @param string|null $default Default URL to use if HTTP_REFERER cannot be read from headers
* @param bool $local If true, restrict referring URLs to local server
* @return string Referring URL
*/
public function referer($default = null, $local = false)
{
if (!$this->request) {
return Router::url($default, !$local);
}
$referer = $this->request->referer($local);
if ($referer === '/' && $default && $default !== $referer) {
$url = Router::url($default, !$local);
if ($local
&& $this->request->base
&& strpos($url, $this->request->base) === 0
) {
$url = substr($url, strlen($this->request->base));
if ($url[0] !== '/') {
$url = '/' . $url;
}
return $url;
}
return $url;
}
return $referer;
}
/**
* Handles pagination of records in Table objects.
*
* Will load the referenced Table object, and have the PaginatorComponent
* paginate the query using the request date and settings defined in `$this->paginate`.
*
* This method will also make the PaginatorHelper available in the view.
*
* @param \Cake\ORM\Table|string|\Cake\ORM\Query|null $object Table to paginate
* (e.g: Table instance, 'TableName' or a Query object)
* @param array $settings The settings/configuration used for pagination.
* @return \Cake\ORM\ResultSet Query results
* @link http://book.cakephp.org/3.0/en/controllers.html#paginating-a-model
* @throws \RuntimeException When no compatible table object can be found.
*/
public function paginate($object = null, array $settings = [])
{
if (is_object($object)) {
$table = $object;
}
if (is_string($object) || $object === null) {
$try = [$object, $this->modelClass];
foreach ($try as $tableName) {
if (empty($tableName)) {
continue;
}
$table = $this->loadModel($tableName);
break;
}
}
$this->loadComponent('Paginator');
if (empty($table)) {
throw new RuntimeException('Unable to locate an object compatible with paginate.');
}
$settings = $settings + $this->paginate;
return $this->Paginator->paginate($table, $settings);
}
/**
* Method to check that an action is accessible from a URL.
*
* Override this method to change which controller methods can be reached.
* The default implementation disallows access to all methods defined on Cake\Controller\Controller,
* and allows all public methods on all subclasses of this class.
*
* @param string $action The action to check.
* @return bool Whether or not the method is accessible from a URL.
*/
public function isAction($action)
{
$baseClass = new ReflectionClass('Cake\Controller\Controller');
if ($baseClass->hasMethod($action)) {
return false;
}
try {
$method = new ReflectionMethod($this, $action);
} catch (ReflectionException $e) {
return false;
}
return $method->isPublic();
}
/**
* Called before the controller action. You can use this method to configure and customize components
* or perform logic that needs to happen before each controller action.
*
* @param \Cake\Event\Event $event An Event instance
* @return \Cake\Network\Response|null
* @link http://book.cakephp.org/3.0/en/controllers.html#request-life-cycle-callbacks
*/
public function beforeFilter(Event $event)
{
return null;
}
/**
* Called after the controller action is run, but before the view is rendered. You can use this method
* to perform logic or set view variables that are required on every request.
*
* @param \Cake\Event\Event $event An Event instance
* @return \Cake\Network\Response|null
* @link http://book.cakephp.org/3.0/en/controllers.html#request-life-cycle-callbacks
*/
public function beforeRender(Event $event)
{
return null;
}
/**
* The beforeRedirect method is invoked when the controller's redirect method is called but before any
* further action.
*
* If the event is stopped the controller will not continue on to redirect the request.
* The $url and $status variables have same meaning as for the controller's method.
* You can set the event result to response instance or modify the redirect location
* using controller's response instance.
*
* @param \Cake\Event\Event $event An Event instance
* @param string|array $url A string or array-based URL pointing to another location within the app,
* or an absolute URL
* @param \Cake\Network\Response $response The response object.
* @return \Cake\Network\Response|null
* @link http://book.cakephp.org/3.0/en/controllers.html#request-life-cycle-callbacks
*/
public function beforeRedirect(Event $event, $url, Response $response)
{
return null;
}
/**
* Called after the controller action is run and rendered.
*
* @param \Cake\Event\Event $event An Event instance
* @return \Cake\Network\Response|null
* @link http://book.cakephp.org/3.0/en/controllers.html#request-life-cycle-callbacks
*/
public function afterFilter(Event $event)
{
return null;
}
}