Filament Curator

Curator uses Path Generators to determine where files are stored. You can set these globally in the config or per instance on a CuratorPicker field.

Built-in Generators:

• DefaultPathGenerator: Saves in disk/directory.
• DatePathGenerator: Saves in disk/directory/Y/m/d.
• UserPathGenerator: Saves in disk/directory/user-auth-identifier.

Custom Generator: Implement the PathGenerator interface to create your own logic.

use Awcodes\Curator\PathGenerators\DatePathGenerator;
use Awcodes\Curator\PathGenerators; // For interface

// Per instance
CuratorPicker::make('image')->pathGenerator(DatePathGenerator::class);

// Custom implementation
class CustomPathGenerator implements PathGenerator
{
    public function getPath(?string $baseDir = null): string
    {
        return ($baseDir ? $baseDir . '/' : '') . 'my/custom/path';
    }
}

To use Curator within Filament Panels, you must add the CuratorPlugin to your panel's configuration. This registers the plugin's resources. Most methods are optional and will fall back to the configuration file if not explicitly provided.

use Awcodes\Curator\CuratorPlugin;
use Filament\Support\Icons\Heroicon

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            CuratorPlugin::make()
                ->label('Media')
                ->pluralLabel('Media')
                ->navigationIcon(Heroicon::OutlinedPhoto)
                ->navigationGroup('Content')
                ->navigationSort(3)
                ->showBadge(true) 
                ->registerNavigation(true)
                ->curations(true)
                ->fileSwap(true),  
        ]);
}

If you are using Filament Panels and have not set up a custom theme, you must follow the Filament Docs first.

Once a custom theme is established, add the plugin's views and styles to your theme CSS file (or your app's CSS file if using standalone packages) using @import and @source directives.

@import '../../../../vendor/awcodes/filament-curator/resources/css/plugin.css';

@source '../../../../vendor/awcodes/filament-curator/**/*.blade.php';

Global settings for Curator can be managed via a published configuration file. Use the following command to publish the config to your application:

php artisan vendor:publish --tag="curator-config"

If you are using the stand-alone forms package instead of Filament Panels, you must manually include the Curator modal in your layout file. It is recommended to place this component before the closing </body> tag.

<x-curator::modals.modal />

If your media is stored on a cloud disk, you must configure the Glide server to use the correct Flysystem driver.

Critical Configuration Notes:

• source: Must point to the cloud disk's Flysystem driver.
• source_path_prefix: Usually an empty string '' for cloud disks because the driver is already rooted at the bucket. A mismatched prefix is the most common cause of broken images.
• cache: Keep this on a fast local disk to avoid repeated cloud requests.

use Awcodes\Curator\Facades\Glide;
use Illuminate\Support\Facades\Storage;

Glide::serverConfig([
    'response' => new LaravelResponseFactory(app('request')),
    'source' => Storage::disk('s3')->getDriver(),
    'source_path_prefix' => '', 
    'cache' => Storage::disk('local')->getDriver(),
    'cache_path_prefix' => '.cache',
    'max_image_size' => 2000 * 2000,
]);

Curator supports both single and multiple media relationships.

Single Relationship

Form:

CuratorPicker::make('featured_image_id')->relationship('featured_image', 'id')

Model:

public function featuredImage(): BelongsTo
{
    return $this->belongsTo(Media::class, 'featured_image_id', 'id');
}

Multiple Relationship

Form:

CuratorPicker::make('product_picture_ids')
    ->multiple()
    ->relationship('product_pictures', 'id')
    ->orderColumn('order')

Model:

public function productPictures(): BelongsToMany
{
    return $this->belongsToMany(Media::class, 'media_post', 'post_id', 'media_id')
        ->withPivot('order')
        ->orderBy('order');
}

You can extend the default Media model and tell Curator to use your custom class via the configuration file.

use Awcodes\Curator\Models\Media;

class CustomMedia extends Media
{
    protected $table = 'media';
}

// In config/curator.php
'model' => \App\Models\Cms\Media::class,

To upgrade to Curator v4, your environment must meet the following minimum requirements:

• PHP: 8.2 or higher
• Laravel: 11.28 or higher (required by Filament 4)
• Filament: 4.0 or higher
• Tailwind CSS: 4.0 or higher