configurable routing + documentation

Author: sten

README.md

@@ -1,13 +1,18 @@
-# A simple document and image manager for the Filament Flexible Blocks package.
+# Laravel Filament Flexible Blocks Asset Manager
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/statik-be/laravel-filament-flexible-blocks-asset-manager.svg?style=flat-square)](https://packagist.org/packages/statik-be/laravel-filament-flexible-blocks-asset-manager)
 [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/statik-be/laravel-filament-flexible-blocks-asset-manager/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/statik-be/laravel-filament-flexible-blocks-asset-manager/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/statik-be/laravel-filament-flexible-blocks-asset-manager/fix-php-code-styling.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/statik-be/laravel-filament-flexible-blocks-asset-manager/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/statik-be/laravel-filament-flexible-blocks-asset-manager.svg?style=flat-square)](https://packagist.org/packages/statik-be/laravel-filament-flexible-blocks-asset-manager)
 
+This package provides a simple document and image manager for the [Laravel Filament Flexible Content Blocks](https://github.com/statikbe/laravel-filament-flexible-content-blocks) package.
 
+The key features are:
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+- a simple asset model 
+- integration with the call-to-action features of the [Laravel Filament Flexible Content Blocks](https://github.com/statikbe/laravel-filament-flexible-content-blocks) package.
+- basic filament CRUD UI
+- routing to retrieve the assets
 
 ## Installation
 
@@ -30,31 +35,55 @@ You can publish the config file with:
 php artisan vendor:publish --tag="laravel-filament-flexible-blocks-asset-manager-config"
 ```
 
-Optionally, you can publish the views using
+Optionally, you can publish the translations using
 
 ```bash
-php artisan vendor:publish --tag="laravel-filament-flexible-blocks-asset-manager-views"
+php artisan vendor:publish --tag="laravel-filament-flexible-blocks-asset-manager-translations"
 ```
 
-This is the contents of the published config file:
+### Setup with the Filament Flexible Content Blocks package
+
+To integrate the plugin with Filament, you need to add it a panel in the filament service provider. See the code sample below:
 
 ```php
-return [
-];
+public function panel(Panel $panel): Panel
+{
+    return $panel
+        ->default()
+        //...
+        ->plugins([
+            SpatieLaravelTranslatablePlugin::make()
+                ->defaultLocales(['nl']),
+            //...
+            FilamentFlexibleBlocksAssetManagerPlugin::make()
+        ]);
+}
 ```
 
-## Usage
+Then to use the asset manager in the call-to-actions you have to add them to the configuration of the Filament Flexible 
+Content Blocks package:
 
 ```php
-$laravelFilamentFlexibleBlocksAssetManager = new Statikbe\LaravelFilamentFlexibleBlocksAssetManager();
-echo $laravelFilamentFlexibleBlocksAssetManager->echoPhrase('Hello, Statikbe!');
+return [
+    //...
+     
+    'call_to_action_models' => [
+        [
+            'model' => \Statikbe\FilamentFlexibleBlocksAssetManager\Models\Asset::class,
+            'call_to_action_type' => \Statikbe\FilamentFlexibleBlocksAssetManager\Filament\Form\Fields\Blocks\Type\AssetCallToActionType::class,
+        ],
+        //...
+        //\App\Models\TranslatablePage::class,
+    ],
+        
+    //...
+]
 ```
 
-## Testing
+## Configuration
 
-```bash
-composer test
-```
+The configuration file is [filament-flexible-blocks-asset-manager.php](config%2Ffilament-flexible-blocks-asset-manager.php)
+fully commented, to explain each configuration option.
 
 ## Changelog
 

config/filament-flexible-blocks-asset-manager.php

@@ -98,5 +98,15 @@
     'asset_authorisation' => [
         //'gate' => 'asset-access',
         //'policy' => AssetPolicy::class,
-    ]
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Asset route prefix
+    |--------------------------------------------------------------------------
+    |
+    | You can change the start of the route path by setting this config.
+    | Do not add a slash as the last character this will be added automatically.
+    */
+    'asset_route_prefix' => '/asset'
 ];

routes/filament-flexible-blocks-asset-manager.php

@@ -1,9 +1,14 @@
 <?php
 
 use Illuminate\Support\Facades\Route;
+use Illuminate\Support\Str;
+use Statikbe\FilamentFlexibleBlocksAssetManager\FilamentFlexibleBlocksAssetManagerConfig;
 use Statikbe\FilamentFlexibleBlocksAssetManager\Http\Controllers\AssetController;
 
 
-Route::get('/asset/{asset}/{locale?}', [AssetController::class, 'index'])
+$assetRoutePrefix = FilamentFlexibleBlocksAssetManagerConfig::getAssetRoutePrefix();
+$assetRoutePrefix = Str::replaceEnd('/', '', $assetRoutePrefix);
+
+Route::get("$assetRoutePrefix/{asset}/{locale?}", [AssetController::class, 'index'])
     ->middleware(['web'])
     ->name('filament-flexible-blocks-asset-manager.asset_index');

src/FilamentFlexibleBlocksAssetManagerConfig.php

@@ -6,46 +6,56 @@ class FilamentFlexibleBlocksAssetManagerConfig
 {
     public static function hasTranslatableAssets(): bool
     {
-        return config('filament-flexible-blocks-asset-manager.translatable_assets', false);
+        return self::getConfig('translatable_assets', false);
     }
 
     public static function getAssetAuthorisationGate(): ?string
     {
-        return config('filament-flexible-blocks-asset-manager.asset_authorisation.gate');
+        return self::getConfig('asset_authorisation.gate');
     }
 
     public static function getAssetAuthorisationPolicy(): ?string
     {
-        return config('filament-flexible-blocks-asset-manager.asset_authorisation.policy');
+        return self::getConfig('asset_authorisation.policy');
     }
 
     public static function getStorageDisk(): ?string
     {
-        return config('filament-flexible-blocks-asset-manager.storage_disk');
+        return self::getConfig('storage_disk');
     }
 
     public static function getStorageDirectory(): ?string
     {
-        return config('filament-flexible-blocks-asset-manager.storage_directory');
+        return self::getConfig('storage_directory');
     }
 
     public static function getStorageVisibility(): ?string
     {
-        return config('filament-flexible-blocks-asset-manager.storage_visibility') ?? 'public';
+        return self::getConfig('storage_visibility') ?? 'public';
     }
 
     public static function getAcceptedFileTypes(): array
     {
-        return config('filament-flexible-blocks-asset-manager.accepted_file_types') ?? [];
+        return self::getConfig('accepted_file_types') ?? [];
     }
 
     public static function getImageEditor(): array|null
     {
-        return config('filament-flexible-blocks-asset-manager.image_editor', null);
+        return self::getConfig('image_editor', null);
     }
 
     public static function getNavigationGroup(): ?string
     {
-        return config('filament-flexible-blocks-asset-manager.navigation_group');
+        return self::getConfig('navigation_group');
+    }
+
+    public static function getAssetRoutePrefix(): ?string
+    {
+        return self::getConfig('asset_route_prefix', '/asset');
+    }
+
+    public static function getConfig($key = null, $default = null)
+    {
+        return config('filament-flexible-blocks-asset-manager.' . $key, $default);
     }
 }

src/Models/Asset.php

@@ -10,11 +10,12 @@
 use Spatie\Translatable\HasTranslations;
 use Statikbe\FilamentFlexibleContentBlocks\Models\Concerns\HasTranslatedMediaTrait;
 use Statikbe\FilamentFlexibleContentBlocks\Models\Contracts\HasTranslatableMedia;
+use Statikbe\FilamentFlexibleContentBlocks\Models\Contracts\Linkable;
 
 /**
  * @property string $name
  */
-class Asset extends Model implements HasMedia, HasTranslatableMedia
+class Asset extends Model implements HasMedia, HasTranslatableMedia, Linkable
 {
     use HasTranslations;
     use InteractsWithMedia;
@@ -44,8 +45,16 @@ public function getAssetCollection(): string
         return self::MEDIA_COLLECTION_ASSETS;
     }
 
-    /*public function getMorphClass(): string
+    public function getViewUrl(?string $locale = null): string
     {
-        return 'filament-flexible-blocks-asset-manager::asset';
-    }*/
+        return route('filament-flexible-blocks-asset-manager.asset_index', [
+            'asset' => $this,
+            'locale' => $locale,
+        ]);
+    }
+
+    public function getPreviewUrl(?string $locale = null): string
+    {
+        $this->getViewUrl($locale);
+    }
 }