Refactor to solution-forest/filament-tree.

Author: sten

README.md

@@ -47,6 +47,16 @@ php artisan vendor:publish --tag="filament-flexible-content-block-pages-migratio
 php artisan migrate
 ```
 
+Configure the Filament tailwind styling by adding these view paths to `tailwind.config.js`:
+
+```php
+content: [
+    ...
+    './vendor/solution-forest/filament-tree/resources/**/*.blade.php',
+    './vendor/statikbe/laravel-filament-flexible-content-block-pages/**/*.blade.php',
+]
+```
+
 You can now seed the home page and default settings by running:
 
 ```bash

composer.json

@@ -17,13 +17,12 @@
     ],
     "require": {
         "php": "^8.2",
-        "15web/filament-tree": "^1.0",
         "artesaos/seotools": "^1.3",
         "filament/spatie-laravel-tags-plugin": "^3.2",
         "guava/filament-icon-picker": "^2.0",
         "illuminate/contracts": "^10.0||^11.0||^12.0",
-        "kalnoy/nestedset": "^6.0",
         "mcamara/laravel-localization": "^2.3",
+        "solution-forest/filament-tree": "^2.1",
         "spatie/laravel-missing-page-redirector": "^2.11",
         "spatie/laravel-package-tools": "^1.16",
         "statikbe/laravel-filament-flexible-content-blocks": "dev-main"

database/migrations/create_filament_flexible_content_block_menu_items_table.php.stub

@@ -3,7 +3,6 @@
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Kalnoy\Nestedset\NestedSet;
 use Statikbe\FilamentFlexibleContentBlockPages\Facades\FilamentFlexibleContentBlockPages;
 
 return new class extends Migration
@@ -32,8 +31,7 @@ return new class extends Migration
             $table->boolean('is_visible')->default(true);
             $table->boolean('use_model_title')->default(false);
 
-            // Nested set structure
-            NestedSet::columns($table);
+            $table->treeColumns();
 
             $table->timestamps();
 

src/Models/MenuItem.php

@@ -2,24 +2,21 @@
 
 namespace Statikbe\FilamentFlexibleContentBlockPages\Models;
 
-use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
-use Kalnoy\Nestedset\NodeTrait;
+use SolutionForest\FilamentTree\Concern\ModelTree;
 use Spatie\Translatable\HasTranslations;
 use Statikbe\FilamentFlexibleContentBlockPages\Facades\FilamentFlexibleContentBlockPages;
 use Statikbe\FilamentFlexibleContentBlockPages\Models\Contracts\HasMenuLabel;
 use Statikbe\FilamentFlexibleContentBlocks\Models\Contracts\Linkable;
-use Studio15\FilamentTree\Concerns\InteractsWithTree;
 
 class MenuItem extends Model
 {
     use HasFactory;
     use HasTranslations;
-    use InteractsWithTree;
-    use NodeTrait;
+    use ModelTree;
 
     protected $fillable = [
         'menu_id',
@@ -33,14 +30,15 @@ class MenuItem extends Model
         'icon',
         'is_visible',
         'use_model_title',
-        '_lft',
-        '_rgt',
+        'order',
         'parent_id',
     ];
 
     protected $casts = [
         'is_visible' => 'boolean',
         'use_model_title' => 'boolean',
+        'parent_id' => 'int',
+        'order' => 'int',
     ];
 
     public $translatable = ['label'];
@@ -60,6 +58,16 @@ public function linkable(): MorphTo
         return $this->morphTo('linkable', 'linkable_type', 'linkable_id');
     }
 
+    public function parent()
+    {
+        return $this->belongsTo(static::class, $this->determineParentColumnName());
+    }
+
+    public function getMorphClass()
+    {
+        return 'filament-flexible-content-block-pages::menu-item';
+    }
+
     public function getUrl(?string $locale = null): ?string
     {
         // If it has a linkable model, get URL from that
@@ -98,49 +106,8 @@ public function isVisible(): bool
         return $this->is_visible;
     }
 
-    public function canHaveChildren(): bool
-    {
-        $maxDepth = FilamentFlexibleContentBlockPages::config()->getMenuMaxDepth();
-
-        return $this->depth < $maxDepth;
-    }
-
-    public function getMorphClass()
-    {
-        return 'filament-flexible-content-block-pages::menu-item';
-    }
-
-    public static function getTreeLabelAttribute(): string
-    {
-        return 'tree_label';
-    }
-
-    protected function treeLabel(): Attribute
-    {
-        return Attribute::make(
-            get: fn (string $value) => $this->getDisplayLabel(),
-        );
-    }
-
-    public function getTreeCaption(): string
-    {
-        if ($this->linkable_type && $this->linkable) {
-            return flexiblePagesTrans('menu_items.tree.linked_to').' '.class_basename($this->linkable_type);
-        }
-
-        if ($this->url) {
-            return flexiblePagesTrans('menu_items.tree.external_url').': '.$this->url;
-        }
-
-        if ($this->route) {
-            return flexiblePagesTrans('menu_items.tree.route').': '.$this->route;
-        }
-
-        return flexiblePagesTrans('menu_items.tree.no_link');
-    }
-
-    public function getScopeAttributes(): array
+    public function getTitleAttribute(): string
     {
-        return ['menu_id'];
+        return $this->getDisplayLabel();
     }
 }

src/Resources/MenuResource.php

@@ -7,6 +7,7 @@
 use Filament\Forms\Components\Textarea;
 use Filament\Forms\Components\TextInput;
 use Filament\Forms\Form;
+use Filament\Resources\Concerns\Translatable;
 use Filament\Resources\Resource;
 use Filament\Tables\Actions\Action;
 use Filament\Tables\Actions\DeleteBulkAction;
@@ -22,6 +23,12 @@
 
 class MenuResource extends Resource
 {
+    /*
+     * For translating menu item labels
+     * @see ManageMenuItems
+     */
+    use Translatable;
+
     protected static ?string $navigationIcon = 'heroicon-o-bars-3';
 
     protected static ?string $recordRouteKeyName = 'id';

src/Resources/MenuResource/Pages/ManageMenuItems.php

@@ -3,17 +3,16 @@
 namespace Statikbe\FilamentFlexibleContentBlockPages\Resources\MenuResource\Pages;
 
 use Filament\Actions\LocaleSwitcher;
-use Filament\Infolists\Components\IconEntry;
-use Filament\Panel;
-use Filament\Resources\Concerns\Translatable;
-use Filament\Resources\Pages\PageRegistration;
-use Illuminate\Routing\Route;
-use Illuminate\Support\Facades\Route as RouteFacade;
-use Kalnoy\Nestedset\QueryBuilder;
+use Illuminate\Database\Eloquent\Model;
+use SolutionForest\FilamentTree\Concern\TreeRecords\Translatable;
+use SolutionForest\FilamentTree\Actions\Action;
+use SolutionForest\FilamentTree\Actions\DeleteAction;
+use SolutionForest\FilamentTree\Actions\EditAction;
+use SolutionForest\FilamentTree\Pages\TreePage;
 use Statikbe\FilamentFlexibleContentBlockPages\Facades\FilamentFlexibleContentBlockPages;
 use Statikbe\FilamentFlexibleContentBlockPages\Filament\Form\Forms\MenuItemForm;
+use Statikbe\FilamentFlexibleContentBlockPages\Models\MenuItem;
 use Statikbe\FilamentFlexibleContentBlockPages\Resources\MenuResource;
-use Studio15\FilamentTree\Components\TreePage;
 
 class ManageMenuItems extends TreePage
 {
@@ -23,43 +22,23 @@ class ManageMenuItems extends TreePage
 
     public mixed $record;
 
+    protected static int $maxDepth = 3;
+
     public function mount(): void
     {
-        parent::mount();
-
         $menuModelClass = MenuResource::getModel();
         $recordId = request()->route('record');
         $this->record = app($menuModelClass)->findOrFail($recordId);
     }
 
-    /**
-     * Copied from Resource/Page to support routing in resources.
-     * {@inheritDoc}
-     */
-    public static function route(string $path): PageRegistration
-    {
-        return new PageRegistration(
-            page: static::class,
-            route: fn (Panel $panel): Route => RouteFacade::get($path, static::class)
-                ->middleware(static::getRouteMiddleware($panel))
-                ->withoutMiddleware(static::getWithoutRouteMiddleware($panel)),
-        );
-    }
-
-    public static function getModel(): string|QueryBuilder
+    public function getModel(): string
     {
         return FilamentFlexibleContentBlockPages::config()->getMenuItemModel()::class;
     }
 
-    protected function getViewData(): array
+    public function getTranslatableLocales(): array
     {
-        $query = static::getModel()::scoped(['menu_id' => $this->record->id])
-            ->with('linkable')
-            ->defaultOrder();
-
-        return [
-            'tree' => $query->get()->toTree(),
-        ];
+        return static::getResource()::getTranslatableLocales();
     }
 
     public function getTitle(): string
@@ -75,47 +54,67 @@ public function getBreadcrumb(): string
         return flexiblePagesTrans('menu_items.manage.breadcrumb');
     }
 
-    public static function getCreateForm(): array
-    {
-        return MenuItemForm::getSchema();
-    }
-
-    public static function getEditForm(): array
+    protected function getHeaderActions(): array
     {
-        return MenuItemForm::getSchema();
+        return [
+            LocaleSwitcher::make(),
+        ];
     }
 
-    public static function getInfolistColumns(): array
+    protected function getTreeActions(): array
     {
         return [
-            IconEntry::make('is_visible')
-                ->label('')
-                ->icon(fn (bool $state): string => $state ? 'heroicon-o-eye' : 'heroicon-o-eye-slash')
-                ->color(fn (bool $state): string => $state ? 'gray' : 'warning')
-                ->tooltip(fn (bool $state): ?string => $state ? null : flexiblePagesTrans('menu_items.status.hidden'))
-                ->hidden(fn (bool $state): bool => $state)
-                ->size('sm'),
+            Action::make('create')
+                ->mountUsing(
+                    fn ($arguments, $form, $model) => $form->fill([
+                        'menu_id' => $this->record->id,
+                        'parent_id' => $arguments['parent_id'] ?? -1,
+                        'is_visible' => true,
+                        'target' => '_self',
+                    ])
+                )
+                ->action(function (array $data): void {
+                    $data['menu_id'] = $this->record->id;
+                    static::getModel()::create($data);
+                }),
+            EditAction::make()
+                ->mountUsing(
+                    fn ($arguments, $form, $model) => $form->fill([
+                        ...$model->toArray(),
+                        'menu_id' => $this->record->id,
+                    ])
+                ),
+            DeleteAction::make(),
         ];
     }
 
-    protected function getHeaderActions(): array
+    protected function getTreeRecords()
     {
-        return [
-            LocaleSwitcher::make(),
-        ];
+        return static::getModel()::where('menu_id', $this->record->id)
+            ->with('linkable')
+            ->orderBy('order')
+            ->get();
     }
 
-    protected function mutateFormDataBeforeCreate(array $data): array
+    public function getTreeRecordTitle(?Model $record = null): string
     {
-        $data['menu_id'] = $this->record->id;
+        /** @var MenuItem $record */
+        if (! $record) {
+            return '';
+        }
 
-        return $data;
+        $locale = $this->getActiveLocale();
+        return $record->getDisplayLabel($locale);
     }
 
-    protected function mutateFormDataBeforeSave(array $data): array
+    public function getTreeRecordIcon(?\Illuminate\Database\Eloquent\Model $record = null): ?string
     {
-        $data['menu_id'] = $this->record->id;
+        //TODO
+        return parent::getTreeRecordIcon($record);
+    }
 
-        return $data;
+    protected function getFormSchema(): array
+    {
+        return MenuItemForm::getSchema();
     }
 }