Fixes circular reference bug in custom generators

Author: Robin Cawser

src/Vivait/StringGeneratorBundle/EventListener/GeneratorListener.php

@@ -5,6 +5,7 @@
 use Doctrine\Common\Annotations\Reader;
 use Doctrine\ORM\EntityRepository;
 use Doctrine\ORM\Event\LifecycleEventArgs;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Vivait\StringGeneratorBundle\Annotation\GeneratorAnnotation;
 use Vivait\StringGeneratorBundle\Model\GeneratorInterface;
 use Vivait\StringGeneratorBundle\Registry\Registry;
@@ -23,21 +24,32 @@ class GeneratorListener
      * @var GeneratorInterface
      */
     private $generator;
+
     /**
      * @var Registry
      */
     private $registry;
 
+    private $container;
+
     /**
+     * Registry has been made nullable as injecting it causes circular references. Instead, the container is injected
+     * via a setter, and the registry is fetched from there instead.
+     *
      * @param Reader $reader
      * @param Registry $registry
      */
-    public function __construct(Reader $reader, Registry $registry)
+    public function __construct(Reader $reader, Registry $registry = null)
     {
         $this->reader = $reader;
         $this->registry = $registry;
     }
 
+    public function setContainer(ContainerInterface $container)
+    {
+        $this->container = $container;
+    }
+
     /**
      * @param LifecycleEventArgs $args
      */
@@ -75,7 +87,7 @@ public function prePersist(LifecycleEventArgs $args)
     private function generateString($property, GeneratorAnnotation $annotation, $object)
     {
         /** @var GeneratorInterface $generator */
-        $generator = $this->registry->get($annotation->generator);
+        $generator = $this->getRegistry()->get($annotation->generator);
         $generator->setLength($annotation->length);
 
         if(!empty($annotation->callbacks)){
@@ -129,4 +141,15 @@ private function isMethod($class, $callback)
     {
         return method_exists($class, $callback) && is_callable([$class, $callback]);
     }
+
+    /**
+     * @return Registry
+     */
+    private function getRegistry()
+    {
+        if($this->registry){
+            return $this->registry;
+        }
+        return $this->container->get('vivait_generator.registry');
+    }
 }

src/Vivait/StringGeneratorBundle/Resources/config/services.yml

@@ -2,9 +2,12 @@ services:
     vivait_generator.generator.listener:
         class: Vivait\StringGeneratorBundle\EventListener\GeneratorListener
         public: false
-        arguments: [@annotation_reader, @vivait_generator.registry]
+        arguments: [@annotation_reader]
+        calls:
+            - [setContainer, [@service_container]]
         tags:
             - { name: doctrine.event_listener, event: prePersist }
+
     vivait_generator.registry:
         class: Vivait\StringGeneratorBundle\Registry\Registry
         arguments: [@service_container, []]