feat: add caption in file blocks (#37)

* feat: add caption in file blocks * chore: coding style
brd6 · Mar 9, 2024 · 740f3b1 · 740f3b1
1 parent add38da
commit 740f3b1
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 14 deletions.
diff --git a/src/RequestParameters.php b/src/RequestParameters.php
@@ -35,9 +35,6 @@ public function setMethod(string $method): self
         return $this;
     }
 
-    /**
-     * @return array
-     */
     public function getQuery(): array
     {
         return $this->query;
@@ -55,9 +52,6 @@ public function setQuery(array $query): self
         return $this;
     }
 
-    /**
-     * @return array
-     */
     public function getBody(): array
     {
         return $this->body;

diff --git a/src/Resource/AbstractResource.php b/src/Resource/AbstractResource.php
@@ -46,9 +46,6 @@ abstract protected function initialize(): void;
 
     abstract public static function getResourceType(): string;
 
-    /**
-     * @return array
-     */
     public function getRawData(): array
     {
         return $this->rawData;

diff --git a/src/Resource/Block/AbstractBlock.php b/src/Resource/Block/AbstractBlock.php
@@ -206,8 +206,6 @@ protected function getProperty(): ?AbstractProperty
     }
 
     /**
-     * @return array
-     *
      * @psalm-suppress PossiblyNullReference
      */
     public function propertyToArray(): array

diff --git a/src/Resource/File/AbstractFile.php b/src/Resource/File/AbstractFile.php
@@ -7,15 +7,22 @@
 use Brd6\NotionSdkPhp\Exception\InvalidFileException;
 use Brd6\NotionSdkPhp\Exception\UnsupportedFileTypeException;
 use Brd6\NotionSdkPhp\Resource\AbstractJsonSerializable;
+use Brd6\NotionSdkPhp\Resource\RichText\AbstractRichText;
 use Brd6\NotionSdkPhp\Util\StringHelper;
 
+use function array_map;
 use function class_exists;
 
 abstract class AbstractFile extends AbstractJsonSerializable
 {
     private array $rawData = [];
     protected string $type = '';
 
+    /**
+     * @var array|AbstractRichText[]
+     */
+    protected array $caption = [];
+
     public function __construct()
     {
         $this->type = static::getFileType();
@@ -48,6 +55,10 @@ protected function setRawData(array $rawData): self
         $this->rawData = $rawData;
 
         $this->type = (string) ($this->rawData['type'] ?? '');
+        $this->caption = isset($this->rawData['caption']) ? array_map(
+            fn (array $richTextRawData) => AbstractRichText::fromRawData($richTextRawData),
+            (array) $this->rawData['caption'],
+        ) : [];
 
         return $this;
     }
@@ -90,4 +101,22 @@ public function setType(string $type): self
 
         return $this;
     }
+
+    /**
+     * @return array|AbstractRichText[]
+     */
+    public function getCaption(): array
+    {
+        return $this->caption;
+    }
+
+    /**
+     * @param array|AbstractRichText[] $caption
+     */
+    public function setCaption(array $caption): self
+    {
+        $this->caption = $caption;
+
+        return $this;
+    }
 }
diff --git a/src/Resource/RichText/AbstractRichText.php b/src/Resource/RichText/AbstractRichText.php
@@ -71,9 +71,6 @@ protected static function getMapClassFromType(string $type): string
 
     abstract protected function initialize(): void;
 
-    /**
-     * @return array
-     */
     public function getRawData(): array
     {
         return $this->rawData;