Filament Queue Management

https://github.com/jeffersongoncalves/filament-queue-management
Admin
Filament Queue Management is a Filament plugin to monitor, retry, and prune Laravel database queue...
Tokens:1,302
Snippets:11
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Filament Queue Management via Composer

Source: https://github.com/jeffersongoncalves/filament-queue-management/blob/3.x/README.md

Installs the Filament Queue Management plugin via Composer. The core package jeffersongoncalves/laravel-queue-management is pulled in automatically.

```bash
composer require jeffersongoncalves/filament-queue-management:"^3.0"
```

--------------------------------

### Publish Filament Queue Management Config

Source: https://github.com/jeffersongoncalves/filament-queue-management/blob/3.x/README.md

Publishes the plugin's configuration file. Run this after installation to customize the plugin settings.

```bash
php artisan vendor:publish --tag="filament-queue-management-config"
```

--------------------------------

### Plugin configuration file

Source: https://github.com/jeffersongoncalves/filament-queue-management/blob/3.x/README.md

Configuration file for the plugin. The 'group' key defaults to null, which translates to "Queue Management". The 'sort' key is also null by default. Each resource has a slug and navigation icon.

```php
return [
    'navigation' => [
        'group' => null, // null => translated "Queue Management"
        'sort' => null,
    ],
    'resources' => [
        'jobs' => [
            'slug' => 'jobs',
            'navigation_icon' => 'heroicon-o-queue-list',
        ],
        'failed_jobs' => [
            'slug' => 'failed-jobs',
            'navigation_icon' => 'heroicon-o-exclamation-triangle',
        ],
        'job_batches' => [
            'slug' => 'job-batches',
            'navigation_icon' => 'heroicon-o-rectangle-stack',
        ],
    ],
];
```

--------------------------------

### Run tests with composer test

Source: https://github.com/jeffersongoncalves/filament-queue-management/blob/3.x/README.md

Runs the test suite for the package using Composer. This is the standard command for executing tests in a PHP project.

```bash
composer test
```

--------------------------------

### Register FilamentQueueManagementPlugin in panel

Source: https://github.com/jeffersongoncalves/filament-queue-management/blob/3.x/README.md

Register the FilamentQueueManagementPlugin in a Filament panel. All fluent methods are optional and return $this for chaining. If the plugin is not registered, resources are discovered automatically and configuration is read from the published config file.

```php
use Filament\Panel;
use JeffersonGoncalves\Filament\QueueManagement\FilamentQueueManagementPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentQueueManagementPlugin::make()
                ->navigationGroup('Queue Management')   // null => translated default label
                ->navigationSort(99)
                ->jobsSlug('jobs')
                ->failedJobsSlug('failed-jobs')
                ->jobBatchesSlug('job-batches')
                ->jobsNavigationIcon('heroicon-o-queue-list')
                ->failedJobsNavigationIcon('heroicon-o-exclamation-triangle')
                ->jobBatchesNavigationIcon('heroicon-o-rectangle-stack'),
        ]);
}
```
Tokens:
Raw