Merge pull request #15 from roxblnfk/feature/order-by-in-relations

Add supporting of orderBy option in relations

Author: wolfy-j

composer.json

@@ -6,7 +6,7 @@
   "require": {
     "php": ">=7.2",
     "spiral/tokenizer": "^2.7",
-    "cycle/schema-builder": "^1.0",
+    "cycle/schema-builder": "^1.2",
     "doctrine/annotations": "^1.7"
   },
   "require-dev": {

src/Annotation/Relation/HasMany.php

@@ -25,6 +25,7 @@
  *      @Attribute("innerKey", type="string"),
  *      @Attribute("outerKey", type="string"),
  *      @Attribute("where", type="array"),
+ *      @Attribute("orderBy", type="array"),
  *      @Attribute("fkCreate", type="bool"),
  *      @Attribute("fkAction", type="string"),
  *      @Attribute("indexCreate", type="bool"),
@@ -53,6 +54,9 @@ final class HasMany extends Relation
     /** @var array */
     protected $where;
 
+    /** @var array */
+    protected $orderBy;
+
     /** @var bool */
     protected $fkCreate;
 

src/Annotation/Relation/ManyToMany.php

@@ -27,6 +27,7 @@
  *      @Attribute("outerKey", type="string"),
  *      @Attribute("innerKey", type="string"),
  *      @Attribute("where", type="array"),
+ *      @Attribute("orderBy", type="array"),
  *      @Attribute("though", type="string", required=true),
  *      @Attribute("thoughInnerKey", type="string"),
  *      @Attribute("thoughOuterKey", type="string"),
@@ -58,6 +59,9 @@ final class ManyToMany extends Relation
     /** @var array */
     protected $where;
 
+    /** @var array */
+    protected $orderBy;
+
     /** @var string */
     protected $though;
 

tests/Annotated/Fixtures/Simple.php

@@ -37,7 +37,7 @@ class Simple implements LabelledInterface
     protected $one;
 
     /**
-     * @HasMany(target="WithTable", where={"id": {">": 1}})
+     * @HasMany(target="WithTable", where={"id": {">=": 1}}, orderBy={"id": "DESC"})
      * @var WithTable[]|Collection
      */
     protected $many;

tests/Annotated/Fixtures/WithTable.php

@@ -36,7 +36,7 @@ class WithTable implements LabelledInterface
     /** @Column(type="primary") */
     protected $id;
 
-    /** @ManyToMany(target="Tag", though="Tag/Context") */
+    /** @ManyToMany(target="Tag", though="Tag/Context", where={"id": {">=": "1"}}, orderBy={"id": "DESC"}) */
     protected $tags;
 
     /** @MorphedHasMany(target="Label", outerKey="owner_id", morphKey="owner_role", indexCreate=false) */

tests/Annotated/Relation/HasManyTest.php

@@ -32,24 +32,31 @@ public function testRelation(): void
     {
         $r = new Registry($this->dbal);
 
-        $schema = (new Compiler())->compile($r, [
-            new Entities($this->locator),
-            new ResetTables(),
-            new MergeColumns(),
-            new GenerateRelations(),
-            new RenderTables(),
-            new RenderRelations(),
-            new MergeIndexes(),
-            new SyncTables(),
-            new GenerateTypecast(),
-        ]);
+        $schema = (new Compiler())->compile(
+            $r,
+            [
+                new Entities($this->locator),
+                new ResetTables(),
+                new MergeColumns(),
+                new GenerateRelations(),
+                new RenderTables(),
+                new RenderRelations(),
+                new MergeIndexes(),
+                new SyncTables(),
+                new GenerateTypecast(),
+            ]
+        );
 
         $this->assertArrayHasKey('many', $schema['simple'][Schema::RELATIONS]);
         $this->assertSame(Relation::HAS_MANY, $schema['simple'][Schema::RELATIONS]['many'][Relation::TYPE]);
         $this->assertSame('withTable', $schema['simple'][Schema::RELATIONS]['many'][Relation::TARGET]);
-
-        $this->assertSame([
-            'id' => ['>' => 1]
-        ], $schema['simple'][Schema::RELATIONS]['many'][Relation::SCHEMA][Relation::WHERE]);
+        $this->assertSame(
+            ["id" => [">=" => 1]],
+            $schema['simple'][Schema::RELATIONS]['many'][Relation::SCHEMA][Relation::WHERE]
+        );
+        $this->assertSame(
+            ["id" => "DESC"],
+            $schema['simple'][Schema::RELATIONS]['many'][Relation::SCHEMA][Relation::ORDER_BY]
+        );
     }
 }

tests/Annotated/Relation/ManyToManyTest.php

@@ -57,10 +57,18 @@ public function testRelation(): void
             $schema['withTable'][Schema::RELATIONS]['tags'][Relation::TARGET]
         );
 
-
         $this->assertSame(
             'tagContext',
-            $schema['withTable'][Schema::RELATIONS]['tags'][Relation::SCHEMA][Relation::THOUGH_ENTITY]
+            $schema['withTable'][Schema::RELATIONS]['tags'][Relation::SCHEMA][Relation::THROUGH_ENTITY]
+        );
+
+        $this->assertSame(
+            ["id" => [">=" => "1"]],
+            $schema['withTable'][Schema::RELATIONS]['tags'][Relation::SCHEMA][Relation::WHERE]
+        );
+        $this->assertSame(
+            ["id" => "DESC"],
+            $schema['withTable'][Schema::RELATIONS]['tags'][Relation::SCHEMA][Relation::ORDER_BY]
         );
     }
 }