/
AbstractView.php
238 lines (201 loc) · 5.62 KB
/
AbstractView.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
<?php
namespace Concrete\Core\View;
use Concrete\Core\Http\ResponseAssetGroup;
use Request;
use URL;
use Core;
/**
* Abstract view class
*/
abstract class AbstractView
{
protected static $requestInstance;
protected static $requestInstances = array();
protected $scopeItems = array();
public $controller;
protected $template;
protected $outputAssets = array();
public function getViewTemplate()
{
return $this->template;
}
public function addScopeItems($items)
{
foreach ($items as $key => $value) {
$this->scopeItems[$key] = $value;
}
}
public static function getRequestInstance()
{
if (!self::$requestInstance instanceof View) {
View::setRequestInstance(new View());
}
return self::$requestInstance;
}
/**
* @param mixed $mixed object to view
*/
public function __construct($mixed = false)
{
$this->constructView($mixed);
}
protected static function setRequestInstance(View $v)
{
View::$requestInstances[] = $v;
self::$requestInstance = $v;
}
protected static function revertRequestInstance()
{
array_pop(View::$requestInstances);
self::$requestInstance = last(View::$requestInstances);
if (self::$requestInstance === false) {
// 'last' can return false if there are no request instances.
// In that case a fresh instance should be retrieved.
self::$requestInstance = View::getInstance();
}
}
abstract public function start($state);
public function startRender()
{
if (is_object($this->controller)) {
$this->controller->on_before_render();
}
}
abstract protected function constructView($mixed);
abstract public function setupRender();
abstract public function finishRender($contents);
abstract public function action($action);
public function addHeaderAsset($asset)
{
$r = ResponseAssetGroup::get();
$r->addHeaderAsset($asset);
}
public function addFooterAsset($asset)
{
$r = ResponseAssetGroup::get();
$r->addFooterAsset($asset);
}
public function addOutputAsset($asset)
{
$r = ResponseAssetGroup::get();
$r->addOutputAsset($asset);
}
public function requireAsset($assetType, $assetHandle = false)
{
$r = ResponseAssetGroup::get();
$r->requireAsset($assetType, $assetHandle);
}
public function setController($controller)
{
$this->controller = $controller;
}
public function setViewTemplate($template)
{
$this->template = $template;
}
/**
* Returns the value of the item in the POST array.
*
* @param $key
*/
public function post($key, $defaultValue = null)
{
$r = Request::getInstance();
return $r->post($key, $defaultValue);
}
abstract protected function onBeforeGetContents();
protected function postProcessViewContents($contents)
{
return $contents;
}
protected function onAfterGetContents()
{
}
public function getScopeItems()
{
if (is_object($this->controller)) {
$sets = $this->controller->getSets();
$helpers = $this->controller->getHelperObjects();
$return = array_merge($this->scopeItems, $sets, $helpers);
} else {
$return = $this->scopeItems;
}
$return['view'] = $this;
$return['controller'] = $this->controller;
return $return;
}
public function render($state = false)
{
if ($this instanceof View) {
$this->setRequestInstance($this);
}
$this->start($state);
$this->setupRender();
$this->startRender();
$scopeItems = $this->getScopeItems();
$contents = $this->renderViewContents($scopeItems);
$contents = $this->postProcessViewContents($contents);
$response = $this->finishRender($contents);
if ($this instanceof View) {
$this->revertRequestInstance();
}
return $response;
}
public function renderViewContents($scopeItems)
{
if (file_exists($this->template)) {
extract($scopeItems);
ob_start();
$this->onBeforeGetContents();
include $this->template;
$this->onAfterGetContents();
$contents = ob_get_contents();
ob_end_clean();
return $contents;
}
}
/**
* url is a utility function that is used inside a view to setup urls w/tasks and parameters.
*
* @deprecated
*
* @param string $action
* @param string $task
*
* @return string $url
*/
public static function url($action, $task = null)
{
$args = func_get_args();
return (string) call_user_func_array(array('URL', 'to'), $args);
}
public function renderError($title, $error, $errorObj = null)
{
Core::make('helper/concrete/ui')->renderError($title, $error);
}
/**
*/
public function addHeaderItem($item)
{
$this->addHeaderAsset($item);
}
/**
*/
public function addFooterItem($item)
{
$this->addFooterAsset($item);
}
/**
* Get an instance of the View.
*
* Note: In versions before 8.5.0a3, this method may
* return 'false' if it's called after the page
* is rendered (for example in middleware).
*
* @return View
*/
public static function getInstance()
{
return View::getRequestInstance();
}
}