• Screenshots
• Features
• Installation
• Publish Account Model
• Add Accounts Guard
• Usage
• Auto Account Meta Caching
  • Use Accounts as SaaS Panel
  • Use Notifications
  • Use Account Locations
• Use Filament Types
  • Use Account Column
• Use Filament Impersonate
  • How to use builder
• Custom create / edit validation
• Attach New Field To Accounts
  • Attach Relation To Accounts
  • Attach Table Button
• Auth Events
  • OTP Event
  • Account Success Login Event
  • Account Registered Event
• Use Auth Builder
  • How to use
• APIs
• Other Filament Packages
• Support
• Docs
• Changelog
• Security
• Credits
• License

full accounts manager with API/Notifications/Contacts to manage your contacts and accounts

#Screenshots

#Features

• [x] Accounts Manager
• [x] Cached Meta
• [x] Account Locations
• [x] Account Teams
• [x] Account Types
• [x] Account Requests
• [x] Account SaaS Panel With Edit Profile [Jetstream]
• [x] Account Login By
• [x] Account Active/Block
• [x] Account Avatar
• [x] Account OTP Activation
• [x] Account Filament Alerts Integration
• [x] Account Impersonate Integration
• [x] Account APIs
• [x] Auth Builder Service
• [x] Support Multi Tenants
• [x] Account Table Column
• [x] Account Panel Events
• [x] Attach New Field To Accounts
• [x] Export
• [x] Import
• [ ] Google Contacts Integrations

#Installation

composer require tomatophp/filament-accounts

after install your package please run this command

php artisan filament-accounts:install

if you are not using this package as a plugin please register the plugin on /app/Providers/Filament/AdminPanelProvider.php

->plugin(\TomatoPHP\FilamentAccounts\FilamentAccountsPlugin::make()
    ->useAccountMeta()
    ->showAddressField()
    ->showTypeField()
    ->useRequests()
    ->useContactUs()
    ->useLoginBy()
    ->useAvatar()
    ->useAPIs()
)

NOTE To make ->useAvatar() work you need the Media Library plugin to be installed and migrated you can use this command to publish the migration

php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="medialibrary-migrations"

#Publish Account Model

you can publish your account model to add other relations or implement some interfaces by using this command

php artisan vendor:publish --tag="filament-accounts-model"

now go to your filament-accounts.php config file and change the model value to the new one.

if you don't find it you can publish it

php artisan vendor:publish --tag="filament-accounts-config"

#Add Accounts Guard

now you need to add a new guard to your auth.php config like this

<?php
 
return [
 /*
    * Features of Tomato CRM
    *
    * accounts: Enable/Disable Accounts Feature
    */
    "features" => [
        "accounts" => true,
        "meta" => true,
        "locations" => true,
        "contacts" => true,
        "requests" => true,
        "notifications" => true,
        "loginBy" => true,
        "avatar" => true,
        "types" => true,
        "teams" => true,
        "apis" => true,
        "send_otp" => true,
        "impersonate" => [
            'active'=> true,
            'redirect' => '/app',
        ],
    ],
 
    /*
     * Accounts Configurations
     *
     * resource: User Resource Class
     */
    "resource" => null,
 
    /*
     * Accounts Configurations
     *
     * login_by: Login By Phone or Email
     */
    "login_by" => "email",
 
    /*
     * Accounts Configurations
     *
     * required_otp: Enable/Disable OTP Verification
     */
    "required_otp" => true,
 
    /*
     * Accounts Configurations
     *
     * model: User Model Class
     */
    "model" => \TomatoPHP\FilamentAccounts\Models\Account::class,
 
    /*
     * Accounts Configurations
     *
     * guard: Auth Guard
     */
    "guard" => "accounts",
];

#Usage

this plugin makes it easy to make a starting point for your app if this app has customers to manage

but here is the problem, every app has a different way of managing customers, so we built a Facade service to control the way you want to manage your customers

#Auto Account Meta Caching

on your .env add this

CACHE_STORE=array
MODEL_CACHE_STORE=array

supported cache stores are

+ Redis
+ MemCached
+ APC
+ Array

#Use Accounts as SaaS Panel

install jetstream without install it.

composer require laravel/jetstream

than publish the migrations

php artisan vendor:publish --tag=filament-accounts-teams-migrations

now you need to migrate your database

php artisan migrate

now publish your Accounts model

php artisan vendor:publish --tag="filament-accounts-model"

inside your published model use this implementation

class Account extends Authenticatable implements HasMedia, FilamentUser, HasAvatar, HasTenants, HasDefaultTenant
{
    ...
    use InteractsWithTenant;
}

on your main panel you must use teams

->plugin(\TomatoPHP\FilamentAccounts\FilamentAccountsPlugin::make()
        ...
        ->canLogin()
        ->canBlocked()
        ->useTeams()
)

now on your new panel just use this plugin

->plugin(
    FilamentAccountsSaaSPlugin::make()
        ->databaseNotifications()
        ->checkAccountStatusInLogin()
        ->APITokenManager()
        ->editTeam()
        ->deleteTeam()
        ->teamInvitation()
        ->showTeamMembers()
        ->editProfile()
        ->editPassword()
        ->browserSesstionManager()
        ->deleteAccount()
        ->editProfileMenu()
        ->registration()
        ->useOTPActivation(),
)

you can change settings by remove just methods from plugin.

NOTE to use ->useOTPActivation() you need to install Filament Alets from the next step first, and to use ->databaseNotifications() you need to publish notification database table first

#Use Notifications

to make ->useOTPActivation() work you need to install Filament Alets and allow ->useNotifications() on the plugin

->plugin(\TomatoPHP\FilamentAccounts\FilamentAccountsPlugin::make()
    ...
    ->useNotifications()
)

#Use Account Locations

you can use account locations by install Filament Locations and allow ->useLocations() on the plugin

->plugin(\TomatoPHP\FilamentAccounts\FilamentAccountsPlugin::make()
    ...
    ->useLocations()
)

#Use Filament Types

you can use the types to manage your accounts types by install Filament Types and allow ->useTypes() on the plugin

->plugin(\TomatoPHP\FilamentAccounts\FilamentAccountsPlugin::make()
    ...
    ->useTypes()
)

#Use Account Column

you can use the account column in any table by using this code

public static function table(Table $table): Table
{
    return $table
        ->columns([
            AccountColumn::make('account.id'),
        ]);
}

just pass the account id to the column

#Use Filament Impersonate

you can use the impersonate to impersonate the user by install it first

composer require stechstudio/filament-impersonate

now on your main panel provider add ->useImpersonate() , ->impersonateRedirect('/app') to the plugin

->plugin(\TomatoPHP\FilamentAccounts\FilamentAccountsPlugin::make()
    ...
    ->useImpersonate()
    ->impersonateRedirect('/app')
)

now clear your config

php artisan config:cache

for more information check the Filament Impersonate

#How to use builder

just install the package and you will get everything working, it supports some features ready to use:

• Accounts
• Locations
• Contact Us
• Send Notifications
• Auth APIs
• Send OTP Events

you can activate or deactivate any feature you want from the package config file.

#Custom create / edit validation

you can custom the validation rules for creating / editing accounts by just passing the rules you want to the facade service method

 
use TomatoPHP\FilamentAccounts\Facades\FilamentAccounts;
 
public function boot()
{
    FilamentAccounts::validation(
        create: [
            'email' => 'unique:accounts,email',
            'type_id' => 'required|integer|exists:types,id',
        ],
        edit: [
            'email' => 'sometimes|unique:accounts,email',
            'type_id' => 'sometimes|integer|exists:types,id',
        ],
        api_create: [
            'email' => 'unique:accounts,email',
            'type_id' => 'required|integer|exists:types,id',
        ],
        api_edit: [
            'email' => 'sometimes|unique:accounts,email',
            'type_id' => 'sometimes|integer|exists:types,id',
        ]
    );
 
}

by using this method you can custom the validation rules for creating / editing accounts on the web and APIs

#Attach New Field To Accounts

you can attach a new field to the accounts table by just passing the field name and the field type to the facade service method

 
use TomatoPHP\FilamentAccounts\Facades\FilamentAccounts;
 
public function boot()
{
    FilamentAccounts::attach(
        key: 'birthday',
        label: __('Birthday'),
        type: 'date',
        show_on_create: false,
        show_on_edit: false
    );
}

#Attach Relation To Accounts

you can attach a new relation to the accounts relations manager by just passing the relation class to the facade service method

use TomatoPHP\FilamentAccounts\Facades\FilamentAccounts;
 
public function boot()
{
    FilamentAccounts::registerAccountRelation([
        AccountOrdersRelationManager::make()
    ]);
}

#Attach Table Button

you can attach a new button to the accounts table by just passing the button class to the facade service method

use TomatoPHP\FilamentAccounts\Facades\FilamentAccounts;
 
public function boot()
{
    FilamentAccounts::registerAccountActions([
        \Filament\Tables\Actions\Action::make('orders')
    ]);
}

#Auth Events

we have added a lot of events to the package, so you can listen to them and do what you want.

#OTP Event

use TomatoPHP\FilamentAccounts\Events\SendOTP;
use TomatoPHP\FilamentAlerts\Services\SendNotification;
 
public function register()
{
    Event::listen([
        SendOTP::class
    ], function ($data) {
        $user = $data->model::find($data->modelId);
 
        SendNotification::make(['email'])
            ->title('OTP')
            ->message('Your OTP is ' . $user->otp_code)
            ->type('info')
            ->database(false)
            ->model(Account::class)
            ->id($user->id)
            ->privacy('private')
            ->icon('bx bx-user')
            ->url(url('/'))
            ->fire();
    });
}

#Account Success Login Event

When the user logs in successfully, we fire this event.

use TomatoPHP\FilamentAccounts\Events\AccountLogged;
 
public function register()
{
    Event::listen([
        AccountLogged::class
    ], function ($data) {
        $user = $data->model::find($data->modelId);
        if($user->meta('is_admin_approve') !== 'yes'){
            return response()->json([
                "status" => false,
                "message" => __('your Account is activated. but you cannot login till admin approve.'),
            ], 400)->send();
        }
    });
}

#Account Registered Event

When the user registers successfully, we fire this event.

use TomatoPHP\FilamentAccounts\Events\AccountLogged;
 
public function register()
{
    Event::listen([
        AccountRegistered::class
    ], function ($data) {
        $user = $data->model::find($data->modelId);
        $user->last_login = Carbon::now();
        $user->save();
    });
}

#Use Auth Builder

you can build multi-auth using the same accounts table in a very easy way, so we created a Facade class to help you do that.

#How to use

you just need to create 2 controllers AuthController, ProfileController

 
use TomatoPHP\FilamentAccounts\Services\Traits\Auth\Login;
use TomatoPHP\FilamentAccounts\Services\Traits\Auth\Register;
use TomatoPHP\FilamentAccounts\Services\Traits\Auth\Otp;
use TomatoPHP\FilamentAccounts\Services\Traits\Auth\ResetPassword;
 
class AuthController extends Controller
{
    use Login;
    use Register;
    use Otp;
    use ResetPassword;
 
    public string $guard = 'web';
    public bool $otp = true;
    public string $model = Account::class;
    public string $loginBy = 'email';
    public string $loginType = 'email';
    public ?string $resource = null;
 
    public function __construct()
    {
        $this->guard = config('filament-accounts.guard');
        $this->otp = config('filament-accounts.required_otp');
        $this->model = config('filament-accounts.model');
        $this->loginBy = config('filament-accounts.login_by');
        $this->loginType = config('filament-accounts.login_by');
        $this->resource = config('filament-accounts.resource', null);
    }

and on your profile controller, you just need to use Profile traits

use TomatoPHP\FilamentAccounts\Services\Traits\Auth\Profile\User;
use TomatoPHP\FilamentAccounts\Services\Traits\Auth\Profile\Update;
use TomatoPHP\FilamentAccounts\Services\Traits\Auth\Profile\Delete;
use TomatoPHP\FilamentAccounts\Services\Traits\Auth\Profile\Logout;
 
class ProfileController extends Controller
{
    use User;
    use Update;
    use Delete;
    use Logout;
 
    public string $guard = 'web';
    public bool $otp = true;
    public string $model = Account::class;
    public string $loginBy = 'email';
    public string $loginType = 'email';
    public ?string $resource = null;
 
    public function __construct()
    {
        $this->guard = config('filament-accounts.guard');
        $this->otp = config('filament-accounts.required_otp');
        $this->model = config('filament-accounts.model');
        $this->loginBy = config('filament-accounts.login_by');
        $this->loginType = config('filament-accounts.login_by');
        $this->resource = config('filament-accounts.resource', null);
    }
}

#APIs

we have added a lot of APIs to the package, so you can use them to manage your accounts. please check this file API Collection

#Other Filament Packages

• Filament Users
• Filament Translations
• Filament Settings Hub
• Filament Locations Seeder
• Filament Alerts
• Filament Wallet Manager
• Filament Artisan Runner
• Filament File Browser
• Filament Developer Gate
• Filament Icons Picker
• Filament Menus Generator
• Filament Splade Integration
• Filament Types Manager
• Filament Plugins
• Filament Helpers Classes

#Support

you can join our discord server to get support TomatoPHP

#Docs

you can check docs of this package on Docs

#Changelog

Please see CHANGELOG for more information on what has changed recently.

#Security

Please see SECURITY for more information about security.

#Credits

• Fady Mondy

#License

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