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

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