Filament Users

https://github.com/tomatophp/filament-users
Admin
Filament Users is a FilamentPHP plugin for Laravel that adds a customizable user management...
Tokens:83,594
Snippets:615
Trust Score:10
License:MIT
Update:3 days ago
Show doc for...
Tokens:
Raw
### Install filamen-users package

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Run this Composer command to install the tomatophp/filament-users package.

```bash
composer require tomatophp/filament-users
```

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

### Run shield setup commands

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Run these Artisan commands to set up and configure Filament Shield.

```bash
php artisan shield:setup
php artisan shield:super_admin
```

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

### Install Filament Shield package

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Install the bezhansalleh/filament-shield package to enable role-based access control for the users resource.

```bash
composer require bezhansalleh/filament-shield
```

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

### Example: using getModel()

Source: https://github.com/tomatophp/filament-users

Shows how to call FilamentUser::getModel() and use the returned model class to run a query.

```php
use TomatoPHP\FilamentUsers\Facades\FilamentUser;

$userModel = FilamentUser::getModel();

$count = $userModel::query()->count();
```

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

### Install Laravel Jetstream for Teams

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Install Laravel Jetstream as a prerequisite for using Laravel Jetstream Teams with this package.

```bash
composer require laravel/jetstream
```

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

### UserForm::configure() usage example

Source: https://github.com/tomatophp/filament-users

Shows how configure() is called by UserResource::form() via the resource configuration.

```php
// Called by UserResource::form() via the resource config:
// config('filament-users.resource.form.class')::configure($schema)
```

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

### register() method example

Source: https://github.com/tomatophp/filament-users

Shows how to register custom fields via UserForm::register() in a boot method. The example adds a phone TextInput with tel() and required() modifiers.

```php
use Filament\Forms\Components\TextInput;
use TomatoPHP\FilamentUsers\Filament\Resources\Users\Schemas\UserForm;

public function boot()
{
    UserForm::register([
        TextInput::make('phone')->tel()->required(),
    ]);
}
```

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

### boot(Panel $panel)

Source: https://github.com/tomatophp/filament-users

Boots the plugin on the given panel, conditionally registering feature building blocks into static registries based on configuration and installed packages.

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

### Description
Boots the plugin on the given panel, conditionally registering feature building blocks into static registries based on configuration and installed packages.

### Method
boot

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

### Parameters
#### Parameters
- **$panel** (Filament\Panel) - Required - The panel being booted

### Side Effects
- If `config('filament-users.shield')` is truthy and `BezhanSalleh\FilamentShield\FilamentShield` exists:
  - `UserForm::register(Components\Roles::make())`
  - `UsersTable::register(Columns\Roles::make())`
  - `UserFilters::register(Filters\Roles::make())`
  - `UserBulkActions::register(BulkActions\RolesAction::make())`
  - `UserInfolist::register(Entries\Roles::make())`
- If `config('filament-users.teams')` is truthy and `Laravel\Jetstream\Team` exists:
  - `UserForm::register(Components\Teams::make())`
  - `UsersTable::register(Columns\Teams::make())`
  - `UserFilters::register(Filters\Teams::make())`
  - `UserBulkActions::register(BulkActions\TeamsAction::make())`
  - `UserInfolist::register(Entries\Teams::make())`
- If `config('filament-users.impersonate.enabled')` is truthy:
  - `UserActions::register(Actions\ImpersonateAction::make())`

### Throws
No exceptions are thrown here. The `class_exists()` guards make these registrations no-ops when the optional integrations are not installed.

```

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

### Plugin registration example

Source: https://github.com/tomatophp/filament-users

Registers the plugin on a Filament panel using the make() method.

```php
->plugin(\TomatoPHP\FilamentUsers\FilamentUsersPlugin::make())
```

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

### Full customization example for config/filament-users.php

Source: https://github.com/tomatophp/filament-users

Shows a fully customized published configuration file for the Filament Users package. It sets group, navigation, impersonation banner options, Shield integration, teams, custom models, and resource classes. Note that the 'publish_resource' key is documented but unused because no 'filament-user:publish' artisan command exists.

```php
// config/filament-users.php (published)
return [
    'group' => 'Admin',
    'navigation_sort' => 3,
    'navigation_icon' => 'heroicon-o-users',

    'impersonate' => [
        'enabled' => true,
        'redirect_to' => '/admin/dashboard',
        'back_to' => '/admin/users',
        'leave_middleware' => 'auth',
        'auth_guard' => 'web',
        'banner' => [
            'style' => 'auto',
            'position' => 'bottom',
            'fixed' => false,
        ],
    ],

    'shield' => true,
    'simple' => false,
    'teams' => true,
    'styled_columns' => true,

    'model' => \App\Models\User::class,
    'team_model' => \App\Models\Team::class,
    'roles_model' => \Spatie\Permission\Models\Role::class,

    'resource' => [
        'table' => [
            'class' => \TomatoPHP\FilamentUsers\Filament\Resources\Users\Tables\UsersTable::class,
            'filters' => \TomatoPHP\FilamentUsers\Filament\Resources\Users\Tables\UserFilters::class,
            'actions' => \TomatoPHP\FilamentUsers\Filament\Resources\Users\Tables\UserActions::class,
            'bulkActions' => \TomatoPHP\FilamentUsers\Filament\Resources\Users\Tables\UserBulkActions::class,
        ],
        'form' => [
            'class' => \TomatoPHP\FilamentUsers\Filament\Resources\Users\Schemas\UserForm::class,
        ],
        'infolist' => [
            'class' => \TomatoPHP\FilamentUsers\Filament\Resources\Users\Schemas\UserInfolist::class,
        ],
    ],

    'avatar_collection' => 'avatar',
];
```

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

### Error handling example for getModel()

Source: https://github.com/tomatophp/filament-users

Demonstrates catching the RuntimeException thrown when the configured model class does not exist, logging the error and aborting with HTTP 500.

```php
use TomatoPHP\FilamentUsers\Facades\FilamentUser;

try {
    $model = FilamentUser::getModel();
} catch (\RuntimeException $e) {
    // e.g. "Model class App\Models\User does not exist."
    Log::error('filament-users: misconfigured user model', ['message' => $e->getMessage()]);
    abort(500);
}
```

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

### Example — enabling the teams resource

Source: https://github.com/tomatophp/filament-users

Shows how to enable the teams resource via configuration and how to access the team model from the resource.

```APIDOC
## Example — enabling the teams resource

### Description
Shows how to enable the teams resource via configuration and how to access the team model from the resource.

### Configuration
```php
// config/filament-users.php
'teams' => true,
```

### Usage
```php
// from a service provider boot()
use TomatoPHP\FilamentUsers\Filament\Resources\Teams\TeamResource;

$model = TeamResource::getModel(); // config('filament-users.team_model')
```
```

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

### redirectTo()

Source: https://github.com/tomatophp/filament-users

Sets the URL the admin is redirected to after impersonation starts.

```APIDOC
## redirectTo()

### Description
Sets the URL the admin is redirected to after impersonation starts.

### Method
`public function redirectTo(Closure | string $redirectTo): self`

### Parameters
- `$redirectTo` (Closure | string) - Required - URL, or closure returning one

### Return Type
`self` (fluent).
```

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

### Register custom bulk action in boot()

Source: https://github.com/tomatophp/filament-users

Example of registering a custom bulk action (ForceDeleteBulkAction) via UserBulkActions::register() in a service provider's boot method.

```php
use Filament\Tables\BulkActions\ForceDeleteBulkAction;
use TomatoPHP\FilamentUsers\Filament\Resources\Users\Tables\UserBulkActions;

public function boot()
{
    UserBulkActions::register([
        ForceDeleteBulkAction::make(),
    ]);
}
```

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

### GET /filament-impersonate/leave

Source: https://github.com/tomatophp/filament-users

Leaves the current impersonation session. If not impersonating, redirects to the root path; otherwise, it calls ImpersonateManager::leave() and redirects to the stored back-to URL.

```APIDOC
## [GET] /filament-impersonate/leave

### Description
Leaves the current impersonation session. If not impersonating, redirects to the root path; otherwise, it calls ImpersonateManager::leave() and redirects to the stored back-to URL.

### Method
GET

### Endpoint
/filament-impersonate/leave

### Parameters
No request parameters.

### Response
#### Success Response (302)
- **Location** (string) - `/` or the `impersonate.back_to` session value
- **body** - empty (redirect responses carry no body)

### Status Codes
- **302 Found** - always (both branches are redirects)

### Request Example
No request body (GET request).

### Response Example
No response body (redirect response).
```

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

### Example: Using RolesAction with AuthorizesRecords

Source: https://github.com/tomatophp/filament-users

Shows how to register the bulk roles action. With an app policy in place, users the policy denies 'update' on are silently skipped by the bulk roles action.

```php
use TomatoPHP\FilamentUsers\Filament\Resources\Users\Tables\BulkActions\RolesAction;

// With an app policy (e.g. App\Policies\UserPolicy) in place:
// Users the policy denies 'update' on are silently skipped by the bulk roles action.
UserBulkActions::register(RolesAction::make());
```

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

### register() README hook usage

Source: https://github.com/tomatophp/filament-users

Registers a custom column (or array of columns) with the UsersTable. Non-Column items in the array are skipped. This example shows adding a searchable 'phone' TextColumn in a boot() method, as used in the README.

```php
use Filament\Tables\Columns\TextColumn;
use TomatoPHP\FilamentUsers\Filament\Resources\Users\Tables\UsersTable;

public function boot()
{
    UsersTable::register([
        TextColumn::make('phone')->searchable(),
    ]);
}
```

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

### redirectTo(Closure|string $redirectTo): self

Source: https://github.com/tomatophp/filament-users

Sets the redirect URL after impersonation starts. Accepts a string or a Closure that is resolved lazily when the getter is called.

```APIDOC
## redirectTo(Closure|string $redirectTo): self

### Description
Sets the redirect URL after impersonation starts. Accepts a string or a Closure that is resolved lazily when the getter is called.

### Method
`redirectTo`

### Parameters
- **$redirectTo** (Closure|string) - Required - The redirect URL or a Closure returning the URL.

### Return Value
- **self** - Returns the trait instance for chaining.
```

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

### impersonate() method implementation

Source: https://github.com/tomatophp/filament-users

Public method that starts impersonation. Returns false if canBeImpersonated() fails; otherwise stores impersonate.back_to and impersonate.guard in the session, calls ImpersonateManager::take(), and redirects to getRedirectTo().

```php
public function impersonate($record): bool | Redirector | RedirectResponse
{
    if (! $this->canBeImpersonated($record)) {
        return false;
    }

    session()->put([
        'impersonate.back_to' => $this->getBackTo() ?? request(
            'fingerprint.path',
            request()->header('referer'),
        ) ?? Filament::getCurrentOrDefaultPanel()->getUrl(),
        'impersonate.guard' => $this->getGuard(),
    ]);

    app(ImpersonateManager::class)->take(Filament::auth()->user(), $record, $this->getGuard());

    return redirect($this->getRedirectTo());
}
```

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

### Example: impersonate a user with FilamentUser facade

Source: https://github.com/tomatophp/filament-users

Shows how to use FilamentUser::impersonate() with a guard, redirectTo, and backTo. The result is false when the target equals the current user, already impersonating, or blocked by canImpersonate()/canBeImpersonated().

```php
use TomatoPHP\FilamentUsers\Facades\FilamentUser;

$target = \App\Models\User::find($id);

FilamentUser::guard('web')->redirectTo('/admin')->backTo('/admin/users');

$result = FilamentUser::impersonate($target);

if ($result === false) {
    // target equals current user, already impersonating, or blocked by canImpersonate()/canBeImpersonated()
}
```

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

### boot() method

Source: https://github.com/tomatophp/filament-users

Public method that calls registerImpersonate(). Returns void.

```php
public function boot(): void
{
    $this->registerImpersonate();
}
```

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

### boot()

Source: https://github.com/tomatophp/filament-users

Boots the plugin with a Filament panel. This method is called by Filament after registration to initialize the plugin.

```APIDOC
## boot()

### Description
Boots the plugin with a Filament panel. This method is called by Filament after registration to initialize the plugin.

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

### Parameters
- **$panel** (Panel) - Required - The Filament panel instance to boot the plugin with.

### Returns
- **void**
```

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

### Publish Language Files

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Run this artisan command to publish the filament-users language files.

```bash
php artisan vendor:publish --tag="filament-users-lang"
```

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

### FilamentUser::impersonate()

Source: https://github.com/tomatophp/filament-users

Starts impersonating a given user. This method is available through the Impersonates trait.

```APIDOC
## FilamentUser::impersonate()

### Description
Starts impersonating a given user. This method is available through the Impersonates trait.

### Method
impersonate

### Signature
`public function impersonate()`

### Parameters
- **$user** (mixed) - Required - The user to impersonate.

### Return Value
mixed - The result of the impersonation attempt.
```

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

### configure() method implementation

Source: https://github.com/tomatophp/filament-users

Configures the schema by appending default and registered components.

```php
public static function configure(Schema $schema): Schema
{
    return $schema->components(static::getSchema());
}
```

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

### Publish teams migration and models

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Run this artisan command to publish the teams migration and models.

```bash
php artisan filament-users:teams
```

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

### impersonate($record): bool|Redirector|RedirectResponse

Source: https://github.com/tomatophp/filament-users

Starts impersonation of the given record. Returns a redirect response or boolean depending on the outcome.

```APIDOC
## impersonate($record): bool|Redirector|RedirectResponse

### Description
Starts impersonation of the given record. Returns a redirect response or boolean depending on the outcome.

### Method
`impersonate`

### Parameters
- **$record** (mixed) - Required - The record to impersonate.

### Return Value
- **bool|Redirector|RedirectResponse** - Redirect response on success, or boolean indicating failure.
```

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

### Enable Simple User Resource

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Set 'simple' to true in the filament-users.php config to switch the resource from pages to modals. This changes the user interface behavior.

```php
/**
 * ---------------------------------------------
 * Use Simple Resource
 * ---------------------------------------------
 * change the resource from pages to modals by allow simple resource.
 */
'simple' => true,
```

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

### form(), infolist(), and table() delegate to config classes

Source: https://github.com/tomatophp/filament-users

These static methods delegate schema/table configuration to classes specified in the 'filament-users' config keys (resource.form.class, resource.infolist.class, resource.table.class). Each method returns the configured Schema or Table instance.

```php
public static function form(Schema $schema): Schema       // line 62
{
    return config('filament-users.resource.form.class')::configure($schema);
}

public static function infolist(Schema $schema): Schema   // line 67
{
    return config('filament-users.resource.infolist.class')::configure($schema);
}

public static function table(Table $table): Table         // line 72
{
    return config('filament-users.resource.table.class')::configure($table);
}
```

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

### Get registered relations with FilamentUser::getRelations()

Source: https://github.com/tomatophp/filament-users

Returns the list of registered relations as an array, empty by default. Consumed by UserResource::getRelations().

```php
public static function getRelations(): array
{
    return FilamentUser::getRelations();
}
```

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

### form() / infolist() / table()

Source: https://github.com/tomatophp/filament-users

Static configuration-delegating methods that return the schema or table for the resource. Each method delegates to a class specified in the configuration, allowing customization.

```APIDOC
## form() / infolist() / table()

### Description
Static methods that delegate configuration to classes defined in the Filament Users configuration.

### Methods
- `public static function form(Schema $schema): Schema`
- `public static function infolist(Schema $schema): Schema`
- `public static function table(Table $table): Table`

### Parameters
- **$schema** (`Filament\Schemas\Schema`) - Required - The schema instance for form or infolist.
- **$table** (`Filament\Tables\Table`) - Required - The table instance.

### Return Types
- `Schema` for `form()` and `infolist()`
- `Table` for `table()`

### Delegation
- `form()` → `config('filament-users.resource.form.class')` → `Schemas\UserForm`
- `infolist()` → `config('filament-users.resource.infolist.class')` → `Schemas\UserInfolist`
- `table()` → `config('filament-users.resource.table.class')` → `Tables\UsersTable`

```

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

### getRedirectTo(): string

Source: https://github.com/tomatophp/filament-users

Returns the redirect URL after impersonation starts. Resolves the property or falls back to the configuration value `filament-users.impersonate.redirect_to` (default `/admin`).

```APIDOC
## getRedirectTo(): string

### Description
Returns the redirect URL after impersonation starts. Resolves the property or falls back to the configuration value `filament-users.impersonate.redirect_to` (default `/admin`).

### Method
`getRedirectTo`

### Return Value
- **string** - The resolved redirect URL.
```

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

### Enable shield in filament-users config

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Set the 'shield' option to true in the filament-users.php config file to enable Filament Shield integration.

```php
/*
 * User Filament Shield
 */
"shield" => true,
```

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

### Publish filament-users config

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Publish the package configuration file using this Artisan command.

```bash
php artisan vendor:publish --tag="filament-users-config"
```

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

### isImpersonating() method

Source: https://github.com/tomatophp/filament-users

Returns whether impersonation is active by delegating to the ImpersonateManager. Example shows usage with the FilamentUser facade for banner or page guard logic.

```php
public function isImpersonating(): bool
{
    return app(ImpersonateManager::class)->isImpersonating();
}
```

```php
use TomatoPHP\FilamentUsers\Facades\FilamentUser;

if (FilamentUser::isImpersonating()) {
    // banner / page guard logic
}
```

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

### impersonate($record)

Source: https://github.com/tomatophp/filament-users

Starts an impersonation session for the given user record. Returns false if impersonation is not allowed, otherwise redirects to the configured redirect URL.

```APIDOC
## [POST] impersonate($record)

### Description
Starts an impersonation session for the given user record. Returns false if impersonation is not allowed, otherwise redirects to the configured redirect URL.

### Method
POST

### Endpoint
impersonate($record)

### Parameters
#### Path Parameters
- **$record** (mixed, Eloquent Model) - Required - The user record to impersonate

### Response
#### Success Response (200)
- **bool** - false when impersonation is not allowed
- **RedirectResponse | Redirector** - when impersonation starts; redirect to getRedirectTo()

### Request Example
```php
use TomatoPHP\FilamentUsers\Facades\FilamentUser;

$target = \App\Models\User::find($id);

FilamentUser::guard('web')->redirectTo('/admin')->backTo('/admin/users');

$result = FilamentUser::impersonate($target);

if ($result === false) {
    // target equals current user, already impersonating, or blocked by canImpersonate()/canBeImpersonated()
}
```
```

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

### Migrate teams migration

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Run this artisan command to migrate the teams migration.

```bash
php artisan migrate
```

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

### Blade link to filament-users.leave route

Source: https://github.com/tomatophp/filament-users

Used in the banner component (resources/views/components/banner.blade.php) to provide a link that triggers the leave-impersonation route. The label is translated via the 'filament-users::user.banner.leave' key.

```blade
<a href="{{ route('filament-users.leave') }}">{{ trans('filament-users::user.banner.leave') }}</a>
```

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

### Register custom user actions and bulk actions in boot()

Source: https://github.com/tomatophp/filament-users

Use this in a service provider's boot() method to register custom actions. Registered actions are appended after the defaults returned by make().

```php
use TomatoPHP\FilamentUsers\Filament\Resources\Users\Tables\UserActions;
use TomatoPHP\FilamentUsers\Filament\Resources\Users\Tables\UserBulkActions;

public function boot(): void
{
    // Registered actions are appended after the defaults returned by make()
    UserActions::register([/* custom actions */]);
    UserBulkActions::register([/* custom bulk actions */]);
}
```

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

### Run PEST tests with composer test

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Use this command to run the PEST testing suite for the package.

```bash
composer test
```

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

### TeamInfolist configure() method implementation

Source: https://github.com/tomatophp/filament-users

Configures the schema with entries for user name, team name, personal team icon, and timestamps. Uses Filament TextEntry and IconEntry components with labels from translation keys.

```php
return $schema->components([
    TextEntry::make('user.name')->label(trans('filament-users::user.team.columns.owner'))->numeric(),
    TextEntry::make('name')->label(trans('filament-users::user.team.columns.name')),
    IconEntry::make('personal_team')
        ->label(trans('filament-users::user.team.columns.personal_team'))
        ->boolean(),
    TextEntry::make('created_at')->dateTime()->label(trans('filament-users::user.resource.created_at')),
    TextEntry::make('updated_at')->dateTime()->label(trans('filament-users::user.resource.updated_at')),
]);
```

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

### Get team model from service provider

Source: https://github.com/tomatophp/filament-users

Retrieves the team model class using TeamResource::getModel(), which returns the value of config('filament-users.team_model'). Place this in a service provider's boot() method.

```php
// from a service provider boot()
use TomatoPHP\FilamentUsers\Filament\Resources\Teams\TeamResource;

$model = TeamResource::getModel(); // config('filament-users.team_model')
```

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

### Register Infolist Entry via UserInfolist::register()

Source: https://github.com/tomatophp/filament-users

Hook into the boot method to add a custom infolist entry. Non-Entry items in the array are skipped.

```php
use Filament\Infolists\Components\TextEntry;
use TomatoPHP\FilamentUsers\Filament\Resources\Users\Schemas\UserInfolist;

public function boot()
{
    UserInfolist::register([
        TextEntry::make('last_login_at')->dateTime(),
    ]);
}
```

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

### Route definition for filament-users.leave

Source: https://github.com/tomatophp/filament-users

Defines the only custom HTTP route in routes/web.php. It checks if impersonation is active via ImpersonateManager::isImpersonating(); if not, redirects to '/'. Otherwise calls leave() and redirects to the 'impersonate.back_to' session value (pulled and removed). Middleware is dynamically applied from config('filament-users.impersonate.leave_middleware'), default 'auth'.

```php
Route::get('filament-impersonate/leave', function () {
    if (! app(ImpersonateManager::class)->isImpersonating()) {
        return redirect('/');
    }

    app(ImpersonateManager::class)->leave();

    return redirect(
        session()->pull('impersonate.back_to')
    );
})->name('filament-users.leave')->middleware(config('filament-users.impersonate.leave_middleware'));
```

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

### UsersTable configure() method

Source: https://github.com/tomatophp/filament-users

Configures the table with columns, filters, record actions, and toolbar actions using config-driven classes.

```php
public static function configure(Table $table): Table
{
    return $table
        ->columns(static::getColumns())
        ->filters(config('filament-users.resource.table.filters')::make())
        ->recordActions(config('filament-users.resource.table.actions')::make())
        ->toolbarActions(config('filament-users.resource.table.bulkActions')::make());
}
```

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

### Disable shipped user and teams resources with useUserResource() and useTeamsResource()

Source: https://github.com/tomatophp/filament-users

Use these fluent methods to prevent the plugin from registering its built-in user or teams resources. The example shows disabling the shipped user resource and teams resource when you provide your own UI. Note that teams registration also requires config('filament-users.teams') to be truthy.

```php
// Publish your own user resource and disable the shipped one
FilamentUsersPlugin::make()->useUserResource(false)

// You ship your own teams UI
FilamentUsersPlugin::make()->useTeamsResource(false)
```

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

### Avatar::make()

Source: https://github.com/tomatophp/filament-users

Creates an infolist entry for displaying the user's avatar. It branches based on model trait detection, using a Spatie Media Library image entry for MediaLibrary/tenancy models or a Gravatar fallback image entry otherwise.

```APIDOC
## `Avatar::make()`

### Description
Creates an infolist entry for displaying the user's avatar. It branches based on model trait detection, using a Spatie Media Library image entry for MediaLibrary/tenancy models or a Gravatar fallback image entry otherwise.

### Method
`make`

### Signature
`public static function make(): Infolists\Components\Entry`

### Return Type
`Infolists\Components\Entry`

### Request Example
```php
// No explicit example provided in the source.
```
```

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

### Run PHPStan analysis with composer analyse

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Use this command to run PHPStan static analysis on the codebase.

```bash
composer analyse
```

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

### configure(Schema $schema): Schema

Source: https://github.com/tomatophp/filament-users

Configures the infolist schema by adding default and registered components. This method is called by the resource's infolist() method.

```APIDOC
## configure(Schema $schema): Schema

### Description
Configures the infolist schema by adding default and registered components. This method is called by the resource's infolist() method.

### Method
configure

### Signature
`public static function configure(Schema $schema): Schema`

### Parameters
- **$schema** (Filament\Schemas\Schema) - Required - The incoming schema provided by `Resource::infolist()`

### Return Type
Schema - Schema with default + registered entries appended (registered entries follow defaults via `array_merge`).

### Source
`src/Filament/Resources/Users/Schemas/UserInfolist.php:14`
```

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

### Enable Filament Teams in config

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Add this to your filament-users.php config to enable teams. After updating the config, clear the config cache with the provided artisan commands.

```php
/*
 * User Filament Teams
 */
"teams" => true,
```

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

### Run filament-users:teams and migrate

Source: https://github.com/tomatophp/filament-users

Publishes Jetstream-style team migrations and models into the hosting app, then runs migrations. The command prints 'Filament User Teams Resource published successfully.' after copying 7 files.

```bash
php artisan filament-users:teams
php artisan migrate

```

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

### TeamsTable configure() method implementation

Source: https://github.com/tomatophp/filament-users

Configures the table with columns, filters, record actions, default sort, and toolbar actions. Includes searchable/sortable name column, hidden personal_team icon, dateTime columns, owner filter, view/edit actions, and bulk delete.

```php
return $table
    ->columns([
        Tables\Columns\TextColumn::make('name')
            ->label(trans('filament-users::user.team.columns.name'))
            ->searchable()
            ->sortable(),
        Tables\Columns\IconColumn::make('personal_team')
            ->label(trans('filament-users::user.team.columns.personal_team'))
            ->toggleable(isToggledHiddenByDefault: true),
        Tables\Columns\TextColumn::make('created_at')
            ->label(trans('filament-users::user.resource.created_at'))
            ->dateTime()
            ->sortable()
            ->toggleable(isToggledHiddenByDefault: true),
        Tables\Columns\TextColumn::make('updated_at')
            ->label(trans('filament-users::user.resource.updated_at'))
            ->dateTime()
            ->sortable()
            ->toggleable(isToggledHiddenByDefault: true),
    ])
    ->filters([
        Tables\Filters\SelectFilter::make('owner')
            ->label(trans('filament-users::user.team.columns.owner'))
            ->searchable()
            ->relationship('owner', 'name'),
    ])
    ->recordActions([
        ViewAction::make()->iconButton()->tooltip(__('filament-actions::view.single.label')),
        EditAction::make()->iconButton()->tooltip(__('filament-actions::edit.single.label')),
    ])
    ->defaultSort('id', 'desc')
    ->toolbarActions([
        BulkActionGroup::make([
            DeleteBulkAction::make(),
        ]),
    ]);
```

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

### make()

Source: https://github.com/tomatophp/filament-users

Static factory method that creates a new FilamentUsersPlugin instance. Use this to instantiate the plugin for registration on a Filament panel.

```APIDOC
## make()

### Description
Static factory method that creates a new FilamentUsersPlugin instance. Use this to instantiate the plugin for registration on a Filament panel.

### Method
`public static function make(): self`

### Returns
- **self** - A new FilamentUsersPlugin instance.

### Example
```php
->plugin(\TomatoPHP\FilamentUsers\FilamentUsersPlugin::make())
```
```

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

### Name::make()

Source: https://github.com/tomatophp/filament-users

Creates a text entry for displaying the user's name. It renders a full-width text entry labeled 'Name'.

```APIDOC
## `Name::make()`

### Description
Creates a text entry for displaying the user's name. It renders a full-width text entry labeled 'Name'.

### Method
`make`

### Signature
`public static function make(): Infolists\Components\TextEntry`

### Return Type
`Infolists\Components\TextEntry`

### Request Example
```php
// No explicit example provided in the source.
```
```

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

### Custom Resource Classes Configuration

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Configure custom resource classes for table, form, and infolist in the filament-users config file. Each key maps to a custom class that must return the same structure as the default config.

```php
/**
 * ---------------------------------------------
 * Resource Building
 * ---------------------------------------------
 * if you want to use the resource custom class
 */
'resource' => [
    'table' => [
        'class' => \TomatoPHP\FilamentUsers\Resources\UserResource\Table\UserTable::class,
        'filters' => \TomatoPHP\FilamentUsers\Resources\UserResource\Table\UserFilters::class,
        'actions' => \TomatoPHP\FilamentUsers\Resources\UserResource\Table\UserActions::class,
        'bulkActions' => \TomatoPHP\FilamentUsers\Resources\UserResource\Table\UserBulkActions::class,
    ],
    'form' => [
        'class' => \TomatoPHP\FilamentUsers\Resources\UserResource\Schemas\UserForm::class
    ],
    'infolist' => [
        'class' => \TomatoPHP\FilamentUsers\Resources\UserResource\Schemas\UserInfolist::class
    ]
]
```

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

### Abstract Entry Base Class

Source: https://github.com/tomatophp/filament-users

Base class for all infolist entry factories. Subclasses must implement the static make() method returning a Filament Entry.

```php
// src/Filament/Resources/Users/Schemas/Entries/Entry.php
abstract class Entry
{
    abstract public static function make(): \Filament\Infolists\Components\Entry;
}
```

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

### Register Infolist Entries hook

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Use the UserInfolist class to register custom infolist entries for the user resource.

```php
use TomatoPHP\FilamentUsers\Filament\Resources\Users\Schemas\UserInfolist;

public function boot()
{
    UserInfolist::register([
       \Filament\Infolists\Components\TextEntry::make('something')
    ]);
}
```

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

### Static factory method make()

Source: https://github.com/tomatophp/filament-users

Returns a new FilamentUsersPlugin instance.

```php
public static function make(): self
```

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

### Email::make()

Source: https://github.com/tomatophp/filament-users

Creates a text entry for displaying the user's email address. It renders a text entry labeled 'Email'.

```APIDOC
## `Email::make()`

### Description
Creates a text entry for displaying the user's email address. It renders a text entry labeled 'Email'.

### Method
`make`

### Signature
`public static function make(): Infolists\Components\TextEntry`

### Return Type
`Infolists\Components\TextEntry`

### Request Example
```php
// No explicit example provided in the source.
```
```

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

### Use FilamentUser facade in service provider

Source: https://github.com/tomatophp/filament-users

Shows how to use the FilamentUser facade in a service provider's boot method. Registers a relation manager and checks if impersonation is active, logging the user model when it is.

```php
use TomatoPHP\FilamentUsers\Facades\FilamentUser;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        FilamentUser::register([
            \App\Filament\Resources\Users\RelationManagers\OrdersRelationManager::class,
        ]);

        if (FilamentUser::isImpersonating()) {
            Log::info('Impersonation session active', ['user' => FilamentUser::getModel()]);
        }
    }
}
```

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

### Clear config cache

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Run these Artisan commands to clear and optimize the configuration cache after changing config files.

```bash
php artisan config:cache
php artisan optimize
```

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

### getPages() returns page routes based on simple config

Source: https://github.com/tomatophp/filament-users

Returns Filament page routes for the user resource. When config('filament-users.simple') is true, only an 'index' route using ManageUsers is returned; otherwise it returns index, create, edit, and view routes. The default config value is false.

```php
public static function getPages(): array
{
    return
        config('filament-users.simple')
            ? [
                'index' => Pages\ManageUsers::route('/'),
            ] : [
                'index' => Pages\ListUsers::route('/'),
                'create' => Pages\CreateUser::route('/create'),
                'edit' => Pages\EditUser::route('/{record}/edit'),
                'view' => Pages\ViewUser::route('/{record}'),
            ];
}
```

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

### Enable Filament Impersonate in config

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Add this to your filament-users.php config to enable impersonation. After updating the config, clear the config cache with the provided artisan commands.

```php
/*
 * User Filament Impersonate
 */
"impersonate" => [
    'enable' => true
],
```

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

### Register Table Bulk Actions hook

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Use the UserBulkActions class to register custom bulk actions for the user resource.

```php
use TomatoPHP\FilamentUsers\Filament\Resources\Users\Tables\UserBulkActions;

public function boot()
{
    UserBulkActions::register([
        \Filament\Tables\BulkActions\DeleteAction::make()
    ]);
}
```

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

### Per-panel user model configuration

Source: https://github.com/tomatophp/filament-users

Configure different user model classes for each panel using the 'model' config key. FilamentUser::getModel() resolves the class via filament()->getId() and falls back to the first entry for unknown ids. After changing config, run 'php artisan config:cache && php artisan optimize'.

```php
// Two panels, two user models
'model' => [
    'admin' => \App\Models\Admin::class,
    'api'   => \App\Models\User::class,
],
```

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

### Roles::make()

Source: https://github.com/tomatophp/filament-users

Creates a text entry for displaying the user's roles as success badges. It is visible only when roles exist and is auto-registered when shield is enabled.

```APIDOC
## `Roles::make()`

### Description
Creates a text entry for displaying the user's roles as success badges. It is visible only when roles exist and is auto-registered when shield is enabled.

### Method
`make`

### Signature
`public static function make(): Infolists\Components\TextEntry`

### Return Type
`Infolists\Components\TextEntry`

### Request Example
```php
return Infolists\Components\TextEntry::make('roles.name')
    ->visible(static fn ($record) => $record->roles->isNotEmpty())
    ->columnSpanFull()
    ->badge()
    ->icon('heroicon-o-shield-check')
    ->color('success')
    ->label(trans('filament-users::user.resource.roles'));
```
```

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

### getDefaultComponents() method implementation

Source: https://github.com/tomatophp/filament-users

Builds the default entry components, conditionally including avatar based on hasAvatar().

```php
public static function getDefaultComponents(): array
{
    $components = [];
    if (filament('filament-user')::hasAvatar()) {
        $components[] = Entries\Avatar::make();
    }

    $components[] = Entries\Name::make();
    $components[] = Entries\Email::make();
    $components[] = Entries\Verified::make();

    return $components;
}
```

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

### form(), infolist(), and table() delegate to factory classes

Source: https://github.com/tomatophp/filament-users

These schema methods are hardwired to the shipped factory classes without config indirection. form() delegates to Schemas\TeamForm, infolist() to Schemas\TeamInfolist, and table() to Tables\TeamsTable, each documented in team-schema.md.

```php
public static function form(Schema $schema): Schema        // line 55
{
    return TeamForm::configure($schema);
}

public static function infolist(Schema $schema): Schema    // line 60
{
    return TeamInfolist::configure($schema);
}

public static function table(Table $table): Table          // line 65
{
    return TeamsTable::configure($table);
}
```

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

### Import FilamentUsersPlugin

Source: https://github.com/tomatophp/filament-users

Import the plugin class for use in a Filament panel provider.

```php
use TomatoPHP\FilamentUsers\FilamentUsersPlugin;
```

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

### Expose default UserInfolist components in infolist

Source: https://github.com/tomatophp/filament-users

Use this snippet to compose a Filament infolist schema with all default entries from UserInfolist. It imports the UserInfolist class and returns the schema with getDefaultComponents().

```php
use TomatoPHP\FilamentUsers\Filament\Resources\Users\Schemas\UserInfolist;

// Expose every default entry for manual schema composition
public static function infolist(Schema $schema): Schema
{
    return $schema->components(UserInfolist::getDefaultComponents());
}
```

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

### Avatar::make() with Spatie Media Library

Source: https://github.com/tomatophp/filament-users

Returns a SpatieMediaLibraryFileUpload when the user model uses Spatie\MediaLibrary\InteractsWithMedia or TomatoPHP\FilamentSaasPanel\Traits\InteractsWithTenant. Uses config('filament-users.avatar_collection') for the collection name.

```php
SpatieMediaLibraryFileUpload::make(config('filament-users.avatar_collection'))
    ->label(trans('filament-users::user.resource.avatar'))
    ->columnSpanFull()
    ->alignCenter()
    ->image()
    ->collection(config('filament-users.avatar_collection'))
    ->avatar()
    ->imageEditor()
    ->imageEditorAspectRatios(['16:9', '4:3', '1:1']);
```

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

### Teams::make() TextColumn factory

Source: https://github.com/tomatophp/filament-users

Creates a TextColumn for teams.name with an info badge and users icon. No explicit label is set. Auto-registered when teams = true.

```php
return Tables\Columns\TextColumn::make('teams.name')
    ->color('info')
    ->icon('heroicon-o-users')
    ->toggleable()
    ->badge();
```

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

### Import FilamentUser Facade

Source: https://github.com/tomatophp/filament-users

Use this import to access the FilamentUser facade, which provides customization APIs for the user resource, including registered RelationManagers and impersonation helpers.

```php
use TomatoPHP\FilamentUsers\Facades\FilamentUser;
```

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

### Register User Relation Manager

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Use the FilamentUser facade to register a custom relation manager in your service provider's boot method.

```php
use TomatoPHP\FilamentUsers\Facades\FilamentUser;

public function boot()
{
    FilamentUser::register([
        \Filament\Resources\RelationManagers\RelationManager::make() // Replace with your custom relation manager
    ]);
}
```

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

### getModel() method

Source: https://github.com/tomatophp/filament-users

Returns the fully qualified class name (FQCN) of the Filament user model by delegating to FilamentUser::getModel(). Throws RuntimeException if the configured class does not exist.

```php
public static function getModel(): string
{
    return FilamentUser::getModel();
}
```

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

### register() method - panel registration

Source: https://github.com/tomatophp/filament-users

Registers user and team resources on the panel based on static flags and config. If useUserResource is true, adds Users\UserResource; if config('filament-users.teams') and useTeamsResource are true, adds Teams\TeamResource.

```php
public function register(Panel $panel): void
{
    if (self::$useUserResource) {
        $panel->resources([
            Users\UserResource::class,
        ]);
    }

    if (config('filament-users.teams') && self::$useTeamsResource) {
        $panel->resources([
            Teams\TeamResource::class,
        ]);
    }
}
```

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

### getPluralLabel() / getLabel()

Source: https://github.com/tomatophp/filament-users

Returns the plural and singular labels for the user resource, using translations with defaults.

```APIDOC
## getPluralLabel() / getLabel()

### Description
Returns the plural and singular labels for the user resource, using translations with defaults.

### Signatures
- `public static function getPluralLabel(): string` — `trans('filament-users::user.resource.label')`.
- `public static function getLabel(): string` — `trans('filament-users::user.resource.single')` (default `'User'`).

### Return Type
`string` for both.
```

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

### TeamForm configure method implementation

Source: https://github.com/tomatophp/filament-users

Attaches three components to the schema: a required TextInput for 'name', a required Select for 'user_id' with relationship 'owner', and a Toggle for 'personal_team'.

```php
return $schema->components([
    Forms\Components\TextInput::make('name')
        ->label(trans('filament-users::user.team.columns.name'))
        ->required()
        ->maxLength(255),
    Forms\Components\Select::make('user_id')
        ->label(trans('filament-users::user.team.columns.owner'))
        ->relationship('owner', 'name')
        ->required()
        ->preload()
        ->searchable(),
    Forms\Components\Toggle::make('personal_team')->label(trans(
        'filament-users::user.team.columns.personal_team',
    )),
]);
```

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

### Fix code style with composer format

Source: https://github.com/tomatophp/filament-users/blob/master/README.md

Use this command to automatically fix code style issues in the project.

```bash
composer format
```

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

### getDefaultComponents(): array

Source: https://github.com/tomatophp/filament-users

Returns the default array of Entry components for the infolist, including avatar (if enabled), name, email, and verified entries.

```APIDOC
## getDefaultComponents(): array

### Description
Returns the default array of Entry components for the infolist, including avatar (if enabled), name, email, and verified entries.

### Method
getDefaultComponents

### Signature
`public static function getDefaultComponents(): array`

### Return Type
array of Entry instances

### Returned Components
| # | Entry factory | State path | Condition |
|---|---------------|------------|-----------|
| 1 | `Entries\Avatar::make()` | `avatar` collection or `profile_photo_path` | only when `hasAvatar()` |
| 2 | `Entries\Name::make()` | `name` | always |
| 3 | `Entries\Email::make()` | `email` | always |
| 4 | `Entries\Verified::make()` | `email_verified_at` | always |

### Source
`src/Filament/Resources/Users/Schemas/UserInfolist.php:19`
```

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

### Roles::make() TextColumn factory

Source: https://github.com/tomatophp/filament-users

Creates a TextColumn for roles.name with formatted state, success badge, and shield icon. Auto-registered when shield = true.

```php
return Tables\Columns\TextColumn::make('roles.name')
    ->formatStateUsing(static fn ($state) => str($state)->replace('_', ' ')->replace('-', ' ')->title())
    ->icon('heroicon-o-shield-check')
    ->color('success')
    ->toggleable()
    ->badge()
    ->label(trans('filament-users::user.resource.roles'));
```

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

### Import UsersTable class

Source: https://github.com/tomatophp/filament-users

Import the UsersTable class from the TomatoPHP Filament Users package.

```php
use TomatoPHP\FilamentUsers\Filament\Resources\Users\Tables\UsersTable;
```
Tokens:
Raw