/
Cell.php
191 lines (169 loc) · 4.44 KB
/
Cell.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
<?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 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\View;
use Cake\Core\App;
use Cake\Event\EventManager;
use Cake\Network\Request;
use Cake\Network\Response;
use Cake\Utility\Inflector;
use Cake\Utility\ModelAwareTrait;
use Cake\Utility\ViewVarsTrait;
/**
* Cell base.
*
*/
abstract class Cell {
use ModelAwareTrait;
use ViewVarsTrait;
/**
* Instance of the View created during rendering. Won't be set until after
* Cell::__toString() is called.
*
* @var \Cake\View\View
*/
public $View;
/**
* Name of the action that was invoked.
*
* Action name will be inflected to get the template name when rendering.
*
* @var string
*/
public $action;
/**
* Automatically set to the name of a plugin.
*
* @var string
*/
public $plugin = null;
/**
* 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
*/
public $request;
/**
* An instance of a Response object that contains information about the impending response
*
* @var \Cake\Network\Response
*/
public $response;
/**
* The name of the View class this cell sends output to.
*
* @var string
*/
public $viewClass = 'Cake\View\View';
/**
* Instance of the Cake\Event\EventManager this cell is using
* to dispatch inner events.
*
* @var \Cake\Event\EventManager
*/
protected $_eventManager = null;
/**
* These properties are settable directly on Cell and passed to the View as options.
*
* @var array
* @see \Cake\View\View
*/
protected $_validViewOptions = [
'viewVars', 'helpers', 'viewPath', 'plugin',
];
/**
* List of valid options (constructor's fourth arguments)
*
* @var array
*/
protected $_validCellOptions = [];
/**
* Constructor.
*
* @param \Cake\Network\Request $request
* @param \Cake\Network\Response $response
* @param \Cake\Event\EventManager $eventManager
* @param array $cellOptions
*/
public function __construct(Request $request = null, Response $response = null,
EventManager $eventManager = null, array $cellOptions = []) {
$this->_eventManager = $eventManager;
$this->request = $request;
$this->response = $response;
$this->modelFactory('Table', ['Cake\ORM\TableRegistry', 'get']);
foreach ($this->_validCellOptions as $var) {
if (isset($cellOptions[$var])) {
$this->{$var} = $cellOptions[$var];
}
}
}
/**
* Rendering method.
*
* @param string $action Custom template name to render. If not provided (null), the last
* value will be used. This value is automatically set by `CellTrait::cell()`.
* @return void
*/
public function render($action = null) {
if ($action !== null) {
$this->action = $action;
}
return $this->__toString();
}
/**
* Magic method.
*
* Starts the rendering process when Cell is echoed.
*
* @return string Rendered cell
*/
public function __toString() {
$this->View = $this->createView();
$this->View->layout = false;
$className = explode('\\', get_class($this));
$className = array_pop($className);
$this->View->subDir = 'Cell' . DS . substr($className, 0, strpos($className, 'Cell'));
return $this->View->render(Inflector::underscore($this->action));
}
/**
* Debug info.
*
* @return void
*/
public function __debugInfo() {
return [
'plugin' => $this->plugin,
'action' => $this->action,
'viewClass' => $this->viewClass,
'request' => $this->request,
'response' => $this->response,
];
}
/**
* Returns the Cake\Event\EventManager manager instance for this cell.
*
* You can use this instance to register any new listeners or callbacks to the
* cell events, or create your own events and trigger them at will.
*
* @return \Cake\Event\EventManager
*/
public function getEventManager() {
if (empty($this->_eventManager)) {
$this->_eventManager = new EventManager();
}
return $this->_eventManager;
}
}