feat: use spatie's laravel-translatable package and filament plugin

Author: SlimDeluxe

composer.json

@@ -44,18 +44,19 @@
         "php": "^8.3",
         "bezhansalleh/filament-language-switch": "^3.1",
         "bezhansalleh/filament-shield": "^3.3",
-        "cactus-galaxy/filament-astrotomic": "^0.3.0",
         "datalinx/php-utils": "^2.5",
         "dutchcodingcompany/filament-developer-logins": "^1.6",
         "eclipsephp/world-plugin": "dev-main",
         "filament/filament": "^3.3",
         "filament/spatie-laravel-media-library-plugin": "^3.2",
+        "filament/spatie-laravel-translatable-plugin": "^3.2",
         "laravel/framework": "^11.0",
         "laravel/horizon": "^5.31",
         "laravel/telescope": "^5.5",
         "laravel/tinker": "^2.10",
         "pxlrbt/filament-environment-indicator": "^2.1",
         "spatie/laravel-package-tools": "^1.18",
+        "spatie/laravel-translatable": "^6.11",
         "tangodev-it/filament-emoji-picker": "^1.0"
     },
     "require-dev": {

src/Http/Middleware/SetupPanel.php

@@ -4,8 +4,9 @@
 
 use Closure;
 use Eclipse\Core\Models\Locale;
+use Filament\Facades\Filament;
+use Filament\SpatieLaravelTranslatablePlugin;
 use Illuminate\Http\Request;
-use Illuminate\Support\Facades\Config;
 use Symfony\Component\HttpFoundation\Response;
 
 class SetupPanel
@@ -17,8 +18,18 @@ class SetupPanel
      */
     public function handle(Request $request, Closure $next): Response
     {
-        // Set available languages for the Translatable package
-        Config::set('translatable.locales', Locale::getAvailableLocales()->pluck('id')->toArray());
+        $localeIds = Locale::getAvailableLocales()->pluck('id')->toArray();
+
+        $panel = Filament::getPanel();
+
+        if ($panel) {
+            // Set locales for the Translatable plugin
+            $panel
+                ->plugin(
+                    SpatieLaravelTranslatablePlugin::make()
+                        ->defaultLocales($localeIds)
+                );
+        }
 
         return $next($request);
     }

src/Providers/AdminPanelProvider.php

@@ -2,12 +2,10 @@
 
 namespace Eclipse\Core\Providers;
 
-use Astrotomic\Translatable\Translatable;
 use BezhanSalleh\FilamentLanguageSwitch\LanguageSwitch;
 use BezhanSalleh\FilamentShield\Facades\FilamentShield;
 use BezhanSalleh\FilamentShield\FilamentShieldPlugin;
 use BezhanSalleh\FilamentShield\Middleware\SyncShieldTenant;
-use CactusGalaxy\FilamentAstrotomic\FilamentAstrotomicTranslatablePlugin;
 use DutchCodingCompany\FilamentDeveloperLogins\FilamentDeveloperLoginsPlugin;
 use Eclipse\Core\Filament\Pages\EditProfile;
 use Eclipse\Core\Http\Middleware\SetupPanel;
@@ -17,6 +15,7 @@
 use Eclipse\Core\Models\User\Permission;
 use Eclipse\Core\Models\User\Role;
 use Eclipse\Core\Policies\User\RolePolicy;
+use Eclipse\Core\Services\PluginRegistry;
 use Eclipse\World\EclipseWorld;
 use Filament\Http\Middleware\Authenticate;
 use Filament\Http\Middleware\DisableBladeIconComponents;
@@ -31,19 +30,17 @@
 use Filament\Support\Enums\MaxWidth;
 use Filament\Support\Enums\Platform;
 use Filament\Support\Facades\FilamentView;
-use Filament\Tables;
+use Filament\Tables\Columns\Column;
 use Filament\Widgets;
 use Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse;
 use Illuminate\Cookie\Middleware\EncryptCookies;
-use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken;
 use Illuminate\Routing\Middleware\SubstituteBindings;
 use Illuminate\Session\Middleware\AuthenticateSession;
 use Illuminate\Session\Middleware\StartSession;
 use Illuminate\Support\Facades\Blade;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Gate;
-use Illuminate\Support\Str;
 use Illuminate\View\Middleware\ShareErrorsFromSession;
 use pxlrbt\FilamentEnvironmentIndicator\EnvironmentIndicatorPlugin;
 
@@ -53,7 +50,7 @@ public function panel(Panel $panel): Panel
     {
         $package_src = __DIR__.'/../../src/';
 
-        return $panel
+        $panel
             ->default()
             ->id('admin')
             ->path('admin')
@@ -115,7 +112,6 @@ public function panel(Panel $panel): Panel
                     ->enabled(app()->isLocal())
                     ->modelClass(User::class)
                     ->users(config('eclipse.developer_logins') ?: []),
-                FilamentAstrotomicTranslatablePlugin::make(),
                 EclipseWorld::make(),
             ])
             ->navigationGroups([
@@ -138,13 +134,24 @@ public function panel(Panel $panel): Panel
                     // Always visible for local env, otherwise the viewHorizon permission is required
                     ->visible(fn (User $user): bool => app()->isLocal() || $user->can('viewHorizon')),
             ]);
+
+        // Add plugins from the plugin registry
+        foreach (app(PluginRegistry::class)->getPlugins() as $plugin) {
+            $panel->plugin($plugin)->getPlugin();
+        }
+
+        return $panel;
     }
 
     public function register(): void
     {
         parent::register();
 
         FilamentView::registerRenderHook('panels::body.end', fn (): string => Blade::render("@vite('resources/js/app.js')"));
+
+        $this->app->singleton(PluginRegistry::class, function () {
+            return new PluginRegistry;
+        });
     }
 
     /**
@@ -163,28 +170,19 @@ public function boot(): void
             ->setPermissionClass(Permission::class)
             ->setRoleClass(Role::class);
 
+        // Set common settings for Filament table columns
+        Column::configureUsing(function (Column $column) {
+            $column
+                ->toggleable()
+                ->sortable();
+        });
+
         // Prohibit Filament Shield's destructive commands in production
         FilamentShield::prohibitDestructiveCommands($this->app->isProduction());
 
         // Load customized translations for Filament Shield
         $this->loadTranslationsFrom(__DIR__.'/../../resources/lang/vendor/filament-shield', 'filament-shield');
 
-        // Configure search for translatable model attributes
-        Tables\Columns\TextColumn::configureUsing(function (Tables\Columns\TextColumn $column): void {
-            if (Str::match('@^translations?\.(\w+)$@', $column->getName())) {
-                $column
-                    ->searchable(query: function (Builder $query, string $search) use ($column): Builder {
-                        $columnName = Str::after($column->getName(), '.');
-                        if ($query->hasNamedScope('whereTranslationLike')) {
-                            /* @var Translatable $query */
-                            return $query->whereTranslationLike($columnName, "%{$search}%");
-                        }
-
-                        return $query->where($columnName, 'like', "%{$search}%");
-                    });
-            }
-        });
-
         // Configure language switcher
         LanguageSwitch::configureUsing(function (LanguageSwitch $switch) {
             $availableLocales = Locale::getAvailableLocales();

src/Services/PluginRegistry.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Eclipse\Core\Services;
+
+use Filament\Contracts\Plugin;
+use InvalidArgumentException;
+
+/**
+ * Registry for managing Filament plugins in the application.
+ *
+ * This class serves as a central registry for Filament plugins, allowing them to be:
+ * - Registered in the AppServiceProvider during application bootstrap
+ * - Retrieved and configured in the AdminPanelProvider for the admin panel setup
+ * - Managed as a collection that can be accessed throughout the application
+ *
+ * The registry supports adding both single plugins and arrays of plugins,
+ * ensuring type safety by validating that all registered items implement
+ * the Filament\Contracts\Plugin interface.
+ */
+class PluginRegistry
+{
+    /**
+     * @var Plugin[]
+     */
+    protected array $plugins = [];
+
+    /**
+     * Add plugin to registry
+     *
+     * @param  Plugin|Plugin[]  $plugin  Plugin instance or array of plugins
+     */
+    public function addPlugin(Plugin|array $plugin): void
+    {
+        if (is_array($plugin)) {
+            foreach ($plugin as $p) {
+                if (! $p instanceof Plugin) {
+                    throw new InvalidArgumentException('Plugin must be an instance of Filament\\Contracts\\Plugin!');
+                }
+                $this->plugins[] = $p;
+            }
+        } else {
+            $this->plugins[] = $plugin;
+        }
+    }
+
+    /**
+     * Get all registered plugins
+     *
+     * @return Plugin[]
+     */
+    public function getPlugins(): array
+    {
+        return $this->plugins;
+    }
+}

tests/Unit/Http/Middleware/SetupPanelTest.php

@@ -1,13 +1,19 @@
 <?php
 
 use Eclipse\Core\Models\Locale;
+use Filament\Contracts\Plugin;
+use Filament\Facades\Filament;
 
 test('panel is set up correctly', function () {
 
     // Send a request to load the panel and middleware
     $this->get('/admin/login')->assertStatus(200);
 
-    expect(Config::get('translatable.locales'))
-        ->toBeArray()
+    /** @var \Filament\SpatieLaravelTranslatablePlugin $plugin */
+    $plugin = Filament::getPanel()->getPlugin('spatie-laravel-translatable');
+
+    expect($plugin)
+        ->toBeInstanceOf(Plugin::class)
+        ->and($plugin->getDefaultLocales())
         ->toContain(...Locale::getAvailableLocales()->pluck('id')->toArray());
 });