README

Add a button to easily clear the cache from your filament admin.

Compatibility

Installation

You can install the package via composer:

composer require cms-multi/filament-clear-cache

Configuration

You can publish the configuration with:

php artisan vendor:publish --provider="CmsMulti\FilamentClearCache\FilamentClearCacheServiceProvider"

Registering the plugin

use CmsMulti\FilamentClearCache\FilamentClearCachePlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentClearCachePlugin::make(),
        ])
}

Conditionally enabling the plugin

You can restrict the plugin to specific environments using the enabled() method:

use CmsMulti\FilamentClearCache\FilamentClearCachePlugin;
use Illuminate\Support\Facades\App;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentClearCachePlugin::make()
                ->enabled(App::environment(['local', 'staging'])),
        ])
}

When disabled, the clear cache button will not be rendered.

Customizing

Under the hood optimize:clear is called after clicking the trash button.

You may register any custom commands from inside the boot() method of your Service Provider:

use CmsMulti\FilamentClearCache\Facades\FilamentClearCache;

public function boot()
{
    FilamentClearCache::addCommand('page-cache:clear');
}

To increment the button count call Livewire event clearCacheIncrement.

// Livewire v2
$this->emit('clearCacheIncrement');

// Livewire v3+
$this->dispatch('clearCacheIncrement')->to(\CmsMulti\FilamentClearCache\Http\Livewire\ClearCache::class);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• howdu
• All Contributors

License

The MIT License (MIT). Please see License File for more information.