Added specific layout serialization methods for different use cases

Author: toonvandenbos

README.md

@@ -9,6 +9,7 @@ This package's only purpose is to build custom repeated layout components, such
     - `register($layout, $limit)`
 - get all registered layouts
     - `layouts()`
+    - `layoutsMenu()`
 - limiting layouts
     - `limit($instances)`
     - `$layout->limit($instances)`

src/Concerns/HasLayouts.php

@@ -89,4 +89,17 @@ public function layouts() : LayoutsCollection
 
         return $this->layouts;
     }
+
+    /**
+     * Get all the defined layouts serialized for display in a menu.
+     *
+     * @return array
+     */
+    public function layoutsMenu() : array
+    {
+        return $this->layouts()
+            ->map(fn(Layout $layout) => $layout->toButtonArray())
+            ->values()
+            ->all();
+    }
 }

src/Concerns/HasResolver.php

@@ -170,11 +170,7 @@ public function serializeAs(string $format)
     public function serializeAsArray()
     {
         return $this->instances()
-            ->map(fn(Layout $instance) => [
-                'key' => $instance->getKey(),
-                'id' => $instance->getId(),
-                'attributes' => $instance->getAttributes()
-            ])
+            ->map(fn(Layout $instance) => $instance->toSerializableArray())
             ->all();
     }
 

src/Contracts/Flexible.php

@@ -39,6 +39,13 @@ public function getLayout(string $key) : ?Layout;
      */
     public function layouts() : LayoutsCollection;
 
+    /**
+     * Get all the defined layouts serialized for display in a menu.
+     *
+     * @return array
+     */
+    public function layoutsMenu() : array;
+
     /**
      * Prevent the Flexible container to instanciate more layouts
      * than the indicated amount.

src/Contracts/Layout.php

@@ -85,4 +85,18 @@ public function isInsertable(Flexible $container);
      * @return \Whitecube\LaravelFlexibleContent\Contracts\Layout
      */
     public function make(?string $id = null, array $attributes = []) : Layout;
+
+    /**
+     * Convert the layout instance's state to an array that can be saved.
+     *
+     * @return array
+     */
+    public function toSerializableArray() : array;
+
+    /**
+     * Convert the layout to an array that can be displayed in a user menu.
+     *
+     * @return array
+     */
+    public function toButtonArray() : array;
 }

src/Layout.php

@@ -289,17 +289,42 @@ public function toArray()
     }
 
     /**
-     * Transform layout for front-end serialization (AJAX requests usage). 
-     * This method should most probably be extended for proper exploitation.
+     * Convert the layout instance's state to an array that can be saved.
      *
      * @return array
      */
-    public function jsonSerialize()
+    public function toSerializableArray() : array
     {
         return [
             'key' => $this->getKey(),
             'id' => $this->getId(),
+            'attributes' => $this->getAttributes(),
+        ];
+    }
+
+    /**
+     * Convert the layout to an array that can be displayed in a user menu.
+     *
+     * @return array
+     */
+    public function toButtonArray() : array
+    {
+        return [
+            'key' => $this->getKey(),
             'limit' => $this->getLimit(),
         ];
     }
+
+    /**
+     * Transform layout for front-end serialization (AJAX requests usage). 
+     *
+     * @return array
+     */
+    public function jsonSerialize()
+    {
+        return array_merge(
+            $this->toButtonArray(),
+            $this->toSerializableArray()
+        );
+    }
 }

tests/Unit/InstanceResolvingTest.php

@@ -98,9 +98,12 @@
     expect($serialized)->toBeArray();
 
     foreach (['foo', 'bar', 'foo'] as $index => $key) {
-        expect($serialized[$index]['key'] ?? null)->toBe($key);
-        expect($serialized[$index]['id'] ?? null)->toBeString();
-        expect($serialized[$index]['attributes']['test'] ?? null)->toBe($index);
+        $item = $serialized[$index];
+
+        expect($item['key'] ?? null)->toBe($key);
+        expect($item['id'] ?? null)->toBeString();
+        expect($item['attributes']['test'] ?? null)->toBe($index);
+        expect(array_key_exists('limit', $item))->toBeFalse();
     }
 });
 
@@ -117,9 +120,12 @@
     expect($serialized = json_decode($serialized, true))->toBeArray();
 
     foreach (['foo', 'bar', 'foo'] as $index => $key) {
-        expect($serialized[$index]['key'] ?? null)->toBe($key);
-        expect($serialized[$index]['id'] ?? null)->toBeString();
-        expect($serialized[$index]['attributes']['test'] ?? null)->toBe($index);
+        $item = $serialized[$index];
+
+        expect($item['key'] ?? null)->toBe($key);
+        expect($item['id'] ?? null)->toBeString();
+        expect($item['attributes']['test'] ?? null)->toBe($index);
+        expect(array_key_exists('limit', $item))->toBeFalse();
     }
 });
 
@@ -135,9 +141,12 @@
     expect($serialized)->toBeInstanceOf(Collection::class);
 
     foreach (['foo', 'bar', 'foo'] as $index => $key) {
-        expect($serialized->get($index)['key'] ?? null)->toBe($key);
-        expect($serialized->get($index)['id'] ?? null)->toBeString();
-        expect($serialized->get($index)['attributes']['test'] ?? null)->toBe($index);
+        $item = $serialized->get($index);
+
+        expect($item['key'] ?? null)->toBe($key);
+        expect($item['id'] ?? null)->toBeString();
+        expect($item['attributes']['test'] ?? null)->toBe($index);
+        expect(array_key_exists('limit', $item))->toBeFalse();
     }
 });
 

tests/Unit/LayoutManipulationTest.php

@@ -71,7 +71,29 @@
     expect($converted['something'])->toBeFalse();
 });
 
-it('can convert layout to a JSON response object (for its frontend use)', function() {
+it('can convert layout to a saveable array', function() {
+    $layout = (new Layout())->key('foo')->limit(5)->make(null, ['test' => true, 'something' => false]);
+
+    $converted = $layout->toSerializableArray();
+
+    expect(array_key_exists('key', $converted))->toBeTrue();
+    expect(array_key_exists('id', $converted))->toBeTrue();
+    expect(array_key_exists('attributes', $converted))->toBeTrue();
+    expect(array_key_exists('limit', $converted))->toBeFalse();
+});
+
+it('can convert layout to a displayable (menu) array', function() {
+    $layout = (new Layout())->key('foo')->limit(5)->make(null, ['test' => true, 'something' => false]);
+
+    $converted = $layout->toButtonArray();
+
+    expect(array_key_exists('key', $converted))->toBeTrue();
+    expect(array_key_exists('id', $converted))->toBeFalse();
+    expect(array_key_exists('attributes', $converted))->toBeFalse();
+    expect(array_key_exists('limit', $converted))->toBeTrue();
+});
+
+it('can convert layout to a JSON response object', function() {
     $layout = (new Layout())->key('foo')->make(null, ['test' => true, 'something' => false]);
 
     $converted = json_decode(json_encode($layout), true);
@@ -80,9 +102,5 @@
     expect($converted['key'])->toBe('foo');
     expect(array_key_exists('id', $converted))->toBeTrue();
     expect(array_key_exists('limit', $converted))->toBeTrue();
-
-    // In this package, we do not include the layout's attributes in its JSON structure
-    // since they should probably be manipulated by the extending flexible container. It is 
-    // up to the developer to decide if attributes should be sent to the view.
-    expect(array_key_exists('attributes', $converted))->toBeFalse();
+    expect(array_key_exists('attributes', $converted))->toBeTrue();
 });

tests/Unit/LayoutRegistrationTest.php

@@ -87,3 +87,16 @@
     expect($collection)->toBeInstanceOf(LayoutsCollection::class);
     expect($collection->keys()->implode(','))->toBe('foo,bar');
 });
+
+it('can return all registered layouts as a "menu" array', function() {
+    $flexible = (new Flexible())
+        ->register(fn ($layout) => $layout->key('foo')->limit(3))
+        ->register(fn ($layout) => $layout->key('bar')->limit(4));
+
+    $menu = $flexible->layoutsMenu();
+
+    expect($menu)->toBeArray();
+    expect($menu)->toHaveCount(2);
+    expect(array_key_exists('id', $menu[0]))->toBeFalse();
+    expect(array_key_exists('limit', $menu[0]))->toBeTrue();
+});