Issues/1246 (#1323)

* Fix #1246 after merge

* Fix #1246: add default order, allow multiple orders with optional direction

Author: vincentchalamon

features/bootstrap/FeatureContext.php

@@ -139,10 +139,12 @@ public function thereIsDummyObjects($nb)
     public function thereAreFooObjectsWithFakeNames($nb)
     {
         $names = ['Hawsepipe', 'Sthenelus', 'Ephesian', 'Separativeness', 'Balbo'];
+        $bars = ['Lorem', 'Dolor', 'Dolor', 'Sit', 'Amet'];
 
         for ($i = 0; $i < $nb; ++$i) {
             $foo = new Foo();
             $foo->setName($names[$i]);
+            $foo->setBar($bars[$i]);
 
             $this->manager->persist($foo);
         }

features/main/default_order.feature

@@ -17,35 +17,40 @@ Feature: Default order
       "@id": "/foos",
       "@type": "hydra:Collection",
       "hydra:member": [
+        {
+          "@id": "/foos/5",
+          "@type": "Foo",
+          "id": 5,
+          "name": "Balbo",
+          "bar": "Amet"
+        },
         {
           "@id": "/foos/2",
           "@type": "Foo",
           "id": 2,
-          "name": "Sthenelus"
+          "name": "Sthenelus",
+          "bar": "Dolor"
         },
         {
-          "@id": "/foos/4",
+          "@id": "/foos/3",
           "@type": "Foo",
-          "id": 4,
-          "name": "Separativeness"
+          "id": 3,
+          "name": "Ephesian",
+          "bar": "Dolor"
         },
         {
           "@id": "/foos/1",
           "@type": "Foo",
           "id": 1,
-          "name": "Hawsepipe"
+          "name": "Hawsepipe",
+          "bar": "Lorem"
         },
         {
-          "@id": "/foos/3",
-          "@type": "Foo",
-          "id": 3,
-          "name": "Ephesian"
-        },
-        {
-          "@id": "/foos/5",
+          "@id": "/foos/4",
           "@type": "Foo",
-          "id": 5,
-          "name": "Balbo"
+          "id": 4,
+          "name": "Separativeness",
+          "bar": "Sit"
         }
       ],
       "hydra:totalItems": 5,

src/Bridge/Doctrine/Orm/Extension/OrderExtension.php

@@ -45,7 +45,13 @@ public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGenerator
         if (null !== $this->resourceMetadataFactory) {
             $defaultOrder = $this->resourceMetadataFactory->create($resourceClass)->getAttribute('order');
             if (null !== $defaultOrder) {
-                $queryBuilder->addOrderBy('o.'.$defaultOrder[0], $defaultOrder[1] ?? 'ASC');
+                foreach ($defaultOrder as $field => $order) {
+                    if (is_int($field)) {
+                        $field = $order;
+                        $order = 'ASC';
+                    }
+                    $queryBuilder->addOrderBy('o.'.$field, $order);
+                }
 
                 return;
             }

tests/Bridge/Doctrine/Orm/Extension/OrderExtensionTest.php

@@ -75,7 +75,7 @@ public function testApplyToCollectionWithOrderOverriden()
         $classMetadataProphecy = $this->prophesize(ClassMetadata::class);
         $classMetadataProphecy->getIdentifier()->shouldBeCalled()->willReturn(['name']);
 
-        $resourceMetadataFactoryProphecy->create(Dummy::class)->shouldBeCalled()->willReturn(new ResourceMetadata(null, null, null, null, null, ['order' => ['foo', 'DESC']]));
+        $resourceMetadataFactoryProphecy->create(Dummy::class)->shouldBeCalled()->willReturn(new ResourceMetadata(null, null, null, null, null, ['order' => ['foo' => 'DESC']]));
 
         $emProphecy = $this->prophesize(EntityManager::class);
         $emProphecy->getClassMetadata(Dummy::class)->shouldBeCalled()->willReturn($classMetadataProphecy->reveal());
@@ -93,11 +93,12 @@ public function testApplyToCollectionWithOrderOverridenWithNoDirection()
         $queryBuilderProphecy = $this->prophesize(QueryBuilder::class);
 
         $queryBuilderProphecy->addOrderBy('o.foo', 'ASC')->shouldBeCalled();
+        $queryBuilderProphecy->addOrderBy('o.bar', 'DESC')->shouldBeCalled();
 
         $classMetadataProphecy = $this->prophesize(ClassMetadata::class);
         $classMetadataProphecy->getIdentifier()->shouldBeCalled()->willReturn(['name']);
 
-        $resourceMetadataFactoryProphecy->create(Dummy::class)->shouldBeCalled()->willReturn(new ResourceMetadata(null, null, null, null, null, ['order' => ['foo']]));
+        $resourceMetadataFactoryProphecy->create(Dummy::class)->shouldBeCalled()->willReturn(new ResourceMetadata(null, null, null, null, null, ['order' => ['foo', 'bar' => 'DESC']]));
 
         $emProphecy = $this->prophesize(EntityManager::class);
         $emProphecy->getClassMetadata(Dummy::class)->shouldBeCalled()->willReturn($classMetadataProphecy->reveal());

tests/Fixtures/TestBundle/Entity/Foo.php

@@ -13,7 +13,6 @@
 
 namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity;
 
-use ApiPlatform\Core\Annotation\ApiProperty;
 use ApiPlatform\Core\Annotation\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Validator\Constraints as Assert;
@@ -24,7 +23,7 @@
  * @author Vincent Chalamon <[email protected]>
  *
  * @ApiResource(attributes={
- *     "order"={"name", "DESC"}
+ *     "order"={"bar", "name": "DESC"}
  * })
  * @ORM\Entity
  */
@@ -40,14 +39,21 @@ class Foo
     private $id;
 
     /**
-     * @var string The dummy name
+     * @var string The foo name
      *
      * @ORM\Column
      * @Assert\NotBlank
-     * @ApiProperty(iri="http://schema.org/name")
      */
     private $name;
 
+    /**
+     * @var string The foo bar
+     *
+     * @ORM\Column
+     * @Assert\NotBlank
+     */
+    private $bar;
+
     public function getId()
     {
         return $this->id;
@@ -62,4 +68,14 @@ public function getName()
     {
         return $this->name;
     }
+
+    public function getBar()
+    {
+        return $this->bar;
+    }
+
+    public function setBar($bar)
+    {
+        $this->bar = $bar;
+    }
 }