Allow custom generator classes to be used

Author: Robin Cawser

DependencyInjection/Configuration.php

@@ -19,6 +19,10 @@ public function getConfigTreeBuilder()
     {
         $treeBuilder = new TreeBuilder();
         $rootNode = $treeBuilder->root('vivait_string_generator');
+        $rootNode
+            ->children()
+                ->scalarNode('generator_class')->defaultValue('Vivait\StringGeneratorBundle\Generator\StringGenerator')->end()
+            ;
 
 
         // Here you should define the parameters that are allowed to

DependencyInjection/VivaitStringGeneratorExtension.php

@@ -24,5 +24,6 @@ public function load(array $configs, ContainerBuilder $container)
 
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.yml');
+        $container->setParameter('vivait_string_generator.generator_class', $config['generator_class']);
     }
 }

EventListener/IdGeneratorListener.php EventListener/StringGeneratorListener.phpEventListener/IdGeneratorListener.php renamed to EventListener/StringGeneratorListener.php

@@ -5,17 +5,21 @@
 use Doctrine\Common\Annotations\Reader;
 use Doctrine\ORM\Event\LifecycleEventArgs;
 use Vivait\StringGeneratorBundle\Annotation as Vivait;
-use Vivait\StringGeneratorBundle\Generator\StringGenerator;
-use Vivait\StringGeneratorBundle\Model\StringGeneratorInterface;
+use Vivait\StringGeneratorBundle\Model\GeneratorInterface;
 
-class IdGeneratorListener
+class StringGeneratorListener
 {
     private $reader;
     private $repo;
+    /**
+     * @var GeneratorInterface
+     */
+    private $generator;
 
-    public function __construct(Reader $reader)
+    public function __construct(Reader $reader, GeneratorInterface $generator)
     {
         $this->reader = $reader;
+        $this->generator = $generator;
     }
 
     /**
@@ -58,22 +62,23 @@ public function prePersist(LifecycleEventArgs $args)
      */
     private function generateId($property, Vivait\StringGenerator $annotation)
     {
-        $generator = new StringGenerator();
-        $generator
+        $this->generator
             ->setAlphabet($annotation->alphabet)
             ->setLength($annotation->length);
 
-        $id = $generator->generate();
+        $str = $this->generator->generate();
 
         if ($annotation->prefix) {
-            $id = sprintf("%s%s%s", $annotation->prefix, $annotation->separator, $id);
+            $str = sprintf("%s%s%s", $annotation->prefix, $annotation->separator, $str);
         }
 
-        if ($this->repo->findOneBy([$property => $id])) {
+        if ($this->repo->findOneBy([$property => $str])) {
             $this->generateId($property, $annotation);
         } else {
-            return $id;
+            return $str;
         }
+
+
     }
 
 

Generator/StringGenerator.php

@@ -2,26 +2,43 @@
 
 namespace Vivait\StringGeneratorBundle\Generator;
 
-use Vivait\StringGeneratorBundle\Model\StringGeneratorInterface;
+use Vivait\StringGeneratorBundle\Model\GeneratorInterface;
 
-class StringGenerator implements StringGeneratorInterface
+class StringGenerator implements GeneratorInterface
 {
 
     private $alphabet;
     private $length;
 
+
+    /**
+     * Set the characters that can be used to generate the string
+     *
+     * @param $alphabet
+     * @return $this
+     */
     public function setAlphabet($alphabet)
     {
         $this->alphabet = $alphabet;
         return $this;
     }
 
+    /**
+     * Set the length of the generated string
+     * @param $length
+     * @return $this
+     */
     public function setLength($length)
     {
         $this->length = $length;
         return $this;
     }
 
+    /**
+     * Creates a random string based on a length and alphabet
+     *
+     * @return string
+     */
     public function generate()
     {
         $str = [];

Model/StringGeneratorInterface.php Model/GeneratorInterface.phpModel/StringGeneratorInterface.php renamed to Model/GeneratorInterface.php

@@ -2,7 +2,7 @@
 
 namespace Vivait\StringGeneratorBundle\Model;
 
-interface StringGeneratorInterface
+interface GeneratorInterface
 {
 
     /**

README.md

@@ -80,8 +80,16 @@ A prefix can be obtained via a callback to a method in the entity using `prefix_
         return $this->category->getCode();
     }
 
-### Custom characters
+### Alphabet
 
 Setting `alphabet` limits the characters the generator can choose from. Defaults to alphanumeric.
 
-    @Vivait\StringGenerator(alphabet="abcdefghkmnpqrstuwxyz")
+    @Vivait\StringGenerator(alphabet="abcdefghkmnpqrstuwxyz")
+    
+## Custom generator
+
+If you want to use a different generator to create your string, create a class that implements namespace 
+`Vivait\StringGeneratorBundle\Model\GeneratorInterface`. Add the fully qualified classname to your config.yml:
+
+    vivait_string_generator:
+      generator_class: Acme\BlogBundle\Generator\UsernameGenerator

Resources/config/services.yml

@@ -1,8 +1,11 @@
 parameters:
 
 services:
+  vivait_stringgenerator.generator:
+      class: "%vivait_string_generator.generator_class%"
   vivait_stringgenerator.generator.listener:
-      class: Vivait\StringGeneratorBundle\EventListener\IdGeneratorListener
-      arguments: ["@annotation_reader"]
+      class: Vivait\StringGeneratorBundle\EventListener\StringGeneratorListener
+      arguments: ["@annotation_reader", "@vivait_stringgenerator.generator"]
       tags:
-          - { name: doctrine.event_listener, event: prePersist }
+          - { name: doctrine.event_listener, event: prePersist }
+