Added JsonSerializable to Layout (frontend serialization)

Author: toonvandenbos

src/Layout.php

@@ -3,13 +3,14 @@
 namespace Whitecube\LaravelFlexibleContent;
 
 use ArrayAccess;
+use JsonSerializable;
 use Illuminate\Support\Str;
 use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Database\Eloquent\Concerns\HasAttributes;
 use Illuminate\Database\Eloquent\Concerns\HidesAttributes;
 use Whitecube\LaravelFlexibleContent\Contracts\Layout as LayoutInterface;
 
-class Layout implements LayoutInterface, ArrayAccess, Arrayable
+class Layout implements LayoutInterface, ArrayAccess, JsonSerializable, Arrayable
 {
     use HasAttributes;
     use HidesAttributes;
@@ -268,4 +269,19 @@ public function toArray()
     {
         return $this->attributesToArray();
     }
+
+    /**
+     * Transform layout for front-end serialization (AJAX requests usage). 
+     * This method should most probably be extended for proper exploitation.
+     *
+     * @return array
+     */
+    public function jsonSerialize()
+    {
+        return [
+            'key' => $this->getKey(),
+            'id' => $this->getId(),
+            'limit' => $this->getLimit(),
+        ];
+    }
 }

tests/Unit/LayoutManipulationTest.php

@@ -58,3 +58,19 @@
     expect($converted['test'])->toBeTrue();
     expect($converted['something'])->toBeFalse();
 });
+
+it('can convert layout to a JSON response object (for its frontend use)', function() {
+    $layout = (new Layout())->key('foo')->make(null, ['test' => true, 'something' => false]);
+
+    $converted = json_decode(json_encode($layout), true);
+
+    expect($converted)->toBeArray();
+    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();
+});