|
1
|
|
|
<?php declare(strict_types=1); |
|
2
|
|
|
/** |
|
3
|
|
|
* Starlit App. |
|
4
|
|
|
* |
|
5
|
|
|
* @copyright Copyright (c) 2016 Starweb AB |
|
6
|
|
|
* @license BSD 3-Clause |
|
7
|
|
|
*/ |
|
8
|
|
|
|
|
9
|
|
|
namespace Starlit\App; |
|
10
|
|
|
|
|
11
|
|
|
use Starlit\App\Container\Container; |
|
12
|
|
|
use Starlit\App\Provider\BootableServiceProviderInterface; |
|
13
|
|
|
use Symfony\Component\HttpFoundation\Request; |
|
14
|
|
|
use Symfony\Component\HttpFoundation\Response; |
|
15
|
|
|
use Symfony\Component\Routing\Exception\ResourceNotFoundException; |
|
16
|
|
|
use Starlit\App\Provider\ServiceProviderInterface; |
|
17
|
|
|
use Starlit\App\Provider\StandardServiceProvider; |
|
18
|
|
|
use Starlit\App\Provider\ErrorServiceProvider; |
|
19
|
|
|
|
|
20
|
|
|
class BaseApp extends Container |
|
21
|
|
|
{ |
|
22
|
|
|
/** |
|
23
|
|
|
* @const string |
|
24
|
|
|
*/ |
|
25
|
|
|
const CHARSET = 'UTF-8'; |
|
26
|
|
|
|
|
27
|
|
|
/** |
|
28
|
|
|
* @var Config |
|
29
|
|
|
*/ |
|
30
|
|
|
protected $config; |
|
31
|
|
|
|
|
32
|
|
|
/** |
|
33
|
|
|
* @var string |
|
34
|
|
|
*/ |
|
35
|
|
|
protected $environment; |
|
36
|
|
|
|
|
37
|
|
|
/** |
|
38
|
|
|
* @var ServiceProviderInterface[] |
|
39
|
|
|
*/ |
|
40
|
|
|
protected $providers = []; |
|
41
|
|
|
|
|
42
|
|
|
/** |
|
43
|
|
|
* @var bool |
|
44
|
|
|
*/ |
|
45
|
|
|
protected $booted = false; |
|
46
|
|
|
|
|
47
|
|
|
/** |
|
48
|
|
|
* @var bool |
|
49
|
|
|
*/ |
|
50
|
|
|
protected $isCli = false; |
|
51
|
|
|
|
|
52
|
|
|
/** |
|
53
|
|
|
* Constructor. |
|
54
|
|
|
* |
|
55
|
|
|
* @param array|Config $config |
|
56
|
|
|
* @param string $environment Defaults to "production" |
|
57
|
|
|
*/ |
|
58
|
22 |
|
public function __construct(array $config = [], string $environment = 'production') |
|
59
|
|
|
{ |
|
60
|
22 |
|
if ($config instanceof Config) { |
|
61
|
|
|
$this->config = $config; |
|
62
|
|
|
} else { |
|
63
|
22 |
|
$this->config = new Config($config); |
|
64
|
|
|
} |
|
65
|
|
|
|
|
66
|
22 |
|
$this->environment = $environment; |
|
67
|
|
|
|
|
68
|
22 |
|
$this->init(); |
|
69
|
22 |
|
} |
|
70
|
|
|
|
|
71
|
|
|
/** |
|
72
|
|
|
* Initializes the application object. |
|
73
|
|
|
|
|
74
|
|
|
* Override and put initialization code that should always be run as early as |
|
75
|
|
|
* possible here, but make sure no objects are actually instanced here, because then |
|
76
|
|
|
* mock objects can't be injected in their place. Place object instance code in |
|
77
|
|
|
* the preHandle method. |
|
78
|
|
|
*/ |
|
79
|
22 |
|
protected function init(): void |
|
80
|
|
|
{ |
|
81
|
22 |
|
$this->isCli = (PHP_SAPI === 'cli'); |
|
82
|
|
|
|
|
83
|
22 |
|
if ($this->config->has('phpSettings')) { |
|
84
|
22 |
|
$this->setPhpSettings($this->config->get('phpSettings')); |
|
85
|
|
|
} |
|
86
|
|
|
|
|
87
|
22 |
|
$this->registerProviders(); |
|
88
|
22 |
|
} |
|
89
|
|
|
|
|
90
|
22 |
|
protected function registerProviders(): void |
|
91
|
|
|
{ |
|
92
|
22 |
|
$this->register(new ErrorServiceProvider()); |
|
93
|
22 |
|
$this->register(new StandardServiceProvider()); |
|
94
|
22 |
|
} |
|
95
|
|
|
|
|
96
|
22 |
|
public function register(ServiceProviderInterface $provider): void |
|
97
|
|
|
{ |
|
98
|
22 |
|
$this->providers[] = $provider; |
|
99
|
|
|
|
|
100
|
22 |
|
$provider->register($this); |
|
101
|
22 |
|
} |
|
102
|
|
|
|
|
103
|
22 |
|
protected function setPhpSettings(array $phpSettings, string $prefix = ''): void |
|
104
|
|
|
{ |
|
105
|
22 |
|
foreach ($phpSettings as $key => $val) { |
|
106
|
22 |
|
$key = $prefix . $key; |
|
107
|
22 |
|
if (\is_scalar($val)) { |
|
108
|
22 |
|
\ini_set($key, $val); |
|
109
|
22 |
|
} elseif (\is_array($val)) { |
|
110
|
22 |
|
$this->setPhpSettings($val, $key . '.'); // Set sub setting with a recursive call |
|
111
|
|
|
} |
|
112
|
|
|
} |
|
113
|
22 |
|
} |
|
114
|
|
|
|
|
115
|
|
|
/** |
|
116
|
|
|
* Boot the application and its service providers. |
|
117
|
|
|
* |
|
118
|
|
|
* This is normally called by handle(). If requests are not handled |
|
119
|
|
|
* this method will have to called manually to boot. |
|
120
|
|
|
*/ |
|
121
|
6 |
|
public function boot(): void |
|
122
|
|
|
{ |
|
123
|
6 |
|
if ($this->booted) { |
|
124
|
1 |
|
return; |
|
125
|
|
|
} |
|
126
|
|
|
|
|
127
|
6 |
|
foreach ($this->providers as $provider) { |
|
128
|
6 |
|
if ($provider instanceof BootableServiceProviderInterface) { |
|
129
|
2 |
|
$provider->boot($this); |
|
130
|
|
|
} |
|
131
|
|
|
} |
|
132
|
|
|
|
|
133
|
6 |
|
$this->booted = true; |
|
134
|
6 |
|
} |
|
135
|
|
|
|
|
136
|
|
|
/** |
|
137
|
|
|
* Pre handle method meant to be overridden in descendant classes (optional). |
|
138
|
|
|
* |
|
139
|
|
|
* This method is called before an request is handled. Object instance code should be |
|
140
|
|
|
* place here and not in init() (more info about this at init()). |
|
141
|
|
|
* |
|
142
|
|
|
* @param Request $request |
|
143
|
|
|
* @return Response|null |
|
144
|
|
|
*/ |
|
145
|
3 |
|
protected function preHandle(Request $request): ?Response |
|
|
|
|
|
|
146
|
|
|
{ |
|
147
|
3 |
|
return null; |
|
148
|
|
|
} |
|
149
|
|
|
|
|
150
|
|
|
/** |
|
151
|
|
|
* Post route method meant to be overridden in descendant classes (optional). |
|
152
|
|
|
* This method is called before an request is dispatched but after it's routed. This means that we know |
|
153
|
|
|
* it's a valid route and have access to the route attributes at this stage. |
|
154
|
|
|
* |
|
155
|
|
|
* @param Request $request |
|
156
|
|
|
* @return Response|null |
|
157
|
|
|
*/ |
|
158
|
1 |
|
protected function postRoute(Request $request): ?Response |
|
|
|
|
|
|
159
|
|
|
{ |
|
160
|
1 |
|
return null; |
|
161
|
|
|
} |
|
162
|
|
|
|
|
163
|
|
|
/** |
|
164
|
|
|
* Handles an http request and returns a response. |
|
165
|
|
|
* |
|
166
|
|
|
* @param Request $request |
|
167
|
|
|
* @return Response |
|
168
|
|
|
*/ |
|
169
|
4 |
|
public function handle(Request $request): Response |
|
170
|
|
|
{ |
|
171
|
4 |
|
$this->alias('request', Request::class); |
|
172
|
4 |
|
$this->set(Request::class, $request); |
|
173
|
|
|
|
|
174
|
4 |
|
$this->boot(); |
|
175
|
|
|
|
|
176
|
4 |
|
if (($preHandleResponse = $this->preHandle($request))) { |
|
177
|
1 |
|
return $preHandleResponse; |
|
178
|
|
|
} |
|
179
|
|
|
|
|
180
|
|
|
try { |
|
181
|
3 |
|
$controller = $this->get(RouterInterface::class)->route($request); |
|
182
|
|
|
|
|
183
|
2 |
|
if (($postRouteResponse = $this->postRoute($request))) { |
|
184
|
1 |
|
return $postRouteResponse; |
|
185
|
|
|
} |
|
186
|
|
|
|
|
187
|
1 |
|
$response = $controller->dispatch(); |
|
188
|
1 |
|
} catch (ResourceNotFoundException $e) { |
|
189
|
1 |
|
$response = $this->getNoRouteResponse($request); |
|
190
|
|
|
} |
|
191
|
|
|
|
|
192
|
2 |
|
$this->postHandle($request); |
|
193
|
|
|
|
|
194
|
2 |
|
return $response; |
|
195
|
|
|
} |
|
196
|
|
|
|
|
197
|
1 |
|
protected function getNoRouteResponse(Request $request): Response |
|
|
|
|
|
|
198
|
|
|
{ |
|
199
|
1 |
|
return new Response('Not Found', 404); |
|
200
|
|
|
} |
|
201
|
|
|
|
|
202
|
|
|
/** |
|
203
|
|
|
* Post handle method meant to be overridden in descendant classes (optional). |
|
204
|
|
|
* This method is called after an request has been handled but before |
|
205
|
|
|
* the response is returned from the handle method. |
|
206
|
|
|
* |
|
207
|
|
|
* @param Request $request |
|
208
|
|
|
*/ |
|
209
|
2 |
|
protected function postHandle(Request $request): void |
|
|
|
|
|
|
210
|
|
|
{ |
|
211
|
2 |
|
} |
|
212
|
|
|
|
|
213
|
22 |
|
public function getConfig(): Config |
|
214
|
|
|
{ |
|
215
|
22 |
|
return $this->config; |
|
216
|
|
|
} |
|
217
|
|
|
|
|
218
|
22 |
|
public function isCli(): bool |
|
219
|
|
|
{ |
|
220
|
22 |
|
return $this->isCli; |
|
221
|
|
|
} |
|
222
|
|
|
|
|
223
|
1 |
|
public function getRequest(): ?Request |
|
224
|
|
|
{ |
|
225
|
1 |
|
return $this->has(Request::class) ? $this->get(Request::class) : null; |
|
226
|
|
|
} |
|
227
|
|
|
|
|
228
|
1 |
|
public function getEnvironment(): string |
|
229
|
|
|
{ |
|
230
|
1 |
|
return $this->environment; |
|
231
|
|
|
} |
|
232
|
|
|
} |
|
233
|
|
|
|
starweb /
starlit-app
Loading history...
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.