-
Notifications
You must be signed in to change notification settings - Fork 30
Expand file tree
/
Copy pathController.php
More file actions
499 lines (446 loc) · 12 KB
/
Controller.php
File metadata and controls
499 lines (446 loc) · 12 KB
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
<?php
/**
* This file is part of the PPI Framework.
*
* @copyright Copyright (c) 2012 Paul Dragoonis <[email protected]>
* @license http://opensource.org/licenses/mit-license.php MIT
*
* @link http://www.ppi.io
*/
namespace PPI\Framework\Module;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Zend\ServiceManager\ServiceLocatorAwareInterface;
use Zend\ServiceManager\ServiceLocatorInterface;
/**
* The base PPI controller class.
*
* @author Paul Dragoonis <[email protected]>
*/
class Controller implements ServiceLocatorAwareInterface
{
/**
* Service Locator.
*
* @var null|object
*/
protected $serviceLocator = null;
/**
* Caching the results of results from $this->is() lookups.
*
* @var array
*/
protected $isCache = array();
/**
* The options for this controller.
*
* @var array
*/
protected $options = array();
/**
* Controller helpers.
*
* @var array
*/
protected $helpers = array();
/**
* Get the request object.
*
* @return object
*/
protected function getRequest()
{
return $this->serviceLocator->get('Request');
}
/**
* Get the response object.
*
* @return object
*/
protected function getResponse()
{
return $this->serviceLocator->get('Response');
}
/**
* Obtain a controller helper by its key name.
*
* @param string $helperName
*
* @throws \InvalidArgumentException
*
* @return mixed
*/
protected function helper($helperName)
{
if (!isset($this->helpers[$helperName])) {
throw new \InvalidArgumentException('Unable to locate controller helper: ' . $helperName);
}
return $this->helpers[$helperName];
}
/**
* Set a helper object.
*
* @param string $helperName
* @param object $helper
*/
public function setHelper($helperName, $helper)
{
$this->helpers[$helperName] = $helper;
}
/**
* Returns a server parameter by name.
*
* @param string $key The key
* @param mixed $default The default value if the parameter key does not exist
* @param bool $deep If true, a path like foo[bar] will find deeper items
*
* @return string
*/
protected function server($key = null, $default = null, $deep = false)
{
return $key === null ? $this->getServer()->all() : $this->getServer()->get($key, $default, $deep);
}
/**
* Returns a post parameter by name.
*
* @param string $key The key
* @param mixed $default The default value if the parameter key does not exist
* @param bool $deep If true, a path like foo[bar] will find deeper items
*
* @return string
*/
protected function post($key = null, $default = null, $deep = false)
{
return $key === null ? $this->getPost()->all() : $this->getPost()->get($key, $default, $deep);
}
/**
* Returns a files parameter by name.
*
* @param string $key The key
* @param mixed $default The default value if the parameter key does not exist
* @param bool $deep If true, a path like foo[bar] will find deeper items
*
* @return string
*/
protected function files($key = null, $default = null, $deep = false)
{
return $key === null ? $this->getFiles()->all() : $this->getFiles()->get($key, $default, $deep);
}
/**
* Returns a query string parameter by name.
*
* @param string $key The key
* @param mixed $default The default value if the parameter key does not exist
* @param bool $deep If true, a path like foo[bar] will find deeper items
*
* @return string
*/
protected function queryString($key = null, $default = null, $deep = false)
{
return $key === null ? $this->getQueryString()->all() : $this->getQueryString()->get($key, $default, $deep);
}
/**
* Returns a server parameter by name.
*
* @param string $key The key
* @param mixed $default The default value if the parameter key does not exist
* @param bool $deep If true, a path like foo[bar] will find deeper items
*
* @return string
*/
protected function cookie($key = null, $default = null, $deep = false)
{
return $key === null ? $this->getCookie()->all() : $this->getCookie()->get($key, $default, $deep);
}
/**
* Get/Set a session value.
*
* @param string $key
* @param null|mixed $default If this is not null, it enters setter mode
*
* @return mixed
*/
protected function session($key = null, $default = null)
{
return $key === null ? $this->getSession()->all() : $this->getSession()->get($key, $default);
}
/**
* Shortcut for getting the server object.
*
* @return object
*/
protected function getServer()
{
return $this->getService('Request')->server;
}
/**
* Shortcut for getting the files object.
*
* @return object
*/
protected function getFiles()
{
return $this->getService('Request')->files;
}
/**
* Shortcut for getting the cookie object.
*
* @return object
*/
protected function getCookie()
{
return $this->getService('Request')->cookies;
}
/**
* Shortcut for getting the query string object.
*
* @return object
*/
protected function getQueryString()
{
return $this->getService('Request')->query;
}
/**
* Shortcut for getting the post object.
*
* @return object
*/
protected function getPost()
{
return $this->getService('Request')->request;
}
/**
* Shortcut for getting the session object.
*
* @return mixed
*/
protected function getSession()
{
return $this->getService('session');
}
/**
* Check if a condition 'is' true.
*
* @param string $key
*
* @throws InvalidArgumentException
*
* @return bool
*/
protected function is($key)
{
switch ($key = strtolower($key)) {
case 'ajax':
if (!isset($this->isCache['ajax'])) {
return $this->isCache['ajax'] = $this->getService('Request')->isXmlHttpRequest();
}
return $this->isCache['ajax'];
case 'put':
case 'delete':
case 'post':
case 'patch':
if (!isset($this->isCache['requestMethod'][$key])) {
$this->isCache['requestMethod'][$key] = $this->getService('Request')->getMethod() === strtoupper($key);
}
return $this->isCache['requestMethod'][$key];
case 'ssl':
case 'https':
case 'secure':
if (!isset($this->isCache['secure'])) {
$this->isCache['secure'] = $this->getService('Request')->isSecure();
}
return $this->isCache['secure'];
default:
throw new \InvalidArgumentException("Invalid 'is' key supplied: {$key}");
}
}
/**
* Get the remote users ip address.
*
* @return string
*/
protected function getIP()
{
return $this->server('REMOTE_ADDR');
}
/**
* Get a routing param's value.
*
* @param string $param
*
* @return mixed
*/
protected function getRouteParam($param)
{
return $this->helper('routing')->getParam($param);
}
/**
* Get the remote users user agent.
*
* @return string
*/
protected function getUserAgent()
{
return $this->server('HTTP_USER_AGENT');
}
/**
* Set service locator.
*
* @param ServiceLocatorInterface $serviceLocator
*/
public function setServiceLocator(ServiceLocatorInterface $serviceLocator)
{
$this->serviceLocator = $serviceLocator;
}
/**
* Get service locator.
*
* @return ServiceLocatorInterface
*/
public function getServiceLocator()
{
return $this->serviceLocator;
}
/**
* Get a registered service.
*
* @param string $service
*
* @return mixed
*/
protected function getService($service)
{
return $this->getServiceLocator()->get($service);
}
/**
* Get the data source service.
*
* @return mixed
*/
protected function getDataSource()
{
return $this->getService('DataSource');
}
/**
* Render a template.
*
* @param string $template The template to render
* @param array $params The params to pass to the renderer
* @param array $options Extra options
*
* @return string
*/
protected function render($template, array $params = array(), array $options = array())
{
$renderer = $this->serviceLocator->get('templating');
// Helpers
if (isset($options['helpers'])) {
foreach ($options['helpers'] as $helper) {
$renderer->addHelper($helper);
}
}
return $renderer->render($template, $params);
}
/**
* Set Flash Message.
*
* @param string $flashType The flash type
* @param string $message The flash message
*/
protected function setFlash($flashType, $message)
{
$this->getSession()->getFlashBag()->set($flashType, $message);
}
/**
* Create a RedirectResponse object with your $url and $statusCode.
*
* @param string $url
* @param int $statusCode
*
* @return RedirectResponse
*/
protected function redirect($url, $statusCode = 302)
{
$response = new RedirectResponse($url, $statusCode);
$this->getServiceLocator()->set('Response', $response);
return $response;
}
/**
* Shortcut function for redirecting to a route without manually calling $this->generateUrl()
* You just specify a route name and it goes there.
*
* @param $route
* @param array $parameters
* @param bool|false $absolute
*
* @return RedirectResponse
*/
protected function redirectToRoute($route, $parameters = array(), $absolute = false)
{
return $this->redirect($this->getService('Router')->generate($route, $parameters, $absolute));
}
/**
* Generate a URL from the specified route name.
*
* @param string $route
* @param array $parameters
* @param bool $absolute
*
* @return string
*/
protected function generateUrl($route, $parameters = array(), $absolute = false)
{
return $this->getService('Router')->generate($route, $parameters, $absolute);
}
/**
* Get the app's global configuration.
*
* @return mixed
*/
protected function getConfig()
{
return $this->getService('Config');
}
/**
* Set the options for this controller.
*
* @param array $options
*
* @return $this
*/
public function setOptions($options)
{
$this->options = $options;
return $this;
}
/**
* Get an option from the controller.
*
* @param string $option The option name
* @param null $default The default value if the option does not exist
*
* @return mixed
*/
public function getOption($option, $default = null)
{
return isset($this->options[$option]) ? $this->options[$option] : $default;
}
/**
* Get the environment type, defaulting to 'development' if it has not been set.
*
* @return string
*/
public function getEnv()
{
return $this->getOption('environment', 'development');
}
/**
* Add a template global variable.
*
* @param string $param
* @param mixed $value
*/
protected function addTemplateGlobal($param, $value)
{
$this->getService('templating')->addGlobal($param, $value);
}
}