Add page routes

sten · sten · commit 0d2b94bfdf3f · 2025-06-24T23:22:06.000+02:00
Add seeders
diff --git a/README.md b/README.md
@@ -5,15 +5,7 @@
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/statikbe/laravel-filament-flexible-content-block-pages/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/statikbe/laravel-filament-flexible-content-block-pages/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/statikbe/laravel-filament-flexible-content-block-pages.svg?style=flat-square)](https://packagist.org/packages/statikbe/laravel-filament-flexible-content-block-pages)
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
-
-## Support us
-
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-filament-flexible-content-block-pages.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-filament-flexible-content-block-pages)
-
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
+TODO This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
 
 ## Installation
 
@@ -29,7 +21,7 @@ Publish the config file with:
 php artisan vendor:publish --tag="filament-flexible-content-block-pages-config"
 ```
 
-If you want to alter the names of the database tables, do so in the config file, before running the migrations.
+If you want to alter the names of the database tables, do so in the config file, **before running the migrations**.
 
 You can publish and run the migrations with:
 
@@ -38,32 +30,42 @@ php artisan vendor:publish --tag="filament-flexible-content-block-pages-migratio
 php artisan migrate
 ```
 
-This is the contents of the published config file:
-
-```php
-return [
-];
-```
+Check [the configuration documentation}(#configuration) for more explanations on how to tweak the package.
 
 Optionally, you can publish the views using
 
 ```bash
 php artisan vendor:publish --tag="filament-flexible-content-block-pages-views"
 ```
 
-## Usage
+## Setup in your project
+
+### Routes
+
+Register the routes in your route file, probably `web.php`:
 
 ```php
-$filamentFlexibleContentBlockPages = new Statikbe\FilamentFlexibleContentBlockPages();
-echo $filamentFlexibleContentBlockPages->echoPhrase('Hello, Statikbe!');
+\Statikbe\FilamentFlexibleContentBlockPages\Facades\FilamentFlexibleContentBlockPages::routes();
 ```
 
-## Testing
+### Filament panel
 
-```bash
-composer test
+The package contains a pre-configured panel. You can register the panel in the `app.php` configuration file.
+
+```php
+'providers' => [
+    // ...
+    \Statikbe\FilamentFlexibleContentBlockPages\FlexibleContentBlockPagesPanel::class,
+    // ...
+],
 ```
 
+If you want you can build your own panel from the provided resources.
+
+## Configuration
+
+TODO
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
diff --git a/database/migrations/create_filament_flexible_content_block_pages_settings_table.php.stub b/database/migrations/create_filament_flexible_content_block_pages_settings_table.php.stub
@@ -12,7 +12,7 @@ return new class extends Migration {
         Schema::create(FilamentFlexibleContentBlockPages::config()->getSettingsTable(), function (Blueprint $table) {
             $table->id();
             $table->string(Settings::SETTING_SITE_TITLE);
-            $table->text(Settings::SETTING_CONTACT_INFO)->nullable();
+            $table->json(Settings::SETTING_CONTACT_INFO)->nullable();
             $table->json(Settings::SETTING_FOOTER_COPYRIGHT)->nullable();
             $table->timestamps();
         });
diff --git a/database/seeders/DatabaseSeeder.php b/database/seeders/DatabaseSeeder.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Database\Seeders;
+
+use Illuminate\Database\Seeder;
+
+class DatabaseSeeder extends Seeder
+{
+    public function run(): void
+    {
+        $this->call([
+            HomePageSeeder::class,
+            SettingsSeeder::class,
+        ]);
+    }
+}
diff --git a/database/seeders/HomePageSeeder.php b/database/seeders/HomePageSeeder.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Database\Seeders;
+
+use Illuminate\Database\Seeder;
+use Statikbe\FilamentFlexibleContentBlockPages\Facades\FilamentFlexibleContentBlockPages;
+use Statikbe\FilamentFlexibleContentBlockPages\Models\Page;
+
+class HomePageSeeder extends Seeder
+{
+    public function run(): void
+    {
+        $locales = FilamentFlexibleContentBlockPages::config()->getSupportedLocales();
+        $pageModel = FilamentFlexibleContentBlockPages::config()->getPageModel();
+
+        $homePage = new $pageModel;
+        $homePage->code = Page::HOME_PAGE;
+        $this->setTranslatedField($homePage, 'title', 'Home', $locales);
+        $homePage->save();
+    }
+
+    private function setTranslatedField(Page $homePage, string $field, string $value, array $locales)
+    {
+        foreach ($locales as $locale) {
+            $homePage->setTranslation($field, $locale, $value);
+        }
+    }
+}
diff --git a/database/seeders/SettingsSeeder.php b/database/seeders/SettingsSeeder.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace Database\Seeders;
+
+use Illuminate\Database\Seeder;
+use Statikbe\FilamentFlexibleContentBlockPages\Facades\FilamentFlexibleContentBlockPages;
+use Statikbe\FilamentFlexibleContentBlockPages\Models\Settings;
+
+class SettingsSeeder extends Seeder
+{
+    public function run(): void
+    {
+        $locales = FilamentFlexibleContentBlockPages::config()->getSupportedLocales();
+        $settingsModel = FilamentFlexibleContentBlockPages::config()->getSettingsModel();
+        $settings = new $settingsModel;
+
+        $settings->site_title = config('app.name');
+        $this->setTranslatedField($settings, 'footer_copyright', 'Made with love by Statik', $locales);
+
+        $settings->save();
+    }
+
+    private function setTranslatedField(Settings $settings, string $field, string $value, array $locales)
+    {
+        foreach ($locales as $locale) {
+            $settings->setTranslation($field, $locale, $value);
+        }
+    }
+}
diff --git a/src/FilamentFlexibleContentBlockPages.php b/src/FilamentFlexibleContentBlockPages.php
@@ -2,10 +2,25 @@
 
 namespace Statikbe\FilamentFlexibleContentBlockPages;
 
+use Illuminate\Support\Facades\Route;
+use Statikbe\FilamentFlexibleContentBlockPages\Http\Controllers\PageController;
+
 class FilamentFlexibleContentBlockPages
 {
-    public static function config(): FilamentFlexibleContentBlockPagesConfig
+    public function config(): FilamentFlexibleContentBlockPagesConfig
     {
         return app(FilamentFlexibleContentBlockPagesConfig::class);
     }
+
+    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');
+    }
 }
diff --git a/src/Http/Controllers/PageController.php b/src/Http/Controllers/PageController.php
@@ -2,17 +2,16 @@
 
 namespace Statikbe\FilamentFlexibleContentBlockPages\Http\Controllers;
 
-use Artesaos\SEOTools\Facades\SEOTools;
 use Artesaos\SEOTools\Facades\SEOMeta;
-use Carbon\Carbon;
+use Artesaos\SEOTools\Facades\SEOTools;
 use Illuminate\Foundation\Validation\ValidatesRequests;
 use Illuminate\Http\Response;
 use Illuminate\Routing\Controller;
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Cache;
-use Illuminate\Support\Facades\Storage;
 use Mcamara\LaravelLocalization\Facades\LaravelLocalization;
 use Spatie\MediaLibrary\Conversions\ConversionCollection;
+use Spatie\MediaLibrary\MediaCollections\Models\Media;
 use Statikbe\FilamentFlexibleContentBlockPages\Facades\FilamentFlexibleContentBlockPages;
 use Statikbe\FilamentFlexibleContentBlockPages\Models\Page;
 use Statikbe\FilamentFlexibleContentBlockPages\Models\Settings;
@@ -22,10 +21,11 @@ class PageController extends Controller
     use ValidatesRequests;
 
     const CACHE_SEO_IMAGE_DIMENSIONS = 'seo_image_dimensions:%s';
+
     const CACHE_SEO_IMAGE_TTL = 60 * 60 * 8; // in seconds
-    const TEMPLATE_PATH = 'filament-flexible-content-block-pages::pages.';
 
-    // TODO make an abstract model with the table name to use as class to resolve in the route param
+    const TEMPLATE_PATH = 'filament-flexible-content-block-pages::pages.index';
+
     public function index(Page $page)
     {
         // check if page is published:
@@ -41,11 +41,41 @@ public function index(Page $page)
         $this->setSEOLocalisationAndCanonicalUrl();
         $this->setSEOImage($page);
 
-        return view(self::TEMPLATE_PATH.'index', [
+        return view(self::TEMPLATE_PATH, [
             'page' => $page,
         ]);
     }
 
+    public function homeIndex()
+    {
+        $page = Page::code(Page::HOME_PAGE)
+            ->firstOrFail();
+
+        return $this->index($page);
+    }
+
+    public function childIndex(Page $parent, Page $page)
+    {
+        // check if the page is a child of the parent
+        if (! $parent->isParentOf($page)) {
+            abort(Response::HTTP_NOT_FOUND);
+        }
+
+        // render the page with the regular page index function of the controller, or invoke the correct controller here:
+        return $this->index($page);
+    }
+
+    public function grandchildIndex(Page $grandparent, Page $parent, Page $page)
+    {
+        // check if the page is a child of the parent
+        if (! $parent->isParentOf($page) || ! $grandparent->isParentOf($parent)) {
+            abort(Response::HTTP_NOT_FOUND);
+        }
+
+        // render the page with the regular page index function of the controller, or invoke the correct controller here:
+        return $this->index($page);
+    }
+
     protected function getSEOTitlePostfix()
     {
         return sprintf(' | %s', flexiblePagesSetting(Settings::SETTING_SITE_TITLE));
@@ -98,37 +128,35 @@ protected function setBasicSEO(Page $page)
 
     protected function setSEOImage(Page $page)
     {
-        //TODO copy getSEOMedia in HasSEOAttributesTrait
         $seoMedia = $page->getFallbackImageMedia($page->SEOImage()->first(), $page->getSEOImageCollection());
         $seoUrl = null;
         $imageDimensions = null;
 
-        /*if ($seoMedia) {
+        // 1. try SEO image of the page
+        if ($seoMedia) {
             $seoUrl = $seoMedia->getUrl($page->getSEOImageConversionName());
             $imageDimensions = $this->getSEOImageDimensions($seoMedia, $page->getSEOImageConversionName());
-        } else if()
-            $seoUrl = $seoMedia->getUrl($page->getSEOImageConversionName());
-        $imageDimensions = $this->getSEOImageDimensions($seoMedia, $page->getSEOImageConversionName());
-            $this->setSEODefaultImage($page);
+        } else {
+            // 2. try the hero image of the page
+            $seoMedia = $page->getFallbackImageMedia($page->heroImage()->first(), $page->getHeroImageCollection());
+            if ($seoMedia) {
+                $seoUrl = $seoMedia->getUrl($page->getSEOImageConversionName());
+                $imageDimensions = $this->getSEOImageDimensions($seoMedia, $page->getSEOImageConversionName());
+            }
+
+            // 3. try the default SEO image in the settings
+            if (! $seoMedia || ! $seoUrl) {
+                /** @var Settings $settings */
+                $settings = FilamentFlexibleContentBlockPages::config()->getSettingsModel()::getSettings();
+                $seoMedia = $settings->getFallbackImageMedia($settings->defaultSeoImage()->first(), $settings::COLLECTION_DEFAULT_SEO);
+                $seoUrl = $seoMedia->getUrl($settings::CONVERSION_DEFAULT_SEO);
+                $imageDimensions = $this->getSEOImageDimensions($seoMedia, $settings::CONVERSION_DEFAULT_SEO);
+            }
         }
 
-        if($seoUrl && $imageDimensions) {
+        if ($seoUrl && $imageDimensions) {
             SEOTools::opengraph()->addImage($seoUrl, $imageDimensions);
             SEOTools::twitter()->addValue('image', $seoUrl);
-        }*/
-    }
-
-    protected function setSEODefaultImage(Page $page)
-    {
-        $defaultSeoImage = flexiblePagesSettingImageUrl(Settings::COLLECTION_DEFAULT_SEO, Settings::CONVERSION_DEFAULT_SEO);
-        // $test = Storage::get($defaultSeoImage);
-        if ($defaultSeoImage && trim($defaultSeoImage) != '') {
-            $seoParams = $this->getSEOImageDimensions($defaultSeoImage, true);
-            $this->setSEOImage($defaultSeoImage, $seoParams);
-        } else {
-            $imageUrl = $page->getHeroImageUrl($page->getSEOImageConversionName());
-            $seoParams = $this->getSEOImageDimensions($imageUrl, true);
-            $this->setSEOImage($imageUrl, $seoParams);
         }
     }
 
@@ -143,7 +171,7 @@ protected function getSEOImageDimensions(Media $seoMedia, string $conversion)
 
         return Cache::remember($cacheKey,
             self::CACHE_SEO_IMAGE_TTL,
-            function() use ($seoMedia, $conversion) {
+            function () use ($seoMedia, $conversion) {
                 $conversionCollection = ConversionCollection::createForMedia($seoMedia);
                 $conversion = $conversionCollection->getByName($conversion);
 
diff --git a/src/Listeners/SlugChangedListener.php b/src/Listeners/SlugChangedListener.php
@@ -2,9 +2,9 @@
 
 namespace Statikbe\FilamentFlexibleContentBlockPages\Listeners;
 
+use Illuminate\Http\Response;
 use Statikbe\FilamentFlexibleContentBlockPages\Models\Page;
 use Statikbe\FilamentFlexibleContentBlockPages\Models\Redirect;
-use Illuminate\Http\Response;
 use Statikbe\FilamentFlexibleContentBlocks\Events\SlugChanged;
 
 /**
@@ -14,31 +14,30 @@ class SlugChangedListener
 {
     public function handle(SlugChanged $event): void
     {
-        //add redirect:
-        if($event->recordWasPublished) {
-            foreach ($event->changedSlugs as $changedSlug){
+        // add redirect:
+        if ($event->recordWasPublished) {
+            foreach ($event->changedSlugs as $changedSlug) {
                 $oldUrl = null;
                 $newUrl = null;
 
-                if($changedSlug['newSlug'] && !empty(trim($changedSlug['newSlug']))) {
+                if ($changedSlug['newSlug'] && ! empty(trim($changedSlug['newSlug']))) {
                     if ($event->record instanceof Page) {
 
                         $oldUrl = $this->getUrl($event->record, $changedSlug['locale'], $changedSlug['oldSlug']);
                         $newUrl = $this->getUrl($event->record, $changedSlug['locale'], $changedSlug['newSlug']);
                     }
                 }
 
-
-                if($newUrl && $oldUrl){
+                if ($newUrl && $oldUrl) {
                     $oldUrlPath = parse_url($oldUrl, PHP_URL_PATH);
                     $newUrlPath = parse_url($newUrl, PHP_URL_PATH);
 
                     $redirectDoesNotExist = Redirect::where('old_url', $oldUrlPath)
                         ->where('new_url', $newUrlPath)
                         ->notExists();
 
-                    if($redirectDoesNotExist) {
-                        $redirect = new Redirect();
+                    if ($redirectDoesNotExist) {
+                        $redirect = new Redirect;
                         $redirect->old_url = $oldUrlPath;
                         $redirect->new_url = $newUrlPath;
                         $redirect->status_code = Response::HTTP_MOVED_PERMANENTLY;
diff --git a/src/Models/Page.php b/src/Models/Page.php
@@ -45,6 +45,8 @@ class Page extends Model implements HasCode, HasContentBlocks, HasHeroImageAttri
     use HasTranslatedSEOAttributesTrait;
     use HasTranslatedSlugAttributeTrait;
 
+    const HOME_PAGE = 'HOME';
+
     public function getTable()
     {
         return FilamentFlexibleContentBlockPages::config()->getPagesTable();
diff --git a/src/Models/Settings.php b/src/Models/Settings.php
diff --git a/src/Resources/SettingsResource.php b/src/Resources/SettingsResource.php

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,8 @@ class Page extends Model implements HasCode, HasContentBlocks, HasHeroImageAttri`
`45`	`45`	`use HasTranslatedSEOAttributesTrait;`
`46`	`46`	`use HasTranslatedSlugAttributeTrait;`
`47`	`47`
	`48`	`+ const HOME_PAGE = 'HOME';`
	`49`	`+`
`48`	`50`	`public function getTable()`
`49`	`51`	`{`
`50`	`52`	`return FilamentFlexibleContentBlockPages::config()->getPagesTable();`