Merge pull request #1727 from Nilead/v2.4.x

Allow Sortable objects to be compared by custom method

Author: l3pp4rd

doc/sortable.md

@@ -30,6 +30,7 @@ Content:
 - [Yaml](#yaml-mapping) mapping example
 - [Xml](#xml-mapping) mapping example
 - Basic usage [examples](#basic-examples)
+- Custom comparison method (#custom-comparisons)
 
 
 <a name="including-extension"></a>
@@ -295,3 +296,33 @@ To move an item at the end of the list, you can set the position to `-1`:
 ```
 $item2->setPosition(-1);
 ```
+
+<a name="custom-comparisons"></a>
+
+## Custom comparison:
+
+Sortable works by comparing objects in the same group to see how they should be positioned. From time to time you may want to customize the way these
+objects are compared by simply implementing the Doctrine\Common\Comparable interface
+
+``` php
+<?php
+namespace Entity;
+
+use Doctrine\Common\Comparable;
+
+/**
+ * @ORM\Table(name="items")
+ * @ORM\Entity(repositoryClass="Gedmo\Sortable\Entity\Repository\SortableRepository")
+ */
+class Item implements Comparable
+{
+    public function compareTo($other)
+    {
+        // return 1 if this object is considered greater than the compare value
+        
+        // return -1 if this object is considered less than the compare value
+        
+        // return 0 if this object is considered equal to the compare value
+    }
+}
+```

lib/Gedmo/Sortable/SortableListener.php

@@ -2,6 +2,7 @@
 
 namespace Gedmo\Sortable;
 
+use Doctrine\Common\Comparable;
 use Doctrine\Common\EventArgs;
 use Doctrine\Common\Persistence\Mapping\ClassMetadata;
 use Doctrine\Common\Persistence\Proxy;
@@ -461,7 +462,13 @@ public function postFlush(EventArgs $args)
                                 $matches = $gr === null;
                             } elseif (is_object($gr) && is_object($value) && $gr !== $value) {
                                 // Special case for equal objects but different instances.
-                                $matches = $gr == $value;
+                                // If the object implements Comparable interface we can use its compareTo method
+                                // Otherwise we fallback to normal object comparison
+                                if ($gr instanceof Comparable) {
+                                    $matches = $gr->compareTo($value);
+                                } else {
+                                    $matches = $gr == $value;
+                                }
                             } else {
                                 $matches = $gr === $value;
                             }