vendor/jms/serializer-bundle/DependencyInjection/JMSSerializerExtension.php line 209

Open in your IDE?
  1. <?php
  3. namespace JMS\SerializerBundle\DependencyInjection;
  5. use JMS\Serializer\EventDispatcher\EventSubscriberInterface;
  6. use JMS\Serializer\Exception\RuntimeException;
  7. use JMS\Serializer\Handler\SubscribingHandlerInterface;
  8. use Symfony\Component\Config\FileLocator;
  9. use Symfony\Component\DependencyInjection\Alias;
  10. use Symfony\Component\DependencyInjection\ContainerBuilder;
  11. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  12. use Symfony\Component\DependencyInjection\Reference;
  13. use Symfony\Component\Finder\Finder;
  14. use Symfony\Component\HttpKernel\DependencyInjection\ConfigurableExtension;
  15. use Symfony\Component\Stopwatch\Stopwatch;
  16. use JMS\Serializer\Metadata\Driver\TypedPropertiesDriver;
  17. use Symfony\Component\Templating\Helper\Helper;
  19. class JMSSerializerExtension extends ConfigurableExtension
  20. {
  21. public function loadInternal(array $config, ContainerBuilder $container)
  22. {
  23. $container
  24. ->registerForAutoconfiguration(EventSubscriberInterface::class)
  25. ->addTag('jms_serializer.event_subscriber');
  27. $container
  28. ->registerForAutoconfiguration(SubscribingHandlerInterface::class)
  29. ->addTag('jms_serializer.subscribing_handler');
  31. $loader = new XmlFileLoader($container, new FileLocator(array(
  32. __DIR__ . '/../Resources/config/')));
  33. $loader->load('services.xml');
  35. // Built-in handlers.
  36. $container->getDefinition('jms_serializer.datetime_handler')
  37. ->addArgument($config['handlers']['datetime']['default_format'])
  38. ->addArgument($config['handlers']['datetime']['default_timezone'])
  39. ->addArgument($config['handlers']['datetime']['cdata']);
  41. $container->getDefinition('jms_serializer.array_collection_handler')
  42. ->replaceArgument(0, $config['handlers']['array_collection']['initialize_excluded']);
  44. // Built-in subscribers.
  45. $container->getDefinition('jms_serializer.doctrine_proxy_subscriber')
  46. ->replaceArgument(0, !$config['subscribers']['doctrine_proxy']['initialize_virtual_types'])
  47. ->replaceArgument(1, $config['subscribers']['doctrine_proxy']['initialize_excluded']);
  49. // Built-in object constructor.
  50. $container->getDefinition('jms_serializer.doctrine_object_constructor')
  51. ->replaceArgument(2, $config['object_constructors']['doctrine']['fallback_strategy']);
  53. // property naming
  54. $container
  55. ->getDefinition('jms_serializer.camel_case_naming_strategy')
  56. ->addArgument($config['property_naming']['separator'])
  57. ->addArgument($config['property_naming']['lower_case']);
  59. if (!empty($config['property_naming']['id'])) {
  60. $container->setAlias('jms_serializer.naming_strategy', $config['property_naming']['id']);
  61. }
  63. if (!class_exists(Helper::class)) {
  64. $container->removeDefinition('jms_serializer.templating.helper.serializer');
  65. }
  67. $bundles = $container->getParameter('kernel.bundles');
  69. if (!isset($bundles['TwigBundle'])) {
  70. $container->removeDefinition('jms_serializer.twig_extension.serializer');
  71. $container->removeDefinition('jms_serializer.twig_extension.serializer_runtime_helper');
  72. }
  74. if (!empty($config['expression_evaluator']['id'])) {
  75. $container
  76. ->getDefinition('jms_serializer.deserialization_graph_navigator_factory')
  77. ->replaceArgument(5, new Reference($config['expression_evaluator']['id']));
  79. $container
  80. ->getDefinition('jms_serializer.serialization_graph_navigator_factory')
  81. ->replaceArgument(4, new Reference($config['expression_evaluator']['id']));
  83. $container
  84. ->getDefinition('jms_serializer.accessor_strategy.default')
  85. ->setArgument(0, new Reference($config['expression_evaluator']['id']));
  87. } else {
  88. $container->removeDefinition('jms_serializer.expression_evaluator');
  89. }
  91. // metadata
  92. if ('none' === $config['metadata']['cache']) {
  93. $container->removeAlias('jms_serializer.metadata.cache');
  94. } elseif ('file' === $config['metadata']['cache']) {
  95. $container
  96. ->getDefinition('jms_serializer.metadata.cache.file_cache')
  97. ->replaceArgument(0, $config['metadata']['file_cache']['dir']);
  99. $dir = $container->getParameterBag()->resolveValue($config['metadata']['file_cache']['dir']);
  100. if (!is_dir($dir) && !@mkdir($dir, 0777, true) && !is_dir($dir)) {
  101. throw new RuntimeException(sprintf('Could not create cache directory "%s".', $dir));
  102. }
  103. } else {
  104. $container->setAlias('jms_serializer.metadata.cache', new Alias($config['metadata']['cache'], false));
  105. }
  107. if ($config['metadata']['infer_types_from_doctrine_metadata'] === false) {
  108. $container->setParameter('jms_serializer.infer_types_from_doctrine_metadata', false);
  109. }
  111. if (PHP_VERSION_ID >= 70400 && class_exists(TypedPropertiesDriver::class)) {
  112. $container->getDefinition('jms_serializer.metadata.typed_properties_driver')
  113. ->setDecoratedService('jms_serializer.metadata_driver')
  114. ->setPublic(false)
  115. ;
  116. }
  118. $container
  119. ->getDefinition('jms_serializer.metadata_factory')
  120. ->replaceArgument(2, $config['metadata']['debug']);
  122. // warmup
  123. if (!empty($config['metadata']['warmup']['paths']['included']) && class_exists(Finder::class)) {
  124. $container
  125. ->getDefinition('jms_serializer.cache.cache_warmer')
  126. ->replaceArgument(0, $config['metadata']['warmup']['paths']['included'])
  127. ->replaceArgument(2, $config['metadata']['warmup']['paths']['excluded']);
  128. } else {
  129. $container->removeDefinition('jms_serializer.cache.cache_warmer');
  130. }
  132. // directories
  133. $directories = array();
  134. if ($config['metadata']['auto_detection']) {
  135. foreach ($bundles as $name => $class) {
  136. $ref = new \ReflectionClass($class);
  138. $dir = dirname($ref->getFileName()) . '/Resources/config/serializer';
  139. if (file_exists($dir)) {
  140. $directories[$ref->getNamespaceName()] = $dir;
  141. }
  142. }
  143. }
  144. foreach ($config['metadata']['directories'] as $directory) {
  145. $directory['path'] = rtrim(str_replace('\\', '/', $directory['path']), '/');
  147. if ('@' === $directory['path'][0]) {
  148. $pathParts = explode('/', $directory['path']);
  149. $bundleName = substr($pathParts[0], 1);
  151. if (!isset($bundles[$bundleName])) {
  152. throw new RuntimeException(sprintf('The bundle "%s" has not been registered with AppKernel. Available bundles: %s', $bundleName, implode(', ', array_keys($bundles))));
  153. }
  155. $ref = new \ReflectionClass($bundles[$bundleName]);
  156. $directory['path'] = dirname($ref->getFileName()) . substr($directory['path'], strlen('@' . $bundleName));
  157. }
  159. $dir = rtrim($directory['path'], '\\/');
  160. if (!file_exists($dir)) {
  161. throw new RuntimeException(sprintf('The metadata directory "%s" does not exist for the namespace "%s"', $dir, $directory['namespace_prefix']));
  162. }
  164. $directories[rtrim($directory['namespace_prefix'], '\\')] = $dir;
  165. }
  166. $container
  167. ->getDefinition('jms_serializer.metadata.file_locator')
  168. ->replaceArgument(0, $directories);
  170. $this->setVisitorOptions($config, $container);
  172. if (!$container->getParameter('kernel.debug') || !class_exists(Stopwatch::class)) {
  173. $container->removeDefinition('jms_serializer.stopwatch_subscriber');
  174. }
  176. // context factories
  177. $services = [
  178. 'serialization' => 'jms_serializer.configured_serialization_context_factory',
  179. 'deserialization' => 'jms_serializer.configured_deserialization_context_factory',
  180. ];
  181. foreach ($services as $configKey => $serviceId) {
  182. $contextFactory = $container->getDefinition($serviceId);
  184. if (isset($config['default_context'][$configKey]['id'])) {
  185. $container->setAlias('jms_serializer.' . $configKey . '_context_factory', new Alias($config['default_context'][$configKey]['id'], true));
  186. $container->setAlias('JMS\\Serializer\\ContextFactory\\' . ucfirst($configKey) . 'ContextFactoryInterface', new Alias($config['default_context'][$configKey]['id'], true));
  187. $container->removeDefinition($serviceId);
  188. continue;
  189. }
  191. if (isset($config['default_context'][$configKey]['version'])) {
  192. $contextFactory->addMethodCall('setVersion', [$config['default_context'][$configKey]['version']]);
  193. }
  194. if (isset($config['default_context'][$configKey]['serialize_null'])) {
  195. $contextFactory->addMethodCall('setSerializeNulls', [$config['default_context'][$configKey]['serialize_null']]);
  196. }
  197. if (!empty($config['default_context'][$configKey]['attributes'])) {
  198. $contextFactory->addMethodCall('setAttributes', [$config['default_context'][$configKey]['attributes']]);
  199. }
  200. if (!empty($config['default_context'][$configKey]['groups'])) {
  201. $contextFactory->addMethodCall('setGroups', [$config['default_context'][$configKey]['groups']]);
  202. }
  203. if (!empty($config['default_context'][$configKey]['enable_max_depth_checks'])) {
  204. $contextFactory->addMethodCall('enableMaxDepthChecks');
  205. }
  206. }
  207. }
  209. public function getConfiguration(array $config, ContainerBuilder $container)
  210. {
  211. return new Configuration($container->getParameterBag()->resolveValue('%kernel.debug%'));
  212. }
  214. private function setVisitorOptions(array $config, ContainerBuilder $container): void
  215. {
  216. // json (serialization)
  217. if (isset($config['visitors']['json_serialization']['options'])) {
  218. $container->getDefinition('jms_serializer.json_serialization_visitor')
  219. ->addMethodCall('setOptions', [$config['visitors']['json_serialization']['options']]);
  220. }
  221. if (isset($config['visitors']['json_serialization']['depth'])) {
  222. $container->getDefinition('jms_serializer.json_serialization_visitor')
  223. ->addMethodCall('setDepth', [$config['visitors']['json_serialization']['depth']]);
  224. }
  226. // json (deserialization)
  227. if (isset($config['visitors']['json_deserialization']['options'])) {
  228. $container->getDefinition('jms_serializer.json_deserialization_visitor')
  229. ->addMethodCall('setOptions', [$config['visitors']['json_deserialization']['options']]);
  230. }
  232. // xml (serialization)
  233. if (!empty($config['visitors']['xml_serialization']['default_root_name'])) {
  234. $container->getDefinition('jms_serializer.xml_serialization_visitor')
  235. ->addMethodCall('setDefaultRootName', [
  236. $config['visitors']['xml_serialization']['default_root_name'],
  237. $config['visitors']['xml_serialization']['default_root_ns'],
  238. ]);
  239. }
  240. if (!empty($config['visitors']['xml_serialization']['version'])) {
  241. $container->getDefinition('jms_serializer.xml_serialization_visitor')
  242. ->addMethodCall('setDefaultVersion', [$config['visitors']['xml_serialization']['version']]);
  243. }
  244. if (!empty($config['visitors']['xml_serialization']['encoding'])) {
  245. $container->getDefinition('jms_serializer.xml_serialization_visitor')
  246. ->addMethodCall('setDefaultEncoding', [$config['visitors']['xml_serialization']['encoding']]);
  247. }
  248. if (!empty($config['visitors']['xml_serialization']['format_output'])) {
  249. $container->getDefinition('jms_serializer.xml_serialization_visitor')
  250. ->addMethodCall('setFormatOutput', [$config['visitors']['xml_serialization']['format_output']]);
  251. }
  253. // xml (deserialization)
  254. if (!empty($config['visitors']['xml_deserialization']['doctype_whitelist'])) {
  255. $container->getDefinition('jms_serializer.xml_deserialization_visitor')
  256. ->addMethodCall('setDoctypeWhitelist', [$config['visitors']['xml_deserialization']['doctype_whitelist']]);
  257. }
  258. if (!empty($config['visitors']['xml_deserialization']['external_entities'])) {
  259. $container->getDefinition('jms_serializer.xml_deserialization_visitor')
  260. ->addMethodCall('enableExternalEntities', [$config['visitors']['xml_deserialization']['external_entities']]);
  261. }
  262. if (!empty($config['visitors']['xml_deserialization']['options'])) {
  263. $container->getDefinition('jms_serializer.xml_deserialization_visitor')
  264. ->addMethodCall('setOptions', [$config['visitors']['xml_deserialization']['options']]);
  265. }
  266. }
  267. }