Welcome to StoryComponent class 🚀

Author: roberto-butti

CHANGELOG.md

@@ -5,6 +5,8 @@
 - Refactoring Space, Spaces and SpaceResponse
 - Adding some helper method to Space like region() and planLevel()
 - Refactoring Story / Stories , StoryResponse, StoriesResponse
+- Adding StoryComponent class
+- Refactoring Asset, Assets and AssetResponse
 
 ## 0.0.7 - 2025-02-09
 

README.md

@@ -25,7 +25,7 @@ The *Storyblok Management API PHP Client* library simplifies the integration wit
 Install the package via Composer:
 
 ```shell
-composer require storyblok/php-management-api-client
+composer require storyblok/php-management-api-client:dev-main
 ```
 
 Below is an example showcasing how to use the library to interact with the Management API.
@@ -325,10 +325,15 @@ echo $story->name() . PHP_EOL;
 To create a story, you can call the `create()` method provided by `StoryApi` and use the `StoryData` class. The `StoryData` class is specific for storing and handling story information. It also provides some nice methods for accessing some relevant Story fields.
 
 ```php
+$content = new StoryComponent("article-page");
+$content->set("title", "My New Article");
+$content->set("body", "This is the content");
+// $content->setAsset("image", $assetCreated);
+
 $story = new Story(
     name: "A Story",
     slug: "a-story",
-    contentType: "article-page"
+    content: $content
 );
 try{
     $storyCreated = $storyApi->create($story)->data();

src/Data/Asset.php

@@ -4,18 +4,50 @@
 
 namespace Storyblok\ManagementApi\Data;
 
-class Asset extends StoryblokData
+use Storyblok\ManagementApi\Exceptions\StoryblokFormatException;
+
+class Asset extends BaseData
 {
-    /*
+    public function __construct(
+        string $filename,
+    ) {
+        $this->data = [];
+        $this->data['filename'] = $filename;
+        $this->data['fieldtype'] = "asset";
+    }
+
+    /**
      * The Asset data response payload doesn't have the typical
      * "asset" attribute (like the story, the space etc)
-     * This is the reason why the makeFromResponse is not implemented here
+     * @param mixed[] $data
+     * @throws StoryblokFormatException
      */
-
-    #[\Override]
     public static function make(array $data = []): self
     {
-        return new self($data);
+        $dataObject = new StoryblokData($data);
+        if (! $dataObject->hasKey('fieldtype')) {
+            $dataObject->set("fieldtype", "asset");
+        }
+
+        if (!($dataObject->hasKey('filename') && $dataObject->hasKey('fieldtype'))) {
+            // is not valid
+        }
+
+        $asset = new Asset(
+            $dataObject->getString("filename")
+        );
+        $asset->setData($dataObject->toArray());
+        // validate
+        if (! $asset->isValid()) {
+            throw new StoryblokFormatException("Asset is not valid");
+        }
+
+        return $asset;
+    }
+
+    public function isValid(): bool
+    {
+        return $this->hasKey('filename');
     }
 
     public function id(): string

src/Data/BaseData.php

@@ -248,6 +248,11 @@ public function toJson(): string|false
         return json_encode($this->data, JSON_PRETTY_PRINT);
     }
 
+    public function dump(): void
+    {
+        echo $this->toJson();
+    }
+
     /**
      * Retrieves a value from the data by key. Supports dot notation for nested keys.
      *

src/Data/Story.php

@@ -16,13 +16,13 @@ class Story extends BaseData
     public function __construct(
         string $name,
         string $slug,
-        string $contentType
+        StoryComponent $content,
     ) {
         $this->data = [];
         $this->data['name'] = $name;
         $this->data['slug'] = $slug;
-        $this->data['content'] = [];
-        $this->data['content']['component'] = $contentType;
+        $this->data['content'] = $content->toArray();
+
     }
 
     /**
@@ -36,10 +36,12 @@ public static function make(array $data = []): self
             // is not valid
         }
 
+        $content = StoryComponent::make($dataObject->getArray("content"));
+
         $story = new Story(
             $dataObject->getString("name"),
             $dataObject->getString("slug"),
-            $dataObject->getString("content.component")
+            $content
         );
         $story->setData($dataObject->toArray());
         // validate
@@ -71,12 +73,15 @@ public function setCreatedAt(string $createdAt): void
         $this->set('created_at', $createdAt);
     }
 
-    /**
-     * @param array<mixed> $content
-     */
-    public function setContent(array $content): void
+    public function setContent(StoryComponent $content): void
+    {
+        $this->set('content', $content->toArray());
+    }
+
+    public function content(): StoryComponent
     {
-        $this->set('content', $content);
+        $contentArray = $this->getArray('content');
+        return StoryComponent::make($contentArray);
     }
 
     public function name(): string

src/Data/StoryComponent.php

@@ -0,0 +1,90 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Storyblok\ManagementApi\Data;
+
+use Storyblok\ManagementApi\Data\BaseData;
+use Storyblok\ManagementApi\Exceptions\StoryblokFormatException;
+
+/**
+ * Class StoryComponent
+ *
+ * Represents the content section within a Story object retrieved from the
+ * Storyblok API.
+ *
+ * The content section is an object containing field data associated with the
+ * specific story type's content structure.
+ * It also includes a `component` property, which holds the technical name of
+ * the story type.
+ *
+ * Example structure of content property in a story:
+ * ```json
+ * {
+ *   "component": "page",
+ *   "title": "Homepage",
+ *   "body": [
+ *     { "component": "text", "text": "Welcome to our website" }
+ *   ]
+ * }
+ * ```
+ */
+class StoryComponent extends BaseData
+{
+    public function __construct(
+        string $contentType,
+    ) {
+        $this->data = [];
+        $this->data['component'] = $contentType;
+    }
+
+    /**
+     * @param mixed[] $data
+     * @throws StoryblokFormatException
+     */
+    public static function make(array $data = []): self
+    {
+        if (! array_key_exists("component", $data)) {
+            throw new StoryblokFormatException(
+                "Story `content` is not valid, `component` property is missing."
+            );
+        }
+
+        $storyContent = new StoryComponent(
+            $data["component"],
+        );
+        $storyContent->setData($data);
+        // validate
+        if (! $storyContent->isValid()) {
+            throw new StoryblokFormatException("Story content is not valid");
+        }
+
+        return $storyContent;
+
+    }
+
+    public function setComponent(string $component): self
+    {
+        $this->set('component', $component);
+        return $this;
+    }
+
+    public function component(): string
+    {
+        return $this->getString('component');
+    }
+
+    /**
+     * Validates if the story content contains all required fields and valid values
+     */
+    public function isValid(): bool
+    {
+        return $this->hasKey('component');
+    }
+
+    public function setAsset(string $field, Asset $asset): self
+    {
+        $this->set($field, $asset->toArray());
+        return $this;
+    }
+}

src/Endpoints/StoryApi.php

@@ -8,6 +8,7 @@
 use Psr\Log\NullLogger;
 use Storyblok\ManagementApi\Data\Stories;
 use Storyblok\ManagementApi\Data\Story;
+use Storyblok\ManagementApi\Data\StoryComponent;
 use Storyblok\ManagementApi\Exceptions\InvalidStoryDataException;
 use Storyblok\ManagementApi\Exceptions\StoryblokApiException;
 use Storyblok\ManagementApi\ManagementApiClient;
@@ -106,9 +107,7 @@ public function create(Story $storyData): StoryResponse
         $this->validateStoryData($storyData);
 
         if (!$storyData->hasKey("content")) {
-            $storyData->setContent([
-                "component" => $storyData->defaultContentType(),
-            ]);
+            $storyData->setContent(new StoryComponent($storyData->defaultContentType()));
         }
 
         try {