Add implicit queued exports

Author: patrickbrouwers

docs/export/queued.md

@@ -27,6 +27,31 @@ return (new InvoicesExport)->queue('invoices.xlsx');
 Behind the scenes the query will be chunked and multiple jobs will be chained. These jobs will be executed in the correct order,
 and will only execute if non of the previous have failed. 
 
+### Implicit Export queueing
+
+You can also mark an export implicitly as a queued export. You can do this by using Laravel's `ShouldQueue` contract.
+
+```php
+namespace App\Exports;
+
+class InvoicesExport implements FromQuery, ShouldQueue
+{
+    use Exportable;
+
+    public function query()
+    {
+        return Invoice::query();
+    }
+}
+```
+
+In your controller you can now call the normal `->store()` method. 
+Based on the presence of the `ShouldQueue` contract, the export will be queued.
+
+```php
+return (new InvoicesExport)->store('invoices.xlsx');
+```
+
 ### Appending jobs
 
 The `queue()` method returns an instance of Laravel's `PendingDispatch`. This means you can chain extra jobs.

src/Concerns/Exportable.php

@@ -32,7 +32,7 @@ public function download(string $fileName = null, string $writerType = null)
      * @param string|null $writerType
      *
      * @throws InvalidArgumentException
-     * @return bool
+     * @return bool|PendingDispatch
      */
     public function store(string $filePath = null, string $disk = null, string $writerType = null)
     {

src/Excel.php

@@ -2,6 +2,7 @@
 
 namespace Maatwebsite\Excel;
 
+use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Filesystem\FilesystemManager;
 use Illuminate\Contracts\Routing\ResponseFactory;
 
@@ -82,6 +83,10 @@ public function download($export, string $fileName, string $writerType = null)
      */
     public function store($export, string $filePath, string $disk = null, string $writerType = null)
     {
+        if ($export instanceof ShouldQueue) {
+            return $this->queue($export, $filePath, $disk, $writerType);
+        }
+
         $file = $this->export($export, $filePath, $writerType);
 
         return $this->filesystem->disk($disk)->put($filePath, fopen($file, 'r+'));

tests/Data/Stubs/ShouldQueueExport.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Maatwebsite\Excel\Tests\Data\Stubs;
+
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Maatwebsite\Excel\Concerns\Exportable;
+use Maatwebsite\Excel\Concerns\WithMultipleSheets;
+
+class ShouldQueueExport implements WithMultipleSheets, ShouldQueue
+{
+    use Exportable;
+
+    /**
+     * @return SheetWith100Rows[]
+     */
+    public function sheets(): array
+    {
+        return [
+            new SheetWith100Rows('A'),
+            new SheetWith100Rows('B'),
+            new SheetWith100Rows('C'),
+        ];
+    }
+}

tests/QueuedExportTest.php

@@ -4,6 +4,7 @@
 
 use Maatwebsite\Excel\Tests\Data\Stubs\QueuedExport;
 use Maatwebsite\Excel\Tests\Data\Stubs\AfterQueueExportJob;
+use Maatwebsite\Excel\Tests\Data\Stubs\ShouldQueueExport;
 
 class QueuedExportTest extends TestCase
 {
@@ -30,4 +31,16 @@ public function can_queue_an_export_and_store_on_different_disk()
             new AfterQueueExportJob(__DIR__ . '/Data/Disks/Test/queued-export.xlsx'),
         ]);
     }
+
+    /**
+     * @test
+     */
+    public function can_implicitly_queue_an_export()
+    {
+        $export = new ShouldQueueExport();
+
+        $export->store('queued-export.xlsx', 'test')->chain([
+            new AfterQueueExportJob(__DIR__ . '/Data/Disks/Test/queued-export.xlsx'),
+        ]);
+    }
 }