improve properties and collections

Addition of JsonSerializable in Entity, and toArray/toJson in according classes to improve serialized structure (when working with inertiajs, own api, or general better handling outside of php.
Add more property-classes (Number and Title).
Some small property-refactoring.

Author: johguentner

src/Endpoints/Database.php

@@ -29,7 +29,7 @@ public function __construct(string $databaseId, Notion $notion)
         parent::__construct($notion);
     }
 
-    public function query(): Collection
+    public function query(): PageCollection
     {
         $postData = [];
 
@@ -54,8 +54,7 @@ public function query(): Collection
 
             ->json();
 
-        $pageCollection = new PageCollection($response);
-        return $pageCollection->getResults();
+        return new PageCollection($response);
     }
 
     public function filterBy(Collection $filter)

src/Entities/Database.php

@@ -14,6 +14,7 @@ class Database extends Entity
     protected string $objectType = "";
     protected array $rawTitle = [];
     protected array $rawProperties = [];
+    protected array $propertyNames = [];
     protected DateTime $createdTime;
     protected DateTime $lastEditedTime;
 
@@ -56,6 +57,7 @@ private function fillProperties(): void
     {
         if (Arr::exists($this->responseData, 'properties')) {
             $this->rawProperties = $this->responseData['properties'];
+            $this->propertyNames = array_keys($this->rawProperties);
         }
     }
 
@@ -88,7 +90,7 @@ public function getRawProperties(): array
 
     public function getPropertyNames(): array
     {
-        return array_keys($this->rawProperties);
+        return $this->propertyNames;
     }
 
     public function getCreatedTime(): DateTime

src/Entities/Entity.php

@@ -7,8 +7,9 @@
 use FiveamCode\LaravelNotionApi\Notion;
 use Illuminate\Support\Arr;
 use Carbon\Carbon;
+use JsonSerializable;
 
-class Entity
+class Entity implements JsonSerializable
 {
     private string $id;
     protected array $responseData = [];
@@ -69,6 +70,11 @@ public function getRaw(): array
         return $this->responseData;
     }
 
+    public function jsonSerialize()
+    {
+        return $this->toArray();
+    }
+
     public function toArray(): array {
         return get_object_vars($this);
     }

src/Entities/Page.php

@@ -14,7 +14,8 @@ class Page extends Entity
     protected string $title = "";
     protected string $objectType = "";
     protected array $rawProperties = [];
-    protected Collection $propertyCollection;
+    protected array $propertyMap = [];
+    protected Collection $properties;
     protected DateTime $createdTime;
     protected DateTime $lastEditedTime;
 
@@ -47,17 +48,18 @@ private function fillProperties(): void
     {
         if (Arr::exists($this->responseData, 'properties')) {
             $this->rawProperties = $this->responseData['properties'];
-            $this->propertyCollection = new Collection();
+            $this->properties = new Collection();
             foreach (array_keys($this->rawProperties) as $propertyKey) {
-                $this->propertyCollection->add(Property::fromResponse($propertyKey, $this->rawProperties[$propertyKey]));
+                $property = Property::fromResponse($propertyKey, $this->rawProperties[$propertyKey]);
+                $this->properties->add($property);
+                $this->propertyMap[$propertyKey] = $property;
             }
         }
     }
 
-
     private function fillTitle(): void
     {
-        $titleProperty = $this->propertyCollection->filter(function ($property) {
+        $titleProperty = $this->properties->filter(function ($property) {
             return $property->getType() == "title";
         })->first();
 
@@ -76,19 +78,15 @@ public function getTitle(): string
         return $this->title;
     }
 
-
     public function getProperties(): Collection
     {
-        return $this->propertyCollection;
+        return $this->properties;
     }
 
     public function getProperty(string $propertyName): ?Property
     {
-        $property = $this->propertyCollection->filter(function ($property) use ($propertyName) {
-            return $property->getTitle() == $propertyName;
-        })->first();
-
-        return $property;
+        //TODO:Handle undefined propertyNames (exception/null/?)
+        return $this->propertyMap[$propertyName];
     }
 
     public function getObjectType(): string

src/Entities/Properties/Number.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities\Properties;
+
+use DateTime;
+use FiveamCode\LaravelNotionApi\Entities\Entity;
+use FiveamCode\LaravelNotionApi\Entities\PropertyItems\RichText;
+use FiveamCode\LaravelNotionApi\Entities\PropertyItems\SelectItem;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+use FiveamCode\LaravelNotionApi\Notion;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Collection;
+
+class Number extends Property
+{
+    protected float $number = 0;
+
+    protected function fillFromRaw(): void
+    {
+        parent::fillFromRaw();
+        // if (!is_array($this->rawContent))
+        //     throw HandlingException::instance("The property-type is number, however the raw data-structure does not represent this type (= array of items). Please check the raw response-data.");
+
+        $this->fillNumber();
+    }
+
+    protected function fillNumber(): void
+    {
+        $this->content = $this->rawContent;
+    }
+
+    public function getContent(): float
+    {
+        return $this->content;
+    }
+
+    public function getNumber(): float
+    {
+        return $this->content;
+    }
+}

src/Entities/Properties/Property.php

@@ -47,6 +47,7 @@ private function fillContent(): void
     {
         if (Arr::exists($this->responseData, $this->getType())) {
             $this->rawContent = $this->responseData[$this->getType()];
+            $this->content = $this->rawContent;
         }
     }
 
@@ -78,8 +79,12 @@ public static function fromResponse($propertyKey, $rawContent): Property
             return new Select($propertyKey, $rawContent);
         } else if ($rawContent['type'] == 'text') {
             return new Text($propertyKey, $rawContent);
-        } else if($rawContent['type'] == 'created_by'){
+        } else if ($rawContent['type'] == 'created_by') {
             return new CreatedBy($propertyKey, $rawContent);
+        } else if ($rawContent['type'] == 'title') {
+            return new Title($propertyKey, $rawContent);
+        } else if ($rawContent['type'] == 'number') {
+            return new Number($propertyKey, $rawContent);
         }
 
 

src/Entities/Properties/Text.php

@@ -13,13 +13,21 @@
 
 class Text extends Property
 {
+    protected string $plainText = "";
+
     protected function fillFromRaw(): void
     {
         parent::fillFromRaw();
         if (!is_array($this->rawContent))
             throw HandlingException::instance("The property-type is text, however the raw data-structure does not represent this type (= array of items). Please check the raw response-data.");
 
+        $this->fillText();
+    }
+
+    protected function fillText(): void
+    {
         $this->content = new RichText($this->rawContent);
+        $this->plainText = $this->content->getPlaintext();
     }
 
     public function getContent(): RichText
@@ -34,7 +42,6 @@ public function getRichText(): RichText
 
     public function getPlainText()
     {
-        return $this->content->getPlaintext();
+        return $this->plainText;
     }
-
 }

src/Entities/Properties/Title.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities\Properties;
+
+use DateTime;
+use FiveamCode\LaravelNotionApi\Entities\Entity;
+use FiveamCode\LaravelNotionApi\Entities\PropertyItems\RichText;
+use FiveamCode\LaravelNotionApi\Entities\PropertyItems\SelectItem;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+use FiveamCode\LaravelNotionApi\Notion;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Collection;
+
+class Title extends Property
+{
+    protected string $plainText = "";
+
+    protected function fillFromRaw(): void
+    {
+        parent::fillFromRaw();
+        if (!is_array($this->rawContent))
+            throw HandlingException::instance("The property-type is title, however the raw data-structure does not represent this type (= array of items). Please check the raw response-data.");
+
+        $this->fillText();
+    }
+
+    private function fillText(): void
+    {
+        $this->content = new RichText($this->rawContent);
+        $this->plainText = $this->content->getPlaintext();
+    }
+
+    public function getContent(): RichText
+    {
+        return $this->getRichText();
+    }
+
+    public function getRichText(): RichText
+    {
+        return $this->content;
+    }
+
+    public function getPlainText()
+    {
+        return $this->plainText;
+    }
+}

src/Entities/PropertyItems/RichText.php

@@ -11,7 +11,7 @@
 
 class RichText extends Entity
 {
-    private string $plainText = "";
+    protected string $plainText = "";
 
     public function __construct(array $responseData)
     {

src/Entities/PropertyItems/SelectItem.php

@@ -11,8 +11,8 @@
 
 class SelectItem extends Entity
 {
-    private string $color;
-    private string $name;
+    protected string $color;
+    protected string $name;
 
     public function __construct(array $responseData)
     {