Backpack PermissionManager

By default, spatie/laravel-permission uses the Auth facade, which uses the default guard from config/auth.php, not the backpack guard. To use Laravel's native @can directive inside Backpack routes, you have two options:

Option A: Change the Backpack guard to default

In config/backpack/base.php, set the guard to null so it uses the default web guard:

'guard' => null,

Note: New roles/permissions will be saved with the "web" guard.

Option B: Add Middleware

Add the UseBackpackAuthGuardInsteadOfDefaultAuthGuard middleware to your Backpack routes in config/backpack/base.php:

'middleware_class' => [
    App\Http\Middleware\CheckIfAdmin::class,
    \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
    Backpack\CRUD\app\Http\Middleware\UseBackpackAuthGuardInsteadOfDefaultAuthGuard::class,
],

Note: New roles/permissions will be saved with the "backpack" guard.

Alternative: If you don't want to change guards, you can always use backpack_user()->can('permission-name') which works regardless of the guard configuration.

// Option A: config/backpack/base.php
'guard' => null,

// Option B: config/backpack/base.php
'middleware_class' => [
    // ...
    Backpack\CRUD\app\Http\Middleware\UseBackpackAuthGuardInsteadOfDefaultAuthGuard::class,
],

Follow these steps to install the package and its dependency, spatie/laravel-permission.

1. Install via Composer

composer require backpack/permissionmanager

2. Setup Spatie​Permission

Since this package is a UI for spatie/laravel-permission, you must complete its installation steps:

1. Publish migrations: php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="permission-migrations"
2. Run migrations: php artisan migrate
3. Publish config: php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="permission-config"
4. Add the Spatie\Permission\Traits\HasRoles trait to your User model.

3. Setup Backpack​PermissionManager

1. Publish the package config and migrations:

php artisan vendor:publish --provider="Backpack\PermissionManager\PermissionManagerServiceProvider" --tag="config" --tag="migrations"

2. Run migrations: php artisan migrate

4. Configure your User Model

Ensure your User model (defined in config/backpack/permissionmanager.php) uses both the CrudTrait and the HasRoles trait:

<?php namespace App\
Models;

use Backpack\CRUD\app\Models\Traits\CrudTrait;
use Spatie\Permission\Traits\HasRoles;
use Illuminate\
Foundation\\Auth\\User as Authenticatable;

class User extends Authenticatable
{
    use CrudTrait;
    use HasRoles;

    // ...
}

composer require backpack/permissionmanager

# Spatie setup
php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="permission-migrations"
php artisan migrate
php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="permission-config"

# PermissionManager setup
php artisan vendor:publish --provider="Backpack\PermissionManager\PermissionManagerServiceProvider" --tag="config" --tag="migrations"
php artisan migrate

To completely customize the routes used by the PermissionManager (e.g., to use your own controllers for role or permission), create a file at routes/backpack/permissionmanager.php. The package will prioritize this file over its internal routes.

In this file, you can define groups for your custom controllers and separate groups for the original package controllers to maintain standard functionality for other resources.

// routes/backpack/permissionmanager.php

Route::group([
    'namespace'  => 'App\Http\Controllers\Admin',
    'prefix'     => config('backpack.base.route_prefix', 'admin'),
    'middleware' => ['web', backpack_middleware()],
],
function () {
    Route::crud('user', 'UserCrudController');
});

Route::group([
    'namespace'  => '\Backpack\PermissionManager\app\Http\Controllers',
    'prefix'     => config('backpack.base.route_prefix', 'admin'),
    'middleware' => ['web', backpack_middleware()],
],
function () {
    Route::crud('permission', 'PermissionCrudController');
    Route::crud('role', 'RoleCrudController');
});

You can dynamically control CRUD operation access (navigation buttons and security guards) based on Spatie permissions. This is achieved by using $this->crud->allowAccess() and $this->crud->denyAccess() within your controller's setup() method.

To implement this cleanly, create a trait that maps permission levels (e.g., see, edit) to specific CRUD operations (e.g., list, show, create, update, delete) and call it from your CrudController.

namespace App	raits;

use Backpack\CRUD\app\Library\CrudPanel\CrudPanelFacade as CRUD;

trait CrudPermissionTrait
{
    public array $operations = ['list', 'show', 'create', 'update', 'delete'];

    public function setAccessUsingPermissions()
    {
        $this->crud->denyAccess($this->operations);
        $table = CRUD::getModel()->getTable();
        $user = request()->user();

        if (!$user) return;

        foreach ([
            'see' => ['list', 'show'],
            'edit' => ['list', 'show', 'create', 'update', 'delete'],
        ] as $level => $operations) {
            if ($user->can("$table.$level")) {
                $this->crud->allowAccess($operations);
            }
        }
    }
}

The UserCrudController is the central controller for managing users within the Backpack admin interface. It integrates roles and permissions into the standard CRUD operations. When customizing your own user management, you can leverage its patterns for handling password hashing and relationship management.

Key features implemented in this controller include:

• Password Handling: Automatically hashes the password field if provided and cleans up password_confirmation from the request.
• Relationship Management: Uses checklist_dependency to manage the interconnected relationship between Roles and Permissions.
• Filtering: (Requires Backpack Pro) Adds dropdown and select2 filters for role and permissions to the list view.

<?php

namespace Backpack\PermissionManager\app\Http\Controllers;

use Backpack\CRUD\app\Http\Controllers\CrudController;

class UserCrudController extends CrudController
{
    // Implementation details for managing users with roles and permissions
}