Filament Users Roles Permissions

https://github.com/cwsps154/users-roles-permissions
Admin
A Filament v4 plugin that provides comprehensive user management, role assignment, and permission...
Tokens:39,885
Snippets:335
Trust Score:5.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Usage example

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-has-role.md

Shows how to use the trait's methods on a user instance: get role, avatar URL, online status, and panel access.

```php
/** @var \App\Models\User $user */
$user = auth()->user();

$role = $user->role;                 // Role|null
$avatarUrl = $user->getFilamentAvatarUrl(); // ?string
$online = $user->isOnline();          // bool
$allowed = $user->canAccessPanel($panel);   // true
```

--------------------------------

### Run installation artisan commands

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/README.md

Run these artisan commands to set up the package. For Laravel 11, use make:queue-batches-table and make:notifications-table; for Laravel 10, use queue:batches-table and notifications:table. Then publish migrations, install the package, and publish Filament assets.

```shell
# for laravel 11
php artisan make:queue-batches-table
php artisan make:notifications-table //ensure these queues and notifications migrates are published
# for laravel 10
php artisan queue:batches-table
php artisan notifications:table
# for both
php artisan vendor:publish --tag=filament-actions-migrations //publish filament import and export migrations
php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="medialibrary-migrations" //publish spatie media provider
php artisan users-roles-permissions:install
php artisan filament:assets
```

--------------------------------

### Usage example

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/filament-resource-role.md

Example of reusing RoleResource's authorization and cluster methods in a custom resource.

```php
use CWSPS154\UsersRolesPermissions\Filament\Clusters\UserManager\Resources\RoleResource;

// In a custom Filament resource you could reuse the authorization logic:
if (RoleResource::canCreate()) {
    // render create button
}

$cluster = RoleResource::getCluster(); // CWSPS154\UsersRolesPermissions\Filament\Clusters\UserManager::class
```

--------------------------------

### Install via Composer

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/README.md

Install the package using Composer. Requires PHP 8.2+, Laravel 10.0+, and Filament 4.0+.

```shell
composer require cwsps154/users-roles-permissions
```

--------------------------------

### Example: calling UserManager::checkAccess

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/user-manager-cluster.md

Example usage of checkAccess with different plugin getters: getCanViewAnyUser, getCanEditUser (passing a User record), and getCanAccessEditProfile.

```php
use CWSPS154\UsersRolesPermissions\Filament\Clusters\UserManager;
use App\Models\User;

$canListUsers = UserManager::checkAccess('getCanViewAnyUser');
$canEditUser  = UserManager::checkAccess('getCanEditUser', User::find(1));
$canEditProfile = UserManager::checkAccess('getCanAccessEditProfile');
```

--------------------------------

### Usage example for PermissionResource

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/filament-resource-permission.md

Shows how to use the getEloquentQuery method to retrieve only module-level permissions (those having children).

```php
use CWSPS154\UsersRolesPermissions\Filament\Clusters\UserManager\Resources\PermissionResource;

$query = PermissionResource::getEloquentQuery();
// only module-level permissions (those having children)
```

--------------------------------

### Role model usage example

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-role.md

Shows how to fetch the admin role, check all_permission, attach a permission, and retrieve permission options for forms.

```php
use CWSPS154\UsersRolesPermissions\Models\Role;

$role = Role::firstWhere('identifier', Role::ADMIN);

if ($role->all_permission) {
    // bypasses all permission checks
}

// Grant a permission
$role->permissions()->attach($permissionId);

// Enabled permission options for a form
$options = Role::getPermissionOptions(); // Collection<name => id>
```

--------------------------------

### Basic setup with custom abilities

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Configures the plugin with custom ability callbacks for view, create, edit, delete, and profile access. Uses Gate::allows for view and create, boolean for edit/delete, and a closure for profile access.

```php
use CWSPS154\UsersRolesPermissions\UsersRolesPermissionsPlugin;
use Illuminate\Support\Facades\Gate;

$panel->plugins([
    UsersRolesPermissionsPlugin::make()
        ->canViewAnyUser(fn () => Gate::allows('manage-users'))
        ->canCreateUser('create-user-ability', ['team' => $currentTeamId])
        ->canEditUser(true)
        ->canDeleteUser(false)
        ->canAccessEditProfile(fn () => auth()->user()->is_active),
]);
```

--------------------------------

### Usage example with Permission model

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-permission.md

Shows how to retrieve a permission by identifier and navigate parent/children relations. Also demonstrates that the serialized permission uses the permission_with_panel_ids accessor.

```php
use CWSPS154\UsersRolesPermissions\Models\Permission;

/** @var Permission $permission */
$permission = Permission::firstWhere('identifier', Permission::VIEW_ROLE);

// Tree navigation
$module = $permission->parent;   // Permission (identifier: 'role')
$abilities = $module->children;  // Collection of Permission children

// Serialized uses the accessor
echo $permission->permission_with_panel_ids;
```

--------------------------------

### Artisan commands to run seeders

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/database-seeders.md

Commands to run the seeders: full install with interactive prompt, standalone DatabaseSeeder, or individual seeders for re-runs.

```bash
# Full seed (includes the interactive installer prompts)
php artisan users-roles-permissions:install   # answer "yes" to the seeder prompt

# Or standalone
php artisan db:seed --class="CWSPS154\UsersRolesPermissions\Database\Seeders\DatabaseSeeder"

# Or a single seeder (useful for re-runs)
php artisan db:seed --class="CWSPS154\UsersRolesPermissions\Database\Seeders\RoleSeeder"
php artisan db:seed --class="CWSPS154\UsersRolesPermissions\Database\Seeders\UserSeeder"
```

--------------------------------

### User model checklist

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-has-role.md

Example User model that uses the HasRole trait and implements required interfaces, with fillable, hidden, and casts properties.

```php
use App\Models\User as Authenticatable;
use CWSPS154\UsersRolesPermissions\Models\HasRole;
use Filament\Models\Contracts\FilamentUser;
use Filament\Models\Contracts\HasAvatar;
use Spatie\MediaLibrary\HasMedia;

class User extends Authenticatable implements HasMedia, HasAvatar, FilamentUser
{
    use HasRole;

    protected $fillable = ['name', 'email', 'mobile', 'password', 'role_id', 'last_seen', 'is_active'];

    protected $hidden = ['password', 'remember_token'];

    protected function casts(): array
    {
        return [
            'email_verified_at' => 'datetime',
            'password' => 'hashed',
            'last_seen' => 'datetime',
            'is_active' => 'boolean',
        ];
    }
}
```

--------------------------------

### RolePermission usage example for existence check and writes

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-role-permission.md

Shows a direct existence check via query, and write operations through the Role relation using sync and attach. Note that the model is typically not instantiated directly.

```php
use CWSPS154\UsersRolesPermissions\Models\RolePermission;
use CWSPS154\UsersRolesPermissions\Models\Role;

// Direct existence check (as the gate does)
$hasPermission = RolePermission::query()
    ->where('role_id', $roleId)
    ->where('permission_id', $permissionId)
    ->exists();

// Write path through the Role relation instead
$role = Role::findOrFail($roleId);
$role->permissions()->sync([$permissionId]);   // replaces the whole role_permissions set
$role->permissions()->attach($permissionId);    // adds one link
```

--------------------------------

### Override cluster and user resource in config

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/configuration.md

Example of overriding the default configuration values. Replace the cluster and user resource with your own classes; the comment indicates additional keys can be customized.

```php
// config/users-roles-permissions.php (published)
return [
    'cluster' => \App\Filament\Clusters\MyUserManager::class,
    'resource' => [
        'user' => \App\Filament\Resources\MyUserResource::class,
        // ...
    ],
];
```

--------------------------------

### Configure UsersRolesPermissionsPlugin with fluent ability setters

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/configuration.md

Configure the plugin's fluent ability setters. The example disables user deletion and restricts user creation to a specific email via a closure. Closure values are evaluated through Filament's EvaluatesClosures; string+arguments become gate arrays; booleans are cast.

```php
use CWSPS154\UsersRolesPermissions\UsersRolesPermissionsPlugin;

$panel->plugins([
    UsersRolesPermissionsPlugin::make()
        ->canDeleteUser(false)
        ->canCreateUser(fn () => auth()->user()->email === 'manager@example.com'),
]);
```

--------------------------------

### getCanCreatePermission

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Gets the configured ability for creating a permission. Returns either a normalized gate-array or a boolean.

```APIDOC
## getCanCreatePermission

### Description
Gets the configured ability for creating a permission. Returns either a normalized gate-array or a boolean.

### Method
PHP method

### Signature
```php
public function getCanCreatePermission(): array|bool
```

### Returns
`array|bool` - Either the normalized gate-array or a plain boolean.

### Default after `grantPermissions()`
`['ability' => 'have-access', 'arguments' => 'create-permission']`
```

--------------------------------

### getCanCreateUser

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Gets the configured ability for creating a user. Returns either a normalized gate-array or a boolean.

```APIDOC
## getCanCreateUser

### Description
Gets the configured ability for creating a user. Returns either a normalized gate-array or a boolean.

### Method
PHP method

### Signature
```php
public function getCanCreateUser(): array|bool
```

### Returns
`array|bool` - Either the normalized gate-array or a plain boolean.

### Default after `grantPermissions()`
`['ability' => 'have-access', 'arguments' => 'create-user']`
```

--------------------------------

### getCanCreateRole

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Gets the configured ability for creating a role. Returns either a normalized gate-array or a boolean.

```APIDOC
## getCanCreateRole

### Description
Gets the configured ability for creating a role. Returns either a normalized gate-array or a boolean.

### Method
PHP method

### Signature
```php
public function getCanCreateRole(): array|bool
```

### Returns
`array|bool` - Either the normalized gate-array or a plain boolean.

### Default after `grantPermissions()`
`['ability' => 'have-access', 'arguments' => 'create-role']`
```

--------------------------------

### UsersRolesPermissionsPlugin::boot(Panel $panel)

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Boot method for the plugin. Currently empty (TODO in source).

```APIDOC
## UsersRolesPermissionsPlugin::boot(Panel $panel)

### Description
Boot method for the plugin. Currently empty (TODO in source).

### Method
`boot`

### Signature
```php
public function boot(Panel $panel): void
```

### Parameters
- **$panel** (Panel) - Required - The Filament panel instance.

### Returns
`void`
```

--------------------------------

### boot method signature

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-service-provider.md

Declares the boot method of the service provider, returning the provider instance for chaining.

```php
public function boot(): UsersRolesPermissionsServiceProvider

```

--------------------------------

### getCanViewAnyPermission

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Gets the configured ability for viewing any permission. Returns either a normalized gate-array or a boolean.

```APIDOC
## getCanViewAnyPermission

### Description
Gets the configured ability for viewing any permission. Returns either a normalized gate-array or a boolean.

### Method
PHP method

### Signature
```php
public function getCanViewAnyPermission(): array|bool
```

### Returns
`array|bool` - Either the normalized gate-array or a plain boolean.

### Default after `grantPermissions()`
`['ability' => 'have-access', 'arguments' => 'view-permission']`
```

--------------------------------

### getCanDeleteRole

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Gets the configured ability for deleting a role. Returns either a normalized gate-array or a boolean.

```APIDOC
## getCanDeleteRole

### Description
Gets the configured ability for deleting a role. Returns either a normalized gate-array or a boolean.

### Method
PHP method

### Signature
```php
public function getCanDeleteRole(): array|bool
```

### Returns
`array|bool` - Either the normalized gate-array or a plain boolean.

### Default after `grantPermissions()`
`['ability' => 'have-access', 'arguments' => 'delete-role']`
```

--------------------------------

### getCanEditRole

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Gets the configured ability for editing a role. Returns either a normalized gate-array or a boolean.

```APIDOC
## getCanEditRole

### Description
Gets the configured ability for editing a role. Returns either a normalized gate-array or a boolean.

### Method
PHP method

### Signature
```php
public function getCanEditRole(): array|bool
```

### Returns
`array|bool` - Either the normalized gate-array or a plain boolean.

### Default after `grantPermissions()`
`['ability' => 'have-access', 'arguments' => 'edit-role']`
```

--------------------------------

### Registering the plugin in a Filament panel

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Use the make() method to instantiate the plugin and register it within the panel's plugins array.

```php
use CWSPS154\UsersRolesPermissions\UsersRolesPermissionsPlugin;

$panel->plugins([
    UsersRolesPermissionsPlugin::make(), // required to enable this extension
]);
```

--------------------------------

### getCanViewAnyRole

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Gets the configured ability for viewing any role. Returns either a normalized gate-array or a boolean.

```APIDOC
## getCanViewAnyRole

### Description
Gets the configured ability for viewing any role. Returns either a normalized gate-array or a boolean.

### Method
PHP method

### Signature
```php
public function getCanViewAnyRole(): array|bool
```

### Returns
`array|bool` - Either the normalized gate-array or a plain boolean.

### Default after `grantPermissions()`
`['ability' => 'have-access', 'arguments' => 'view-role']`
```

--------------------------------

### getCanDeleteUser

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Gets the configured ability for deleting a user. Returns either a normalized gate-array or a boolean.

```APIDOC
## getCanDeleteUser

### Description
Gets the configured ability for deleting a user. Returns either a normalized gate-array or a boolean.

### Method
PHP method

### Signature
```php
public function getCanDeleteUser(): array|bool
```

### Returns
`array|bool` - Either the normalized gate-array or a plain boolean.

### Default after `grantPermissions()`
`['ability' => 'have-access', 'arguments' => 'delete-user']`
```

--------------------------------

### getCanEditUser

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Gets the configured ability for editing a user. Returns either a normalized gate-array or a boolean.

```APIDOC
## getCanEditUser

### Description
Gets the configured ability for editing a user. Returns either a normalized gate-array or a boolean.

### Method
PHP method

### Signature
```php
public function getCanEditUser(): array|bool
```

### Returns
`array|bool` - Either the normalized gate-array or a plain boolean.

### Default after `grantPermissions()`
`['ability' => 'have-access', 'arguments' => 'edit-user']`
```

--------------------------------

### UsersRolesPermissionsPlugin::register(Panel $panel)

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Performs the panel wiring: discovers clusters, sets the profile page, adds auth middleware, and adds gzip response middleware.

```APIDOC
## UsersRolesPermissionsPlugin::register(Panel $panel)

### Description
Performs the panel wiring: discovers clusters, sets the profile page, adds auth middleware, and adds gzip response middleware.

### Method
`register`

### Signature
```php
public function register(Panel $panel): void
```

### Parameters
- **$panel** (Panel) - Required - The Filament panel instance to configure.

### Returns
`void`

### Behavior
- Discovers clusters from `__DIR__.'/Filament/Clusters'` for namespace `CWSPS154\UsersRolesPermissions\Filament\Clusters`.
- Sets the profile page to `EditProfile::class` with `false` (likely meaning not a modal).
- Adds auth middleware: `HaveAccess`, `IsActive`, `IsOnline`.
- Adds middleware: `GzipEncodeResponse`.
```

--------------------------------

### getCanViewAnyUser

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Gets the configured ability for viewing any user. Returns either a normalized gate-array or a boolean.

```APIDOC
## getCanViewAnyUser

### Description
Gets the configured ability for viewing any user. Returns either a normalized gate-array or a boolean.

### Method
PHP method

### Signature
```php
public function getCanViewAnyUser(): array|bool
```

### Returns
`array|bool` - Either the normalized gate-array or a plain boolean.

### Default after `grantPermissions()`
`['ability' => 'have-access', 'arguments' => 'view-user']`
```

--------------------------------

### Manual middleware registration with HaveAccess, IsActive, IsOnline

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/http-middleware.md

Registers the middleware chain on a route group. The plugin registers these automatically; manual registration is only needed for custom routes.

```php
use CWSPS154\UsersRolesPermissions\Http\Middleware\HaveAccess;
use CWSPS154\UsersRolesPermissions\Http\Middleware\IsActive;
use CWSPS154\UsersRolesPermissions\Http\Middleware\IsOnline;
use Illuminate\Support\Facades\Route;

Route::middleware(['auth', HaveAccess::class, IsActive::class, IsOnline::class])
    ->group(function () {
        // protected routes
    });
```

--------------------------------

### getCanAccessEditProfile

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Gets the configured ability for accessing the edit profile page. Returns either a normalized gate-array or a boolean.

```APIDOC
## getCanAccessEditProfile

### Description
Gets the configured ability for accessing the edit profile page. Returns either a normalized gate-array or a boolean.

### Method
PHP method

### Signature
```php
public function getCanAccessEditProfile(): array|bool
```

### Returns
`array|bool` - Either the normalized gate-array or a plain boolean.

### Default after `grantPermissions()`
`true` (not covered by `grantPermissions()`)
```

--------------------------------

### UsersRolesPermissionsServiceProvider configurePackage method signature

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-service-provider.md

Declares the method that configures the package using Spatie's package tools. This method is called by PackageServiceProvider to register package components.

```php
public function configurePackage(Package $package): void
```

--------------------------------

### RoleSeeder run method

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/database-seeders.md

RoleSeeder creates or updates the admin role (Role::ADMIN = 'admin') with all_permission = true.

```php
public function run(): void
{
    Role::updateOrCreate(
        ['identifier' => Role::ADMIN],
        [
            'role' => 'Admin',
            'all_permission' => true,
            'is_active' => true,
        ]
    );
}
```

--------------------------------

### Plugin lifecycle methods

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

The plugin implements the Filament Plugin contract with getId, register, and boot methods.

```php
public function getId(): string

public function register(Panel $panel): void

public function boot(Panel $panel): void
```

--------------------------------

### SyncPermissions handle method

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/console-sync-permissions.md

The handle method orchestrates the sync process: it collects config paths, requires and merges them, syncs permissions, deletes missing ones, and outputs info. It returns void implicitly.

```php
public function handle()
```

--------------------------------

### Composer autodiscovery providers entry for UsersRolesPermissionsServiceProvider

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-service-provider.md

Registers the service provider through Laravel's package auto-discovery by adding it to the extra.laravel.providers array in composer.json. This is required for the package to be discovered automatically when installed.

```json
"extra": {
    "laravel": {
        "providers": [
            "CWSPS154\\UsersRolesPermissions\\UsersRolesPermissionsServiceProvider"
        ]
    }
}
```

--------------------------------

### Blade usage example for EditProfile access check

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/filament-pages.md

Conditionally renders a link to the profile edit page in a Blade view when EditProfile::canAccess() returns true. Uses Filament::getProfileUrl() to generate the URL.

```php
use CWSPS154\UsersRolesPermissions\Filament\Clusters\UserManager\Resources\UserResource\Pages\EditProfile;

// Conditionally rendered in a custom Blade view
@if (EditProfile::canAccess())
    <a href="{{ Filament::getProfileUrl() }}">Edit Profile</a>
@endif
```

--------------------------------

### Using a custom UserResource

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Sets a custom UserResource class via setUserResource. Note: setUserResource() is not defined in the current source and will cause a fatal error; use the config override instead.

```php
use CWSPS154\UsersRolesPermissions\UsersRolesPermissionsPlugin;
use CWSPS154\UsersRolesPermissions\Filament\Clusters\UserManager\Resources\UserResource;

$panel->plugins([
    UsersRolesPermissionsPlugin::make()->setUserResource(UserResource::class),
]);
```

--------------------------------

### Panel wiring in register method

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

The register method configures clusters, profile pages, and middleware for the panel.

```php
$panel->discoverClusters(
    in: __DIR__.'/Filament/Clusters',
    for: 'CWSPS154\\UsersRolesPermissions\\Filament\\Clusters'
)->profile(EditProfile::class, false)
    ->authMiddleware([
        HaveAccess::class,
        IsActive::class,
        IsOnline::class,
    ])->middleware(
        [
            GzipEncodeResponse::class,
        ]
    );
```

--------------------------------

### Compute $panel_ids for panels with plugin

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/types.md

Top-of-file snippet that computes `$panel_ids` dynamically for every registered panel that has the plugin. Used in the `config/cwsps-permissions.php` file.

```php
foreach (Filament::getPanels() as $panel) {
    if ($panel->hasPlugin(UsersRolesPermissionsServiceProvider::$name)) {
        $panel_ids[] = $panel->getId();
    }
}
```

--------------------------------

### SyncPermissions command definition

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/console-sync-permissions.md

Defines the console command's configuration constant, signature, and description. The signature is 'permissions:sync' and the description is 'Sync permissions from permissions.php to the database'. The constant 'cwsps-permissions.php' is used to locate the config file in config/ and vendor directories.

```php
const PERMISSIONS_CONFIG = 'cwsps-permissions.php';

protected $signature = 'permissions:sync';

protected $description = 'Sync permissions from permissions.php to the database';
```

--------------------------------

### canAccessPanel method

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-has-role.md

Always returns true, granting access to every panel for every user. Satisfies Filament's FilamentUser contract.

```php
public function canAccessPanel(Panel $panel): bool
{
    return true;
}
```

--------------------------------

### Call permissions:sync programmatically

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/console-sync-permissions.md

Programmatic invocation of the permissions:sync command using Laravel's Artisan facade, capturing the console output.

```php
// From code
use Illuminate\Support\Facades\Artisan;

Artisan::call('permissions:sync');
$output = Artisan::output(); // captured console output
```

--------------------------------

### UsersRolesPermissionsPlugin::make()

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Resolves the plugin from the container and immediately calls grantPermissions(), so every ability defaults to a have-access gate check scoped to a permission identifier.

```APIDOC
## UsersRolesPermissionsPlugin::make()

### Description
Resolves the plugin from the container and immediately calls `grantPermissions()`, so every ability defaults to a `have-access` gate check scoped to a permission identifier.

### Method
`make`

### Signature
```php
public static function make(): static
```

### Parameters
None.

### Returns
`static` — a configured plugin instance.

### Example
```php
use CWSPS154\UsersRolesPermissions\UsersRolesPermissionsPlugin;

$panel->plugins([
    UsersRolesPermissionsPlugin::make(), // required to enable this extension
]);
```
```

--------------------------------

### Sync permissions to database

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/README.md

Sync updated permissions from the cwsps-permissions.php config file to the database.

```shell
php artisan permissions:sync
```

--------------------------------

### Assert middleware denial redirects and flash

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/errors.md

Tests middleware denials (HaveAccess, IsActive) which redirect with a 302 and flash a notification. Use assertRedirect() for HaveAccess and assertSessionHas('filament_notifications') for IsActive.

```php
$response = $this->get('/user-manager/users');
$response->assertRedirect();
// or for IsActive:
$response->assertSessionHas('filament_notifications');
```

--------------------------------

### Publish users-roles-permissions config

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/README.md

Publish the config file users-roles-permissions.php. You can create additional permissions using the cwsps-permissions.php config file.

```shell
php artisan vendor:publish --tag=users-roles-permissions-config
```

--------------------------------

### Page registration - getPages()

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/filament-resource-role.md

Registers the index page for the resource, using the configured role manager class.

```php
public static function getPages(): array
{
    return [
        'index' => config('users-roles-permissions.manager.role')::route('/'),
    ];
}
```

--------------------------------

### Catch exceptions from Artisan::call('permissions:sync')

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/errors.md

Shows how to call the permissions:sync command and handle exceptions. Note that E1/E2 and ValidationException (E3) are caught internally and printed via $this->error(), so they never propagate to the caller; failures only surface in the command output (Artisan::output()). The command's exit code does not distinguish real failures because handle() always completes after the catch.

```php
try {
    Artisan::call('permissions:sync');
} catch (\Exception $e) {
    // E1/E2 never escape: they are caught internally and printed with $this->error().
    // ValidationException (E3) also never escapes for the same reason.
    report($e);
}
```

--------------------------------

### UserSeeder run method

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/database-seeders.md

UserSeeder upserts the default administrator with email admin@gmail.com, password admin@123 (hashed), is_admin = true, linked to the admin role, and mobile = 1234567890. Precondition: RoleSeeder must have run first; otherwise ->first()->id errors on null.

```php
public function run(): void
{
    $user = User::where('email', 'admin@gmail.com')->first();

    if ($user) {
        $user->update([
            'name' => 'Admin',
            'email_verified_at' => now(),
            'password' => Hash::make('admin@123'),
            'is_admin' => true,
            'role_id' => Role::where('identifier', Role::ADMIN)->select('id')->first()->id,
            'is_active' => true,
        ]);
    } else {
        User::create([
            'name' => 'Admin',
            'email' => 'admin@gmail.com',
            'mobile' => '1234567890',
            'email_verified_at' => now(),
            'password' => Hash::make('admin@123'),
            'is_admin' => true,
            'role_id' => Role::where('identifier', Role::ADMIN)->select('id')->first()->id,
            'is_active' => true,
        ]);
    }
}
```

--------------------------------

### UserManager navigation methods

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/user-manager-cluster.md

Navigation methods for the cluster: label and breadcrumb use the translation key 'users-roles-permissions::users-roles-permissions.user.manager' ("Users Manager"), icon is 'heroicon-o-user-group', group is 'System' (translated), and sort is 100.

```php
public static function getNavigationLabel(): string
// __('users-roles-permissions::users-roles-permissions.user.manager')  => "Users Manager"

public static function getClusterBreadcrumb(): ?string
// same translation key

public static function getNavigationIcon(): string|Htmlable|null
// 'heroicon-o-user-group'

public static function getNavigationGroup(): ?string
// __('users-roles-permissions::users-roles-permissions.system') => "System"

public static function getNavigationSort(): ?int
// 100
```

--------------------------------

### ManageRoles page class methods

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/filament-pages.md

Defines the header action as a slide-over CreateAction, returns a translated title, and resolves the resource from configuration. The resource is obtained via config('users-roles-permissions.resource.role').

```php
protected function getHeaderActions(): array
{
    return [
        Actions\CreateAction::make()->slideOver(),
    ];
}

public function getTitle(): string|Htmlable
{
    return __('users-roles-permissions::users-roles-permissions.role.resource.role');
}

public static function getResource(): string
{
    return static::$resource = config('users-roles-permissions.resource.role');
}
```

--------------------------------

### Implement required interfaces on User model

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/README.md

The User model must implement these interfaces: Spatie\MediaLibrary\HasMedia, Filament\Models\Contracts\HasAvatar, and Filament\Models\Contracts\FilamentUser.

```php
implements HasMedia, HasAvatar, FilamentUser
```

--------------------------------

### ManageUsers page class methods

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/filament-pages.md

Defines the header action as a slide-over CreateAction, returns a translated title, and resolves the resource from configuration. The resource is obtained via config('users-roles-permissions.resource.user').

```php
protected function getHeaderActions(): array
{
    return [
        Actions\CreateAction::make()->slideOver(),
    ];
}

public function getTitle(): string|Htmlable
{
    return __('users-roles-permissions::users-roles-permissions.user.resource.user');
}

public static function getResource(): string
{
    return static::$resource = config('users-roles-permissions.resource.user');
}
```

--------------------------------

### DatabaseSeeder run method

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/database-seeders.md

DatabaseSeeder's run method calls the three seeders in order: permissions, role, user.

```php
public function run(): void
{
    $this->call([
        PermissionSeeder::class,
        RoleSeeder::class,
        UserSeeder::class,
    ]);
}
```

--------------------------------

### Register UsersRolesPermissionsPlugin in Filament PanelProvider

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/README.md

Add the plugin to your Filament PanelProvider's panel() method. databaseNotifications() is required to see export files for permissions; databaseTransactions() is optional; the plugin is required to enable the extension.

```php
use CWSPS154\UsersRolesPermissions\UsersRolesPermissionsPlugin;

$panel->databaseNotifications() //need to see the export files for the permission
    ->databaseTransactions() //optional
    ->plugins([UsersRolesPermissionsPlugin::make()]); //required to enable this extension
```

--------------------------------

### IsOnline Middleware Tracking

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/http-middleware.md

Use in middleware to track user online status. Sets a cache key for 2 minutes and updates last_seen while temporarily disabling userstamping to avoid rewriting updated_by.

```php
if (Auth::check()) {
    $expireAt = now()->addMinutes(2);
    Cache::put('user-is-online.'.Auth()->id(), true, $expireAt);
    $user = Auth::user();
    $user->stopUserstamping();
    $user->last_seen = now();
    $user->save();
    $user->startUserstamping();
}

return $next($request);
```

--------------------------------

### isOnline method

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-has-role.md

Checks if the user is online by verifying the presence of the 'user-is-online.<id>' cache key, which is maintained by the IsOnline middleware for 2 minutes on each authenticated request.

```php
public function isOnline(): bool
{
    return Cache::has('user-is-online.'.$this->id);
}
```

--------------------------------

### registerMediaConversions method

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-has-role.md

Registers the 'avatar' media conversion with a max fit of 300x300, processed synchronously via nonQueued().

```php
public function registerMediaConversions(?Media $media = null): void
{
    $this
        ->addMediaConversion('avatar')
        ->fit(Fit::Max, 300, 300)
        ->nonQueued();
}
```

--------------------------------

### Build and strip route prefix in HaveAccess middleware

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/endpoints.md

Builds the full route prefix from the panel id and strips it from the current route name to obtain the prefixless route name used for permission matching.

```php
$panelRoutePrefix = Permission::FILAMENT_ROUTE_PREFIX.'.'.$currentPanelId;
$currentRouteNameWithOutPrefix = str_replace($panelRoutePrefix.'.', '', $currentRouteName);
```

--------------------------------

### Register middleware classes in UsersRolesPermissionsPlugin

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/http-middleware.md

Registers the three middleware classes as panel authMiddleware, applied to every authenticated route of the panel. The GzipEncodeResponse middleware is from an external package and is not part of this package.

```php
->authMiddleware([
    HaveAccess::class,
    IsActive::class,
    IsOnline::class,
])->middleware([
    GzipEncodeResponse::class, // from erlandmuchasaj/laravel-gzip, not part of this package
])
```

--------------------------------

### Authorization methods — canViewAny, canCreate, canEdit, canDelete

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/filament-resource-user.md

Each method delegates to UserManager::checkAccess() with a specific permission key. canEdit and canDelete pass the $record to checkAccess, while canViewAny and canCreate do not.

```php
public static function canViewAny(): bool
// UserManager::checkAccess('getCanViewAnyUser')

public static function canCreate(): bool
// UserManager::checkAccess('getCanCreateUser')

public static function canEdit(Model $record): bool
// UserManager::checkAccess('getCanEditUser', $record)

public static function canDelete(Model $record): bool
// UserManager::checkAccess('getCanDeleteUser', $record)
```

--------------------------------

### getPages() method for User resource

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/filament-resource-user.md

Registers the index page for the User resource using a configurable page class. The route name is 'filament.<panel>.user-manager.resources.users.index' and the page class defaults to ManageUsers.

```php
public static function getPages(): array
{
    return [
        'index' => config('users-roles-permissions.manager.user')::route('/'),
    ];
}
```

--------------------------------

### Register console commands

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-service-provider.md

Registers the SyncPermissions command (permissions:sync) only when running in the console.

```php
if ($this->app->runningInConsole()) {
    $this->commands([
        SyncPermissions::class,
    ]);
}

```

--------------------------------

### Pages and cluster configuration

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/filament-resource-permission.md

Defines the resource pages and cluster. The index page route is configured via config, and the cluster is also from config.

```php
public static function getPages(): array
{
    return [
        'index' => config('users-roles-permissions.manager.permission')::route('/'),
    ];
}

public static function getCluster(): ?string
{
    return static::$cluster = config('users-roles-permissions.cluster');
}
```

--------------------------------

### Table header actions with ExportAction and ImportAction

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/filament-resource-permission.md

Defines the header actions for the table: an export action and an import action, both gated by the 'getCanCreatePermission' ability. The visibility closure calls checkAccess twice with the same expression.

```php
ExportAction::make()
    ->exporter(config('users-roles-permissions.export.permission'))
    ->visible(fn () => static::$cluster::checkAccess('getCanCreatePermission') && static::$cluster::checkAccess('getCanCreatePermission')),
ImportAction::make()
    ->importer(config('users-roles-permissions.import.permission'))
    ->visible(fn () => static::$cluster::checkAccess('getCanCreatePermission') && static::$cluster::checkAccess('getCanCreatePermission')),
```

--------------------------------

### Reading the resolved ability and checking it

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Retrieves the plugin instance and checks the resolved ability. getCanViewAnyUser() returns array|bool; if array, uses Gate::allows with ability and arguments, otherwise uses the boolean. Aborts with 403 if not allowed.

```php
use CWSPS154\UsersRolesPermissions\UsersRolesPermissionsPlugin;
use Filament\Facades\Filament;
use Illuminate\Support\Facades\Gate;

$plugin = Filament::getCurrentPanel()->getPlugin(UsersRolesPermissionsPlugin::class);

// getCanViewAnyUser() returns array|bool
$resolved = $plugin->getCanViewAnyUser();

if (is_array($resolved)) {
    $allowed = Gate::allows($resolved['ability'], $resolved['arguments']);
} else {
    $allowed = $resolved;
}

if (! $allowed) {
    abort(403, 'No permission');
}
```

--------------------------------

### Static model binding

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/filament-resource-role.md

Binds the resource to the Role model.

```php
protected static ?string $model = Role::class;
```

--------------------------------

### canCreateUser

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Sets the ability to create a user. Accepts a boolean, a Closure, or a gate ability string with arguments.

```APIDOC
## canCreateUser

### Description
Sets the ability to create a user. Accepts a boolean, a Closure, or a gate ability string with arguments.

### Method
PHP method

### Signature
```php
public function canCreateUser(bool|Closure|string $ability = true, $arguments = null): static
```

### Parameters
- **$ability** (bool|Closure|string) - Optional - A boolean; a Closure evaluated through Filament's `EvaluatesClosures`; or a gate ability name (used with `$arguments`)
- **$arguments** (mixed) - Optional - Gate arguments. Only meaningful when `$ability` is a string

### Returns
`static` (fluent).

### Default after `grantPermissions()`
`['ability' => 'have-access', 'arguments' => 'create-user']`
```

--------------------------------

### isOnline()

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-has-role.md

Checks whether the user is online by verifying the existence of the 'user-is-online.<id>' cache key, which is maintained by the IsOnline middleware.

```APIDOC
## isOnline()

### Description
Checks if the user is currently online by verifying the cache key `user-is-online.<id>`, which is maintained for 2 minutes on each authenticated request by the `IsOnline` middleware.

### Method
`isOnline(): bool`

### Returns
- `bool` - `true` if the cache key exists, otherwise `false`.
```

--------------------------------

### registerMediaConversions()

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-has-role.md

Registers the media conversion for the avatar, fitting it to a maximum of 300x300 pixels and processing it synchronously.

```APIDOC
## registerMediaConversions()

### Description
Registers the `avatar` media conversion with a maximum fit of 300x300 pixels, processed synchronously via `nonQueued()`.

### Method
`registerMediaConversions(?Media $media = null): void`

### Parameters
#### Parameters
- `$media` (?Media) - Optional - Default: `null` - The Spatie media item.
```

--------------------------------

### Check multiple permissions with Gate::allows

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-service-provider.md

Pass an array of identifiers to check multiple permissions at once. Each identifier must resolve to an active permission record associated with the user's role and the current panel.

```php
$can = Gate::allows('have-access', ['view-user', 'edit-user']);
```

--------------------------------

### getRoute method

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-permission.md

Composes a named route using the FILAMENT_ROUTE_PREFIX, panel_id, and route properties. Note that panel_id is not a defined attribute, so it may be null and produce 'filament.<route>' unless dynamically set. Use config('users-roles-permissions') and Filament::getCurrentPanel()->getId() if reliable route names are needed.

```php
public function getRoute()
{
    return self::FILAMENT_ROUTE_PREFIX.$this->panel_id.'.'.$this->route;
}
```

--------------------------------

### Publish language files

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/README.md

Publish the language folder to add translations for the mobile field using propaganistas/laravel-phone.

```shell
php artisan lang:publish
```

--------------------------------

### Permission model static members

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-permission.md

Defines the FILAMENT_ROUTE_PREFIX constant, $cacheKeyPrefix property, and the $fillable, $casts, and $appends properties for the Permission model.

```php
public const FILAMENT_ROUTE_PREFIX = 'filament';

public static string $cacheKeyPrefix = 'permissions_for_panel';

protected $fillable = [
    'name',
    'identifier',
    'panel_ids',
    'route',
    'parent_id',
    'status',
];

protected $casts = [
    'panel_ids' => 'array',
    'status' => 'boolean',
];

protected $appends = ['permission_with_panel_ids'];
```

--------------------------------

### Add fillable, hidden, and casts to User model

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/README.md

Add these properties and casts to your User model: $fillable, $hidden, and the casts() method. The casts include email_verified_at as datetime, password as hashed, last_seen as datetime, and is_active as boolean.

```php
    /**
     * The attributes that are mass assignable.
     *
     * @var array<int, string>
     */
    protected $fillable = [
        'name',
        'email',
        'mobile',
        'password',
        'role_id',
        'last_seen',
        'is_active'
    ];

    /**
     * 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',
            'last_seen' => 'datetime',
            'is_active' => 'boolean',
        ];
    }
```

--------------------------------

### PermissionSeeder run method

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/database-seeders.md

PermissionSeeder invokes the SyncPermissions console command, which reads config/cwsps-permissions.php and upserts/deletes permission rows.

```php
public function run(): void
{
    Artisan::call('permissions:sync');
}
```

--------------------------------

### Check single permission with Gate::allows

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-service-provider.md

Use the Gate facade to verify if the current user has a specific permission identifier.

```php
use Illuminate	Support	Facades	Gate;

if (Gate::allows('have-access', 'view-user')) {
    // current user may view users
}
```

--------------------------------

### ManagePermissions getHeaderActions and related methods

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/filament-pages.md

Defines the header actions (empty), title, and resource for the ManagePermissions page. The empty getHeaderActions means no create action; permissions are synced via artisan command or import action.

```php
protected function getHeaderActions(): array
{
    return [
    ];
}

public function getTitle(): string|Htmlable
{
    return __('users-roles-permissions::users-roles-permissions.permission.resource.permission');
}

public static function getResource(): string
{
    return static::$resource = config('users-roles-permissions.resource.permission');
}
```

--------------------------------

### canCreatePermission

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/users-roles-permissions-plugin.md

Sets the ability to create a permission. Accepts a boolean, a Closure, or a gate ability string with arguments.

```APIDOC
## canCreatePermission

### Description
Sets the ability to create a permission. Accepts a boolean, a Closure, or a gate ability string with arguments.

### Method
PHP method

### Signature
```php
public function canCreatePermission(bool|Closure|string $ability = true, $arguments = null): static
```

### Parameters
- **$ability** (bool|Closure|string) - Optional - A boolean; a Closure evaluated through Filament's `EvaluatesClosures`; or a gate ability name (used with `$arguments`)
- **$arguments** (mixed) - Optional - Gate arguments. Only meaningful when `$ability` is a string

### Returns
`static` (fluent).

### Default after `grantPermissions()`
`['ability' => 'have-access', 'arguments' => 'create-permission']`
```

--------------------------------

### Permission to plugin ability map

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-permission.md

Maps each permission identifier to the plugin setter used by UsersRolesPermissionsPlugin::grantPermissions().

```php
public const ALL_PERMISSIONS = [
    self::PERMISSION => 'canViewAnyPermission',
    self::VIEW_PERMISSION => 'canViewAnyPermission',
    self::CREATE_PERMISSION => 'canCreatePermission',
    self::ROLE => 'canViewAnyRole',
    self::VIEW_ROLE => 'canViewAnyRole',
    self::CREATE_ROLE => 'canCreateRole',
    self::EDIT_ROLE => 'canEditRole',
    self::DELETE_ROLE => 'canDeleteRole',
    self::USER => 'canViewAnyUser',
    self::VIEW_USER => 'canViewAnyUser',
    self::CREATE_USER => 'canCreateUser',
    self::EDIT_USER => 'canEditUser',
    self::DELETE_USER => 'canDeleteUser',
];
```

--------------------------------

### Cluster retrieval - getCluster()

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/filament-resource-role.md

Returns the cluster class from configuration, defaulting to UserManager.

```php
public static function getCluster(): ?string
{
    return static::$cluster = config('users-roles-permissions.cluster');
}
```

--------------------------------

### Migration stubs for role_permissions table

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-role-permission.md

Excerpts from migration stubs that create the pivot table with a permission_id foreign key and add a role_id foreign key. Note the role_id foreign key is added in a separate migration.

```php
// create_role_permissions_table.php.stub (excerpt)
Schema::create('role_permissions', function (Blueprint $table) {
    $table->foreignUuid('permission_id')->constrained('permissions')->cascadeOnDelete();
});
// create_roles_table.php.stub (excerpt)
Schema::table('role_permissions', function (Blueprint $table) {
    $table->foreignUuid('role_id')->constrained('roles')->cascadeOnDelete();
});
```

--------------------------------

### RolePermission usage in service provider and middleware

Source: https://github.com/cwsps154/users-roles-permissions/blob/main/_autodocs/api-reference/models-role-permission.md

Shows two static queries for role-permission membership: one inside the 'have-access' gate and one in the HaveAccess middleware.

```php
// src/UsersRolesPermissionsServiceProvider.php — inside the 'have-access' gate
if (RolePermission::where('role_id', $user->role_id)->where('permission_id', $permission->id)->exists()) {
    return true;
}

// src/Http/Middleware/HaveAccess.php — route-level check
$rolePermission = RolePermission::where('role_id', Auth::user()->role_id)
    ->where('permission_id', $permission->id)
    ->first();
```
Tokens:
Raw