Overview

Filament PHP resources are a core concept used to manage database models in an admin panel. They provide an abstraction layer over CRUD (Create, Read, Update, Delete) operations and allow developers to define how models are managed within the Filament admin panel.

What is a Resource in AureusERP?

A Resource in Filament PHP is a class that represents a database model inside the Filament admin panel. It defines how records of that model are displayed, created, updated, and deleted.

Each resource is stored in the respective module's directory and typically consists of:

• A resource class (e.g., PostResource.php)
• A set of related pages (e.g., ListPosts, CreatePost, EditPost, ViewPost)
• Form and table configurations

Creating a Filament Resource

To generate a Filament resource, use the following command:

php artisan make:filament-resource Post --view --model-namespace=Webkul\\Path\\Models

For more information visit Filament Official Documentation

Upon execution, the command prompts you to select a panel:

 ┌ Which panel would you like to create this in? ───────────────┐
 │ › ● admin                                                    │
 │   ○ customer                                                 │
 └──────────────────────────────────────────────────────────────┘

After selecting the panel, another prompt appears asking you to choose the namespace for the resource:

 ┌ Which namespace would you like to create this in? ────────────────────┐
 │ › ● Webkul\Contact\Filament\Clusters\Configurations\Resources         │
 │   ○ Webkul\Employee\Filament\Clusters\Configurations\Resources        │
 │   ○ Webkul\Employee\Filament\Clusters\Reportings\Resources            │
 │   ○ Webkul\Inventory\Filament\Clusters\Configurations\Resources       │
 │   ○ Webkul\Inventory\Filament\Clusters\Operations\Resources           │
 └───────────────────────────────────────────────────────────────────────┘

Here, you can specify where the resource should be generated based on the module structure.

Once generated, the resource files will be located in:

• Webkul\Blog\Filament\Admin\Resources\PostResource.php
• Webkul\Blog\Filament\Admin\Resources\PostResource/Pages/
  • ListPosts.php
  • CreatePost.php
  • EditPost.php
  • ViewPost.php (if enabled)

For more detailed documentation, refer to the official Filament PHP Documentation.

Anatomy of a Filament Resource

(A) Resource Class (PostResource.php)

The main resource file defines:

• The model it represents
• Navigation settings (icon, group, etc.)
• The table display configuration
• The form fields for creating/editing records

Example PostResource.php

<?php

namespace Webkul\Blog\Filament\Admin\Resources;

use BackedEnum;
use Filament\Actions\DeleteAction;
use Filament\Actions\EditAction;
use Filament\Actions\ViewAction;
use Filament\Forms\Components\TextInput;
use Filament\Infolists\Components\TextEntry;
use Filament\Resources\Resource;
use Filament\Schemas\Schema;
use Filament\Tables\Columns\TextColumn;
use Filament\Tables\Table;
use UnitEnum;
use Webkul\Blog\Filament\Admin\Resources\PostResource\Pages\CreatePost;
use Webkul\Blog\Filament\Admin\Resources\PostResource\Pages\EditPost;
use Webkul\Blog\Filament\Admin\Resources\PostResource\Pages\ListPosts;
use Webkul\Blog\Filament\Admin\Resources\PostResource\Pages\ViewPost;
use Webkul\Blog\Models\Post;
use Webkul\Support\Enums\NavigationGroup;

class PostResource extends Resource
{
    protected static ?string $model = Post::class;

    protected static string|BackedEnum|null $navigationIcon = 'heroicon-o-document-text';

    public static function getNavigationGroup(): string|UnitEnum
    {
        return NavigationGroup::Website;
    }

    public static function form(Schema $schema): Schema
    {
        return $schema
            ->components([
                TextInput::make('title')
                    ->required()
                    ->maxLength(255),
                TextInput::make('slug')
                    ->required()
                    ->unique(Post::class, 'slug', ignoreRecord: true),
            ]);
    }

    public static function table(Table $table): Table
    {
        return $table
            ->columns([
                TextColumn::make('id')->sortable(),
                TextColumn::make('title')->searchable(),
                TextColumn::make('slug')->searchable(),
                TextColumn::make('created_at')->dateTime(),
            ])
            ->filters([])
            ->recordActions([
                ViewAction::make(),
                EditAction::make(),
                DeleteAction::make(),
            ]);
    }

    public static function infolist(Schema $schema): Schema
    {
        return $schema
            ->components([
                TextEntry::make('title')
                    ->placeholder('—'),
                TextEntry::make('slug')
                    ->placeholder('—'),
            ]);
    }

    public static function getRelations(): array
    {
        return [];
    }

    public static function getPages(): array
    {
        return [
            'index'  => ListPosts::route('/'),
            'create' => CreatePost::route('/create'),
            'view'   => ViewPost::route('/{record}'),
            'edit'   => EditPost::route('/{record}/edit'),
        ];
    }
}

A few things to note about the current APIs used above:

• Both form() and infolist() receive and return a Filament\Schemas\Schema object, and components are registered with ->components([...]).
• Layout components such as Group and Section live under Filament\Schemas\Components, while fields (TextInput, Select, etc.) remain under Filament\Forms\Components and entries (TextEntry, ImageEntry, etc.) under Filament\Infolists\Components.
• All actions (row actions, bulk actions, page actions) are unified under the Filament\Actions namespace. Row actions are registered with ->recordActions([...]) and bulk actions with ->toolbarActions([...]) on the table.

For more advanced configurations and customizations, refer to the official Filament documentation. 🚀

(B) Pages

Each resource has associated pages, found in Webkul\Blog\Filament\Admin\Resources\PostResource\Pages. These define how posts interact with the model in the Filament panel.

ListPosts.php (Listing Records)

<?php

namespace Webkul\Blog\Filament\Admin\Resources\PostResource\Pages;

use Filament\Resources\Pages\ListRecords;
use Webkul\Blog\Filament\Admin\Resources\PostResource;

class ListPosts extends ListRecords
{
    protected static string $resource = PostResource::class;
}

• This page lists all Post records with the table columns and filters defined in PostResource.php.

CreatePost.php (Creating a Record)

<?php

namespace Webkul\Blog\Filament\Admin\Resources\PostResource\Pages;

use Filament\Resources\Pages\CreateRecord;
use Webkul\Blog\Filament\Admin\Resources\PostResource;

class CreatePost extends CreateRecord
{
    protected static string $resource = PostResource::class;
}

• This page provides the form defined in PostResource.php for creating a new post.

EditPost.php (Editing a Record)

<?php

namespace Webkul\Blog\Filament\Admin\Resources\PostResource\Pages;

use Filament\Resources\Pages\EditRecord;
use Webkul\Blog\Filament\Admin\Resources\PostResource;

class EditPost extends EditRecord
{
    protected static string $resource = PostResource::class;
}

• This page allows editing a post’s details using the form schema.

ViewPost.php (Viewing a Record)

<?php

namespace Webkul\Blog\Filament\Admin\Resources\PostResource\Pages;

use Filament\Resources\Pages\ViewRecord;
use Webkul\Blog\Filament\Admin\Resources\PostResource;

class ViewPost extends ViewRecord
{
    protected static string $resource = PostResource::class;
}

• If enabled, this allows detailed viewing of a single post record.

Advanced Features

Global Search

You can enable global search for a resource:

protected static ?string $recordTitleAttribute = 'title';

public static function getGloballySearchableAttributes(): array
{
    return ['title', 'author.name'];
}

You can also add extra details to each global search result (Model here is Illuminate\Database\Eloquent\Model):

public static function getGlobalSearchResultDetails(Model $record): array
{
    return [
        __('Author') => $record->author?->name ?? '—',
    ];
}

Relationships

If a post has many comments:

public static function getRelations(): array
{
    return [
        RelationManagers\CommentsRelationManager::class,
    ];
}

And create a CommentsRelationManager class inside Webkul\Blog\Filament\Admin\Resources\PostResource\RelationManagers

<?php

namespace Webkul\Blog\Filament\Admin\Resources\PostResource\RelationManagers;

use Filament\Resources\RelationManagers\RelationManager;

class CommentsRelationManager extends RelationManager
{
    protected static string $relationship = 'comments';

    protected static ?string $title = 'Comments';
}