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

Open in your IDE?
  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\Compiler\CompilerPassInterface;
  10. use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
  11. use Symfony\Component\DependencyInjection\ContainerBuilder;
  12. use Symfony\Component\DependencyInjection\Reference;
  14. class CustomHandlersPass implements CompilerPassInterface
  15. {
  16. public function process(ContainerBuilder $container)
  17. {
  18. $handlers = [];
  19. $handlerServices = [];
  20. foreach ($container->findTaggedServiceIds('jms_serializer.handler') as $id => $tags) {
  21. foreach ($tags as $attrs) {
  22. if (!isset($attrs['type'], $attrs['format'])) {
  23. throw new \RuntimeException(sprintf('Each tag named "jms_serializer.handler" of service "%s" must have at least two attributes: "type" and "format".', $id));
  24. }
  26. $directions = [GraphNavigatorInterface::DIRECTION_DESERIALIZATION, GraphNavigatorInterface::DIRECTION_SERIALIZATION];
  27. if (isset($attrs['direction'])) {
  28. if (!defined($directionConstant = 'JMS\Serializer\GraphNavigatorInterface::DIRECTION_' . strtoupper($attrs['direction']))) {
  29. throw new \RuntimeException(sprintf('The direction "%s" of tag "jms_serializer.handler" of service "%s" does not exist.', $attrs['direction'], $id));
  30. }
  32. $directions = [constant($directionConstant)];
  33. }
  35. foreach ($directions as $direction) {
  36. $method = $attrs['method'] ?? HandlerRegistry::getDefaultMethod($direction, $attrs['type'], $attrs['format']);
  37. $priority = isset($attrs['priority']) ? intval($attrs['priority']) : 0;
  38. $ref = new Reference($id);
  39. if (class_exists(ServiceLocatorTagPass::class) || $container->getDefinition($id)->isPublic()) {
  40. $handlerServices[$id] = $ref;
  41. $handlers[] = [$direction, $attrs['type'], $attrs['format'], $priority, $id, $method];
  42. } else {
  43. $handlers[] = [$direction, $attrs['type'], $attrs['format'], $priority, $ref, $method];
  44. }
  45. }
  46. }
  47. }
  49. foreach ($container->findTaggedServiceIds('jms_serializer.subscribing_handler') as $id => $tags) {
  50. $def = $container->getDefinition($id);
  51. $class = $def->getClass();
  53. $ref = new \ReflectionClass($class);
  54. if (!$ref->implementsInterface('JMS\Serializer\Handler\SubscribingHandlerInterface')) {
  55. throw new \RuntimeException(sprintf('The service "%s" must implement the SubscribingHandlerInterface.', $id));
  56. }
  58. foreach (call_user_func([$class, 'getSubscribingMethods']) as $methodData) {
  59. if (!isset($methodData['format'], $methodData['type'])) {
  60. throw new \RuntimeException(sprintf('Each method returned from getSubscribingMethods of service "%s" must have a "type", and "format" attribute.', $id));
  61. }
  63. $directions = [GraphNavigatorInterface::DIRECTION_DESERIALIZATION, GraphNavigatorInterface::DIRECTION_SERIALIZATION];
  64. if (isset($methodData['direction'])) {
  65. $directions = [$methodData['direction']];
  66. }
  68. foreach ($directions as $direction) {
  69. $priority = isset($methodData['priority']) ? intval($methodData['priority']) : 0;
  70. $method = $methodData['method'] ?? HandlerRegistry::getDefaultMethod($direction, $methodData['type'], $methodData['format']);
  72. $ref = new Reference($id);
  73. if (class_exists(ServiceLocatorTagPass::class) || $def->isPublic()) {
  74. $handlerServices[$id] = $ref;
  75. $handlers[] = [$direction, $methodData['type'], $methodData['format'], $priority, $id, $method];
  76. } else {
  77. $handlers[] = [$direction, $methodData['type'], $methodData['format'], $priority, $ref, $method];
  78. }
  79. }
  80. }
  81. }
  83. $handlers = $this->sortAndFlattenHandlersList($handlers);
  85. $container->findDefinition('jms_serializer.handler_registry')
  86. ->addArgument($handlers);
  88. if (class_exists(ServiceLocatorTagPass::class)) {
  89. $serviceLocator = ServiceLocatorTagPass::register($container, $handlerServices);
  90. $container->findDefinition('jms_serializer.handler_registry')->replaceArgument(0, $serviceLocator);
  91. }
  92. }
  94. private function sortAndFlattenHandlersList(array $allHandlers)
  95. {
  96. $sorter = static function ($a, $b) {
  97. return $b[3] === $a[3] ? 0 : ($b[3] > $a[3] ? 1 : -1);
  98. };
  99. self::stable_uasort($allHandlers, $sorter);
  100. $handlers = [];
  101. foreach ($allHandlers as $handler) {
  102. [$direction, $type, $format, $priority, $service, $method] = $handler;
  103. $handlers[$direction][$type][$format] = [$service, $method];
  104. }
  106. return $handlers;
  107. }
  109. /**
  110. * Performs stable sorting. Copied from http://php.net/manual/en/function.uasort.php#121283
  111. *
  112. * @param array $array
  113. * @param $value_compare_func
  114. *
  115. * @return bool
  116. */
  117. private static function stable_uasort(array &$array, $value_compare_func)
  118. {
  119. $index = 0;
  120. foreach ($array as &$item) {
  121. $item = [$index++, $item];
  122. }
  124. $result = uasort($array, static function ($a, $b) use ($value_compare_func) {
  125. $result = call_user_func($value_compare_func, $a[1], $b[1]);
  127. return 0 === $result ? $a[0] - $b[0] : $result;
  128. });
  129. foreach ($array as &$item) {
  130. $item = $item[1];
  131. }
  133. return $result;
  134. }
  135. }