1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/* |
4
|
|
|
* This file is part of the Symfony-Util package. |
5
|
|
|
* |
6
|
|
|
* (c) Jean-Bernard Addor |
7
|
|
|
* |
8
|
|
|
* For the full copyright and license information, please view the LICENSE |
9
|
|
|
* file that was distributed with this source code. |
10
|
|
|
*/ |
11
|
|
|
|
12
|
|
|
namespace Tests\Component; |
13
|
|
|
|
14
|
|
|
use Symfony\Bridge\Twig\TwigEngine; |
15
|
|
|
use Symfony\Bundle\FrameworkBundle\Client; |
16
|
|
|
use Symfony\Bundle\FrameworkBundle\Controller\ControllerNameParser; |
17
|
|
|
use Symfony\Bundle\FrameworkBundle\Controller\ControllerResolver; // Many controller resolver exists! |
18
|
|
|
use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddCacheClearerPass; |
19
|
|
|
use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddCacheWarmerPass; |
20
|
|
|
// use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddConsoleCommandPass; |
21
|
|
|
use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ControllerArgumentValueResolverPass; |
22
|
|
|
use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\RoutingResolverPass; |
23
|
|
|
use Symfony\Bundle\FrameworkBundle\FrameworkBundle; |
24
|
|
|
use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait; |
25
|
|
|
use Symfony\Bundle\FrameworkBundle\Routing\DelegatingLoader; |
26
|
|
|
use Symfony\Bundle\FrameworkBundle\Routing\RedirectableUrlMatcher; |
27
|
|
|
use Symfony\Bundle\FrameworkBundle\Routing\Router; |
28
|
|
|
use Symfony\Component\Config\Loader\LoaderInterface; |
29
|
|
|
use Symfony\Component\Config\Loader\LoaderResolver; |
30
|
|
|
use Symfony\Component\Config\ResourceCheckerConfigCacheFactory; |
31
|
|
|
use Symfony\Component\DependencyInjection\Compiler\PassConfig; |
32
|
|
|
use Symfony\Component\DependencyInjection\ContainerBuilder; |
33
|
|
|
use Symfony\Component\DependencyInjection\ContainerInterface; |
34
|
|
|
use Symfony\Component\DependencyInjection\Reference; |
35
|
|
|
use Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher; |
36
|
|
|
use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass; |
37
|
|
|
use Symfony\Component\HttpFoundation\RequestStack; |
38
|
|
|
use Symfony\Component\HttpKernel\Controller\ArgumentResolver; |
39
|
|
|
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\DefaultValueResolver; |
40
|
|
|
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ServiceValueResolver; |
41
|
|
|
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactory; |
42
|
|
|
use Symfony\Component\HttpKernel\EventListener\RouterListener; |
43
|
|
|
use Symfony\Component\HttpKernel\HttpKernel; |
44
|
|
|
use Symfony\Component\HttpKernel\Kernel; // Manages an environment made of bundles. HttpKernel is needed in addition! |
45
|
|
|
use Symfony\Component\HttpKernel\UriSigner; |
46
|
|
|
use Symfony\Component\Routing\Generator\Dumper\PhpGeneratorDumper; |
47
|
|
|
use Symfony\Component\Routing\Generator\UrlGenerator; |
48
|
|
|
use Symfony\Component\Routing\Loader\DependencyInjection\ServiceRouterLoader; |
49
|
|
|
use Symfony\Component\Routing\Matcher\Dumper\PhpMatcherDumper; |
50
|
|
|
use Symfony\Component\Routing\RouteCollectionBuilder; |
51
|
|
|
use Symfony\Component\Templating\EngineInterface; |
52
|
|
|
use Symfony\Component\Templating\TemplateNameParser; |
53
|
|
|
use Symfony\Component\Templating\TemplateNameParserInterface; |
54
|
|
|
use SymfonyUtil\Controller\EngineAsArgumentController; |
55
|
|
|
|
56
|
|
|
// use Twig_Environment; |
|
|
|
|
57
|
|
|
// use Twig_Loader_Array; |
58
|
|
|
// use Twig_LoaderInterface; |
59
|
|
|
|
60
|
|
|
class AppKernel extends Kernel |
61
|
|
|
{ |
62
|
|
|
use MicroKernelTrait; |
63
|
|
|
|
64
|
|
|
public function registerBundles() |
65
|
|
|
{ |
66
|
|
|
return [ |
67
|
|
|
// new FrameworkBundle(), |
|
|
|
|
68
|
|
|
]; |
69
|
|
|
} |
70
|
|
|
|
71
|
|
|
protected function configureRoutes(RouteCollectionBuilder $routes) |
72
|
|
|
{ |
73
|
|
|
$routes->add('/', EngineAsArgumentController::class, 'index'); |
74
|
|
|
} |
75
|
|
|
|
76
|
|
|
public function registerContainerConfiguration(LoaderInterface $loader) |
77
|
|
|
{ |
78
|
|
|
$loader->load(function (ContainerBuilder $container) use ($loader) { |
79
|
|
|
$this->configureContainer($container, $loader); |
80
|
|
|
|
81
|
|
|
$container->addObjectResource($this); ////////////// TODO understand and consider necessity. |
82
|
|
|
}); |
83
|
|
|
} |
84
|
|
|
|
85
|
|
|
protected function configureContainer(ContainerBuilder $c, LoaderInterface $loader) |
|
|
|
|
86
|
|
|
{ |
87
|
|
|
// https://symfony.com/doc/current/service_container.html |
88
|
|
|
// HttpKernel has to be added! |
89
|
|
|
// TODO: find the right way to configure the service_container!! cheking... |
90
|
|
|
// It does not replace the framework yet, but this is probably based on a config older than Symfony 3.3 |
91
|
|
|
// TODO: reaorganize in different files by dependecy and use eg. HttpKernel, Matcher, ... allowing for alternatives |
92
|
|
|
|
93
|
|
|
$c->register('kernel')->setSynthetic(true); |
94
|
|
|
$c->set('kernel', $this); |
95
|
|
|
|
96
|
|
|
// $c->register('service_container')->setSynthetic(true); |
|
|
|
|
97
|
|
|
// $c->set('service_container', $c); |
|
|
|
|
98
|
|
|
// https://github.com/symfony/dependency-injection/blob/master/Container.php |
99
|
|
|
// Seems to be included by default! |
100
|
|
|
|
101
|
|
|
$c->register('event_dispatcher', ContainerAwareEventDispatcher::class) // services.xml |
102
|
|
|
// TODO: Obsolete use EventDispatcher instead, but may cause other problems |
103
|
|
|
->addArgument(new Reference('service_container')) |
104
|
|
|
; |
105
|
|
|
|
106
|
|
|
$c->register('http_kernel', HttpKernel::class) // services.xml |
107
|
|
|
->addArgument(new Reference('event_dispatcher')) |
108
|
|
|
->addArgument(new Reference('controller_resolver')) |
109
|
|
|
->addArgument(new Reference('request_stack')) |
110
|
|
|
->addArgument(new Reference('argument_resolver')) |
111
|
|
|
; |
112
|
|
|
|
113
|
|
|
$c->register('request_stack', RequestStack::class); // services.xml |
114
|
|
|
|
115
|
|
|
$c->register('uri_signer', UriSigner::class) // services.xml |
116
|
|
|
->addArgument('12345') // app config |
117
|
|
|
; |
118
|
|
|
|
119
|
|
|
$c->register('config_cache_factory', ResourceCheckerConfigCacheFactory::class) // services.xml |
120
|
|
|
->addArgument([]) |
121
|
|
|
; |
122
|
|
|
$c->register('controller_name_converter', ControllerNameParser::class) // web.xml |
123
|
|
|
->setPublic(false) |
124
|
|
|
->addTag('monolog.logger', ['channel' => 'request']) |
125
|
|
|
->addArgument(new Reference('kernel')) |
126
|
|
|
; |
127
|
|
|
|
128
|
|
|
$c->register('controller_resolver', ControllerResolver::class) // web.xml |
|
|
|
|
129
|
|
|
// ->setPublic(false) |
130
|
|
|
->addTag('monolog.logger', ['channel' => 'request']) |
131
|
|
|
->addArgument(new Reference('service_container')) |
132
|
|
|
->addArgument(new Reference('controller_name_converter')) |
133
|
|
|
->addArgument(new Reference('logger', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)) |
134
|
|
|
; |
135
|
|
|
|
136
|
|
|
$c->register('argument_metadata_factory', ArgumentMetadataFactory::class) // web.xml |
|
|
|
|
137
|
|
|
// ->setPublic(false) |
138
|
|
|
; |
139
|
|
|
|
140
|
|
|
$c->register('argument_resolver', ArgumentResolver::class) // web.xml |
|
|
|
|
141
|
|
|
// ->setPublic(false) |
142
|
|
|
->addArgument(new Reference('argument_metadata_factory')) |
143
|
|
|
->addArgument([]) |
144
|
|
|
; |
145
|
|
|
|
146
|
|
|
$c->setParameter('router.resource', 'kernel:loadRoutes'); // resource_type: service |
|
|
|
|
147
|
|
|
// $c->setParameter('router.resource', new Expression('service("kernel").loadRoutes')); |
148
|
|
|
// $c->setParameter('router.resource', MicroKernel::class . ':loadRoutes'); |
149
|
|
|
// $c->setParameter('router.resource', new Reference('kernel') . ':loadRoutes'); |
150
|
|
|
// $c->setParameter('router.resource', MicroKernel::loadRoutes); |
151
|
|
|
// $c->setParameter('router.resource', self::loadRoutes); |
152
|
|
|
// $c->setParameter('router.resource', parent::loadRoutes); |
153
|
|
|
// $c->setParameter('router.resource', [new Reference('kernel'), 'loadRoutes']); |
154
|
|
|
// $c->setParameter('router.resource', ['kernel', 'loadRoutes']); |
155
|
|
|
// $c->setParameter('router.resource', [MicroKernel::class, 'loadRoutes']); |
156
|
|
|
|
157
|
|
|
$c->setParameter('router.cache_class_prefix', $c->getParameter('kernel.container_class')); |
158
|
|
|
// symfony/framework-bundle/DependencyInjection/FrameworkExtension.php |
159
|
|
|
$c->setParameter('router.options.generator_class', UrlGenerator::class); // routing.xml |
160
|
|
|
$c->setParameter('router.options.generator_base_class', UrlGenerator::class); // routing.xml |
161
|
|
|
$c->setParameter('router.options.generator_dumper_class', PhpGeneratorDumper::class); // routing.xml |
162
|
|
|
$c->setParameter('router.options.generator.cache_class', '%router.cache_class_prefix%UrlGenerator'); // routing.xml |
163
|
|
|
$c->setParameter('router.options.matcher_class', RedirectableUrlMatcher::class); // routing.xml |
164
|
|
|
$c->setParameter('router.options.matcher_base_class', RedirectableUrlMatcher::class); // routing.xml |
165
|
|
|
$c->setParameter('router.options.matcher_dumper_class', PhpMatcherDumper::class); // routing.xml |
166
|
|
|
$c->setParameter('router.options.matcher.cache_class', '%router.cache_class_prefix%UrlMatcher'); // routing.xml |
167
|
|
|
|
168
|
|
|
$c->setParameter('router.request_context.host', 'localhost'); // routing.xml |
169
|
|
|
$c->setParameter('router.request_context.scheme', 'http'); // routing.xml |
170
|
|
|
$c->setParameter('router.request_context.base_url', ''); // routing.xml |
171
|
|
|
|
172
|
|
|
$c->setParameter('request_listener.http_port', 80); |
173
|
|
|
$c->setParameter('request_listener.https_port', 443); |
174
|
|
|
// symfony/framework-bundle/DependencyInjection/FrameworkExtension.php |
175
|
|
|
|
176
|
|
|
$c->register('routing.resolver', LoaderResolver::class) // routing.xml |
177
|
|
|
->setPublic(false) |
178
|
|
|
; |
179
|
|
|
|
180
|
|
|
$c->register('routing.loader.service', ServiceRouterLoader::class) // routing.xml |
|
|
|
|
181
|
|
|
// ->setPublic(false) |
182
|
|
|
->addTag('routing.loader') |
183
|
|
|
->addArgument(new Reference('service_container')) |
184
|
|
|
; |
185
|
|
|
$c->register('routing.loader', DelegatingLoader::class) // routing.xml |
186
|
|
|
->addArgument(new Reference('controller_name_converter')) |
187
|
|
|
->addArgument(new Reference('routing.resolver')) |
188
|
|
|
; |
189
|
|
|
//... |
190
|
|
|
$c->register('router.default', Router::class) // routing.xml |
|
|
|
|
191
|
|
|
// ->setPublic(false) |
192
|
|
|
->addTag('monolog.logger', ['channel' => 'router']) |
193
|
|
|
->addArgument(new Reference('service_container')) |
194
|
|
|
->addArgument('%router.resource%') |
195
|
|
|
->addArgument([ |
196
|
|
|
'cache_dir' => '%kernel.cache_dir%', |
197
|
|
|
'debug' => '%kernel.debug%', |
198
|
|
|
'generator_class' => '%router.options.generator_class%', |
199
|
|
|
'generator_base_class' => '%router.options.generator_base_class%', |
200
|
|
|
'generator_dumper_class' => '%router.options.generator_dumper_class%', |
201
|
|
|
'generator_cache_class' => '%router.options.generator.cache_class%', |
202
|
|
|
'matcher_class' => '%router.options.matcher_class%', |
203
|
|
|
'matcher_base_class' => '%router.options.matcher_base_class%', |
204
|
|
|
'matcher_dumper_class' => '%router.options.matcher_dumper_class%', |
205
|
|
|
'matcher_cache_class' => '%router.options.matcher.cache_class%', |
206
|
|
|
'resource_type' => 'service', ////////////////////! |
207
|
|
|
]) |
208
|
|
|
->addArgument(new Reference('router.request_context', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)) |
209
|
|
|
->addArgument(new Reference('logger', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)) |
210
|
|
|
->addMethodCall('setConfigCacheFactory', [new Reference('config_cache_factory')]) |
211
|
|
|
; |
212
|
|
|
$c->setAlias('router', 'router.default'); |
213
|
|
|
|
214
|
|
|
$c->register('router_listener', RouterListener::class) // routing.xml |
215
|
|
|
->addTag('kernel.event_subscriber') |
216
|
|
|
->addTag('monolog.logger', ['channel' => 'request']) |
217
|
|
|
->addArgument(new Reference('router')) |
218
|
|
|
->addArgument(new Reference('request_stack')) |
219
|
|
|
->addArgument(new Reference('router.request_context', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)) |
220
|
|
|
->addArgument(new Reference('logger', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)) |
221
|
|
|
; |
222
|
|
|
|
223
|
|
|
$c->autowire(TemplateNameParser::class) |
224
|
|
|
->setAutoconfigured(true) |
225
|
|
|
->setPublic(false); |
226
|
|
|
$c->setAlias(TemplateNameParserInterface::class, TemplateNameParser::class); |
227
|
|
|
|
228
|
|
|
$c->autowire(\Twig_Loader_Array::class, \Twig_Loader_Array::class) |
229
|
|
|
->setArgument('$templates', ['index.html.twig' => 'Hello Component!']) |
230
|
|
|
->setAutoconfigured(true) |
231
|
|
|
->setPublic(false); |
232
|
|
|
$c->setAlias(\Twig_LoaderInterface::class, \Twig_Loader_Array::class); |
233
|
|
|
|
234
|
|
|
$c->autowire(\Twig_Environment::class, \Twig_Environment::class) |
235
|
|
|
->setAutoconfigured(true) |
236
|
|
|
->setPublic(false); |
237
|
|
|
$c->setAlias(\Twig\Environment::class, \Twig_Environment::class); |
238
|
|
|
|
239
|
|
|
$c->autowire(TwigEngine::class) |
240
|
|
|
->setAutoconfigured(true) |
241
|
|
|
->setPublic(false); |
242
|
|
|
$c->setAlias(EngineInterface::class, TwigEngine::class); |
243
|
|
|
|
244
|
|
View Code Duplication |
if (in_array($this->getEnvironment(), ['test'], true)) { |
|
|
|
|
245
|
|
|
$c->autowire('test.client', Client::class) |
246
|
|
|
->setPublic(true); // Public needed! |
247
|
|
|
} |
248
|
|
|
|
249
|
|
|
//Controllers |
250
|
|
|
$c->autowire(EngineAsArgumentController::class) |
251
|
|
|
->setAutoconfigured(true) |
252
|
|
|
->addTag('controller.service_arguments') |
253
|
|
|
->setPublic(false); |
254
|
|
|
|
255
|
|
|
$c->autowire(Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestAttributeValueResolver::class) // argument_resolver.request_attribute |
256
|
|
|
->setArgument('$container', new Reference('service_container')) |
257
|
|
|
->addTag('controller.argument_value_resolver', array('priority' => 100))->setPublic(false); |
258
|
|
|
$c->autowire(Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestValueResolver::class) // argument_resolver.request |
259
|
|
|
->setArgument('$container', new Reference('service_container')) |
260
|
|
|
->addTag('controller.argument_value_resolver', array('priority' => 50))->setPublic(false); |
261
|
|
|
$c->autowire(Symfony\Component\HttpKernel\Controller\ArgumentResolver\SessionValueResolver::class) // argument_resolver.session |
262
|
|
|
->setArgument('$container', new Reference('service_container')) |
263
|
|
|
->addTag('controller.argument_value_resolver', array('priority' => 50))->setPublic(false); |
264
|
|
|
$c->autowire(ServiceValueResolver::class) // argument_resolver.service |
265
|
|
|
->setArgument('$container', new Reference('service_container')) |
266
|
|
|
->addTag('controller.argument_value_resolver', array('priority' => -50))->setPublic(false); |
267
|
|
|
$c->autowire(DefaultValueResolver::class) // argument_resolver.default |
268
|
|
|
->setArgument('$container', new Reference('service_container')) |
269
|
|
|
->addTag('controller.argument_value_resolver', array('priority' => -100))->setPublic(false); |
270
|
|
|
$c->autowire(Symfony\Component\HttpKernel\Controller\ArgumentResolver\VariadicValueResolver::class) // argument_resolver.variadic |
271
|
|
|
->setArgument('$container', new Reference('service_container')) |
272
|
|
|
->addTag('controller.argument_value_resolver', array('priority' => -150))->setPublic(false); |
273
|
|
|
// https://symfony.com/doc/current/controller/argument_value_resolver.html |
274
|
|
|
// http://api.symfony.com/3.3/Symfony/Component/HttpKernel/Controller/ArgumentResolver/ServiceValueResolver.html |
275
|
|
|
// https://symfony.com/doc/current/service_container/tags.html |
276
|
|
|
|
277
|
|
|
$c->addCompilerPass(new RoutingResolverPass()); |
|
|
|
|
278
|
|
|
$c->addCompilerPass(new RegisterListenersPass(), PassConfig::TYPE_BEFORE_REMOVING); |
279
|
|
|
// $c->addCompilerPass(new AddConsoleCommandPass()); // Dependency need! |
|
|
|
|
280
|
|
|
$c->addCompilerPass(new AddCacheWarmerPass()); |
281
|
|
|
$c->addCompilerPass(new AddCacheClearerPass()); |
282
|
|
|
$c->addCompilerPass(new ControllerArgumentValueResolverPass()); |
|
|
|
|
283
|
|
|
|
284
|
|
|
// Extensions |
285
|
|
|
// $c->loadFromExtension('framework', [ |
|
|
|
|
286
|
|
|
// 'secret' => 'NotSecret', // What about use $ uuid -v4 or $ uuidgen |
|
|
|
|
287
|
|
|
// ]); |
288
|
|
|
} |
289
|
|
|
} |
290
|
|
|
|
291
|
|
|
// Information for Service "test.client" |
292
|
|
|
// ===================================== |
293
|
|
|
|
294
|
|
|
// ---------------- --------------------------------------- |
295
|
|
|
// Option Value |
296
|
|
|
// ---------------- --------------------------------------- |
297
|
|
|
// Service ID test.client |
298
|
|
|
// Class Symfony\Bundle\FrameworkBundle\Client |
299
|
|
|
// Tags - |
300
|
|
|
// Public yes |
301
|
|
|
// Synthetic no |
302
|
|
|
// Lazy no |
303
|
|
|
// Shared no |
304
|
|
|
// Abstract no |
305
|
|
|
// Autowired no |
306
|
|
|
// Autoconfigured no |
307
|
|
|
// ---------------- --------------------------------------- |
308
|
|
|
|
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.