Added instancesValues method

Author: toonvandenbos

README.md

@@ -24,6 +24,7 @@ This package's only purpose is to build custom repeated layout components, such
     - `serializeUsing($callback)`
 - get all inserted instances, and manipulate the LayoutCollection :
     - `instances()`
+    - `instancesValues()`
     - `$instances->find($key)`
     - `$instances->whereKey($key)`
     - `$instances->whereKeyNot($key)`

src/Concerns/HasLayoutInstances.php

@@ -113,6 +113,19 @@ public function instances() : LayoutsCollection
         return $this->instances;
     }
 
+    /**
+     * Get all the inserted layout instances serialized for display in a user interface.
+     *
+     * @return array
+     */
+    public function instancesValues() : array
+    {
+        return $this->instances()
+            ->map(fn(Layout $instance) => $instance->toDisplayableArray())
+            ->values()
+            ->all();
+    }
+
     /**
      * Get the amount of inserted layout instances, total or per layout key.
      *

src/Contracts/Flexible.php

@@ -81,6 +81,13 @@ public function insert(string $key, array $attributes = [], ?int $index = null,
      */
     public function instances() : LayoutsCollection;
 
+    /**
+     * Get all the inserted layout instances serialized for display in a user interface.
+     *
+     * @return array
+     */
+    public function instancesValues() : array;
+
     /**
      * Get the amount of inserted layout instances, total or per layout key.
      *

src/Contracts/Layout.php

@@ -93,8 +93,17 @@ public function make(?string $id = null, array $attributes = []) : Layout;
      */
     public function toSerializableArray() : array;
 
+    /**
+     * Convert the layout instance's state to an array that can be displayed in an user interface.
+     * It is intended to be extended and filled with the frontend component's required attributes.
+     *
+     * @return array
+     */
+    public function toDisplayableArray() : array;
+
     /**
      * Convert the layout to an array that can be displayed in a user menu.
+     * It is intended to be extended and filled with the frontend component's required attributes.
      *
      * @return array
      */

src/Layout.php

@@ -302,8 +302,23 @@ public function toSerializableArray() : array
         ];
     }
 
+    /**
+     * Convert the layout instance's state to an array that can be displayed in an user interface.
+     * It is intended to be extended and filled with the frontend component's required attributes.
+     *
+     * @return array
+     */
+    public function toDisplayableArray() : array
+    {
+        return [
+            'key' => $this->getKey(),
+            'id' => $this->getId(),
+        ];
+    }
+
     /**
      * Convert the layout to an array that can be displayed in a user menu.
+     * It is intended to be extended and filled with the frontend component's required attributes.
      *
      * @return array
      */

tests/Unit/InstanceInsertingTest.php

@@ -6,29 +6,23 @@
 use Whitecube\LaravelFlexibleContent\Exceptions\LayoutNotFoundException;
 
 it('can push a new empty layout instance to its value', function() {
-    $flexible = (new Flexible())->register(function($layout) {
-        $layout->key('foo');
-    });
+    $flexible = (new Flexible())->register(fn ($layout) => $layout->key('foo'));
 
     $flexible->insert('foo');
 
     expect($flexible->count())->toBe(1);
 });
 
 it('can push a layout instance with defined attributes to its value', function() {
-    $flexible = (new Flexible())->register(function($layout) {
-        $layout->key('foo');
-    });
+    $flexible = (new Flexible())->register(fn ($layout) => $layout->key('foo'));
 
     $flexible->insert('foo', ['bar' => 'test'], null, 'some-id');
 
     expect($flexible->count())->toBe(1);
 });
 
 it('can insert a layout at a certain index in its value', function() {
-    $flexible = (new Flexible())->register(function($layout) {
-        $layout->key('foo');
-    });
+    $flexible = (new Flexible())->register(fn ($layout) => $layout->key('foo'));
 
     $flexible->insert('foo', [], null, 'one');
     $flexible->insert('foo', [], null, 'three');
@@ -39,9 +33,22 @@
 });
 
 it('cannot add an unregistered layout key to its value', function() {
-    $flexible = (new Flexible())->register(function($layout) {
-        $layout->key('foo');
-    });
+    $flexible = (new Flexible())->register(fn ($layout) => $layout->key('foo'));
 
     $flexible->insert('bar');
 })->throws(LayoutNotFoundException::class);
+
+it('can return all inserted layout instances as a displayable array', function() {
+    $flexible = (new Flexible())->register(fn ($layout) => $layout->key('foo'));
+
+    $flexible->insert('foo', [], null, 'one');
+    $flexible->insert('foo', [], null, 'two');
+    $flexible->insert('foo', [], null, 'three');
+
+    $value = $flexible->instancesValues();
+
+    expect($value)->toBeArray();
+    expect($value)->toHaveCount(3);
+    expect(array_key_exists('id', $value[0]))->toBeTrue();
+    expect(array_key_exists('limit', $value[0]))->toBeFalse();
+});

tests/Unit/LayoutManipulationTest.php

@@ -82,6 +82,17 @@
     expect(array_key_exists('limit', $converted))->toBeFalse();
 });
 
+it('can convert layout to a displayable (UI) array', function() {
+    $layout = (new Layout())->key('foo')->limit(5)->make(null, ['test' => true, 'something' => false]);
+
+    $converted = $layout->toDisplayableArray();
+
+    expect(array_key_exists('key', $converted))->toBeTrue();
+    expect(array_key_exists('id', $converted))->toBeTrue();
+    expect(array_key_exists('attributes', $converted))->toBeFalse();
+    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]);