cms-multi / filament-clear-cache

Easily clear your Laravel cache from within Filament admin
MIT License
43 stars 5 forks source link
cache clear-cache filament filamentphp laravel laravel-package livewire php

Filament Clear Cache

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

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

Filament Admin Toolbar Header

Compatibility

Plugin Version Filament Version PHP Version
1.x 2.x > 8.0
2.x 3.x > 8.1

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(),
        ])
}

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

License

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