¶Pendahuluan
Pada project kali ini kita akan menggunakan sebuah package yang sangat powerfull yang bernama laravel permission dari spatie, laravel spatie nantinya akan kita gunakan untuk mengatur roles dan permissions didalam project kita.
¶Installasi Laravel Permission Spatie
Silahkan teman-teman buka terminal-nya, kemudian jalankan perintah berikut ini :
Terminal
composer require spatie/laravel-permission:6.4.0
Silahkan tunggu proses installasi-nya sampai selesai. Dan pastikan teman-teman terhubung dengan internet, karena paket ini akan diinstall secara online.
¶Publish Konfigurasi Laravel Permission
Setelah proses installasi selesai dilakukan, sekarang kita lanjutkan untuk melakukan proses publish konfigurasi dari Laravel Spatie Permission. Silahkan jalankan perintah berikut ini di dalam terminal/CMD :
Terminal
php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider"
Jika perintah di atas berhasil dijalankan, maka kita akan mendapatkan 2 file baru, yaitu :
-
config/permissions.php
-
database/migrations/2024_04_22_085406_create_permission_tables.php
Jika kita lihat, di dalam file migration Laravel Spatie Permission akan membuat 5 table, yaitu :
-
roles
-
permissions
-
role_has_permissions
-
model_has_roles
-
model_has_permissions
¶Konfigurasi Model User
Kita lanjutkan untuk menambahkan Traits HasRoles milik Laravel Spatie Permission di dalam Model User. Ini digunakan agar kita bisa menggunakan fitur dan relasi yang ada di dalam Laravel Spatie Permission melalui Model User.
Silahkan buka file app/Models/User.php, kemudian ubah kode-nya menjadi seperti berikut ini :
User.php
<?php
namespace App\Models;
// use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Spatie\Permission\Traits\HasRoles;
class User extends Authenticatable
{
use HasFactory, Notifiable, HasRoles;
/**
* The attributes that are mass assignable.
*
* @var array<int, string>
*/
protected $fillable = [
'name',
'email',
'password',
];
/**
* The attributes that should be hidden for serialization.
*
* @var array<int, string>
*/
protected $hidden = [
'password',
'remember_token',
];
/**
* Get the attributes that should be cast.
*
* @return array<string, string>
*/
protected function casts(): array
{
return [
'email_verified_at' => 'datetime',
'password' => 'hashed',
];
}
/**
* getUserPermissions
*
* @return void
*/
public function getUserPermissions()
{
return $this->getAllPermissions()->mapWithKeys(fn($permission) => [$permission['name'] => true]);
}
/**
* isSuperAdmin
*
* @return void
*/
public function isSuperAdmin()
{
return $this->hasRole('super-admin');
}
}
Di atas kita import Traits dari Laravel Spatie, kurang lebih seperti berikut ini :
User.php
use Spatie\Permission\Traits\HasRoles;
kemudian kita gunakan Traits tersebut di dalam Model Class User, kurang lebih seperti berikut ini :
user.php
use HasFactory, Notifiable, HasScope, HasRoles;
Selanjutnya kita juga menambahkan sebuah method baru dengan nama getUserPermissions, method tersebut kita gunakan untuk mendapatkan data permissions yang dimiliki oleh user.
User.php
public function getUserPermissions()
{
return $this->getAllPermissions()->mapWithKeys(fn($permission) => [$permission['name'] => true]);
}
Terakhir kita juga membuat sebuah method baru dengan nama isSuperAdmin, method tersebut kita gunakan untuk melakukan pengecekan apakah user memiliki role super-admin.
public function isSuperAdmin()
{
return $this->hasRole('super-admin');
}
¶Register Middleware
Agar Laravel Sptie Permission dapat digunakan di dalam aplikasi, maka kita perlu melakukan register middleware. SIlahkan buka file bootstrap/app.php, kemudian tambahkan kode berikut ini di dalam withMiddleware.
app.php
$middleware->alias([
'role' => \Spatie\Permission\Middleware\RoleMiddleware::class,
'permission' => \Spatie\Permission\Middleware\PermissionMiddleware::class,
'role_or_permission' => \Spatie\Permission\Middleware\RoleOrPermissionMiddleware::class,
]);
Jika ditulis secara lengkap, kurang lebih seperti berkut ini :
app.php
<?php
use Illuminate\Foundation\Application;
use Illuminate\Foundation\Configuration\Exceptions;
use Illuminate\Foundation\Configuration\Middleware;
return Application::configure(basePath: dirname(__DIR__))
->withRouting(
web: __DIR__.'/../routes/web.php',
commands: __DIR__.'/../routes/console.php',
health: '/up',
)
->withMiddleware(function (Middleware $middleware) {
$middleware->web(append: [
\App\Http\Middleware\HandleInertiaRequests::class,
\Illuminate\Http\Middleware\AddLinkHeadersForPreloadedAssets::class,
]);
$middleware->alias([
'role' => \Spatie\Permission\Middleware\RoleMiddleware::class,
'permission' => \Spatie\Permission\Middleware\PermissionMiddleware::class,
'role_or_permission' => \Spatie\Permission\Middleware\RoleOrPermissionMiddleware::class,
]);
})
->withExceptions(function (Exceptions $exceptions) {
//
})->create();
¶Super Admin
Terakhir kita akan mendefinisikan sebuah role yang bisa mengakses semua aplikasi yang kita punya, silahkan teman - teman buka file yang bernama AppServiceProvider.php yang terletak di app/Providers, kemudian tambahkan kode berikut ini.
<?php
namespace App\Providers;
use Illuminate\Support\Facades\Gate;
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider
{
/**
* Register any application services.
*/
public function register(): void
{
//
}
/**
* Bootstrap any application services.
*/
public function boot(): void
{
// This works in the app by using gate-related functions like auth()->user->can() and @can()
Gate::before(function ($user, $ability) {
return $user->hasRole('super-admin') ? true : null;
});
}
}
