nova-kit / nova-queued-export-as-csv
Laravel Nova's Queued Export As CSV Action
v1.5.0
2024-10-10 06:29 UTC
Requires
- php: ^7.3 || ^8.0
- composer-runtime-api: ^2.2
- illuminate/support: ^8.83.4 || ^9.51 || ^10.0 || ^11.0
- laravel/serializable-closure: ^1.0
- laravie/serialize-queries: ^2.0 || ^3.0
- symfony/polyfill-php83: ^1.28
Requires (Dev)
- guzzlehttp/guzzle: ^7.2
- larastan/larastan: ^2.4
- laravel/nova: *
- nova-kit/nova-devtool: ^1.3
- orchestra/testbench: ^7.40 || ^8.21 || ^9.0
- phpunit/phpunit: ^9.6 || ^10.1
README
Installation
To install through composer, run the following command from terminal:
composer require "nova-kit/nova-queued-export-as-csv"
Usages
You can replace Laravel\Nova\Actions\ExportAsCsv
with NovaKit\NovaQueuedExportAsCsv\Actions\QueuedExportAsCsv
:
use Laravel\Nova\Actions\ExportAsCsv; use NovaKit\NovaQueuedExportAsCsv\Actions\QueuedExportAsCsv; /** * Get the actions available for the resource. * * @param \Laravel\Nova\Http\Requests\NovaRequest $request * @return array */ public function actions(NovaRequest $request) { return [ QueuedExportAsCsv::make(), ]; }
If you would like to change the storage disk to store the CSV file that is available for download, you may invoke the withStorageDisk()
method when registering the action:
return [ QueuedExportAsCsv::make()->withStorageDisk('s3'), ];
You can also customise the response message by using the following code:
use Laravel\Nova\Actions\Action; use NovaKit\NovaQueuedExportAsCsv\Actions\QueuedExportAsCsv; return [ QueuedExportAsCsv::make()->then(function () { return response()->json(Action::message('Action has been queued!')); }), ];
In order to handle the stored CSV, you need to listen to NovaKit\NovaQueuedExportAsCsv\Events\QueuedCsvExported
event, as an example you can broadcast to Nova's Notification using the following listener class:
<?php namespace App\Listeners; use Illuminate\Contracts\Queue\ShouldQueue; use Illuminate\Queue\InteractsWithQueue; use Illuminate\Support\Facades\Storage; use Laravel\Nova\Notifications\NovaNotification; use Laravel\Nova\URL; use NovaKit\NovaQueuedExportAsCsv\Events\QueuedCsvExported; class NotifyCsvExported { /** * Handle the event. * * @param \NovaKit\NovaQueuedExportAsCsv\Events\QueuedCsvExported $event * @return void */ public function handle(QueuedCsvExported $event) { $event->user->notify( NovaNotification::make() ->message('Your CSV is ready to download.') ->action('Download', URL::remote(Storage::disk($event->storageDisk)->url($event->filename))) ->icon('download') ->type('info') ); } }