1 | <?php |
||
2 | |||
3 | /* |
||
4 | * This file is part of the API Platform project. |
||
5 | * |
||
6 | * (c) Kévin Dunglas <[email protected]> |
||
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 | declare(strict_types=1); |
||
13 | |||
14 | namespace ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection; |
||
15 | |||
16 | use ApiPlatform\Core\Api\FilterInterface; |
||
17 | use ApiPlatform\Core\Bridge\Doctrine\MongoDbOdm\Extension\AggregationCollectionExtensionInterface; |
||
18 | use ApiPlatform\Core\Bridge\Doctrine\MongoDbOdm\Extension\AggregationItemExtensionInterface; |
||
19 | use ApiPlatform\Core\Bridge\Doctrine\MongoDbOdm\Filter\AbstractFilter as DoctrineMongoDbOdmAbstractFilter; |
||
20 | use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\EagerLoadingExtension; |
||
21 | use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\FilterEagerLoadingExtension; |
||
22 | use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryCollectionExtensionInterface as DoctrineQueryCollectionExtensionInterface; |
||
23 | use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryItemExtensionInterface; |
||
24 | use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractContextAwareFilter as DoctrineOrmAbstractContextAwareFilter; |
||
25 | use ApiPlatform\Core\Bridge\Elasticsearch\DataProvider\Extension\RequestBodySearchCollectionExtensionInterface; |
||
26 | use ApiPlatform\Core\DataPersister\DataPersisterInterface; |
||
27 | use ApiPlatform\Core\DataProvider\CollectionDataProviderInterface; |
||
28 | use ApiPlatform\Core\DataProvider\ItemDataProviderInterface; |
||
29 | use ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface; |
||
30 | use ApiPlatform\Core\DataTransformer\DataTransformerInterface; |
||
31 | use ApiPlatform\Core\GraphQl\Resolver\MutationResolverInterface; |
||
32 | use ApiPlatform\Core\GraphQl\Resolver\QueryCollectionResolverInterface; |
||
33 | use ApiPlatform\Core\GraphQl\Resolver\QueryItemResolverInterface; |
||
34 | use ApiPlatform\Core\GraphQl\Type\Definition\TypeInterface as GraphQlTypeInterface; |
||
35 | use Doctrine\Common\Annotations\Annotation; |
||
36 | use phpDocumentor\Reflection\DocBlockFactoryInterface; |
||
37 | use Ramsey\Uuid\Uuid; |
||
38 | use Symfony\Component\BrowserKit\AbstractBrowser; |
||
39 | use Symfony\Component\Cache\Adapter\ArrayAdapter; |
||
40 | use Symfony\Component\Config\FileLocator; |
||
41 | use Symfony\Component\Config\Resource\DirectoryResource; |
||
42 | use Symfony\Component\DependencyInjection\ChildDefinition; |
||
43 | use Symfony\Component\DependencyInjection\ContainerBuilder; |
||
44 | use Symfony\Component\DependencyInjection\Exception\RuntimeException; |
||
45 | use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface; |
||
46 | use Symfony\Component\DependencyInjection\Loader\XmlFileLoader; |
||
47 | use Symfony\Component\DependencyInjection\Reference; |
||
48 | use Symfony\Component\Finder\Finder; |
||
49 | use Symfony\Component\HttpKernel\DependencyInjection\Extension; |
||
50 | use Symfony\Component\Validator\Validator\ValidatorInterface; |
||
51 | use Symfony\Component\Yaml\Yaml; |
||
52 | |||
53 | /** |
||
54 | * The extension of this bundle. |
||
55 | * |
||
56 | * @author Kévin Dunglas <[email protected]> |
||
57 | */ |
||
58 | final class ApiPlatformExtension extends Extension implements PrependExtensionInterface |
||
59 | { |
||
60 | /** |
||
61 | * {@inheritdoc} |
||
62 | */ |
||
63 | public function prepend(ContainerBuilder $container): void |
||
64 | { |
||
65 | if (isset($container->getExtensions()['framework'])) { |
||
66 | $container->prependExtensionConfig('framework', [ |
||
67 | 'serializer' => [ |
||
68 | 'enabled' => true, |
||
69 | ], |
||
70 | ]); |
||
71 | $container->prependExtensionConfig('framework', [ |
||
72 | 'property_info' => [ |
||
73 | 'enabled' => true, |
||
74 | ], |
||
75 | ]); |
||
76 | } |
||
77 | } |
||
78 | |||
79 | /** |
||
80 | * {@inheritdoc} |
||
81 | */ |
||
82 | public function load(array $configs, ContainerBuilder $container): void |
||
83 | { |
||
84 | $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); |
||
85 | |||
86 | $configuration = new Configuration(); |
||
87 | $config = $this->processConfiguration($configuration, $configs); |
||
88 | |||
89 | $formats = $this->getFormats($config['formats']); |
||
90 | $patchFormats = $this->getFormats($config['patch_formats']); |
||
91 | $errorFormats = $this->getFormats($config['error_formats']); |
||
92 | |||
93 | // Backward Compatibility layer |
||
94 | if (isset($formats['jsonapi']) && !isset($patchFormats['jsonapi'])) { |
||
95 | $patchFormats['jsonapi'] = ['application/vnd.api+json']; |
||
96 | } |
||
97 | |||
98 | $this->registerCommonConfiguration($container, $config, $loader, $formats, $patchFormats, $errorFormats); |
||
99 | $this->registerMetadataConfiguration($container, $config, $loader); |
||
100 | $this->registerOAuthConfiguration($container, $config); |
||
101 | $this->registerSwaggerConfiguration($container, $config, $loader); |
||
102 | $this->registerJsonApiConfiguration($formats, $loader); |
||
103 | $this->registerJsonLdHydraConfiguration($container, $formats, $loader, $config['enable_docs']); |
||
104 | $this->registerJsonHalConfiguration($formats, $loader); |
||
105 | $this->registerJsonProblemConfiguration($errorFormats, $loader); |
||
106 | $this->registerGraphQlConfiguration($container, $config, $loader); |
||
107 | $this->registerLegacyBundlesConfiguration($container, $config, $loader); |
||
108 | $this->registerCacheConfiguration($container); |
||
109 | $this->registerDoctrineOrmConfiguration($container, $config, $loader); |
||
110 | $this->registerDoctrineMongoDbOdmConfiguration($container, $config, $loader); |
||
111 | $this->registerHttpCacheConfiguration($container, $config, $loader); |
||
112 | $this->registerValidatorConfiguration($container, $config, $loader); |
||
113 | $this->registerDataCollectorConfiguration($container, $config, $loader); |
||
114 | $this->registerMercureConfiguration($container, $config, $loader); |
||
115 | $this->registerMessengerConfiguration($container, $config, $loader); |
||
116 | $this->registerElasticsearchConfiguration($container, $config, $loader); |
||
117 | $this->registerDataTransformerConfiguration($container); |
||
118 | $this->registerSecurityConfiguration($container, $loader); |
||
119 | |||
120 | $container->registerForAutoconfiguration(DataPersisterInterface::class) |
||
121 | ->addTag('api_platform.data_persister'); |
||
122 | $container->registerForAutoconfiguration(ItemDataProviderInterface::class) |
||
123 | ->addTag('api_platform.item_data_provider'); |
||
124 | $container->registerForAutoconfiguration(CollectionDataProviderInterface::class) |
||
125 | ->addTag('api_platform.collection_data_provider'); |
||
126 | $container->registerForAutoconfiguration(SubresourceDataProviderInterface::class) |
||
127 | ->addTag('api_platform.subresource_data_provider'); |
||
128 | $container->registerForAutoconfiguration(FilterInterface::class) |
||
129 | ->addTag('api_platform.filter'); |
||
130 | |||
131 | if ($container->hasParameter('test.client.parameters') && class_exists(AbstractBrowser::class) && trait_exists('Symfony\Component\HttpClient\HttpClientTrait')) { |
||
132 | $loader->load('test.xml'); |
||
133 | } |
||
134 | } |
||
135 | |||
136 | private function registerCommonConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader, array $formats, array $patchFormats, array $errorFormats): void |
||
137 | { |
||
138 | $loader->load('api.xml'); |
||
139 | $loader->load('data_persister.xml'); |
||
140 | $loader->load('data_provider.xml'); |
||
141 | $loader->load('filter.xml'); |
||
142 | |||
143 | if (class_exists(Uuid::class)) { |
||
144 | $loader->load('ramsey_uuid.xml'); |
||
145 | } |
||
146 | |||
147 | $container->setParameter('api_platform.enable_entrypoint', $config['enable_entrypoint']); |
||
148 | $container->setParameter('api_platform.enable_docs', $config['enable_docs']); |
||
149 | $container->setParameter('api_platform.title', $config['title']); |
||
150 | $container->setParameter('api_platform.description', $config['description']); |
||
151 | $container->setParameter('api_platform.version', $config['version']); |
||
152 | $container->setParameter('api_platform.show_webby', $config['show_webby']); |
||
153 | $container->setParameter('api_platform.exception_to_status', $config['exception_to_status']); |
||
154 | $container->setParameter('api_platform.formats', $formats); |
||
155 | $container->setParameter('api_platform.patch_formats', $patchFormats); |
||
156 | $container->setParameter('api_platform.error_formats', $errorFormats); |
||
157 | $container->setParameter('api_platform.allow_plain_identifiers', $config['allow_plain_identifiers']); |
||
158 | $container->setParameter('api_platform.eager_loading.enabled', $this->isConfigEnabled($container, $config['eager_loading'])); |
||
159 | $container->setParameter('api_platform.eager_loading.max_joins', $config['eager_loading']['max_joins']); |
||
160 | $container->setParameter('api_platform.eager_loading.fetch_partial', $config['eager_loading']['fetch_partial']); |
||
161 | $container->setParameter('api_platform.eager_loading.force_eager', $config['eager_loading']['force_eager']); |
||
162 | $container->setParameter('api_platform.collection.exists_parameter_name', $config['collection']['exists_parameter_name']); |
||
163 | $container->setParameter('api_platform.collection.order', $config['collection']['order']); |
||
164 | $container->setParameter('api_platform.collection.order_parameter_name', $config['collection']['order_parameter_name']); |
||
165 | $container->setParameter('api_platform.collection.pagination.enabled', $this->isConfigEnabled($container, $config['collection']['pagination'])); |
||
166 | $container->setParameter('api_platform.collection.pagination.partial', $config['collection']['pagination']['partial']); |
||
167 | $container->setParameter('api_platform.collection.pagination.client_enabled', $config['collection']['pagination']['client_enabled']); |
||
168 | $container->setParameter('api_platform.collection.pagination.client_items_per_page', $config['collection']['pagination']['client_items_per_page']); |
||
169 | $container->setParameter('api_platform.collection.pagination.client_partial', $config['collection']['pagination']['client_partial']); |
||
170 | $container->setParameter('api_platform.collection.pagination.items_per_page', $config['collection']['pagination']['items_per_page']); |
||
171 | $container->setParameter('api_platform.collection.pagination.maximum_items_per_page', $config['collection']['pagination']['maximum_items_per_page']); |
||
172 | $container->setParameter('api_platform.collection.pagination.page_parameter_name', $config['collection']['pagination']['page_parameter_name']); |
||
173 | $container->setParameter('api_platform.collection.pagination.enabled_parameter_name', $config['collection']['pagination']['enabled_parameter_name']); |
||
174 | $container->setParameter('api_platform.collection.pagination.items_per_page_parameter_name', $config['collection']['pagination']['items_per_page_parameter_name']); |
||
175 | $container->setParameter('api_platform.collection.pagination.partial_parameter_name', $config['collection']['pagination']['partial_parameter_name']); |
||
176 | $container->setParameter('api_platform.collection.pagination', $config['collection']['pagination']); |
||
177 | $container->setParameter('api_platform.http_cache.etag', $config['http_cache']['etag']); |
||
178 | $container->setParameter('api_platform.http_cache.max_age', $config['http_cache']['max_age']); |
||
179 | $container->setParameter('api_platform.http_cache.shared_max_age', $config['http_cache']['shared_max_age']); |
||
180 | $container->setParameter('api_platform.http_cache.vary', $config['http_cache']['vary']); |
||
181 | $container->setParameter('api_platform.http_cache.public', $config['http_cache']['public']); |
||
182 | |||
183 | $container->setAlias('api_platform.operation_path_resolver.default', $config['default_operation_path_resolver']); |
||
184 | $container->setAlias('api_platform.path_segment_name_generator', $config['path_segment_name_generator']); |
||
185 | |||
186 | if ($config['name_converter']) { |
||
187 | $container->setAlias('api_platform.name_converter', $config['name_converter']); |
||
188 | } |
||
189 | } |
||
190 | |||
191 | private function registerMetadataConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void |
||
192 | { |
||
193 | $loader->load('metadata/metadata.xml'); |
||
194 | $loader->load('metadata/xml.xml'); |
||
195 | |||
196 | [$xmlResources, $yamlResources] = $this->getResourcesToWatch($container, $config); |
||
197 | |||
198 | if (!empty($config['resource_class_directories'])) { |
||
199 | $container->setParameter('api_platform.resource_class_directories', array_merge( |
||
200 | $config['resource_class_directories'], $container->getParameter('api_platform.resource_class_directories') |
||
201 | )); |
||
202 | } |
||
203 | |||
204 | $container->getDefinition('api_platform.metadata.extractor.xml')->replaceArgument(0, $xmlResources); |
||
205 | |||
206 | if (class_exists(Annotation::class)) { |
||
207 | $loader->load('metadata/annotation.xml'); |
||
208 | } |
||
209 | |||
210 | if (class_exists(Yaml::class)) { |
||
211 | $loader->load('metadata/yaml.xml'); |
||
212 | $container->getDefinition('api_platform.metadata.extractor.yaml')->replaceArgument(0, $yamlResources); |
||
213 | } |
||
214 | |||
215 | if (interface_exists(DocBlockFactoryInterface::class)) { |
||
216 | $loader->load('metadata/php_doc.xml'); |
||
217 | } |
||
218 | } |
||
219 | |||
220 | private function getBundlesResourcesPaths(ContainerBuilder $container, array $config): array |
||
221 | { |
||
222 | $bundlesResourcesPaths = []; |
||
223 | |||
224 | foreach ($container->getParameter('kernel.bundles_metadata') as $bundle) { |
||
225 | $paths = []; |
||
226 | $dirname = $bundle['path']; |
||
227 | foreach (['.yaml', '.yml', '.xml', ''] as $extension) { |
||
228 | $paths[] = "$dirname/Resources/config/api_resources$extension"; |
||
229 | } |
||
230 | if ($this->isConfigEnabled($container, $config['doctrine'])) { |
||
231 | $paths[] = "$dirname/Entity"; |
||
232 | } |
||
233 | if ($this->isConfigEnabled($container, $config['doctrine_mongodb_odm'])) { |
||
234 | $paths[] = "$dirname/Document"; |
||
235 | } |
||
236 | |||
237 | foreach ($paths as $path) { |
||
238 | if ($container->fileExists($path, false)) { |
||
239 | $bundlesResourcesPaths[] = $path; |
||
240 | } |
||
241 | } |
||
242 | } |
||
243 | |||
244 | return $bundlesResourcesPaths; |
||
245 | } |
||
246 | |||
247 | private function getResourcesToWatch(ContainerBuilder $container, array $config): array |
||
248 | { |
||
249 | $paths = array_unique(array_merge($config['mapping']['paths'], $this->getBundlesResourcesPaths($container, $config))); |
||
250 | |||
251 | // Flex structure (only if nothing specified) |
||
252 | $projectDir = $container->getParameter('kernel.project_dir'); |
||
253 | if (!$paths && is_dir($dir = "$projectDir/config/api_platform")) { |
||
0 ignored issues
–
show
|
|||
254 | $paths = [$dir]; |
||
255 | } |
||
256 | |||
257 | $resources = ['yml' => [], 'xml' => [], 'dir' => []]; |
||
258 | |||
259 | foreach ($paths as $path) { |
||
260 | if (is_dir($path)) { |
||
261 | foreach (Finder::create()->followLinks()->files()->in($path)->name('/\.(xml|ya?ml)$/') as $file) { |
||
262 | $resources['yaml' === ($extension = $file->getExtension()) ? 'yml' : $extension][] = $file->getRealPath(); |
||
263 | } |
||
264 | |||
265 | $resources['dir'][] = $path; |
||
266 | $container->addResource(new DirectoryResource($path, '/\.(xml|ya?ml|php)$/')); |
||
267 | |||
268 | continue; |
||
269 | } |
||
270 | |||
271 | if ($container->fileExists($path, false)) { |
||
272 | if (!preg_match('/\.(xml|ya?ml)$/', $path, $matches)) { |
||
273 | throw new RuntimeException(sprintf('Unsupported mapping type in "%s", supported types are XML & YAML.', $path)); |
||
274 | } |
||
275 | |||
276 | $resources['yaml' === $matches[1] ? 'yml' : $matches[1]][] = $path; |
||
277 | |||
278 | continue; |
||
279 | } |
||
280 | |||
281 | throw new RuntimeException(sprintf('Could not open file or directory "%s".', $path)); |
||
282 | } |
||
283 | |||
284 | $container->setParameter('api_platform.resource_class_directories', $resources['dir']); |
||
285 | |||
286 | return [$resources['xml'], $resources['yml']]; |
||
287 | } |
||
288 | |||
289 | private function registerOAuthConfiguration(ContainerBuilder $container, array $config): void |
||
290 | { |
||
291 | if (!$config['oauth']) { |
||
292 | return; |
||
293 | } |
||
294 | |||
295 | $container->setParameter('api_platform.oauth.enabled', $this->isConfigEnabled($container, $config['oauth'])); |
||
296 | $container->setParameter('api_platform.oauth.clientId', $config['oauth']['clientId']); |
||
297 | $container->setParameter('api_platform.oauth.clientSecret', $config['oauth']['clientSecret']); |
||
298 | $container->setParameter('api_platform.oauth.type', $config['oauth']['type']); |
||
299 | $container->setParameter('api_platform.oauth.flow', $config['oauth']['flow']); |
||
300 | $container->setParameter('api_platform.oauth.tokenUrl', $config['oauth']['tokenUrl']); |
||
301 | $container->setParameter('api_platform.oauth.authorizationUrl', $config['oauth']['authorizationUrl']); |
||
302 | $container->setParameter('api_platform.oauth.scopes', $config['oauth']['scopes']); |
||
303 | } |
||
304 | |||
305 | /** |
||
306 | * Registers the Swagger, ReDoc and Swagger UI configuration. |
||
307 | */ |
||
308 | private function registerSwaggerConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void |
||
309 | { |
||
310 | if (empty($config['swagger']['versions'])) { |
||
311 | return; |
||
312 | } |
||
313 | |||
314 | $loader->load('json_schema.xml'); |
||
315 | $loader->load('swagger.xml'); |
||
316 | |||
317 | if ($config['enable_swagger_ui'] || $config['enable_re_doc']) { |
||
318 | $loader->load('swagger-ui.xml'); |
||
319 | $container->setParameter('api_platform.enable_swagger_ui', $config['enable_swagger_ui']); |
||
320 | $container->setParameter('api_platform.enable_re_doc', $config['enable_re_doc']); |
||
321 | } |
||
322 | |||
323 | $container->setParameter('api_platform.swagger.versions', $config['swagger']['versions']); |
||
324 | $container->setParameter('api_platform.swagger.api_keys', $config['swagger']['api_keys']); |
||
325 | } |
||
326 | |||
327 | private function registerJsonApiConfiguration(array $formats, XmlFileLoader $loader): void |
||
328 | { |
||
329 | if (!isset($formats['jsonapi'])) { |
||
330 | return; |
||
331 | } |
||
332 | |||
333 | $loader->load('jsonapi.xml'); |
||
334 | } |
||
335 | |||
336 | private function registerJsonLdHydraConfiguration(ContainerBuilder $container, array $formats, XmlFileLoader $loader, bool $docEnabled): void |
||
337 | { |
||
338 | if (!isset($formats['jsonld'])) { |
||
339 | return; |
||
340 | } |
||
341 | |||
342 | $loader->load('jsonld.xml'); |
||
343 | $loader->load('hydra.xml'); |
||
344 | |||
345 | if (!$docEnabled) { |
||
346 | $container->removeDefinition('api_platform.hydra.listener.response.add_link_header'); |
||
347 | } |
||
348 | } |
||
349 | |||
350 | private function registerJsonHalConfiguration(array $formats, XmlFileLoader $loader): void |
||
351 | { |
||
352 | if (!isset($formats['jsonhal'])) { |
||
353 | return; |
||
354 | } |
||
355 | |||
356 | $loader->load('hal.xml'); |
||
357 | } |
||
358 | |||
359 | private function registerJsonProblemConfiguration(array $errorFormats, XmlFileLoader $loader): void |
||
360 | { |
||
361 | if (!isset($errorFormats['jsonproblem'])) { |
||
362 | return; |
||
363 | } |
||
364 | |||
365 | $loader->load('problem.xml'); |
||
366 | } |
||
367 | |||
368 | private function registerGraphQlConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void |
||
369 | { |
||
370 | $enabled = $this->isConfigEnabled($container, $config['graphql']); |
||
371 | |||
372 | $container->setParameter('api_platform.graphql.enabled', $enabled); |
||
373 | $container->setParameter('api_platform.graphql.graphiql.enabled', $enabled && $this->isConfigEnabled($container, $config['graphql']['graphiql'])); |
||
374 | $container->setParameter('api_platform.graphql.graphql_playground.enabled', $enabled && $this->isConfigEnabled($container, $config['graphql']['graphql_playground'])); |
||
375 | |||
376 | if (!$enabled) { |
||
377 | return; |
||
378 | } |
||
379 | |||
380 | $container->setParameter('api_platform.graphql.default_ide', $config['graphql']['default_ide']); |
||
381 | $container->setParameter('api_platform.graphql.collection.pagination', $config['graphql']['collection']['pagination']); |
||
382 | |||
383 | $loader->load('graphql.xml'); |
||
384 | |||
385 | $container->registerForAutoconfiguration(QueryItemResolverInterface::class) |
||
386 | ->addTag('api_platform.graphql.query_resolver'); |
||
387 | $container->registerForAutoconfiguration(QueryCollectionResolverInterface::class) |
||
388 | ->addTag('api_platform.graphql.query_resolver'); |
||
389 | $container->registerForAutoconfiguration(MutationResolverInterface::class) |
||
390 | ->addTag('api_platform.graphql.mutation_resolver'); |
||
391 | $container->registerForAutoconfiguration(GraphQlTypeInterface::class) |
||
392 | ->addTag('api_platform.graphql.type'); |
||
393 | } |
||
394 | |||
395 | private function registerLegacyBundlesConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void |
||
396 | { |
||
397 | /** @var string[] $bundles */ |
||
398 | $bundles = $container->getParameter('kernel.bundles'); |
||
399 | |||
400 | if (isset($bundles['FOSUserBundle']) && $config['enable_fos_user']) { |
||
401 | $loader->load('fos_user.xml'); |
||
402 | } |
||
403 | |||
404 | if (isset($bundles['NelmioApiDocBundle']) && $config['enable_nelmio_api_doc']) { |
||
405 | $loader->load('nelmio_api_doc.xml'); |
||
406 | } |
||
407 | } |
||
408 | |||
409 | private function registerCacheConfiguration(ContainerBuilder $container): void |
||
410 | { |
||
411 | if (!$container->hasParameter('kernel.debug') || !$container->getParameter('kernel.debug')) { |
||
412 | $container->removeDefinition('api_platform.cache_warmer.cache_pool_clearer'); |
||
413 | } |
||
414 | |||
415 | if (!$container->hasParameter('api_platform.metadata_cache')) { |
||
416 | return; |
||
417 | } |
||
418 | |||
419 | @trigger_error('The "api_platform.metadata_cache" parameter is deprecated since version 2.4 and will have no effect in 3.0.', E_USER_DEPRECATED); |
||
420 | |||
421 | // BC |
||
422 | if (!$container->getParameter('api_platform.metadata_cache')) { |
||
423 | $container->removeDefinition('api_platform.cache_warmer.cache_pool_clearer'); |
||
424 | |||
425 | $container->register('api_platform.cache.metadata.property', ArrayAdapter::class); |
||
426 | $container->register('api_platform.cache.metadata.resource', ArrayAdapter::class); |
||
427 | $container->register('api_platform.cache.route_name_resolver', ArrayAdapter::class); |
||
428 | $container->register('api_platform.cache.identifiers_extractor', ArrayAdapter::class); |
||
429 | $container->register('api_platform.cache.subresource_operation_factory', ArrayAdapter::class); |
||
430 | $container->register('api_platform.elasticsearch.cache.metadata.document', ArrayAdapter::class); |
||
431 | } |
||
432 | } |
||
433 | |||
434 | private function registerDoctrineOrmConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void |
||
435 | { |
||
436 | if (!$this->isConfigEnabled($container, $config['doctrine'])) { |
||
437 | return; |
||
438 | } |
||
439 | |||
440 | $container->registerForAutoconfiguration(QueryItemExtensionInterface::class) |
||
441 | ->addTag('api_platform.doctrine.orm.query_extension.item'); |
||
442 | $container->registerForAutoconfiguration(DoctrineQueryCollectionExtensionInterface::class) |
||
443 | ->addTag('api_platform.doctrine.orm.query_extension.collection'); |
||
444 | $container->registerForAutoconfiguration(DoctrineOrmAbstractContextAwareFilter::class) |
||
445 | ->setBindings(['$requestStack' => null]); |
||
446 | |||
447 | $loader->load('doctrine_orm.xml'); |
||
448 | |||
449 | if ($this->isConfigEnabled($container, $config['eager_loading'])) { |
||
450 | return; |
||
451 | } |
||
452 | |||
453 | $container->removeAlias(EagerLoadingExtension::class); |
||
454 | $container->removeDefinition('api_platform.doctrine.orm.query_extension.eager_loading'); |
||
455 | $container->removeAlias(FilterEagerLoadingExtension::class); |
||
456 | $container->removeDefinition('api_platform.doctrine.orm.query_extension.filter_eager_loading'); |
||
457 | } |
||
458 | |||
459 | private function registerDoctrineMongoDbOdmConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void |
||
460 | { |
||
461 | if (!$this->isConfigEnabled($container, $config['doctrine_mongodb_odm'])) { |
||
462 | return; |
||
463 | } |
||
464 | |||
465 | $container->registerForAutoconfiguration(AggregationItemExtensionInterface::class) |
||
466 | ->addTag('api_platform.doctrine.mongodb.aggregation_extension.item'); |
||
467 | $container->registerForAutoconfiguration(AggregationCollectionExtensionInterface::class) |
||
468 | ->addTag('api_platform.doctrine.mongodb.aggregation_extension.collection'); |
||
469 | $container->registerForAutoconfiguration(DoctrineMongoDbOdmAbstractFilter::class) |
||
470 | ->setBindings(['$managerRegistry' => new Reference('doctrine_mongodb')]); |
||
471 | |||
472 | $loader->load('doctrine_mongodb_odm.xml'); |
||
473 | } |
||
474 | |||
475 | private function registerHttpCacheConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void |
||
476 | { |
||
477 | $loader->load('http_cache.xml'); |
||
478 | |||
479 | if (!$this->isConfigEnabled($container, $config['http_cache']['invalidation'])) { |
||
480 | return; |
||
481 | } |
||
482 | |||
483 | if ($this->isConfigEnabled($container, $config['doctrine'])) { |
||
484 | $loader->load('doctrine_orm_http_cache_purger.xml'); |
||
485 | } |
||
486 | |||
487 | $loader->load('http_cache_tags.xml'); |
||
488 | |||
489 | $definitions = []; |
||
490 | foreach ($config['http_cache']['invalidation']['varnish_urls'] as $key => $url) { |
||
491 | $definition = new ChildDefinition('api_platform.http_cache.purger.varnish_client'); |
||
492 | $definition->addArgument(['base_uri' => $url] + $config['http_cache']['invalidation']['request_options']); |
||
493 | |||
494 | $definitions[] = $definition; |
||
495 | } |
||
496 | |||
497 | $container->getDefinition('api_platform.http_cache.purger.varnish')->addArgument($definitions); |
||
498 | $container->setAlias('api_platform.http_cache.purger', 'api_platform.http_cache.purger.varnish'); |
||
499 | } |
||
500 | |||
501 | /** |
||
502 | * Normalizes the format from config to the one accepted by Symfony HttpFoundation. |
||
503 | */ |
||
504 | private function getFormats(array $configFormats): array |
||
505 | { |
||
506 | $formats = []; |
||
507 | foreach ($configFormats as $format => $value) { |
||
508 | foreach ($value['mime_types'] as $mimeType) { |
||
509 | $formats[$format][] = $mimeType; |
||
510 | } |
||
511 | } |
||
512 | |||
513 | return $formats; |
||
514 | } |
||
515 | |||
516 | private function registerValidatorConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void |
||
517 | { |
||
518 | if (interface_exists(ValidatorInterface::class)) { |
||
519 | $loader->load('validator.xml'); |
||
520 | } |
||
521 | |||
522 | if (!$config['validator']) { |
||
523 | return; |
||
524 | } |
||
525 | |||
526 | $container->setParameter('api_platform.validator.serialize_payload_fields', $config['validator']['serialize_payload_fields']); |
||
527 | } |
||
528 | |||
529 | private function registerDataCollectorConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void |
||
530 | { |
||
531 | if (!$config['enable_profiler']) { |
||
532 | return; |
||
533 | } |
||
534 | |||
535 | $loader->load('data_collector.xml'); |
||
536 | |||
537 | if ($container->hasParameter('kernel.debug') && $container->getParameter('kernel.debug')) { |
||
538 | $loader->load('debug.xml'); |
||
539 | } |
||
540 | } |
||
541 | |||
542 | private function registerMercureConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void |
||
543 | { |
||
544 | if (!$this->isConfigEnabled($container, $config['mercure'])) { |
||
545 | return; |
||
546 | } |
||
547 | |||
548 | $loader->load('mercure.xml'); |
||
549 | $container->getDefinition('api_platform.mercure.listener.response.add_link_header')->addArgument($config['mercure']['hub_url'] ?? '%mercure.default_hub%'); |
||
550 | |||
551 | if ($this->isConfigEnabled($container, $config['doctrine'])) { |
||
552 | $loader->load('doctrine_orm_mercure_publisher.xml'); |
||
553 | } |
||
554 | } |
||
555 | |||
556 | private function registerMessengerConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void |
||
557 | { |
||
558 | if (!$this->isConfigEnabled($container, $config['messenger'])) { |
||
559 | return; |
||
560 | } |
||
561 | |||
562 | $loader->load('messenger.xml'); |
||
563 | } |
||
564 | |||
565 | private function registerElasticsearchConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void |
||
566 | { |
||
567 | $enabled = $this->isConfigEnabled($container, $config['elasticsearch']); |
||
568 | |||
569 | $container->setParameter('api_platform.elasticsearch.enabled', $enabled); |
||
570 | |||
571 | if (!$enabled) { |
||
572 | return; |
||
573 | } |
||
574 | |||
575 | $loader->load('elasticsearch.xml'); |
||
576 | |||
577 | $container->registerForAutoconfiguration(RequestBodySearchCollectionExtensionInterface::class) |
||
578 | ->addTag('api_platform.elasticsearch.request_body_search_extension.collection'); |
||
579 | |||
580 | $container->setParameter('api_platform.elasticsearch.hosts', $config['elasticsearch']['hosts']); |
||
581 | $container->setParameter('api_platform.elasticsearch.mapping', $config['elasticsearch']['mapping']); |
||
582 | } |
||
583 | |||
584 | private function registerDataTransformerConfiguration(ContainerBuilder $container): void |
||
585 | { |
||
586 | $container->registerForAutoconfiguration(DataTransformerInterface::class) |
||
587 | ->addTag('api_platform.data_transformer'); |
||
588 | } |
||
589 | |||
590 | private function registerSecurityConfiguration(ContainerBuilder $container, XmlFileLoader $loader): void |
||
591 | { |
||
592 | /** @var string[] $bundles */ |
||
593 | $bundles = $container->getParameter('kernel.bundles'); |
||
594 | |||
595 | if (isset($bundles['SecurityBundle'])) { |
||
596 | $loader->load('security.xml'); |
||
597 | } |
||
598 | } |
||
599 | } |
||
600 |
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)
or! empty(...)
instead.