Merge pull request #33 from jonassiewertsen/add-synthesizers-for-statamic-types

Add synthesizers for statamic entries

Author: jonassiewertsen

README.md

@@ -157,6 +157,32 @@ class ShowArticles extends Component
 }
 ```
 
+### EXPERIMENTAL: Statamic Support
+As a little experiment, support for an Entry or EntryCollection has been added, so you can make an entry or a entry collection simply a public property and it just works. 
+
+Supported types:
+- Statamic\Entries\EntryCollection;
+- Statamic\Entries\Entry;
+
+```php
+namespace App\Livewire;
+
+use Livewire\Component;
+use Statamic\Entries\EntryCollection;
+use Statamic\Entries\Entry;
+
+class Foo extends Component
+{
+    public EntryCollection $entries;
+    public Entry $entry;
+```
+
+To make it work, you need to enable that feature first. 
+
+1. php artisan vendor:publish
+2. Select statamic-livewire in the list
+3. Enable synthesizers
+
 ### Entangle: Sharing State Between Livewire And Alpine
 In case you want to share state between Livewire and Alpine, there is a Blade directive called `@entangle`. To be usable with Antlers, we do provide a dedicated tag:
 ```html

config/config.php

@@ -0,0 +1,32 @@
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | EXPERIMENTAL: Livewire Synthesizers
+    |--------------------------------------------------------------------------
+    |
+    | So called synthesizers allow to add custom types to Livewire, which can
+    | can be used to make Livewire aware of Statamic classes that you want
+    | to work with, as it might make things easier. 
+    |
+    | It's recommended to remove or uncomment those synthesizers that are
+    | not used in your application, to avoid overhead by loading those. 
+    |
+    | This features is experimental. It's ment to be tested and to played
+    | with. As long as it is experimental, it can be changed and removed
+    | at any point without a warning.
+    |
+    */
+
+    'synthesizers' => [
+
+        'enabled' => false,
+
+        'classes' => [
+            \Jonassiewertsen\Livewire\Synthesizers\EntryCollectionSynthesizer::class,
+            \Jonassiewertsen\Livewire\Synthesizers\EntrySynthesizer::class,
+        ]
+    ]
+];

src/ServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace Jonassiewertsen\Livewire;
 
+use Livewire\Livewire;
 use Statamic\Providers\AddonServiceProvider;
 
 class ServiceProvider extends AddonServiceProvider
@@ -11,4 +12,32 @@ class ServiceProvider extends AddonServiceProvider
     protected $tags = [
         'Jonassiewertsen\Livewire\Tags\Livewire',
     ];
+
+    public function boot(): void
+    {
+        parent::boot();
+
+        $this->mergeConfigFrom(__DIR__ . '/../config/config.php', 'statamic-livewire');
+
+        if ($this->app->runningInConsole()) {
+            $this->publishes([
+                __DIR__ . '/../config/config.php' => config_path('statamic-livewire.php'),
+            ], 'statamic-livewire');
+        }
+
+        $this->bootSyntesizers();
+    }
+
+    protected function bootSyntesizers()
+    {
+        if (! config('statamic-livewire.synthesizers.enabled', false)) {
+            return;
+        }
+
+        $synthesizers = config('statamic-livewire.synthesizers.classes', []);
+
+        foreach ($synthesizers as $synthesizer) {
+            Livewire::propertySynthesizer($synthesizer);
+        }
+    }
 }

src/Synthesizers/EntryCollectionSynthesizer.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Jonassiewertsen\Livewire\Synthesizers;
+
+use Livewire\Mechanisms\HandleComponents\Synthesizers\Synth;
+use Statamic\Entries\Entry;
+use Statamic\Entries\EntryCollection as StatamicEntryCollection;
+
+class EntryCollectionSynthesizer extends Synth
+{
+    public static $key = 'entry-collection';
+ 
+    public static function match($target)
+    {
+        return $target instanceof StatamicEntryCollection;
+    }
+ 
+    public function dehydrate($target)
+    {
+        $data = [];
+
+        foreach ($target->all() as $entry) {
+            $data[] = [
+                'collection' => $entry->collection()->handle() ?? null,
+                'data' => $entry->data()->all(),
+                'date' => $entry->collection()->dated() ? $entry->date() : null,
+                'id' => $entry->id(),
+                'slug' => $entry->slug() ?? null,
+            ];
+        }
+
+        return [ $data, [] ];
+    }
+ 
+    public function hydrate($values)
+    {
+        $items = [];
+
+        foreach ($values as $value) {
+            $entry = Entry::make()
+                ->id($value['id'])
+                ->slug($value['slug'] ?? null)
+                ->collection($value['collection'] ?? null);
+
+            if ($value['date']) {
+                $entry->date($value['date'] ?? null);
+            }
+
+            $items[] = $entry;
+        }
+
+        return New StatamicEntryCollection($items);
+    }
+}

src/Synthesizers/EntrySynthesizer.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Jonassiewertsen\Livewire\Synthesizers;
+
+use Livewire\Mechanisms\HandleComponents\Synthesizers\Synth;
+use Statamic\Entries\Entry as StatamicEntry;
+use Statamic\Facades\Entry;
+
+class EntrySynthesizer extends Synth
+{
+    public static $key = 'entry-collection';
+ 
+    public static function match($target)
+    {
+        return $target instanceof StatamicEntry;
+    }
+ 
+    public function dehydrate($entry)
+    {
+        return [ 
+            [
+                'collection' => $entry->collection()->handle() ?? null,
+                'data' => $entry->data()->all(),
+                'date' => $entry->collection()->dated() ? $entry->date() : null,
+                'id' => $entry->id(),
+                'slug' => $entry->slug() ?? null,
+            ], [] ];
+    }
+ 
+    public function hydrate($value)
+    {
+        $entry = Entry::make()
+            ->id($value['id'])
+            ->slug($value['slug'] ?? null)
+            ->collection($value['collection'] ?? null);
+
+        if ($value['date']) {
+            $entry->date($value['date'] ?? null);
+        }
+
+        return $entry;
+    }
+}