improve properties and collections

johguentner · johguentner · commit ac2a8474f6da · 2021-05-22T00:00:06.000+02:00
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.
diff --git a/src/Endpoints/Database.php b/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)
diff --git a/src/Entities/Database.php b/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
diff --git a/src/Entities/Entity.php b/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);
     }
diff --git a/src/Entities/Page.php b/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
diff --git a/src/Entities/Properties/Number.php b/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;
+    }
+}
diff --git a/src/Entities/Properties/Property.php b/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);
         }
 
 
diff --git a/src/Entities/Properties/Text.php b/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;
     }
-
 }
diff --git a/src/Entities/Properties/Title.php b/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;
+    }
+}
diff --git a/src/Entities/PropertyItems/RichText.php b/src/Entities/PropertyItems/RichText.php
@@ -11,7 +11,7 @@
 
 class RichText extends Entity
 {
-    private string $plainText = "";
+    protected string $plainText = "";
 
     public function __construct(array $responseData)
     {
diff --git a/src/Entities/PropertyItems/SelectItem.php b/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)
     {

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public function __construct(string $databaseId, Notion $notion)`
`29`	`29`	`parent::__construct($notion);`
`30`	`30`	`}`
`31`	`31`
`32`		`- public function query(): Collection`
	`32`	`+ public function query(): PageCollection`
`33`	`33`	`{`
`34`	`34`	`$postData = [];`
`35`	`35`
`@@ -54,8 +54,7 @@ public function query(): Collection`
`54`	`54`
`55`	`55`	`->json();`
`56`	`56`
`57`		`- $pageCollection = new PageCollection($response);`
`58`		`- return $pageCollection->getResults();`
	`57`	`+ return new PageCollection($response);`
`59`	`58`	`}`
`60`	`59`
`61`	`60`	`public function filterBy(Collection $filter)`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ class Database extends Entity`
`14`	`14`	`protected string $objectType = "";`
`15`	`15`	`protected array $rawTitle = [];`
`16`	`16`	`protected array $rawProperties = [];`
	`17`	`+ protected array $propertyNames = [];`
`17`	`18`	`protected DateTime $createdTime;`
`18`	`19`	`protected DateTime $lastEditedTime;`
`19`	`20`
`@@ -56,6 +57,7 @@ private function fillProperties(): void`
`56`	`57`	`{`
`57`	`58`	`if (Arr::exists($this->responseData, 'properties')) {`
`58`	`59`	`$this->rawProperties = $this->responseData['properties'];`
	`60`	`+ $this->propertyNames = array_keys($this->rawProperties);`
`59`	`61`	`}`
`60`	`62`	`}`
`61`	`63`
`@@ -88,7 +90,7 @@ public function getRawProperties(): array`
`88`	`90`
`89`	`91`	`public function getPropertyNames(): array`
`90`	`92`	`{`
`91`		`- return array_keys($this->rawProperties);`
	`93`	`+ return $this->propertyNames;`
`92`	`94`	`}`
`93`	`95`
`94`	`96`	`public function getCreatedTime(): DateTime`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,8 @@ class Page extends Entity`
`14`	`14`	`protected string $title = "";`
`15`	`15`	`protected string $objectType = "";`
`16`	`16`	`protected array $rawProperties = [];`
`17`		`- protected Collection $propertyCollection;`
	`17`	`+ protected array $propertyMap = [];`
	`18`	`+ protected Collection $properties;`
`18`	`19`	`protected DateTime $createdTime;`
`19`	`20`	`protected DateTime $lastEditedTime;`
`20`	`21`
`@@ -47,17 +48,18 @@ private function fillProperties(): void`
`47`	`48`	`{`
`48`	`49`	`if (Arr::exists($this->responseData, 'properties')) {`
`49`	`50`	`$this->rawProperties = $this->responseData['properties'];`
`50`		`- $this->propertyCollection = new Collection();`
	`51`	`+ $this->properties = new Collection();`
`51`	`52`	`foreach (array_keys($this->rawProperties) as $propertyKey) {`
`52`		`- $this->propertyCollection->add(Property::fromResponse($propertyKey, $this->rawProperties[$propertyKey]));`
	`53`	`+ $property = Property::fromResponse($propertyKey, $this->rawProperties[$propertyKey]);`
	`54`	`+ $this->properties->add($property);`
	`55`	`+ $this->propertyMap[$propertyKey] = $property;`
`53`	`56`	`}`
`54`	`57`	`}`
`55`	`58`	`}`
`56`	`59`
`57`		`-`
`58`	`60`	`private function fillTitle(): void`
`59`	`61`	`{`
`60`		`- $titleProperty = $this->propertyCollection->filter(function ($property) {`
	`62`	`+ $titleProperty = $this->properties->filter(function ($property) {`
`61`	`63`	`return $property->getType() == "title";`
`62`	`64`	`})->first();`
`63`	`65`
`@@ -76,19 +78,15 @@ public function getTitle(): string`
`76`	`78`	`return $this->title;`
`77`	`79`	`}`
`78`	`80`
`79`		`-`
`80`	`81`	`public function getProperties(): Collection`
`81`	`82`	`{`
`82`		`- return $this->propertyCollection;`
	`83`	`+ return $this->properties;`
`83`	`84`	`}`
`84`	`85`
`85`	`86`	`public function getProperty(string $propertyName): ?Property`
`86`	`87`	`{`
`87`		`- $property = $this->propertyCollection->filter(function ($property) use ($propertyName) {`
`88`		`- return $property->getTitle() == $propertyName;`
`89`		`- })->first();`
`90`		`-`
`91`		`- return $property;`
	`88`	`+ //TODO:Handle undefined propertyNames (exception/null/?)`
	`89`	`+ return $this->propertyMap[$propertyName];`
`92`	`90`	`}`
`93`	`91`
`94`	`92`	`public function getObjectType(): string`
Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,7 @@ private function fillContent(): void`
`47`	`47`	`{`
`48`	`48`	`if (Arr::exists($this->responseData, $this->getType())) {`
`49`	`49`	`$this->rawContent = $this->responseData[$this->getType()];`
	`50`	`+ $this->content = $this->rawContent;`
`50`	`51`	`}`
`51`	`52`	`}`
`52`	`53`
`@@ -78,8 +79,12 @@ public static function fromResponse($propertyKey, $rawContent): Property`
`78`	`79`	`return new Select($propertyKey, $rawContent);`
`79`	`80`	`} else if ($rawContent['type'] == 'text') {`
`80`	`81`	`return new Text($propertyKey, $rawContent);`
`81`		`- } else if($rawContent['type'] == 'created_by'){`
	`82`	`+ } else if ($rawContent['type'] == 'created_by') {`
`82`	`83`	`return new CreatedBy($propertyKey, $rawContent);`
	`84`	`+ } else if ($rawContent['type'] == 'title') {`
	`85`	`+ return new Title($propertyKey, $rawContent);`
	`86`	`+ } else if ($rawContent['type'] == 'number') {`
	`87`	`+ return new Number($propertyKey, $rawContent);`
`83`	`88`	`}`
`84`	`89`
`85`	`90`
Original file line number	Diff line number	Diff line change
`@@ -13,13 +13,21 @@`
`13`	`13`
`14`	`14`	`class Text extends Property`
`15`	`15`	`{`
	`16`	`+ protected string $plainText = "";`
	`17`	`+`
`16`	`18`	`protected function fillFromRaw(): void`
`17`	`19`	`{`
`18`	`20`	`parent::fillFromRaw();`
`19`	`21`	`if (!is_array($this->rawContent))`
`20`	`22`	`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.");`
`21`	`23`
	`24`	`+ $this->fillText();`
	`25`	`+ }`
	`26`	`+`
	`27`	`+ protected function fillText(): void`
	`28`	`+ {`
`22`	`29`	`$this->content = new RichText($this->rawContent);`
	`30`	`+ $this->plainText = $this->content->getPlaintext();`
`23`	`31`	`}`
`24`	`32`
`25`	`33`	`public function getContent(): RichText`
`@@ -34,7 +42,6 @@ public function getRichText(): RichText`
`34`	`42`
`35`	`43`	`public function getPlainText()`
`36`	`44`	`{`
`37`		`- return $this->content->getPlaintext();`
	`45`	`+ return $this->plainText;`
`38`	`46`	`}`
`39`		`-`
`40`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`
`12`	`12`	`class RichText extends Entity`
`13`	`13`	`{`
`14`		`- private string $plainText = "";`
	`14`	`+ protected string $plainText = "";`
`15`	`15`
`16`	`16`	`public function __construct(array $responseData)`
`17`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@`
`11`	`11`
`12`	`12`	`class SelectItem extends Entity`
`13`	`13`	`{`
`14`		`- private string $color;`
`15`		`- private string $name;`
	`14`	`+ protected string $color;`
	`15`	`+ protected string $name;`
`16`	`16`
`17`	`17`	`public function __construct(array $responseData)`
`18`	`18`	`{`