vendor/jms/serializer-bundle/DependencyInjection/Compiler/ServiceMapPass.php line 29

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace JMS\SerializerBundle\DependencyInjection\Compiler;
  7. use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  8. use Symfony\Component\DependencyInjection\ContainerBuilder;
  9. use Symfony\Component\DependencyInjection\Reference;
  11. /**
  12.  * This pass allows you to easily create service maps.
  13.  *
  14.  * ```php
  15.  *    $container->addCompilerPass(new ServiceMapPass(
  16.  *        'jms_serializer.visitor',
  17.  *        'format',
  18.  *        function(ContainerBuilder $container, Definition $def) {
  19.  *            $container->getDefinition('jms_serializer')
  20.  *                ->addArgument($def);
  21.  *        }
  22.  *    ));
  23.  * ```
  24.  *
  25.  * In the example above, we convert the visitors into a map service.
  26.  *
  27.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  28.  */
  29. class ServiceMapPass implements CompilerPassInterface, \Serializable
  30. {
  31.     private $tagName;
  32.     private $keyAttributeName;
  33.     private $callable;
  35.     public function __construct($tagName, $keyAttributeName, $callable)
  36.     {
  37.         $this->tagName = $tagName;
  38.         $this->keyAttributeName = $keyAttributeName;
  39.         $this->callable = $callable;
  40.     }
  42.     public function process(ContainerBuilder $container)
  43.     {
  44.         if (!is_callable($this->callable)) {
  45.             throw new \RuntimeException('The callable is invalid. If you had serialized this pass, the original callable might not be available anymore.');
  46.         }
  48.         $serviceMap = [];
  49.         foreach ($container->findTaggedServiceIds($this->tagName) as $id => $tags) {
  50.             foreach ($tags as $tag) {
  51.                 if (!isset($tag[$this->keyAttributeName])) {
  52.                     throw new \RuntimeException(sprintf('The attribute "%s" must be set for service "%s" and tag "%s".', $this->keyAttributeName, $id, $this->tagName));
  53.                 }
  55.                 $serviceMap[$tag[$this->keyAttributeName]] = new Reference($id);
  56.             }
  57.         }
  59.         call_user_func($this->callable, $container, $serviceMap);
  60.     }
  62.     public function serialize()
  63.     {
  64.         return serialize([$this->tagName, $this->keyAttributeName]);
  65.     }
  67.     public function unserialize($str)
  68.     {
  69.         [$this->tagName, $this->keyAttributeName] = unserialize($str);
  70.     }
  71. }