DataTables feature (#29)

Author: pascalbaljet

app/app/Http/Controllers/TableController.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\Models\User;
+use ProtoneMedia\Splade\SpladeTable;
+
+class TableController
+{
+    public function custom()
+    {
+        $users = User::query()->orderBy('name')->paginate(10);
+
+        return view('table.custom', [
+            'users' => SpladeTable::for($users)
+                ->column('name')
+                ->column('email')
+                ->column('actions'),
+        ]);
+    }
+
+    public function rowLink()
+    {
+        $users = User::query()->orderBy('name')->paginate(10);
+
+        return view('table.users', [
+            'users' => SpladeTable::for($users)
+                ->defaultSort('name')
+                ->rowLink(fn (User $user) => route('navigation.one', ['id' => $user->id]))
+                ->column('name')
+                ->column('email')
+                ->column('actions'),
+        ]);
+    }
+}

app/app/Http/UserTableView.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace App\Http;
+
+use App\Models\User;
+use Illuminate\Support\Collection;
+use ProtoneMedia\Splade\SpladeTable;
+use Spatie\QueryBuilder\AllowedFilter;
+use Spatie\QueryBuilder\QueryBuilder;
+
+class UserTableView
+{
+    public function __invoke($paginateMethod)
+    {
+        $globalSearch = AllowedFilter::callback('global', function ($query, $value) {
+            $query->where(function ($query) use ($value) {
+                Collection::wrap($value)->each(function ($value) use ($query) {
+                    $query
+                        ->orWhere('name', 'LIKE', "%{$value}%")
+                        ->orWhere('email', 'LIKE', "%{$value}%");
+                });
+            });
+        });
+
+        $users = QueryBuilder::for(User::query())
+            ->defaultSort('name')
+            ->allowedSorts(['name', 'email', 'language_code'])
+            ->allowedFilters(['name', 'email', 'language_code', $globalSearch])
+            ->{$paginateMethod}(request()->query('perPage', 10))
+            ->withQueryString();
+
+        return view('table.users', [
+            'users' => SpladeTable::for($users)
+                ->withGlobalSearch()
+                ->defaultSort('name')
+                ->column(key: 'name', searchable: true, sortable: true, canBeHidden: false)
+                ->column(key: 'email', searchable: true, sortable: true)
+                ->column(key: 'language_code', label: 'Language')
+                ->column(label: 'Actions')
+                ->selectFilter(key: 'language_code', options: [
+                    'en' => 'English',
+                    'nl' => 'Dutch',
+                ], label: 'Language'),
+        ]);
+    }
+}

app/composer.json

@@ -14,7 +14,8 @@
         "laravel/framework": "^9.19",
         "laravel/sanctum": "^2.14.1",
         "laravel/tinker": "^2.7",
-        "pusher/pusher-php-server": "^7.0"
+        "pusher/pusher-php-server": "^7.0",
+        "spatie/laravel-query-builder": "^5.0"
     },
     "require-dev": {
         "fakerphp/faker": "^1.9.1",

app/database/factories/UserFactory.php

@@ -23,6 +23,7 @@ public function definition()
             'email_verified_at' => now(),
             'password'          => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password
             'remember_token'    => Str::random(10),
+            'language_code'     => fake()->randomElement(['en', 'nl']),
         ];
     }
 

app/database/migrations/2014_10_12_000000_create_users_table.php

@@ -19,6 +19,7 @@ public function up()
             $table->string('email')->unique();
             $table->timestamp('email_verified_at')->nullable();
             $table->string('password');
+            $table->string('language_code');
             $table->rememberToken();
             $table->timestamps();
         });

app/database/seeders/DatabaseSeeder.php

@@ -17,5 +17,7 @@ public function run()
             'name'  => 'Test User',
             'email' => '[email protected]',
         ]);
+
+        \App\Models\User::factory()->count(99)->create();
     }
 }