Add component type helper methods (isNestable, isContentType, isUniversal, getComponentTypeDetail)

Adding isNestable(), isContentType(), isUniversal(), and getComponentTypeDetail() helper methods for Component

Author: roberto-butti

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## 1.1.3 - WIP
+- Adding `isNestable()`, `isContentType()`, `isUniversal()`, and `getComponentTypeDetail()` helper methods for Component
 - Adding `getIntStrict()` helper method (returing a forced integer with default)
 
 

README.md

@@ -739,6 +739,16 @@ foreach ($components as $component) {
 }
 
 ```
+
+Each component has a type based on the `is_root` and `is_nestable` flags. You can use the helper methods `isContentType()`, `isNestable()`, `isUniversal()`, or `getComponentTypeDetail()` to determine the component type:
+
+```php
+foreach ($components as $component) {
+    // returns "content-type", "nestable", "universal", or ""
+    echo $component->name() . " - " . $component->getComponentTypeDetail() . PHP_EOL;
+}
+```
+
 With the same response you can retrieve the component folders.
 You can use the `dataFolders()` method:
 

src/Data/Component.php

@@ -13,11 +13,10 @@ class Component extends BaseData
     /**
      * @param string $name the component name
      */
-    public function __construct(
-        string $name,
-    ) {
+    public function __construct(string $name)
+    {
         $this->data = [];
-        $this->data['name'] = $name;
+        $this->data["name"] = $name;
     }
 
     /**
@@ -27,171 +26,226 @@ public function __construct(
     public static function make(array $data = []): self
     {
         $dataObject = new StoryblokData($data);
-        if (!($dataObject->hasKey('name'))) {
-            throw new StoryblokFormatException("Component is not valid, missing the name");
+        if (!$dataObject->hasKey("name")) {
+            throw new StoryblokFormatException(
+                "Component is not valid, missing the name",
+            );
         }
 
-        $component = new Component(
-            $dataObject->getString("name")
-        );
+        $component = new Component($dataObject->getString("name"));
         $component->setData($dataObject->toArray());
         // validate
-        if (! $component->isValid()) {
+        if (!$component->isValid()) {
             if ($dataObject->getString("name") === "") {
-                throw new StoryblokFormatException("Component is not valid, missing the name");
+                throw new StoryblokFormatException(
+                    "Component is not valid, missing the name",
+                );
             }
 
-            throw new StoryblokFormatException("Component <" . $dataObject->getString("name") . "> is not valid");
+            throw new StoryblokFormatException(
+                "Component <" .
+                    $dataObject->getString("name") .
+                    "> is not valid",
+            );
         }
 
         return $component;
-
     }
 
     public function setName(string $name): void
     {
-        $this->set('name', $name);
+        $this->set("name", $name);
     }
 
     /**
      * Technical name used for component property in entries
      */
     public function name(): string
     {
-        return $this->getString('name');
+        return $this->getString("name");
     }
 
     /**
      * Component name based on the technical name or display name
      */
     public function realName(): string
     {
-        return $this->getString('real_name');
+        return $this->getString("real_name");
     }
 
     /**
      * Name that will be used in the editor interface
      */
     public function displayName(): string
     {
-        return $this->getString('display_name');
+        return $this->getString("display_name");
     }
 
     /**
      * Name that will be used in the editor interface
      */
     public function setDisplayName(string $displayName): void
     {
-        $this->set('display_name', $displayName);
+        $this->set("display_name", $displayName);
     }
 
     /**
      * URL to the preview image, if uploaded
      */
     public function image(): string|null
     {
-        return $this->getStringNullable('image');
+        return $this->getStringNullable("image");
     }
 
     /**
      * URL to the preview image, if uploaded
      */
     public function setImage(string $url): void
     {
-        $this->set('image', $url);
+        $this->set("image", $url);
     }
 
     /**
      * The field that is for preview in the interface (Preview Field)
      */
     public function previewField(): string
     {
-        return $this->getString('preview_field');
+        return $this->getString("preview_field");
     }
 
     /**
      * The field that is for preview in the interface (Preview Field)
      */
     public function setPreviewField(string $value): void
     {
-        $this->set('preview_field', $value);
+        $this->set("preview_field", $value);
     }
 
     /**
      * Creation date
      */
-    public function createdAt(string $format = self::DEFAULT_DATE_FORMAT): null|string
-    {
-        return $this->getFormattedDateTime('created_at', "", format: $format);
+    public function createdAt(
+        string $format = self::DEFAULT_DATE_FORMAT,
+    ): null|string {
+        return $this->getFormattedDateTime("created_at", "", format: $format);
     }
 
     /**
      * Latest update date
      */
-    public function updatedAt(string $format = self::DEFAULT_DATE_FORMAT): null|string
-    {
-        return $this->getFormattedDateTime('updated_at', "", format: $format);
+    public function updatedAt(
+        string $format = self::DEFAULT_DATE_FORMAT,
+    ): null|string {
+        return $this->getFormattedDateTime("updated_at", "", format: $format);
     }
 
     /**
      * The numeric ID in string format "12345678"
      */
     public function id(): string
     {
-        return $this->getString('id');
+        return $this->getString("id");
     }
 
     /**
      * True if the component can be used as a Content Type
+     * for example if is a content-type or a universal
      */
     public function isRoot(): bool
     {
-        return $this->getBoolean('is_root');
+        return $this->getBoolean("is_root");
     }
 
     /**
      * If the component can be used as a Content Type
      */
     public function setRoot(bool $isRoot = true): void
     {
-        $this->set('is_root', $isRoot);
+        $this->set("is_root", $isRoot);
+    }
+
+    /**
+     * True if the component can be nested inside other components
+     */
+    public function isNestable(): bool
+    {
+        return $this->getBoolean("is_nestable");
+    }
+
+    /**
+     * If the component can be nested inside other components
+     */
+    public function setNestable(bool $isNestable = true): void
+    {
+        $this->set("is_nestable", $isNestable);
+    }
+
+    /**
+     * True if the component is a content type (is_root only)
+     */
+    public function isContentType(): bool
+    {
+        return $this->getBoolean("is_root") &&
+            !$this->getBoolean("is_nestable");
+    }
+
+    /**
+     * True if the component is universal (is_root and is_nestable)
+     */
+    public function isUniversal(): bool
+    {
+        return $this->getBoolean("is_root") && $this->getBoolean("is_nestable");
+    }
+
+    /**
+     * Returns the component type as a string:
+     * "universal", "content-type", "nestable", or "".
+     */
+    public function getComponentTypeDetail(): string
+    {
+        return match (true) {
+            $this->isUniversal() => "universal",
+            $this->isContentType() => "content-type",
+            $this->isNestable() => "nestable",
+            default => "",
+        };
     }
 
     public function uuid(): string
     {
-        return $this->getString('uuid');
+        return $this->getString("uuid");
     }
 
     /**
      * @return mixed[]
      */
     public function getSchema(): array
     {
-        return $this->getArray('schema');
+        return $this->getArray("schema");
     }
 
     /**
      * @param mixed[] $schema
      */
     public function setSchema(array $schema): void
     {
-        $this->set('schema', $schema);
+        $this->set("schema", $schema);
     }
 
     /**
      * @param mixed[] $fieldAttributes
      */
     public function setField(string $name, array $fieldAttributes): void
     {
-        $this->set('schema.' . $name, $fieldAttributes);
+        $this->set("schema." . $name, $fieldAttributes);
     }
 
     /**
      * Validates if the component data contains all required fields and valid values
      */
     public function isValid(): bool
     {
-        return $this->hasKey('name');
+        return $this->hasKey("name");
     }
 
     /**
@@ -200,9 +254,7 @@ public function isValid(): bool
      */
     public function setTags(Tags $tags): self
     {
-
         return $this->setTagsFromArray($tags->getTagsArray());
-
     }
 
     /**