Filament Companies

https://github.com/andrewdwallo/filament-companies
Admin
A comprehensive multi-tenant authentication and authorization solution for Laravel Filament with...
Tokens:117,894
Snippets:916
Trust Score:8.9
License:MIT
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install Filament Companies via Composer

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Run this command to install the package. It is the first step in the installation process.

```shell
composer require andrewdwallo/filament-companies
```

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

### Run Migrations

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Run this command to execute the database migrations after installation.

```shell
php artisan migrate:fresh
```

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

### GitHub OAuth Application Setup Values

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Example values for registering a GitHub OAuth application: application name, homepage URL, and authorization callback URL. These are used in the GitHub OAuth app registration steps.

```text
Filament
```

```text
http://filament.test/company
```

```text
http://filament.test/company/oauth/github/callback
```

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

### Add User Menu and Navigation Items for Profile and Company

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Use this as a guide to add navigation items for the Profile and Personal Access Tokens pages, and a menu item to navigate back to the Company Panel.

```php
use Filament\Navigation\MenuItem;
use Filament\Navigation\NavigationItem;
use Illuminate\Support\Facades\Auth;
use Wallo\FilamentCompanies\Pages\User\PersonalAccessTokens;
use Wallo\FilamentCompanies\Pages\User\Profile;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->userMenuItems([
            'profile' => MenuItem::make()
                ->label('Profile')
                ->icon('heroicon-o-user-circle')
                ->url(static fn () => Profile::getUrl()),
            MenuItem::make()
                ->label('Company')
                ->icon('heroicon-o-building-office')
                ->url(static fn () => Pages\Dashboard::getUrl(panel: FilamentCompanies::getCompanyPanel(), tenant: Auth::user()->personalCompany())),
        ])
        ->navigationItems([
            NavigationItem::make('Personal Access Tokens')
                ->label(static fn (): string => __('filament-companies::default.navigation.links.tokens'))
                ->icon('heroicon-o-key')
                ->url(static fn () => PersonalAccessTokens::getUrl()),
        ])
}
```

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

### Scaffold the Application with Artisan

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Execute this command to scaffold the application. You will be prompted to choose between installing the Base package or enabling Socialite support.

```shell
php artisan filament-companies:install
```

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

### Publish Views

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Publishes the package's view files for customization.

```shell
php artisan vendor:publish --tag=filament-companies-views
```

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

### Create a Filament Panel

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Run this Artisan command to create a Filament panel after installing the Panel Builder. This is a required step before using Filament Companies.

```shell
php artisan filament:install --panels
```

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

### Install package from local fork in composer.json

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Add the forked package to your application's composer.json using a path repository and the dev prefix with your branch name. Run composer update after editing.

```json
{
    ...
    "require": {
        "andrewdwallo/filament-companies": "dev-fix/error-message",
    },
    "repositories": [
        {
            "type": "path",
            "url": "filament-companies/"
        }
    ],
    ...
}
```

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

### Add Provider Credentials in config/services.php

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Add your provider's credentials in the providers array in config/services.php. The redirect URI must look similar to the example (e.g., 'APP_URL/company/oauth/provider/callback').

```php
    /*
    |--------------------------------------------------------------------------
    | Third Party Services
    |--------------------------------------------------------------------------
    |
    | This file is for storing the credentials for third party services such
    | as Mailgun, Postmark, AWS and more. This file provides the de facto
    | location for this type of information, allowing packages to have
    | a conventional file to locate the various service credentials.
    |
    */
    
    'github' => [
        'client_id' => env('GITHUB_CLIENT_ID'),
        'client_secret' => env('GITHUB_CLIENT_SECRET'),
        'redirect' => 'https://filament.test/company/oauth/github/callback',
    ],
```

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

### Configure modal layout and behavior with modals() method

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Adjust the layout and behavior of modals using the modals() method. The example shows the package's default settings: width '2xl', alignment 'center', formActionsAlignment 'center', and cancelButtonAction false.

```php
use Filament\Panel;
use Wallo\FilamentCompanies\FilamentCompanies;

class FilamentCompaniesServiceProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugin(
                FilamentCompanies::make()
                    ->modals(
                        width: '2xl', 
                        alignment: 'center', 
                        formActionsAlignment: 'center', 
                        cancelButtonAction: false
                    )
            );
    }
}
```

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

### Configure Roles and Permissions in FilamentCompaniesServiceProvider

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Define the roles and permissions available in the application by overriding the configurePermissions method in app/Providers/FilamentCompaniesServiceProvider.php. This example sets default API token permissions to 'read' and defines 'admin' and 'editor' roles with their respective permissions and descriptions.

```php
/**
 * Configure the roles and permissions that are available within the application.
 */
protected function configurePermissions(): void
{
    FilamentCompanies::defaultApiTokenPermissions(['read']);

    FilamentCompanies::role('admin', 'Administrator', [
        'create',
        'read',
        'update',
        'delete',
    ])->description('Administrator users can perform any action.');

    FilamentCompanies::role('editor', 'Editor', [
        'read',
        'create',
        'update',
    ])->description('Editor users have the ability to read, create, and update.');
}
```

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

### Publish Translations

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Publishes the package's language files for translation.

```shell
php artisan vendor:publish --tag=filament-companies-translations
```

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

### Full Example Configuration (from stub provider)

Source: https://github.com/andrewdwallo/filament-companies

Shows the complete panel configuration for the Filament Companies plugin, including tenant setup, authentication, and all plugin features. Requires PHP ^8.2, Filament ^4.0|^5.0, Laravel ^11.0|^12.0, Laravel Socialite ^5.12, and matomo/device-detector ^6.1.

```php
public function panel(Panel $panel): Panel
{
    return $panel
        ->id('company')
        ->path('company')
        ->default()
        ->login(Login::class)
        ->passwordReset()
        ->homeUrl(static function (): ?string {
            $user = Auth::user();
            if ($company = $user?->primaryCompany()) {
                return Dashboard::getUrl(panel: FilamentCompanies::getCompanyPanel(), tenant: $company);
            }
            return Filament::getPanel(FilamentCompanies::getCompanyPanel())->getTenantRegistrationUrl();
        })
        ->plugin(
            FilamentCompanies::make()
                ->userPanel('admin')
                ->switchCurrentCompany()
                ->updateProfileInformation()
                ->updatePasswords()
                ->manageBrowserSessions()
                ->accountDeletion()
                ->profilePhotos()
                ->api()
                ->companies(invitations: true)
                ->updateCompanyInformation()
                ->manageCompanyEmployees()
                ->companyDeletion()
                ->autoAcceptInvitations()
                ->termsAndPrivacyPolicy()
                ->notifications()
                ->modals(),
        )
        ->registration(Register::class)
        ->tenant(Company::class)
        ->tenantProfile(CompanySettings::class)
        ->tenantRegistration(CreateCompany::class)
        ->authGuard('web');
}
```

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

### Add custom profile components with addProfileComponents()

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Add custom profile components by passing the component class name and sort order to addProfileComponents(). The example adds a component at sort position 7.

```php
use App\Livewire\CustomComponent;

FilamentCompanies::make()
    ->addProfileComponents([
        7 => CustomComponent::class,
    ]);
```

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

### Set GitHub Client Credentials in .env

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Add the GitHub Client ID and Client Secret to the .env file. Replace the placeholders with your actual credentials.

```dotenv
GITHUB_CLIENT_ID=<YOUR_GITHUB_CLIENT_ID>
GITHUB_CLIENT_SECRET=<YOUR_GITHUB_CLIENT_SECRET>
```

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

### Example: Override password updated notification

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Example implementation of overriding the notification sent when a user updates their password. The passwordUpdated method sends a Filament notification.

```php
<?php

namespace App\Actions\FilamentCompanies;

use App\Models\User;
use Filament\Notifications\Notification;
use Wallo\FilamentCompanies\Contracts\UpdatesUserPasswords;

class UpdateUserPassword implements UpdatesUserPasswords
{
    /**
     * Validate and update the user's password.
     *
     * @param  array<string, string>  $input
     */
    public function update(User $user, array $input): void
    {
       // ...
    }

    public function passwordUpdated(): void
    {
        Notification::make()
            ->title('Password Updated')
            ->body('Your password has been updated.')
            ->success();
            ->send();
    }
    
}
```

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

### notifications()

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Configures whether the package sends notifications. Pass false to disable all notifications.

```APIDOC
## notifications()

### Description
Configures whether the package sends notifications. Pass `false` to disable all notifications.

### Method
`notifications()`

### Parameters
- **condition** (bool) - Required - Set to `false` to disable notifications.

### Example
```php
use Filament\Panel;
use Wallo\FilamentCompanies\FilamentCompanies;

class FilamentCompaniesServiceProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugin(
                FilamentCompanies::make()
                    ->notifications(condition: false)
            );
    }
}
```
```

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

### Example usage from stub service provider

Source: https://github.com/andrewdwallo/filament-companies

Shows how to configure default API token permissions and define roles with descriptions. The example sets a default permission of 'read' and creates 'admin' and 'editor' roles with their respective permission lists and descriptions.

```php
FilamentCompanies::defaultApiTokenPermissions(['read']);

FilamentCompanies::role('admin', 'Administrator', ['create', 'read', 'update', 'delete'])
    ->description('Administrator users can perform any action.');

FilamentCompanies::role('editor', 'Editor', ['read', 'create', 'update'])
    ->description('Editor users have the ability to read, create, and update.');
```

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

### Standalone usage of filament-companies:install

Source: https://github.com/andrewdwallo/filament-companies

Shows how to run the install command from the terminal. The first command runs a standard installation, while the second includes the --socialite and --force flags to install with Socialite support and overwrite existing files.

```bash
php artisan filament-companies:install
php artisan filament-companies:install --socialite --force
```

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

### Register Profile and Personal Access Tokens Pages in User Panel

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

In your 'Admin' panel (or any User panel), register these pages so the package works. The Profile and Personal Access Tokens pages must be available.

```php
use Wallo\FilamentCompanies\Pages\User\PersonalAccessTokens;
use Wallo\FilamentCompanies\Pages\User\Profile;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->pages([
            Profile::class,
            PersonalAccessTokens::class,
        ])
}
```

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

### Credentials usage example

Source: https://github.com/andrewdwallo/filament-companies

Example of retrieving credentials from a ConnectedAccount model and using the token for HTTP client authorization headers.

```php
use App\Models\ConnectedAccount;

$account = ConnectedAccount::find(1);          // any App\Models\ConnectedAccount
$creds   = $account->getCredentials();

$token     = $creds->getToken();
$refresh   = $creds->getRefreshToken();
$expiresAt = $creds->getExpiry();

// Interop with HTTP clients
$headers = ['Authorization' => 'Bearer ' . $creds->getToken()];
```

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

### Configure FilamentCompanies plugin in a PanelProvider

Source: https://github.com/andrewdwallo/filament-companies

Shows the recommended setup for the FilamentCompanies plugin inside a Filament PanelProvider. It enables features like user panel, company switching, profile updates, password management, browser sessions, account deletion, profile photos, API, companies with invitations, company information updates, employee management, company deletion, auto-accept invitations, terms and privacy policy, notifications, and modals. In the boot method, it binds the CreateNewUser action and other *Using() bindings, then calls configurePermissions().

```php
use App\Actions\FilamentCompanies\CreateNewUser;
use Wallo\FilamentCompanies\FilamentCompanies;

class FilamentCompaniesServiceProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            ->id('company')
            ->path('company')
            ->plugin(
                FilamentCompanies::make()
                    ->userPanel('admin')
                    ->switchCurrentCompany()
                    ->updateProfileInformation()
                    ->updatePasswords()
                    ->manageBrowserSessions()
                    ->accountDeletion()
                    ->profilePhotos()
                    ->api()
                    ->companies(invitations: true)
                    ->updateCompanyInformation()
                    ->manageCompanyEmployees()
                    ->companyDeletion()
                    ->autoAcceptInvitations()
                    ->termsAndPrivacyPolicy()
                    ->notifications()
                    ->modals(),
            );
    }

    public function boot(): void
    {
        FilamentCompanies::createUsersUsing(CreateNewUser::class);
        // ...other *Using() bindings
        $this->configurePermissions();
    }
}
```

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

### Customize Company Settings Component

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Replace the default company settings component with a custom Livewire component by passing the component class to updateCompanyInformation().

```php
use App\Livewire\CustomCompanyComponent;

FilamentCompanies::make()
    ->updateCompanyInformation(component: CustomCompanyComponent::class);
```

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

### Enable Company Settings Features with FilamentCompanies Plugin

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Configure the company settings page by enabling updateCompanyInformation, manageCompanyEmployees, and companyDeletion features in the FilamentCompanies plugin within a PanelProvider.

```php
use Filament\Panel;
use Wallo\FilamentCompanies\FilamentCompanies;

class FilamentCompaniesServiceProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugin(
                FilamentCompanies::make()
                    ->updateCompanyInformation()   // Enables updating company names
                    ->manageCompanyEmployees()     // Enables company employee management
                    ->companyDeletion()            // Enables company deletion
            );
    }
}
```

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

### Sort Company Settings Components

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Change the order of company settings features by setting the sort parameter on each method.

```php
FilamentCompanies::make()
    ->updateCompanyInformation(sort: 0)
    ->manageCompanyEmployees(sort: 1)
    ->companyDeletion(sort: 2);
```

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

### InstallCommand signature and description

Source: https://github.com/andrewdwallo/filament-companies

Defines the command signature and description for the filament-companies:install artisan command. The --socialite option installs with Socialite support, and --force overwrites existing files. The handle method returns an integer status.

```php
protected $signature = 'filament-companies:install {--socialite : Install with Socialite support} {--force : Overwrite existing files}';
protected $description = 'Install the Filament Companies package';
public function handle(): int
```

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

### User trait example usage

Source: https://github.com/andrewdwallo/filament-companies

Example usage of the user trait methods, showing how to access current company, companies, roles, and permissions.

```php
$user->currentCompany;                       // Wallo\FilamentCompanies\Company
$user->allCompanies();                       // Illuminate\Support\Collection
$user->ownedCompanies;                       // Eloquent Collection
$user->companies;                            // companies user belongs to (not owned)
$user->personalCompany();                    // the "personal" company or null
$user->primaryCompany();                     // personal first, else first company
$user->hasAnyCompanies();                    // bool
$user->ownsCompany($company);                // bool
$user->belongsToCompany($company);           // bool
$user->companyRole($company);                // ?Wallo\FilamentCompanies\Role
$user->hasCompanyRole($company, 'admin');    // bool
$user->companyPermissions($company);         // array
$user->hasCompanyPermission($company, 'server:create'); // bool
```

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

### Handle Company Menu Item When Auto-Accept Invitations is Enabled

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Use this alternative for the Company menu item when Auto-Accept Invitations is enabled, to avoid errors when the user does not have a personal company.

```php
MenuItem::make()
    ->label('Company')
    ->icon('heroicon-o-building-office')
    ->url(static function (): ?string {
        $user = Auth::user();

        if ($company = $user?->primaryCompany()) {
            return Pages\Dashboard::getUrl(panel: FilamentCompanies::getCompanyPanel(), tenant: $company);
        }

        return Filament::getPanel(FilamentCompanies::getCompanyPanel())->getTenantRegistrationUrl();
    }),
```

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

### Role usage example

Source: https://github.com/andrewdwallo/filament-companies

Creates a role with FilamentCompanies::role(), chains description(), then retrieves it with findRole() and calls jsonSerialize().

```php
use Wallo\FilamentCompanies\FilamentCompanies;

$role = FilamentCompanies::role('admin', 'Administrator', ['create', 'read'])
    ->description('Can create and read.');

echo $role->key;                  // 'admin'
$found = FilamentCompanies::findRole('admin');
$json  = $found->jsonSerialize(); // ['key'=>'admin','name'=>...,'description'=>...,'permissions'=>[...]]
```

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

### allCompanies()

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Retrieve all companies (including owned companies) that the user belongs to. This method returns a collection of all companies associated with the user.

```APIDOC
## allCompanies()

### Description
Access all of the companies (including owned companies) that a user belongs to.

### Method
`$user->allCompanies()`

### Returns
- **Illuminate\Support\Collection** - Collection of all companies the user belongs to.

### Example
```php
$user->allCompanies()
```
```

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

### Override notification for DeleteCompany

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Override the default notification for the DeleteCompany action by providing the companyDeleted method.

```php
\App\Actions\FilamentCompanies\DeleteCompany::class

/** @method void companyDeleted(\Illuminate\Database\Eloquent\Model|null $company = null) */
```

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

### Gmail SMTP Mail Configuration in .env

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Add these credentials to your application's .env file to send invitation mail via Gmail SMTP. Use an app password generated from Google's App passwords page, and replace placeholders with your Gmail email and app password.

```dotenv
MAIL_MAILER=smtp
MAIL_HOST=smtp.gmail.com
MAIL_PORT=587
MAIL_USERNAME=<YOUR_GMAIL_EMAIL>
MAIL_PASSWORD=<YOUR_GMAIL_APP_PASSWORD>  
MAIL_ENCRYPTION=tls                    
MAIL_FROM_ADDRESS=<YOUR_GMAIL_EMAIL>
MAIL_FROM_NAME="${APP_NAME}"
```

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

### passwordSet()

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Notification hook called after a user's password is set. Override this method in your action class to customize the notification.

```APIDOC
## passwordSet()

### Description
Notification hook called after a user's password is set. Override this method in your action class to customize the notification.

### Method
`passwordSet()`

### Parameters
- **$user** (\Illuminate\Foundation\Auth\User|null) - Optional - The user whose password was set.
- **$input** (array|null) - Optional - The input data used for the set.

### Example
```php
/** @method void passwordSet(\Illuminate\Foundation\Auth\User|null $user, array|null $input = null) */
```
```

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

### Add Custom Company Settings Component

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Add a custom company settings component by passing the component class name with a sort order to addCompanyComponents().

```php
use App\Livewire\CustomCompanyComponent;

FilamentCompanies::make()
    ->addCompanyComponents([
        5 => CustomCompanyComponent::class,
    ]);
```

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

### Enable Auto-Accept Invitations in FilamentCompaniesServiceProvider

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Configure the FilamentCompaniesServiceProvider to enable auto-accepting invitations, allowing invited users to bypass personal company creation during registration and be redirected to accept their company invitation. If disabled, users must create a personal company during registration if they don't already have one.

```php
FilamentCompanies::make()
    ->companies(invitations: true)
    ->autoAcceptInvitations()
```

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

### Set storage path for profile photos with storagePath parameter

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Store profile photos in a specific directory by setting the storagePath parameter on profilePhotos().

```php
FilamentCompanies::make()
    ->profilePhotos(storagePath: 'profile-avatars')
```

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

### Enable profile photos with profilePhotos() in FilamentCompaniesServiceProvider

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Add the profilePhotos() method to the FilamentCompanies plugin configuration to allow users to upload custom profile photos. Place this in the panel() method of your FilamentCompaniesServiceProvider.

```php
use Filament\Panel;
use Wallo\FilamentCompanies\FilamentCompanies;

class FilamentCompaniesServiceProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugin(
                FilamentCompanies::make()
                    ->profilePhotos()
            )
    }
}
```

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

### Override notification for InviteCompanyEmployee

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Override the default notification for the InviteCompanyEmployee action by providing the employeeInvitationSent method.

```php
\App\Actions\FilamentCompanies\InviteCompanyEmployee::class

/** @method void employeeInvitationSent(\Illuminate\Foundation\Auth\User|null $user = null, \Illuminate\Database\Eloquent\Model|null $company = null, string|null $email = null, string|null $role = null) */
```

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

### personalCompany()

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Access the user's 'personal' company. This method returns the personal company associated with the user.

```APIDOC
## personalCompany()

### Description
Access a user's "personal" company.

### Method
`$user->personalCompany()`

### Returns
- **Wallo\FilamentCompanies\Company** - The personal company.

### Example
```php
$user->personalCompany()
```
```

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

### Usage Example: Wallo\FilamentCompanies\Rules\Role

Source: https://github.com/andrewdwallo/filament-companies

An example demonstrating how to use the Role validation rule in a Laravel Validator to ensure a role value is a registered role key.

```APIDOC
## Usage Example: Wallo\FilamentCompanies\Rules\Role

### Description
An example demonstrating how to use the Role validation rule in a Laravel Validator to ensure a role value is a registered role key.

### Example
```php
use Illuminate\Support\Facades\Validator;
use Wallo\FilamentCompanies\Rules\Role as RoleRule;

$validator = Validator::make(['role' => 'admin'], [
    'role' => ['required', 'string', new RoleRule],
]);

if ($validator->fails()) {
    // role is not a registered role key
}
```
```

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

### Set custom disk for profile photos with disk parameter

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Specify a different storage disk for profile photos by passing the disk parameter to profilePhotos(). By default, the package uses Laravel's public disk.

```php
FilamentCompanies::make()
    ->profilePhotos(disk: 's3')
```

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

### Add Package Vendor Directory to Theme CSS

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Add this line to your resources/css/filament/company/theme.css file so Tailwind can process the CSS used within the package and the company panel.

```css
@source '../../../../vendor/andrewdwallo/filament-companies/resources/views';
```

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

### currentCompany

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Access the user's currently selected company. This property returns the company that the user has currently selected in the application.

```APIDOC
## currentCompany

### Description
Access the user's currently selected company.

### Property
`$user->currentCompany`

### Returns
- **Wallo\FilamentCompanies\Company** - The currently selected company.

### Example
```php
$user->currentCompany
```
```

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

### Usage example for Role validation rule

Source: https://github.com/andrewdwallo/filament-companies

Validates a 'role' input against the RoleRule. If validation fails, the role is not a registered role key. Used internally by UpdateCompanyEmployeeRole.

```php
use Illuminate\Support\Facades\Validator;
use Wallo\FilamentCompanies\Rules\Role as RoleRule;

$validator = Validator::make(['role' => 'admin'], [
    'role' => ['required', 'string', new RoleRule],
]);

if ($validator->fails()) {
    // role is not a registered role key
}
```

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

### Register Verify Email URL via Filament Facade

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Place in AppServiceProvider's boot method to set the verify-email URL using Filament's VerifyEmail facade. Required to avoid errors on the user profile page when using email verification.

```php
use Filament\Facades\Filament;
use Filament\Notifications\Auth\VerifyEmail;

// Verify email notification url
VerifyEmail::createUrlUsing(function ($notifiable) {
    return Filament::getVerifyEmailUrl($notifiable);
});
```

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

### Enable company switching with switchCurrentCompany()

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Use this in FilamentCompaniesServiceProvider to enable or disable the ability to switch the current company. The feature is core and should typically remain enabled; disabling prevents users from switching between companies.

```php
use Filament\Panel;
use Wallo\FilamentCompanies\FilamentCompanies;

class FilamentCompaniesServiceProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugin(
                FilamentCompanies::make()
                    ->switchCurrentCompany()
            );
    }
}
```

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

### hasAnyCompanies()

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Determine if the user has any companies. This method returns a boolean indicating whether the user is associated with at least one company.

```APIDOC
## hasAnyCompanies()

### Description
Determine if the user has any companies.

### Method
`$user->hasAnyCompanies()`

### Returns
- **bool** - True if the user has any companies, false otherwise.

### Example
```php
$user->hasAnyCompanies()
```
```

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

### Bind contract implementations and swap models in boot()

Source: https://github.com/andrewdwallo/filament-companies

Used in boot() to bind contract implementations and swap models. Includes Socialite-related methods and model setters like useUserModel, useCompanyModel, useEmployeeshipModel, useCompanyInvitationModel, and useConnectedAccountModel.

```php
FilamentCompanies::createUsersUsing(CreateNewUser::class);
FilamentCompanies::updateUserProfileInformationUsing(...);
FilamentCompanies::updateUserPasswordsUsing(...);
FilamentCompanies::createCompaniesUsing(...);
FilamentCompanies::updateCompanyNamesUsing(...);
FilamentCompanies::addCompanyEmployeesUsing(...);
FilamentCompanies::inviteCompanyEmployeesUsing(...);
FilamentCompanies::removeCompanyEmployeesUsing(...);
FilamentCompanies::deleteCompaniesUsing(...);
FilamentCompanies::deleteUsersUsing(...);

// Socialite:
FilamentCompanies::resolvesSocialiteUsersUsing(...);
FilamentCompanies::createUsersFromProviderUsing(...);
FilamentCompanies::createConnectedAccountsUsing(...);
FilamentCompanies::updateConnectedAccountsUsing(...);
FilamentCompanies::setUserPasswordsUsing(callable|string);
FilamentCompanies::handlesInvalidStateUsing(callable|string);
FilamentCompanies::generatesProvidersRedirectsUsing(callable|string);

// Models:
useUserModel / useCompanyModel / useEmployeeshipModel / useCompanyInvitationModel / useConnectedAccountModel
```

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

### UpdateUserPassword::passwordUpdated()

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Example of overriding the passwordUpdated notification hook in a custom action class.

```APIDOC
## UpdateUserPassword::passwordUpdated()

### Description
Example of overriding the `passwordUpdated` notification hook in a custom action class.

### Method
`passwordUpdated()`

### Example
```php
<?php

namespace App\Actions\FilamentCompanies;

use App\Models\User;
use Filament\Notifications\Notification;
use Wallo\FilamentCompanies\Contracts\UpdatesUserPasswords;

class UpdateUserPassword implements UpdatesUserPasswords
{
    /**
     * Validate and update the user's password.
     *
     * @param  array<string, string>  $input
     */
    public function update(User $user, array $input): void
    {
       // ...
    }

    public function passwordUpdated(): void
    {
        Notification::make()
            ->title('Password Updated')
            ->body('Your password has been updated.')
            ->success();
            ->send();
    }
    
}
```
```

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

### Add custom components with addProfileComponents/addCompanyComponents

Source: https://github.com/andrewdwallo/filament-companies

Define methods to add profile or company components with a sort order map. The map is [sort => ComponentClass]. Example shows adding a custom Livewire component at sort order 7.

```php
public function addProfileComponents(array $componentsWithSortOrder): static
public function addCompanyComponents(array $componentsWithSortOrder): static

public static function getAddedProfileComponents(): array
public static function getAddedCompanyComponents(): array
```

```php
FilamentCompanies::make()->addProfileComponents([
    7 => \App\Livewire\CustomComponent::class,
]);
```

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

### boot(Panel $panel): void method

Source: https://github.com/andrewdwallo/filament-companies

Boots the plugin for a panel. Registers an event listener for switching the current company if enabled, and registers socialite login render hooks if socialite features are enabled.

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

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

### composer update command

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/UPGRADE.md

Run this command after updating the andrewdwallo/filament-companies dependency to ^4.0 in composer.json, following the Laravel 11 upgrade guide.

```bash
composer update
```

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

### Before: Using Wallo\FilamentCompanies\Providers class

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/UPGRADE.md

In FilamentCompanies 3.x, Socialite providers were enabled and checked using the Providers class. This usage is replaced by the Provider enum in 4.x.

```php

use Wallo\FilamentCompanies\Providers;

// Enable the following Socialite providers.
Providers::github(),
// And so on for the other providers...

// Determine if the following Socialite providers are enabled.
Providers::hasGithub(),
// And so on for the other providers...
```

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

### Configure Socialite Providers in Filament Panel

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Enables and configures Socialite providers and features in the Filament panel plugin. By default, GitHub is enabled. You can add or remove providers from the list. Note: If Twitter is desired, you may only use either Twitter OAuth1 or Twitter OAuth2.

```php
use Filament\Panel;
use Wallo\FilamentCompanies\FilamentCompanies;
use Wallo\FilamentCompanies\Enums\Feature;
use Wallo\FilamentCompanies\Enums\Provider;

class FilamentCompaniesServiceProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugin(
                FilamentCompanies::make()
                    ->socialite(
                        providers: [
                            Provider::Github,
                            Provider::Gitlab,
                            Provider::Google,
                            Provider::Facebook,
                            Provider::Linkedin,
                            Provider::LinkedinOpenId,
                            Provider::Bitbucket,
                            Provider::Slack,
                            Provider::Twitter,
                            Provider::TwitterOAuth2,
                        ],
                        features: [
                            Feature::RememberSession,
                            Feature::ProviderAvatars,
                            Feature::GenerateMissingEmails,
                            Feature::LoginOnRegistration,
                            Feature::CreateAccountOnFirstLogin,
                        ]
                    )
            )
    }
}
```

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

### companyRole($company)

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Get the role that the user is assigned on the company. This method returns the role object for the user on the given company.

```APIDOC
## companyRole($company)

### Description
Get the role that the user is assigned on the company.

### Method
`$user->companyRole($company)`

### Parameters
- **$company** (mixed) - Required - The company to retrieve the role for.

### Returns
- **\Wallo\FilamentCompanies\Role** - The role assigned to the user on the company.

### Example
```php
$user->companyRole($company)
```
```

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

### make() method

Source: https://github.com/andrewdwallo/filament-companies

Factory that resolves the singleton instance from the container: app(static::class).

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

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

### primaryCompany()

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Get the user's primary company, prioritizing the personal company. This method returns the primary company or null if none exists.

```APIDOC
## primaryCompany()

### Description
Get the user's primary company (prioritizes personal company).

### Method
`$user->primaryCompany()`

### Returns
- **Wallo\FilamentCompanies\Company|null** - The primary company or null if none.

### Example
```php
$user->primaryCompany()
```
```

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

### GET /invitations/{invitation}

Source: https://github.com/andrewdwallo/filament-companies

Authenticated and signed route that accepts a company invitation. It triggers the CompanyInvitationController@accept method, which logs in the user if the invitation email matches, or redirects to the login page.

```APIDOC
## [GET] /invitations/{invitation}

### Description
Authenticated and signed route that accepts a company invitation. It triggers the CompanyInvitationController@accept method, which logs in the user if the invitation email matches, or redirects to the login page.

### Method
GET

### Endpoint
/invitations/{invitation}

### Parameters
#### Path Parameters
- **invitation** (integer|string) - Required - The invitation primary key.

#### Query Parameters
- **signature** (string) - Required - Signed URL signature generated via `URL::signedRoute`.

### Response
#### Success Response (302)
Redirects to the home URL with a flashed success notification if the user matches the invitation email, otherwise redirects to the login URL.

#### Error Response (403)
Returns 403 if the signature is invalid or expired.

#### Error Response (404)
Returns 404 if the invitation does not exist.

### Request Example
```php
use App\Models\CompanyInvitation;
use Wallo\FilamentCompanies\FilamentCompanies;

$url = FilamentCompanies::generateAcceptInvitationUrl($invitation); // signed, absolute
```
```

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

### Before 4.x: companies() with invitations

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/UPGRADE.md

In FilamentCompanies 4.x, enabling companies() automatically enabled all company management features. This is the old configuration that is replaced in 5.x.

```php
FilamentCompanies::make()
    ->companies(invitations: true)  // This enabled all company features
```

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

### Override notification for UpdateCompanyName

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Override the default notification for the UpdateCompanyName action by providing the companyNameUpdated method.

```php
\App\Actions\FilamentCompanies\UpdateCompanyName::class

/** @method void companyNameUpdated(\Illuminate\Foundation\Auth\User|null $user = null, \Illuminate\Database\Eloquent\Model|null $company = null, array|null $input = null) */
```

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

### Override notification for SetUserPassword

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Override the default notification for the SetUserPassword action by providing the passwordSet method.

```php
\App\Actions\FilamentCompanies\SetUserPassword::class

/** @method void passwordSet(\Illuminate\Foundation\Auth\User|null $user, array|null $input = null) */
```

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

### Override notification for UpdateUserPassword

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Override the default notification for the UpdateUserPassword action by providing the passwordUpdated method.

```php
\App\Actions\FilamentCompanies\UpdateUserPassword::class

/** @method void passwordUpdated(\Illuminate\Foundation\Auth\User|null $user = null, array|null $input = null) */
```

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

### Override notification for UpdateUserProfileInformation

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Override the default notification for the UpdateUserProfileInformation action by providing the profileInformationUpdated method.

```php
\App\Actions\FilamentCompanies\UpdateUserProfileInformation::class

/** @method void profileInformationUpdated(\Illuminate\Foundation\Auth\User|null $user = null, array|null $input = null) */
```

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

### companies

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Access all of the companies that a user belongs to but does not own. This property returns a collection of companies where the user is a member but not an owner.

```APIDOC
## companies

### Description
Access all of the companies that a user belongs to but does not own.

### Property
`$user->companies`

### Returns
- **Illuminate\Database\Eloquent\Collection** - Collection of companies the user belongs to but does not own.

### Example
```php
$user->companies
```
```

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

### Define roles, permissions, and default API token permissions

Source: https://github.com/andrewdwallo/filament-companies

role() merges its $permissions into the global permission list (deduplicated, sorted). defaultApiTokenPermissions defaults to ['read'] in the stub.

```php
FilamentCompanies::role(string $key, string $name, array $permissions): Role;
FilamentCompanies::permissions(array $permissions): static;
FilamentCompanies::defaultApiTokenPermissions(array $permissions): static; // defaults: ['read'] in stub
```

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

### ownedCompanies

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Access all of the user's owned companies. This property returns a collection of companies that the user owns.

```APIDOC
## ownedCompanies

### Description
Access all of a user's owned companies.

### Property
`$user->ownedCompanies`

### Returns
- **Illuminate\Database\Eloquent\Collection** - Collection of owned companies.

### Example
```php
$user->ownedCompanies
```
```

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

### description() method signature

Source: https://github.com/andrewdwallo/filament-companies

Sets $this->description and returns $this for chaining.

```php
public function description(string $description): static
```

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

### companyDeleted()

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Notification hook called after a company is deleted. Override this method in your action class to customize the notification.

```APIDOC
## companyDeleted()

### Description
Notification hook called after a company is deleted. Override this method in your action class to customize the notification.

### Method
`companyDeleted()`

### Parameters
- **$company** (\Illuminate\Database\Eloquent\Model|null) - Optional - The company that was deleted.

### Example
```php
/** @method void companyDeleted(\Illuminate\Database\Eloquent\Model|null $company = null) */
```
```

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

### companyPermissions($company)

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Access an array of all permissions a user has for a given company. This method returns an array of permission strings.

```APIDOC
## companyPermissions($company)

### Description
Access an array of all permissions a user has for a given company.

### Method
`$user->companyPermissions($company)`

### Parameters
- **$company** (mixed) - Required - The company to retrieve permissions for.

### Returns
- **array** - Array of permission strings.

### Example
```php
$user->companyPermissions($company)
```
```

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

### belongsToCompany($company)

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Determine if a user belongs to a given company. This method accepts a company instance and returns a boolean.

```APIDOC
## belongsToCompany($company)

### Description
Determine if a user belongs to a given company.

### Method
`$user->belongsToCompany($company)`

### Parameters
- **$company** (mixed) - Required - The company to check membership for.

### Returns
- **bool** - True if the user belongs to the company, false otherwise.

### Example
```php
$user->belongsToCompany($company)
```
```

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

### jsonSerialize() method signature

Source: https://github.com/andrewdwallo/filament-companies

Returns an array with keys 'key', 'name', 'description', and 'permissions'. The name and description are passed through __() for translation.

```php
#[ReturnTypeWillChange]
public function jsonSerialize(): array
```

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

### ownsCompany($company)

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Determine if a user owns a given company. This method accepts a company instance and returns a boolean.

```APIDOC
## ownsCompany($company)

### Description
Determine if a user owns a given company.

### Method
`$user->ownsCompany($company)`

### Parameters
- **$company** (mixed) - Required - The company to check ownership for.

### Returns
- **bool** - True if the user owns the company, false otherwise.

### Example
```php
$user->ownsCompany($company)
```
```

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

### employeeInvitationSent()

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Notification hook called after an employee invitation is sent. Override this method in your action class to customize the notification.

```APIDOC
## employeeInvitationSent()

### Description
Notification hook called after an employee invitation is sent. Override this method in your action class to customize the notification.

### Method
`employeeInvitationSent()`

### Parameters
- **$user** (\Illuminate\Foundation\Auth\User|null) - Optional - The user who sent the invitation.
- **$company** (\Illuminate\Database\Eloquent\Model|null) - Optional - The company to which the employee is invited.
- **$email** (string|null) - Optional - The email address of the invited employee.
- **$role** (string|null) - Optional - The role assigned to the invited employee.

### Example
```php
/** @method void employeeInvitationSent(\Illuminate\Foundation\Auth\User|null $user = null, \Illuminate\Database\Eloquent\Model|null $company = null, string|null $email = null, string|null $role = null) */
```
```

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

### companyNameUpdated()

Source: https://github.com/andrewdwallo/filament-companies/blob/5.x/README.md

Notification hook called after a company name is updated. Override this method in your action class to customize the notification.

```APIDOC
## companyNameUpdated()

### Description
Notification hook called after a company name is updated. Override this method in your action class to customize the notification.

### Method
`companyNameUpdated()`

### Parameters
- **$user** (\Illuminate\Foundation\Auth\User|null) - Optional - The user who updated the company name.
- **$company** (\Illuminate\Database\Eloquent\Model|null) - Optional - The company whose name was updated.
- **$input** (array|null) - Optional - The input data used for the update.

### Example
```php
/** @method void companyNameUpdated(\Illuminate\Foundation\Auth\User|null $user = null, \Illuminate\Database\Eloquent\Model|null $company = null, array|null $input = null) */
```
```

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

### manageBrowserSessions() method signature

Source: https://github.com/andrewdwallo/filament-companies

Enables browser-session management. Requires database session driver.

```php
public function manageBrowserSessions(
    bool | Closure | null $condition = true,
    $component = LogoutOtherBrowserSessionsForm::class,
    int $sort = 4
): static
```

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

### manageBrowserSessions()

Source: https://github.com/andrewdwallo/filament-companies

Enables browser-session management (requires database session driver).

```APIDOC
## manageBrowserSessions()

### Description
Enables browser-session management (requires database session driver).

### Method
`manageBrowserSessions`

### Parameters
- **condition** (`bool | Closure | null`) - Optional - Default `true`
- **component** (`mixed`) - Optional - Default `LogoutOtherBrowserSessionsForm::class`
- **sort** (`int`) - Optional - Default `4`

### Return Value
`static`
```

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

### Action Bindings

Source: https://github.com/andrewdwallo/filament-companies

Static registrars that singleton-bind concrete action classes to the application container under their contract interface.

```APIDOC
## Action Bindings

### Description
Static registrars that singleton-bind concrete action classes to the application container under their contract interface.

### Methods
- `createUsersUsing(string $class): void` - Binds to `Contracts\CreatesNewUsers`
- `updateUserProfileInformationUsing(string $class): void` - Binds to `Contracts\UpdatesUserProfileInformation`
- `updateUserPasswordsUsing(string $class): void` - Binds to `Contracts\UpdatesUserPasswords`
- `createCompaniesUsing(string $class): void` - Binds to `Contracts\CreatesCompanies`
- `updateCompanyNamesUsing(string $class): void` - Binds to `Contracts\UpdatesCompanyNames`
- `addCompanyEmployeesUsing(string $class): void` - Binds to `Contracts\AddsCompanyEmployees`
- `inviteCompanyEmployeesUsing(string $class): void` - Binds to `Contracts\InvitesCompanyEmployees`
- `removeCompanyEmployeesUsing(string $class): void` - Binds to `Contracts\RemovesCompanyEmployees`
- `deleteCompaniesUsing(string $class): void` - Binds to `Contracts\DeletesCompanies`
- `deleteUsersUsing(string $class): void` - Binds to `Contracts\DeletesUsers`
```

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

### Role::__construct(string $key, string $name, array $permissions)

Source: https://github.com/andrewdwallo/filament-companies

Creates a new Role instance with a unique key, a human-readable name, and a list of permissions. The name is passed through the translation function when serialized.

```APIDOC
## Role::__construct(string $key, string $name, array $permissions)

### Description
Creates a new Role instance with a unique key, a human-readable name, and a list of permissions.

### Method
Constructor

### Signature
```php
public function __construct(string $key, string $name, array $permissions)
```

### Parameters
- **$key** (string) - Required - The unique role identifier (e.g. `'admin'`).
- **$name** (string) - Required - Human-readable name (runs through `__()` when serialized).
- **$permissions** (array) - Required - The permission list granted by this role.

```

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

### getModals

Source: https://github.com/andrewdwallo/filament-companies

Returns the modal configuration array.

```APIDOC
## getModals

### Description
Returns the modal configuration array.

### Method
getModals

### Signature
```php
public static function getModals(): array
```

### Return Value
- array - Returns a compact('width','alignment','formActionsAlignment','cancelButtonAction') array.
```

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

### primaryCompany method signature

Source: https://github.com/andrewdwallo/filament-companies

Returns personalCompany() if present, else the first of allCompanies(), or null.

```php
public function primaryCompany(): mixed
```

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

### switchCompany method signature

Source: https://github.com/andrewdwallo/filament-companies

Switches the current company. Returns false unless the user belongs to the company; otherwise force-fills current_company_id, saves, sets the relation, and returns true.

```php
public function switchCompany(mixed $company): bool
```

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

### personalCompany method signature

Source: https://github.com/andrewdwallo/filament-companies

Returns the first owned company with personal_company == true, or null.

```php
public function personalCompany(): mixed
```
Tokens:
Raw