added basic sorting structure

mechelon · mechelon · commit 3ab0d9698436 · 2021-05-14T21:30:04.000+02:00
diff --git a/src/Endpoints/Database.php b/src/Endpoints/Database.php
@@ -4,18 +4,22 @@
 
 
 use FiveamCode\LaravelNotionApi\Notion;
+use \FiveamCode\LaravelNotionApi\Entities\Database as DatabaseEntity;
+use FiveamCode\LaravelNotionApi\Query\Sorting;
+use Illuminate\Support\Collection;
 
 class Database extends Endpoint
 {
     private string $databaseId;
+    private Collection $sortings;
 
     public function __construct(string $databaseId, Notion $notion)
     {
         $this->databaseId = $databaseId;
         parent::__construct($notion);
     }
 
-    public function query(string $databaseId): array
+    public function query(): array
     {
 
         $filterJson = '
@@ -26,32 +30,51 @@ public function query(string $databaseId): array
                   }
                 }';
 
+
+        $sortingJson = '{
+        "property": "Ordered",
+	      "timestamp": "created_time",
+	      "direction": "descending"
+	    }';
+
+
         $filter = json_decode($filterJson);
-        $postData = ["filter" => $filter];
+
+        if($this->sortings->isNotEmpty())
+            $postData["sorts"] = Sorting::sortQuery($this->sortings);
 
         $response = $this->post(
-            $this->url(Endpoint::DATABASES . "/{$databaseId}/query"),
+            $this->url(Endpoint::DATABASES . "/{$this->databaseId}/query"),
             $postData
         )
             ->json();
 
-        dump($response);
-        return [];
+        // toDo return Database Entity
+        dd($response);
     }
 
     public function filterBy()
     {
+
+        return $this;
     }
 
-    public function sortBy()
+    public function sortBy(Collection $sortings)
     {
+        $this->sortings = $sortings;
+
+        return $this;
     }
 
     public function limit()
     {
+
+        return $this;
     }
 
     public function offset()
     {
+
+        return $this;
     }
 }
diff --git a/src/Query/QueryHelper.php b/src/Query/QueryHelper.php
@@ -5,13 +5,13 @@
 use Illuminate\Http\Resources\Json\JsonResource;
 use Illuminate\Support\Collection;
 
-class QueryHelper extends JsonResource
+class QueryHelper
 {
     /**
      * Contains the property name the query helper works with.
      * @var
      */
-    protected string $property;
+    protected ?string $property = null;
 
     /**
      * Contains all valid timestamps to sort against.
@@ -20,6 +20,7 @@ class QueryHelper extends JsonResource
      * @var Collection
      */
     protected Collection $validTimestamps;
+
     /**
      * Contains all valid directions to sort by.
      *
diff --git a/src/Query/Sorting.php b/src/Query/Sorting.php
@@ -3,32 +3,76 @@
 namespace FiveamCode\LaravelNotionApi\Query;
 
 use FiveamCode\LaravelNotionApi\Exceptions\WrapperException;
+use Illuminate\Support\Collection;
 
 class Sorting extends QueryHelper
 {
 
-    private string $timestamp;
+    private ?string $timestamp = null;
     private string $direction;
 
-    public function __construct(string $timestamp, string $direction)
+    public function __construct(string $direction, string $property = null, string $timestamp = null)
     {
         parent::__construct();
 
-        if ($this->validTimestamps->contains($timestamp))
+        if ($timestamp !== null && !$this->validTimestamps->contains($timestamp))
             throw WrapperException::instance(
                 "Invalid sorting timestamp provided.", ["invalidTimestamp" => $timestamp]
             );
 
-        if ($this->validDirections->contains($direction))
+
+        if (!$this->validDirections->contains($direction))
             throw WrapperException::instance(
                 "Invalid sorting direction provided.", ["invalidDirection" => $direction]
             );
 
+        $this->property = $property;
         $this->timestamp = $timestamp;
         $this->direction = $direction;
     }
 
+    public static function timestampSort(string $timestampToSort, string $direction)
+    {
+
+        $propertySort = new Sorting($direction, null, $timestampToSort);
+
+        return $propertySort;
+    }
+
+    public static function propertySort(string $property, string $direction)
+    {
+        $propertySort = new Sorting($direction, $property);
 
+        return $propertySort;
+    }
+
+    public function toArray(): array
+    {
+        if ($this->timestamp !== null) {
+            return [
+                "timestamp" => $this->timestamp,
+                "direction" => $this->direction
+            ];
+        }
+
+        return [
+            "property" => $this->property,
+            "direction" => $this->direction
+        ];
+    }
+
+    public static function sortQuery(Collection $sortings): array
+    {
+
+        $querySortings = new Collection();
+
+        $sortings->each(function (Sorting $sorting) use ($querySortings) {
+            $querySortings->add($sorting->toArray());
+        });
+
+        return $querySortings->toArray();
+
+    }
 
 
 }

Original file line number	Diff line number	Diff line change
`@@ -4,18 +4,22 @@`
`4`	`4`
`5`	`5`
`6`	`6`	`use FiveamCode\LaravelNotionApi\Notion;`
	`7`	`+use \FiveamCode\LaravelNotionApi\Entities\Database as DatabaseEntity;`
	`8`	`+use FiveamCode\LaravelNotionApi\Query\Sorting;`
	`9`	`+use Illuminate\Support\Collection;`
`7`	`10`
`8`	`11`	`class Database extends Endpoint`
`9`	`12`	`{`
`10`	`13`	`private string $databaseId;`
	`14`	`+ private Collection $sortings;`
`11`	`15`
`12`	`16`	`public function __construct(string $databaseId, Notion $notion)`
`13`	`17`	`{`
`14`	`18`	`$this->databaseId = $databaseId;`
`15`	`19`	`parent::__construct($notion);`
`16`	`20`	`}`
`17`	`21`
`18`		`- public function query(string $databaseId): array`
	`22`	`+ public function query(): array`
`19`	`23`	`{`
`20`	`24`
`21`	`25`	`$filterJson = '`
`@@ -26,32 +30,51 @@ public function query(string $databaseId): array`
`26`	`30`	`}`
`27`	`31`	`}';`
`28`	`32`
	`33`	`+`
	`34`	`+ $sortingJson = '{`
	`35`	`+ "property": "Ordered",`
	`36`	`+ "timestamp": "created_time",`
	`37`	`+ "direction": "descending"`
	`38`	`+ }';`
	`39`	`+`
	`40`	`+`
`29`	`41`	`$filter = json_decode($filterJson);`
`30`		`- $postData = ["filter" => $filter];`
	`42`	`+`
	`43`	`+ if($this->sortings->isNotEmpty())`
	`44`	`+ $postData["sorts"] = Sorting::sortQuery($this->sortings);`
`31`	`45`
`32`	`46`	`$response = $this->post(`
`33`		`- $this->url(Endpoint::DATABASES . "/{$databaseId}/query"),`
	`47`	`+ $this->url(Endpoint::DATABASES . "/{$this->databaseId}/query"),`
`34`	`48`	`$postData`
`35`	`49`	`)`
`36`	`50`	`->json();`
`37`	`51`
`38`		`- dump($response);`
`39`		`- return [];`
	`52`	`+ // toDo return Database Entity`
	`53`	`+ dd($response);`
`40`	`54`	`}`
`41`	`55`
`42`	`56`	`public function filterBy()`
`43`	`57`	`{`
	`58`	`+`
	`59`	`+ return $this;`
`44`	`60`	`}`
`45`	`61`
`46`		`- public function sortBy()`
	`62`	`+ public function sortBy(Collection $sortings)`
`47`	`63`	`{`
	`64`	`+ $this->sortings = $sortings;`
	`65`	`+`
	`66`	`+ return $this;`
`48`	`67`	`}`
`49`	`68`
`50`	`69`	`public function limit()`
`51`	`70`	`{`
	`71`	`+`
	`72`	`+ return $this;`
`52`	`73`	`}`
`53`	`74`
`54`	`75`	`public function offset()`
`55`	`76`	`{`
	`77`	`+`
	`78`	`+ return $this;`
`56`	`79`	`}`
`57`	`80`	`}`