Introduce new "before making unique" callback to allow unique tree slugs, fixes #1429 and #1604.

Author: cmfcmf

lib/Gedmo/Sluggable/Handler/SlugHandlerWithUniqueCallbackInterface.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Gedmo\Sluggable\Handler;
+
+use Gedmo\Sluggable\Mapping\Event\SluggableAdapter;
+
+/**
+ * This adds the ability to a SlugHandler to change the slug just before its
+ * uniqueness is ensured. It is also called if the unique options is _not_
+ * set.
+ *
+ * @author Gediminas Morkevicius <[email protected]>
+ * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
+interface SlugHandlerWithUniqueCallbackInterface extends SlugHandlerInterface
+{
+    /**
+     * Callback for slug handlers before it is made unique
+     *
+     * @param SluggableAdapter $ea
+     * @param array            $config
+     * @param object           $object
+     * @param string           $slug
+     *
+     * @return void
+     */
+    public function beforeMakingUnique(SluggableAdapter $ea, array &$config, $object, &$slug);
+}

lib/Gedmo/Sluggable/Handler/TreeSlugHandler.php

@@ -17,7 +17,7 @@
  * @author Gediminas Morkevicius <[email protected]>
  * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
-class TreeSlugHandler implements SlugHandlerInterface
+class TreeSlugHandler implements SlugHandlerWithUniqueCallbackInterface
 {
     const SEPARATOR = '/';
 
@@ -128,10 +128,16 @@ public static function validate(array $options, ClassMetadata $meta)
     /**
      * {@inheritDoc}
      */
-    public function onSlugCompletion(SluggableAdapter $ea, array &$config, $object, &$slug)
+    public function beforeMakingUnique(SluggableAdapter $ea, array &$config, $object, &$slug)
     {
         $slug = $this->transliterate($slug, $config['separator'], $object);
+    }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function onSlugCompletion(SluggableAdapter $ea, array &$config, $object, &$slug)
+    {
         if (!$this->isInsert) {
             $wrapped = AbstractWrapper::wrap($object, $this->om);
             $meta = $wrapped->getMetadata();

lib/Gedmo/Sluggable/SluggableListener.php

@@ -4,6 +4,7 @@
 
 use Doctrine\Common\EventArgs;
 use Gedmo\Mapping\MappedEventSubscriber;
+use Gedmo\Sluggable\Handler\SlugHandlerWithUniqueCallbackInterface;
 use Gedmo\Sluggable\Mapping\Event\SluggableAdapter;
 use Doctrine\Common\Persistence\ObjectManager;
 use Gedmo\Tool\Wrapper\AbstractWrapper;
@@ -384,6 +385,16 @@ private function generateSlug(SluggableAdapter $ea, $object)
                     $slug = null;
                 }
 
+                // notify slug handlers --> beforeMakingUnique
+                if ($hasHandlers) {
+                    foreach ($options['handlers'] as $class => $handlerOptions) {
+                        $handler = $this->getHandler($class);
+                        if ($handler instanceof SlugHandlerWithUniqueCallbackInterface) {
+                            $handler->beforeMakingUnique($ea, $options, $object, $slug);
+                        }
+                    }
+                }
+
                 // make unique slug if requested
                 if ($options['unique'] && null !== $slug) {
                     $this->exponent = 0;