rolland97/filament-resource-customizer

Split Filament resource tables into dedicated classes and scaffold Filament Shield permissions, including a runtime permission helper.

v2.1.1 2026-07-07 07:24 UTC

Requires

• php: ^8.3|^8.4|^8.5
• illuminate/contracts: ^11.0||^12.0||^13.0
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• bezhansalleh/filament-shield: *
• larastan/larastan: ^3.0
• laravel/pint: ^1.14
• orchestra/testbench: ^10.5.0
• pestphp/pest: ^4.0
• phpstan/extension-installer: ^1.4
• phpstan/phpstan-deprecation-rules: ^2.0

MIT

• Rolland

• generator
• laravel
• permissions
• filament
• Rolland97
• filament-resource-customizer

Published on Packagist.org on 2026-07-07 07:30 UTC

README

Split Filament resource tables into dedicated classes, and scaffold Filament Shield permissions — including a runtime permission helper.

What it does

• Splits a Filament resource table into dedicated column, filter, and action classes.
• Generates a permissions class per resource (optional).
• Builds or updates Filament Shield resources.manage entries.
• Provides a BaseResourcePermissions helper whose can() / permissions() / permissionKey() produce Filament Shield gate strings at runtime.

Requirements

• PHP 8.3, 8.4, or 8.5, and Laravel 11, 12, or 13 (this package's dependencies).
• Filament v4 or v5 — your application's dependency, not a hard composer dependency of this package.
• Filament Shield (bezhansalleh/filament-shield) — optional; required only for the permission helper (BaseResourcePermissions::can()/permissions()/permissionKey()) and the filament:shield-config command.

This package generates and rewrites Filament resource files as source code; it does not load Filament at runtime, so no filament/* package is a hard dependency. Generated output targets APIs common to Filament v4 and v5. Full application-level compatibility across both majors is verified manually per release (a CI matrix booting generated resources under each major is planned).

Permission helper (BaseResourcePermissions)

BaseResourcePermissions::can(), permissions(), and permissionKey() build authorization gate strings by delegating to Filament Shield, so they require bezhansalleh/filament-shield to be installed. Called without it, they throw a RuntimeException. The rest of the package (table customization, file generation) does not require Shield.

// Full gate string, matching what Shield registered (incl. panel prefix + case):
RequestPermissions::permissionKey('viewApprovalTrail'); // "system:ViewApprovalTrail:Request"

// Authorization check for the current user:
RequestPermissions::can('viewApprovalTrail');           // bool

// All gate strings for the class's methods():
RequestPermissions::permissions();                      // ["system:ViewApprovalTrail:Request", ...]

The panel prefix (system: above) is only added on Filament Shield versions that expose panel prefixing; on versions without it the helpers return the unprefixed key (e.g. ViewApprovalTrail:Request). Either way the result matches what Shield itself registered. A custom FilamentShield::buildPermissionKeyUsing() closure is not honored by these helpers; they use Shield's default key builder.

Installation

composer require rolland97/filament-resource-customizer

Install as a normal (non-dev) dependency: the package ships BaseResourcePermissions, which generated permission classes extend and call at runtime from your policies. Installing with --dev is acceptable only if you use the code-generation commands alone and never use the generated permission classes or helper at runtime.

Publish the config:

php artisan vendor:publish --tag="filament-resource-customizer-config"

Publish stubs (optional):

php artisan vendor:publish --tag="filament-resource-customizer-stubs"

Quick Start

1. Customize a resource:

php artisan filament:customize-resource DepartmentResource

(DepartmentResource is just an example — replace it with your actual resource class.)

1. Or run everything at once:

php artisan filament:customize-resource-all DepartmentResource

Usage

Customize a resource by splitting tables/filters/actions into separate classes:

php artisan filament:customize-resource DepartmentResource

Target a specific panel:

php artisan filament:customize-resource DepartmentResource --panel=Admin

Generate a permissions class for a resource:

php artisan filament:make-resource-permissions DepartmentResource

Generate Filament Shield resources configuration:

php artisan filament:shield-config

Generate for a specific panel:

php artisan filament:shield-config --panel=Admin

Merge with existing resources:

php artisan filament:shield-config --merge

Run all steps (customize, permissions, and Shield config) in one command:

php artisan filament:customize-resource-all DepartmentResource

Run all steps for a specific panel:

php artisan filament:customize-resource-all DepartmentResource --panel=Admin

The target config must already contain a resources.manage array — the command updates it in place and fails with a clear message if it is absent (publish the Filament Shield config first). Everything outside resources.manage is left untouched.

Commands

Command	Description
filament:customize-resource	Generate table, column, filter, and action classes
filament:make-resource-permissions	Generate only the permissions class
filament:shield-config	Update Filament Shield resources.manage
filament:customize-resource-all	Run customize + permissions + Shield config

Options

Option	Commands	Effect
--panel=Name	all	Target a single panel (resolved from panels.path_template, default app/Filament/Name/Resources).
--force	customize-resource, make-resource-permissions, customize-resource-all	Overwrite existing generated files. A resource whose table is already customized (it delegates to generated component classes) is still refused — restore its original inline table to re-run.
--merge / --no-merge	shield-config, customize-resource-all	Merge with, or replace, existing resources.manage rows. Defaults to the shield.merge config value.
--path=	shield-config, customize-resource-all	Path to the Filament Shield config to update (default config/filament-shield.php).

Configuration

Key options in config/filament-resource-customizer.php:

• resources_path: Where Filament resources live; accepts a string or array (default: app/Filament/Resources)
• stubs_path: Custom stub directory (default: stubs/filament-resource-customizer)
• panels.auto_detect: Auto-detect Filament panel resource paths under app/Filament/*/Resources (default: true)
• permissions.enabled: Toggle permissions generation
• permissions.placement: resource, parent, or custom
• permissions.custom_path: Target path if placement is custom
• permissions.namespace: Override permissions namespace
• shield.default_methods: Default methods when no permissions class exists
• shield.static_resources: Always include these resources in manage
• shield.merge: Default merge behavior for filament:shield-config

Permission base class

Generated permission classes extend Rolland\FilamentResourceCustomizer\Support\BaseResourcePermissions by default. To make them extend a shared or custom base instead (for example, a per-app base class that other permission classes inherit from), set permissions.base_class:

// config/filament-resource-customizer.php
'permissions' => [
    // ...
    'base_class' => \App\Filament\Permissions\BasePermissions::class,
],

The configured class must exist; generation fails with a clear error otherwise. The generated file imports it automatically (unless it lives in the generated class's own namespace).

Generated permission methods

Generated permission classes are populated from shield.default_methods: each method becomes a SCREAMING_SNAKE constant, and methods() returns those constants.

class UserPermissions extends BaseResourcePermissions
{
    public const VIEW_ANY = 'viewAny';
    // ... view, create, update, delete

    public static function methods(): array
    {
        return [self::VIEW_ANY /* , ... */];
    }
}

Add your resource-specific permissions (e.g. viewApprovalTrail) as extra constants and append them to methods(). Set shield.default_methods to [] to generate an empty methods().

Filament Shield integration

If you use Filament Shield, the filament:shield-config command will update resources.manage. By default it replaces entries unless you:

• pass --merge, or
• set shield.merge to true in the config.

Keeping hand-maintained config across runs. filament:shield-config only rewrites the resources.manage array — every other section of config/filament-shield.php (for example policies.single_parameter_methods) is left untouched. To keep extra entries inside manage:

• run with --merge (or set shield.merge to true) so existing manage rows are preserved alongside the generated ones;
• declare rows that should always be present in shield.static_resources (config: filament-resource-customizer.shield.static_resources) — these are injected on every run and survive even without --merge.

Note: comments written inside the manage array are not preserved when it is regenerated; comments elsewhere in the file are kept.

Multi-panel setups

You can use any combination of these:

• --panel=Admin to target a single panel for a command.
• resources_path as an array, e.g. ['app/Filament/Resources', 'app/Filament/Admin/Resources'].
• panels.auto_detect=true to auto-add app/Filament/*/Resources alongside the configured paths.

Example Structure

Running the customize command for a resource will generate classes like these:

app/Filament/Resources/Department/Departments/
├── DepartmentResource.php
├── DepartmentPermissions.php
└── Tables/
    ├── DepartmentsTable.php
    ├── DepartmentsColumn.php
    ├── DepartmentsFilter.php
    ├── DepartmentsRecordAction.php
    └── DepartmentsToolbarAction.php

Testing

composer test

Changelog

Please see CHANGELOG for more information.

Upgrading

To the shield-aware permission helper

BaseResourcePermissions::permissions() now returns full Shield gate strings (e.g. system:ViewApprovalTrail:Request) instead of the previous method:Resource form, and can() now returns correct results in panel-prefixed apps. If you hardcoded gate strings in your policies, you can replace them with YourPermissions::can('method'). These methods now require bezhansalleh/filament-shield.

License

The MIT License (MIT). Please see License File for more information.