Add route helpers

Author: sten

README.md

@@ -30,6 +30,12 @@ php artisan vendor:publish --tag="filament-flexible-content-block-pages-migratio
 php artisan migrate
 ```
 
+Further configure the third-party packages that are used. Check the installation documentation of these packages:
+
+- [Laravel Localization](https://github.com/mcamara/laravel-localization?tab=readme-ov-file#installation): 
+  Make sure the middlewares are properly setup if you want to use localised routes.
+
+
 Check [the configuration documentation}(#configuration) for more explanations on how to tweak the package.
 
 Optionally, you can publish the views using
@@ -40,12 +46,19 @@ php artisan vendor:publish --tag="filament-flexible-content-block-pages-views"
 
 ## Setup in your project
 
+### Translations
+
+If you want translated content and routes, go through the following steps: 
+
+1. Configure the supported locales in the Filament Flexible Content Blocks configuration
+2. Configure the `route_helper` in [`filament-flexible-content-block-pages.php`](./config/filament-flexible-content-block-pages.php)
+
 ### Routes
 
 Register the routes in your route file, probably `web.php`:
 
 ```php
-\Statikbe\FilamentFlexibleContentBlockPages\Facades\FilamentFlexibleContentBlockPages::routes();
+\Statikbe\FilamentFlexibleContentBlockPages\Facades\FilamentFlexibleContentBlockPages::defineRoutes();
 ```
 
 ### Filament panel

config/filament-flexible-content-block-pages.php

@@ -55,4 +55,5 @@
         'default_canonical_locale' => 'nl',
     ],
 
+    'route_helper' => \Statikbe\FilamentFlexibleContentBlockPages\Routes\LocalisedPageRouteHelper::class,
 ];

src/FilamentFlexibleContentBlockPages.php

@@ -2,8 +2,8 @@
 
 namespace Statikbe\FilamentFlexibleContentBlockPages;
 
-use Illuminate\Support\Facades\Route;
-use Statikbe\FilamentFlexibleContentBlockPages\Http\Controllers\PageController;
+use Statikbe\FilamentFlexibleContentBlockPages\Models\Page;
+use Statikbe\FilamentFlexibleContentBlockPages\Models\Settings;
 
 class FilamentFlexibleContentBlockPages
 {
@@ -14,13 +14,16 @@ public function config(): FilamentFlexibleContentBlockPagesConfig
 
     public function routes(): void
     {
-        Route::get('{grandparent}/{parent}/{page}', [PageController::class, 'grandchildIndex'])
-            ->name('filament-flexible-content-block-pages::child_page_index');
-        Route::get('{parent}/{page}', [PageController::class, 'childIndex'])
-            ->name('filament-flexible-content-block-pages::child_page_index');
-        Route::get('{page}', [PageController::class, 'index'])
-            ->name('filament-flexible-content-block-pages::page_index');
-        Route::get('/', [PageController::class, 'homeIndex'])
-            ->name('home');
+        $this->config()->getRouteHelper()::defineRoutes();
+    }
+
+    public function getUrl(Page $page, ?string $locale = null): string
+    {
+        return $this->config()->getRouteHelper()::getUrl($page, $locale);
+    }
+
+    public function getSettings(): Settings
+    {
+        return $this->config()->getSettingsModel()::getSettings();
     }
 }

src/FilamentFlexibleContentBlockPagesConfig.php

@@ -6,6 +6,8 @@
 use Statikbe\FilamentFlexibleContentBlockPages\Models\Page;
 use Statikbe\FilamentFlexibleContentBlockPages\Models\Redirect;
 use Statikbe\FilamentFlexibleContentBlockPages\Models\Settings;
+use Statikbe\FilamentFlexibleContentBlockPages\Routes\Contracts\HandlesPageRoutes;
+use Statikbe\FilamentFlexibleContentBlockPages\Routes\LocalisedPageRouteHelper;
 use Statikbe\FilamentFlexibleContentBlocks\FilamentFlexibleContentBlocksServiceProvider;
 
 class FilamentFlexibleContentBlockPagesConfig
@@ -24,11 +26,13 @@ class FilamentFlexibleContentBlockPagesConfig
 
     private string $settingsModel;
 
+    private HandlesPageRoutes $routeHelper;
+
     public function __construct()
     {
         $this->pageModel = $this->packageConfig('models.page', Page::class);
-        $this->redirectModel = $this->packageConfig('models.redirect', \Statikbe\FilamentFlexibleContentBlockPages\Models\Redirect::class);
-        $this->settingsModel = $this->packageConfig('models.settings', \Statikbe\FilamentFlexibleContentBlockPages\Models\Settings::class);
+        $this->redirectModel = $this->packageConfig('models.redirect', Redirect::class);
+        $this->settingsModel = $this->packageConfig('models.settings', Settings::class);
     }
 
     public function getSupportedLocales(): array
@@ -102,6 +106,15 @@ public function getSEODefaultCanonicalLocale(): string
         return $this->packageConfig('seo.default_canonical_locale', 'en');
     }
 
+    public function getRouteHelper(): HandlesPageRoutes
+    {
+        if (! $this->routeHelper) {
+            $this->routeHelper = app($this->packageConfig('route_helper', LocalisedPageRouteHelper::class));
+        }
+
+        return $this->routeHelper;
+    }
+
     private function packageConfig(string $configKey, $default = null): mixed
     {
         return config('filament-flexible-content-block-pages.'.$configKey);

src/Models/Page.php

@@ -4,7 +4,6 @@
 
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
-use Mcamara\LaravelLocalization\Facades\LaravelLocalization;
 use Spatie\MediaLibrary\HasMedia;
 use Statikbe\FilamentFlexibleContentBlockPages\Facades\FilamentFlexibleContentBlockPages;
 use Statikbe\FilamentFlexibleContentBlocks\Models\Concerns\HasAuthorAttributeTrait;
@@ -54,16 +53,7 @@ public function getTable()
 
     public function getViewUrl(?string $locale = null): string
     {
-        // toggle the locale to make sure the slug gets translated:
-        /*$currentLocale = app()->getLocale();
-        $locale = $locale ?? $currentLocale;
-
-        $url = LaravelLocalization::getLocalizedUrl($locale, route('home_index')) . '/' . $this->translate('slug', $locale);
-
-        return $url;*/
-
-        // TODO
-        return 'https://www.google.com';
+        return FilamentFlexibleContentBlockPages::getUrl($this, $locale);
     }
 
     public function getPreviewUrl(?string $locale = null): string

src/Routes/AbstractPageRouteHelper.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Statikbe\FilamentFlexibleContentBlockPages\Routes;
+
+use Illuminate\Support\Facades\Route;
+use Statikbe\FilamentFlexibleContentBlockPages\Http\Controllers\PageController;
+use Statikbe\FilamentFlexibleContentBlockPages\Routes\Contracts\HandlesPageRoutes;
+
+abstract class AbstractPageRouteHelper implements HandlesPageRoutes
+{
+    const ROUTE_PAGE = 'filament-flexible-content-block-pages::child_page_index';
+
+    const ROUTE_HOME = 'home';
+
+    const ROUTE_CHILD_PAGE = 'filament-flexible-content-block-pages::child_page_index';
+
+    const ROUTE_GRANDCHILD_PAGE = 'filament-flexible-content-block-pages::grandchild_page_index';
+
+    public function defineRoutes(): void
+    {
+        Route::get('{grandparent}/{parent}/{page}', [PageController::class, 'grandchildIndex'])
+            ->name(static::ROUTE_GRANDCHILD_PAGE);
+        Route::get('{parent}/{page}', [PageController::class, 'childIndex'])
+            ->name(static::ROUTE_CHILD_PAGE);
+        Route::get('{page}', [PageController::class, 'index'])
+            ->name(static::ROUTE_PAGE);
+        Route::get('/', [PageController::class, 'homeIndex'])
+            ->name(static::ROUTE_HOME);
+    }
+}

src/Routes/Contracts/HandlesPageRoutes.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Statikbe\FilamentFlexibleContentBlockPages\Routes\Contracts;
+
+use Statikbe\FilamentFlexibleContentBlockPages\Models\Page;
+
+interface HandlesPageRoutes
+{
+    /**
+     * Create the page routes. Routes needed:
+     * - home page
+     * - page
+     * - page with parent
+     * - page with grandparent
+     */
+    public function defineRoutes(): void;
+
+    /**
+     * Returns the url of the given page in the given locale.
+     */
+    public function getUrl(Page $page, ?string $locale = null): string;
+}

src/Routes/LocalisedPageRouteHelper.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Statikbe\FilamentFlexibleContentBlockPages\Routes;
+
+use Illuminate\Support\Facades\Route;
+use Mcamara\LaravelLocalization\Facades\LaravelLocalization;
+use Statikbe\FilamentFlexibleContentBlockPages\Models\Page;
+
+/**
+ * Handles localised URLs.
+ */
+class LocalisedPageRouteHelper extends AbstractPageRouteHelper
+{
+    public function defineRoutes(): void
+    {
+        Route::group([
+            'prefix' => LaravelLocalization::setLocale(),
+            'middleware' => ['localeSessionRedirect', 'localizationRedirect', 'localeViewPath', 'localize'],
+        ], function () {
+            parent::defineRoutes();
+        });
+    }
+
+    public function getUrl(Page $page, ?string $locale = null): string
+    {
+        if ($page->code === Page::HOME_PAGE) {
+            return LaravelLocalization::getLocalizedUrl($locale, static::ROUTE_HOME);
+        }
+
+        $ancestorSlugs = [];
+        $locale = $locale ?? app()->getLocale();
+
+        if ($page->parent?->parent) {
+            $ancestorSlugs[] = $page->parent->parent->translate('slug', $locale);
+        }
+
+        if ($page->parent) {
+            $ancestorSlugs[] = $page->parent->translate('slug', $locale);
+        }
+
+        $ancestorSlugs[] = $page->translate('slug', $locale);
+
+        return LaravelLocalization::getLocalizedUrl($locale, route(static::ROUTE_HOME)).'/'.implode('/', $ancestorSlugs);
+    }
+}

src/Routes/PageRouteHelper.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Statikbe\FilamentFlexibleContentBlockPages\Routes;
+
+use Statikbe\FilamentFlexibleContentBlockPages\Models\Page;
+
+/**
+ * Handles non-localised URLs.
+ */
+class PageRouteHelper extends AbstractPageRouteHelper
+{
+    public function getUrl(Page $page, ?string $locale = null): string
+    {
+        if ($page->code === Page::HOME_PAGE) {
+            return route(static::ROUTE_HOME);
+        }
+
+        if ($page->parent && $page->parent->parent) {
+            return route(static::ROUTE_GRANDCHILD_PAGE, [
+                'grandparent' => $page->parent->parent,
+                'parent' => $page->parent,
+                'page' => $page,
+            ]);
+        }
+
+        if ($page->parent) {
+            return route(static::ROUTE_CHILD_PAGE, [
+                'parent' => $page->parent,
+                'page' => $page,
+            ]);
+        }
+
+        return route('page_index', ['page' => $page]);
+    }
+}