added basic filter structure

mechelon · mechelon · commit 4de936a666c9 · 2021-05-14T23:04:27.000+02:00
diff --git a/src/Endpoints/Database.php b/src/Endpoints/Database.php
@@ -30,50 +30,38 @@ public function __construct(string $databaseId, Notion $notion)
 
     public function query(): array
     {
-
-        $filterJson = '
-                {
-                  "property": "Tags",
-                  "multi_select": {
-                    "contains": "great"
-                  }
-                }';
-
-
-        $filter = json_decode($filterJson);
-
         if ($this->sorts->isNotEmpty())
             $postData["sorts"] = Sorting::sortQuery($this->sorts);
 
         if ($this->filter->isNotEmpty())
-            $postData["filter"] = []; //Filter::filterQuery($this->filter);
+            $postData["filter"]["or"] = Filter::filterQuery($this->filter); // TODO Compound filters!
 
         if ($this->startCursor !== null)
             $postData["start_cursor"] = $this->startCursor;
 
         if ($this->pageSize !== null)
             $postData["page_size"] = $this->pageSize;
 
-        $response = $this->post(
-            $this->url(Endpoint::DATABASES . "/{$this->databaseId}/query"),
-            $postData
-        )
+        $response = $this
+            ->post(
+                $this->url(Endpoint::DATABASES . "/{$this->databaseId}/query"),
+                $postData
+            )
             ->json();
 
         // toDo return Database Entity
         dd($response);
     }
 
-    public function filterBy()
+    public function filterBy(Collection $filter)
     {
-
+        $this->filter = $filter;
         return $this;
     }
 
-    public function sortBy(Collection $sortings)
+    public function sortBy(Collection $sorts)
     {
-        $this->sorts = $sortings;
-
+        $this->sorts = $sorts;
         return $this;
     }
 }
diff --git a/src/Query/CompoundFilter.php b/src/Query/CompoundFilter.php
@@ -2,7 +2,15 @@
 
 namespace FiveamCode\LaravelNotionApi\Query;
 
+use FiveamCode\LaravelNotionApi\Exceptions\WrapperException;
+
 class CompoundFilter extends QueryHelper
 {
+    // toDo
 
+    public function __construct()
+    {
+        parent::__construct();
+        throw new WrapperException("not implemented yet.");
+    }
 }
diff --git a/src/Query/Filter.php b/src/Query/Filter.php
@@ -2,21 +2,96 @@
 
 namespace FiveamCode\LaravelNotionApi\Query;
 
+use FiveamCode\LaravelNotionApi\Exceptions\WrapperException;
+use Illuminate\Support\Collection;
+
 class Filter extends QueryHelper
 {
+    private ?string $filterType = null;
+    private ?array $filterConditions = null;
+    private ?array $filterDefinition = null;
+
 
-    public function __construct(string $property )
+    public function __construct(
+        string $property,
+        string $filterType = null,
+        array $filterConditions = null,
+        array $filterDefinition = null
+    )
     {
         parent::__construct();
 
         $this->property = $property;
+        $this->filterType = $filterType;
+        $this->filterConditions = $filterConditions;
+        $this->filterDefinition = $filterDefinition;
+    }
 
+    /**
+     * Returns a text filter instance.
+     *
+     * @see https://developers.notion.com/reference/post-database-query#text-filter-condition
+     *
+     * @param string $property
+     * @param array $filterConditions
+     * @return Filter
+     */
+    public static function textFilter(string $property, array $filterConditions): Filter
+    {
+        return new Filter($property, "text", $filterConditions);
+    }
 
+    /**
+     * This method allows you to define every filter that is offered
+     * by Notion but not implemented in this package yet. Provide the
+     * filter definition as an array like explained in the Notion docs.
+     * Use with caution; this method will be removed in the future and
+     * is marked as deprecated from the start!
+     *
+     * @see https://developers.notion.com/reference/post-database-query#post-database-query-filter
+     *
+     * @param string $property
+     * @param array $filterDefinition
+     *
+     * @deprecated
+     */
+    public static function rawFilter(string $property, array $filterDefinition): Filter
+    {
+        return new Filter($property, null, null, $filterDefinition);
     }
 
-//    public static function textFilter(string $property, ) {
-//
-//    }
+    public function toArray(): array
+    {
+        if ($this->filterDefinition !== null && $this->filterType === null && $this->filterConditions === null) {
+            return array_merge(
+                ["property" => $this->property],
+                $this->filterDefinition
+            );
+        }
+        elseif ($this->filterType !== null && $this->filterConditions !== null && $this->filterDefinition === null) {
+            return [
+                "property" => $this->property,
+                $this->filterType => $this->filterConditions
+            ];
+        }
+        else
+            throw WrapperException::instance("Invalid filter definition.", ["invalidFilter" => $this]);
+
+    }
+
+
+    public static function filterQuery(Collection $filter): array
+    {
+
+        $queryFilter = new Collection();
+
+        $filter->each(function (Filter $filter) use ($queryFilter) {
+            $queryFilter->add($filter->toArray());
+        });
+
+        return $queryFilter->toArray();
+
+    }
 
 
 }

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,15 @@`
`2`	`2`
`3`	`3`	`namespace FiveamCode\LaravelNotionApi\Query;`
`4`	`4`
	`5`	`+use FiveamCode\LaravelNotionApi\Exceptions\WrapperException;`
	`6`	`+`
`5`	`7`	`class CompoundFilter extends QueryHelper`
`6`	`8`	`{`
	`9`	`+ // toDo`
`7`	`10`
	`11`	`+ public function __construct()`
	`12`	`+ {`
	`13`	`+ parent::__construct();`
	`14`	`+ throw new WrapperException("not implemented yet.");`
	`15`	`+ }`
`8`	`16`	`}`