feat: datatable as route action

Author: ejgandelaberon

src/Services/DataTable.php

@@ -151,6 +151,11 @@ abstract class DataTable implements DataTableButtons
      */
     protected string $pdfWriter = 'Dompdf';
 
+    /**
+     * @phpstan-var view-string|null
+     */
+    protected ?string $view = null;
+
     public function __construct()
     {
         /** @var Request $request */
@@ -163,6 +168,11 @@ public function __construct()
         $this->htmlBuilder = $builder;
     }
 
+    public function __invoke(): mixed
+    {
+        return $this->render($this->view, $this->viewData(), $this->viewMergeData());
+    }
+
     /**
      * Process dataTables needed render output.
      *
@@ -742,4 +752,20 @@ protected function buildFastExcelFile(): FastExcel
 
         return (new FastExcel($dataTable->toArray()['data']))->setColumnStyles($styles);
     }
+
+    /**
+     * @return array<string, mixed>
+     */
+    protected function viewData(): array
+    {
+        return [];
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    protected function viewMergeData(): array
+    {
+        return [];
+    }
 }

tests/DataTableServiceTest.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Foundation\Testing\DatabaseTransactions;
 use Illuminate\Http\Response;
+use Illuminate\Routing\Router;
 use Illuminate\Support\Collection;
 use PHPUnit\Framework\Attributes\Test;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
@@ -95,6 +96,23 @@ public function it_is_macroable(): void
         $this->assertEquals('macro', $dataTable->macroMethod());
     }
 
+    #[Test]
+    public function it_can_be_used_as_route_action(): void
+    {
+        /** @var Router|null $router */
+        $router = $this->app['router'] ?? null;
+        $router?->get('datatables-as-route-action', UsersDataTable::class);
+
+        $this->get('datatables-as-route-action')
+            ->assertSeeText('LaravelDataTables')
+            ->assertSeeText('This is a test description');
+
+        // Assert that view data are not present when manually calling render
+        $this->get('users')
+            ->assertSeeText('DataTable')
+            ->assertSeeText('No description');
+    }
+
     protected function setUp(): void
     {
         parent::setUp();

tests/DataTables/UsersDataTable.php

@@ -10,6 +10,8 @@
 
 class UsersDataTable extends DataTable
 {
+    protected ?string $view = 'tests::users';
+
     public function dataTable(Builder $query): EloquentDataTable
     {
         return (new EloquentDataTable($query))
@@ -36,4 +38,12 @@ protected function filename(): string
     {
         return 'Users';
     }
+
+    protected function viewData(): array
+    {
+        return [
+            'title' => 'LaravelDataTables',
+            'description' => 'This is a test description',
+        ];
+    }
 }

tests/views/users.blade.php

@@ -1,3 +1,7 @@
-{{ $dataTable->table() }}
+<h2>{{ $title ?? 'DataTable' }}</h2>
+<p>{{ $description ?? 'No description' }}</p>
+<div>
+    {{ $dataTable->table() }}
+</div>
 
-{{ $dataTable->scripts() }}
+{{ $dataTable->scripts() }}