add properties to User and add UserCollection

johguentner · johguentner · commit 6403c502cb53 · 2021-05-14T23:51:36.000+02:00
diff --git a/src/Endpoints/Users.php b/src/Endpoints/Users.php
@@ -3,9 +3,11 @@
 namespace FiveamCode\LaravelNotionApi\Endpoints;
 
 use FiveamCode\LaravelNotionApi\Entities\User;
+use FiveamCode\LaravelNotionApi\Entities\UserCollection;
 use FiveamCode\LaravelNotionApi\Exceptions\WrapperException;
 use FiveamCode\LaravelNotionApi\Notion;
 use FiveamCode\LaravelNotionApi\Query\StartCursor;
+use Illuminate\Support\Collection;
 
 class Users extends Endpoint implements EndpointInterface
 {
@@ -15,11 +17,32 @@ class Users extends Endpoint implements EndpointInterface
      * url: https://api.notion.com/{version}/users
      * notion-api-docs: https://developers.notion.com/reference/get-users
      *
+     * @return Collection
+     */
+    public function all(): Collection
+    {
+        return $this->collect()->getResults();
+    }
+    
+    
+    /**
+     * List users (raw json-data)
+     * url: https://api.notion.com/{version}/users
+     * notion-api-docs: https://developers.notion.com/reference/get-users
+     *
      * @return array
      */
-    public function all(): array
+    public function allRaw(): array
     {
-        return $this->getJson($this->url(Endpoint::USERS . "?{$this->buildPaginationQuery()}"));
+        return $this->collect()->getRawResults();
+    }
+
+    private function collect(): UserCollection{
+        $result = $this->get(
+            $this->url(Endpoint::USERS . "?{$this->buildPaginationQuery()}")
+        );
+
+        return new UserCollection($result->json());
     }
 
     /**
@@ -32,10 +55,14 @@ public function all(): array
      */
     public function find(string $userId): User
     {
-        $jsonArray = $this->getJson(
+        $response = $this->get(
             $this->url(Endpoint::USERS . "/" . $userId)
         );
-        return new User($jsonArray);
-    }
 
+        if (!$response->ok())
+            throw WrapperException::instance("User not found.", ["userId" => $userId]);
+
+
+        return new User($response->json());
+    }
 }
diff --git a/src/Entities/PageCollection.php b/src/Entities/PageCollection.php
@@ -20,8 +20,12 @@ protected function setResponseData(array $responseData): void
     protected function collectChildren()
     {
         $this->collection = new Collection();
-        foreach ($this->rawResults as $blockChild) {
-            $this->collection->add(new Page($blockChild));
+        foreach ($this->rawResults as $pageChild) {
+            $this->collection->add(new Page($pageChild));
         }
     }
+
+
+
+
 }
diff --git a/src/Entities/User.php b/src/Entities/User.php
@@ -4,12 +4,49 @@
 
 use FiveamCode\LaravelNotionApi\Exceptions\WrapperException;
 use FiveamCode\LaravelNotionApi\Notion;
+use Illuminate\Support\Arr;
 
 class User extends Entity
 {
+    private string $name;
+    private string $avatarUrl;
+
     protected function setResponseData(array $responseData): void
     {
         parent::setResponseData($responseData);
         if ($responseData['object'] !== 'user') throw WrapperException::instance("invalid json-array: the given object is not a user");
+        $this->fillFromRaw();
+    }
+
+    private function fillFromRaw(): void
+    {
+        $this->fillId();
+        $this->fillName();
+        $this->fillAvatarUrl();
+    }
+
+    private function fillName(): void
+    {
+        if (Arr::exists($this->responseData, 'name') && $this->responseData['name'] !== null) {
+            $this->name = $this->responseData['name'];
+        }
+    }
+
+    private function fillAvatarUrl(): void
+    {
+        if (Arr::exists($this->responseData, 'avatar_url') && $this->responseData['avatar_url'] !== null) {
+            $this->avatarUrl = $this->responseData['avatar_url'];
+        }
+    }
+
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getAvatarUrl(): string
+    {
+        return $this->avatarUrl;
     }
 }
diff --git a/src/Entities/UserCollection.php b/src/Entities/UserCollection.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Entities;
+
+use FiveamCode\LaravelNotionApi\Exceptions\WrapperException;
+use FiveamCode\LaravelNotionApi\Notion;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Collection;
+
+
+class UserCollection extends EntityCollection
+{
+
+    protected function setResponseData(array $responseData): void
+    {
+        parent::setResponseData($responseData);
+        $this->collectChildren();
+    }
+
+    protected function collectChildren()
+    {
+        $this->collection = new Collection();
+        foreach ($this->rawResults as $userChild) {
+            $this->collection->add(new User($userChild));
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,12 @@ protected function setResponseData(array $responseData): void`
`20`	`20`	`protected function collectChildren()`
`21`	`21`	`{`
`22`	`22`	`$this->collection = new Collection();`
`23`		`- foreach ($this->rawResults as $blockChild) {`
`24`		`- $this->collection->add(new Page($blockChild));`
	`23`	`+ foreach ($this->rawResults as $pageChild) {`
	`24`	`+ $this->collection->add(new Page($pageChild));`
`25`	`25`	`}`
`26`	`26`	`}`
	`27`	`+`
	`28`	`+`
	`29`	`+`
	`30`	`+`
`27`	`31`	`}`