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

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