Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cms-multi/filament-clear-cache
Easily clear your Laravel cache from within Filament admin
https://github.com/cms-multi/filament-clear-cache
cache clear-cache filament filamentphp laravel laravel-package livewire php
Last synced: about 2 months ago
JSON representation
Easily clear your Laravel cache from within Filament admin
- Host: GitHub
- URL: https://github.com/cms-multi/filament-clear-cache
- Owner: cms-multi
- License: mit
- Created: 2022-12-21T13:13:30.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T03:18:37.000Z (8 months ago)
- Last Synced: 2024-05-02T04:06:33.924Z (8 months ago)
- Topics: cache, clear-cache, filament, filamentphp, laravel, laravel-package, livewire, php
- Language: PHP
- Homepage:
- Size: 129 KB
- Stars: 32
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Filament Clear Cache
[](https://packagist.org/packages/cms-multi/filament-clear-cache)
[](https://github.com/cms-multi/filament-clear-cache/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/cms-multi/filament-clear-cache/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/cms-multi/filament-clear-cache)
Add a button to easily clear the cache from your filament admin.
#### Compatibility
| Plugin Version | Filament Version | PHP Version |
|----------------|-----------------|-------------|
| [1.x](https://github.com/cms-multi/filament-clear-cache/tree/1.x) | 2.x | \> 8.0 |
| [2.x](https://github.com/cms-multi/filament-clear-cache/tree/2.x) | 3.x | \> 8.1 |
## Installation
You can install the package via composer:
```bash
composer require cms-multi/filament-clear-cache
```
## Configuration
You can publish the configuration with:
```shell
php artisan vendor:publish --provider="CmsMulti\FilamentClearCache\FilamentClearCacheServiceProvider"
```
### Registering the plugin
```php
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:
```php
use CmsMulti\FilamentClearCache\Facades\FilamentClearCache;
public function boot()
{
FilamentClearCache::addCommand('page-cache:clear');
}
```
To increment the button count call Livewire event `clearCacheIncrement`.
```php
// Livewire v2
$this->emit('clearCacheIncrement');
// Livewire v3
$this->dispatch('clearCacheIncrement')->to(\CmsMulti\FilamentClearCache\Http\Livewire\ClearCache::class);
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [howdu](https://github.com/cms-multi)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.