vendor/jms/serializer-bundle/DependencyInjection/Compiler/CustomHandlersPass.php line 73

  1. <?php
  3. declare(strict_types=1);
  5. namespace JMS\SerializerBundle\DependencyInjection\Compiler;
  7. use JMS\Serializer\GraphNavigatorInterface;
  8. use JMS\Serializer\Handler\HandlerRegistry;
  9. use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
  10. use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  11. use Symfony\Component\DependencyInjection\ContainerBuilder;
  12. use Symfony\Component\DependencyInjection\Reference;
  14. /**
  15.  * @internal
  16.  */
  17. final class CustomHandlersPass implements CompilerPassInterface
  18. {
  19.     public function process(ContainerBuilder $container)
  20.     {
  21.         $handlersByDirection = $this->findHandlers($container);
  22.         $handlerRegistryDef = $container->findDefinition('jms_serializer.handler_registry');
  24.         $handlerServices = [];
  25.         foreach ($handlersByDirection as $direction => $handlersByType) {
  26.             foreach ($handlersByType as $type => $handlersByFormat) {
  27.                 foreach ($handlersByFormat as $format => $handlerCallable) {
  28.                     $id = (string) $handlerCallable[0];
  30.                     $handlerServices[$id] = new ServiceClosureArgument($handlerCallable[0]);
  31.                     $handlerCallable[0] = $id;
  33.                     $handlerRegistryDef->addMethodCall('registerHandler', [$direction, $type, $format, $handlerCallable]);
  34.                 }
  35.             }
  36.         }
  38.         $container->findDefinition('jms_serializer.handler_registry.service_locator')
  39.             ->setArgument(0, $handlerServices);
  40.     }
  42.     private function findHandlers(ContainerBuilder $container): array
  43.     {
  44.         $handlers = [];
  45.         foreach ($container->findTaggedServiceIds('jms_serializer.handler') as $id => $tags) {
  46.             foreach ($tags as $attrs) {
  47.                 if (!isset($attrs['type'], $attrs['format'])) {
  48.                     throw new \RuntimeException(sprintf('Each tag named "jms_serializer.handler" of service "%s" must have at least two attributes: "type" and "format".', $id));
  49.                 }
  51.                 $directions = [GraphNavigatorInterface::DIRECTION_DESERIALIZATION, GraphNavigatorInterface::DIRECTION_SERIALIZATION];
  52.                 if (isset($attrs['direction'])) {
  53.                     if (!defined($directionConstant = 'JMS\Serializer\GraphNavigatorInterface::DIRECTION_' . strtoupper($attrs['direction']))) {
  54.                         throw new \RuntimeException(sprintf('The direction "%s" of tag "jms_serializer.handler" of service "%s" does not exist.', $attrs['direction'], $id));
  55.                     }
  57.                     $directions = [constant($directionConstant)];
  58.                 }
  60.                 foreach ($directions as $direction) {
  61.                     $method = $attrs['method'] ?? HandlerRegistry::getDefaultMethod($direction, $attrs['type'], $attrs['format']);
  62.                     $priority = isset($attrs['priority']) ? intval($attrs['priority']) : 0;
  64.                     $handlers[] = [$direction, $attrs['type'], $attrs['format'], $priority, new Reference($id), $method];
  65.                 }
  66.             }
  67.         }
  69.         foreach ($container->findTaggedServiceIds('jms_serializer.subscribing_handler') as $id => $tags) {
  70.             $def = $container->getDefinition($id);
  71.             $class = $def->getClass();
  73.             $ref = new \ReflectionClass($class);
  74.             if (!$ref->implementsInterface('JMS\Serializer\Handler\SubscribingHandlerInterface')) {
  75.                 throw new \RuntimeException(sprintf('The service "%s" must implement the SubscribingHandlerInterface.', $id));
  76.             }
  78.             foreach (call_user_func([$class, 'getSubscribingMethods']) as $methodData) {
  79.                 if (!isset($methodData['format'], $methodData['type'])) {
  80.                     throw new \RuntimeException(sprintf('Each method returned from getSubscribingMethods of service "%s" must have a "type", and "format" attribute.', $id));
  81.                 }
  83.                 $directions = [GraphNavigatorInterface::DIRECTION_DESERIALIZATION, GraphNavigatorInterface::DIRECTION_SERIALIZATION];
  84.                 if (isset($methodData['direction'])) {
  85.                     $directions = [$methodData['direction']];
  86.                 }
  88.                 foreach ($directions as $direction) {
  89.                     $priority = isset($methodData['priority']) ? intval($methodData['priority']) : 0;
  90.                     $method = $methodData['method'] ?? HandlerRegistry::getDefaultMethod($direction, $methodData['type'], $methodData['format']);
  92.                     $handlers[] = [$direction, $methodData['type'], $methodData['format'], $priority, new Reference($id), $method];
  93.                 }
  94.             }
  95.         }
  97.         return $this->sortAndFlattenHandlersList($handlers);
  98.     }
  100.     private function sortAndFlattenHandlersList(array $allHandlers)
  101.     {
  102.         $sorter = static function ($a, $b) {
  103.             return $b[3] === $a[3] ? 0 : ($b[3] > $a[3] ? 1 : -1);
  104.         };
  105.         self::stable_uasort($allHandlers, $sorter);
  106.         $handlers = [];
  107.         foreach ($allHandlers as $handler) {
  108.             [$direction, $type, $format, $priority, $service, $method] = $handler;
  109.             $handlers[$direction][$type][$format] = [$service, $method];
  110.         }
  112.         return $handlers;
  113.     }
  115.     /**
  116.      * Performs stable sorting. Copied from http://php.net/manual/en/function.uasort.php#121283
  117.      *
  118.      * @param array $array
  119.      * @param callable $value_compare_func
  120.      *
  121.      * @return bool
  122.      */
  123.     private static function stable_uasort(array &$array, callable $value_compare_func)
  124.     {
  125.         $index = 0;
  126.         foreach ($array as &$item) {
  127.             $item = [$index++, $item];
  128.         }
  130.         $result = uasort($array, static function ($a, $b) use ($value_compare_func) {
  131.             $result = call_user_func($value_compare_func, $a[1], $b[1]);
  133.             return 0 === $result ? $a[0] - $b[0] : $result;
  134.         });
  135.         foreach ($array as &$item) {
  136.             $item = $item[1];
  137.         }
  139.         return $result;
  140.     }
  141. }