Laravel Multitenancy

https://github.com/spatie/laravel-multitenancy
Admin
An unopinionated Laravel package that makes your application tenant-aware, providing essentials for...
Tokens:36,773
Snippets:274
Trust Score:8.5
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Set tenant in setUp for tests with Auth facade

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/executing-code-for-tenants-and-landlords.md

Updates the `setUp` method to ensure a tenant is set when a user login is performed using the `Auth` facade, because tenant switching will not happen automatically. The example uses the first `Tenant` and calls `makeCurrent()` after listening for the `MadeTenantCurrentEvent`.

```php
protected function setUp(): void
{
    parent::setUp();

    Event::listen(MadeTenantCurrentEvent::class, function () {
        $this->beginDatabaseTransaction();
    });

    Tenant::first()->makeCurrent();
}
```

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

### Install and publish package

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Install the spatie/laravel-multitenancy package and publish its configuration and migrations.

```bash
composer require spatie/laravel-multitenancy
php artisan vendor:publish --provider="Spatie\Multitenancy\MultitenancyServiceProvider" --tag="multitenancy-config"
php artisan vendor:publish --provider="Spatie\Multitenancy\MultitenancyServiceProvider" --tag="multitenancy-migrations"
```

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

### Install package via Composer

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/base-installation.md

Install the spatie/laravel-multitenancy package using Composer. Requires PHP 8.3 or higher and Laravel 12 or 13.

```bash
composer require spatie/laravel-multitenancy
```

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

### Apply tenant middleware group to routes

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/base-installation.md

Applies the 'tenant' middleware group to a route group in a routes file.

```php
// in a routes file

Route::middleware('tenant')->group(function() {
    // routes
});
```

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

### Create tenant middleware group in bootstrap/app.php

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/base-installation.md

Creates a custom 'tenant' middleware group for routes that are tenant-aware. Place in bootstrap/app.php.

```php
// in `bootstrap/app.php`

return Application::configure(basePath: dirname(__DIR__))
    // ...
    ->withMiddleware(function (Middleware $middleware) {
        $middleware
            ->group('tenant', [
                \Spatie\Multitenancy\Http\Middleware\NeedsTenant::class,
                \Spatie\Multitenancy\Http\Middleware\EnsureValidTenantSession::class,
            ]);
    });
```

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

### Publish and run landlord migrations

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/using-a-single-database.md

Run these artisan commands to publish and execute the migration for the landlord database. This creates the `tenants` table that holds configuration per tenant. Requires the base installation steps to be completed first.

```bash
php artisan vendor:publish --provider="Spatie\Multitenancy\MultitenancyServiceProvider" --tag="multitenancy-migrations"
php artisan migrate --path=database/migrations/landlord
```

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

### Publish config file

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/base-installation.md

Publish the package's config file to config/multitenancy.php using the artisan vendor:publish command with the specified provider and tag.

```bash
php artisan vendor:publish --provider="Spatie\Multitenancy\MultitenancyServiceProvider" --tag="multitenancy-config"
```

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

### Add tenant middleware to global middleware in bootstrap/app.php

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/base-installation.md

Adds NeedsTenant and EnsureValidTenantSession middleware to the web group for all tenant-aware routes. Place in bootstrap/app.php.

```php
// in `bootstrap/app.php`

return Application::configure(basePath: dirname(__DIR__))
    // ...
    ->withMiddleware(function (Middleware $middleware) {
        $middleware
            ->web(append: [
                \Spatie\Multitenancy\Http\Middleware\NeedsTenant::class,
                \Spatie\Multitenancy\Http\Middleware\EnsureValidTenantSession::class,
            ]);
    });
```

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

### Add lifecycle callback to create database on tenant creation

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/using-a-custom-tenant-model.md

Use Eloquent's 'booted' method to hook into the 'creating' event and call custom logic, such as creating a database when a tenant is created. The example shows a custom tenant model extending the package's Tenant model.

```php
namespace App\Models\Tenant;

use Spatie\Multitenancy\Models\Tenant;

class CustomTenantModel extends Tenant
{
    protected static function booted()
    {
        static::creating(fn(CustomTenantModel $model) => $model->createDatabase());
    }

    public function createDatabase()
    {
        // add logic to create database
    }
}
```

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

### Publish landlord migration

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/using-multiple-databases.md

Publishes the migration that creates the 'tenants' table into database/migrations/landlord. Run after base installation.

```bash
php artisan vendor:publish --provider="Spatie\Multitenancy\MultitenancyServiceProvider" --tag="multitenancy-migrations"
```

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

### Download RoadRunner binary for Octane HTTP tests

Source: https://github.com/spatie/laravel-multitenancy/blob/main/README.md

Required to run the real HTTP tests for Octane. Without this binary, those tests are skipped. CI always installs it.

```bash
vendor/bin/rr get-binary --no-config -n
```

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

### Upgrade package to version 4.0

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/upgrade-guide.md

Run this Composer command to upgrade the spatie/laravel-multitenancy package to version 4.0, which introduces the contract concept for the Tenant.

```bash
composer require spatie/laravel-multitenancy:^4.0
```

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

### Cache behavior with PrefixCacheTask

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/using-tasks-to-prepare-the-environment/prefixing-cache.md

Shows how cache keys are isolated per tenant when PrefixCacheTask is installed. After making a tenant current, the cache returns null for keys set before; each tenant gets its own value, and forgetting the current tenant restores the original value.

```php
cache()->put('key', 'original-value');

$tenant->makeCurrent();
cache('key') // returns null;
cache()->put('key', 'value-for-tenant');

$anotherTenant->makeCurrent();
cache('key') // returns null;
cache()->put('key', 'value-for-another-tenant');

Tenant::forgetCurrent();
cache('key') // returns 'original-value';

$tenant->makeCurrent();
cache('key') // returns 'value-for-tenant'

$anotherTenant->makeCurrent();
cache('key') // returns 'value-for-another-tenant'
```

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

### PrefixCacheTask example implementation

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/using-tasks-to-prepare-the-environment/creating-your-own-task.md

Example task that sets a cache prefix when a tenant becomes current and restores the original prefix when forgotten. The constructor stores the original prefix from config('cache.prefix') and forgetCurrent() restores it. Note that in long-running processes like Laravel Octane and queue workers, forgetCurrent() is the only way to restore the landlord environment.

```php
namespace Spatie\Multitenancy\Tasks;

use Spatie\Multitenancy\Contracts\IsTenant;

class PrefixCacheTask implements SwitchTenantTask
{
    public function __construct(protected ?string $originalPrefix = null)
    {
        $this->originalPrefix ??= config('cache.prefix');
    }

    public function makeCurrent(IsTenant $tenant): void
    {
        $this->setCachePrefix("tenant_{$tenant->id}");
    }

    public function forgetCurrent(): void
    {
        $this->setCachePrefix($this->originalPrefix);
    }

    protected function setCachePrefix(string $prefix): void
    {
        config()->set('cache.prefix', $prefix);

        $storeName = config('cache.default');

        app('cache')->forgetDriver($storeName);
    }
}
```

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

### Create custom SwitchTenantTask with constructor parameters

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Implement SwitchTenantTask to customize tenant switching. The example shows a storage disk task. Tasks can receive constructor parameters via array config.

```php
use Spatie\Multitenancy\Contracts\IsTenant;
use Spatie\Multitenancy\Tasks\SwitchTenantTask;

class SwitchStorageDiskTask implements SwitchTenantTask
{
    public function makeCurrent(IsTenant $tenant): void
    {
        config(['filesystems.disks.s3.bucket' => $tenant->bucket]);
    }

    public function forgetCurrent(): void
    {
        config(['filesystems.disks.s3.bucket' => config('filesystems.default_bucket')]);
    }
}
```

```php
'switch_tenant_tasks' => [
    \App\Tasks\YourTask::class => ['key' => 'value'],
],
```

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

### Iterate tenants with TenantCollection::eachCurrent()

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

TenantCollection adds iteration helpers: eachCurrent, mapCurrent, filterCurrent, rejectCurrent. The example flushes the cache for each tenant.

```php
Tenant::all()->eachCurrent(function (Tenant $tenant) {
    cache()->flush();
});
```

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

### Default config file content

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/base-installation.md

Default content of the published config file at config/multitenancy.php. It includes settings for tenant finder, switch tasks, tenant model, queue awareness, database connections, context keys, and custom actions.

```php
<?php

use Illuminate\Broadcasting\BroadcastEvent;
use Illuminate\Events\CallQueuedListener;
use Illuminate\Mail\SendQueuedMailable;
use Illuminate\Notifications\SendQueuedNotifications;
use Illuminate\Queue\CallQueuedClosure;
use Spatie\Multitenancy\Actions\ForgetCurrentTenantAction;
use Spatie\Multitenancy\Actions\MakeQueueTenantAwareAction;
use Spatie\Multitenancy\Actions\MakeTenantCurrentAction;
use Spatie\Multitenancy\Actions\MigrateTenantAction;
use Spatie\Multitenancy\Models\Tenant;

return [
    /*
     * This class is responsible for determining which tenant should be current
     * for the given request.
     *
     * This class should extend `Spatie\Multitenancy\TenantFinder\TenantFinder`
     *
     */
    'tenant_finder' => null,

    /*
     * These fields are used by tenant:artisan command to match one or more tenant.
     */
    'tenant_artisan_search_fields' => [
        'id',
    ],

    /*
     * These tasks will be performed when switching tenants.
     *
     * A valid task is any class that implements Spatie\Multitenancy\Tasks\SwitchTenantTask
     */
    'switch_tenant_tasks' => [
        // \Spatie\Multitenancy\Tasks\PrefixCacheTask::class,
        // \Spatie\Multitenancy\Tasks\SwitchTenantDatabaseTask::class,
        // \Spatie\Multitenancy\Tasks\SwitchRouteCacheTask::class,
    ],

    /*
     * This class is the model used for storing configuration on tenants.
     *
     * It must  extend `Spatie\Multitenancy\Models\Tenant::class` or
     * implement `Spatie\Multitenancy\Contracts\IsTenant::class` interface
     */
    'tenant_model' => Tenant::class,

    /*
     * If there is a current tenant when dispatching a job, the id of the current tenant
     * will be automatically set on the job. When the job is executed, the set
     * tenant on the job will be made current.
     */
    'queues_are_tenant_aware_by_default' => true,

    /*
     * The connection name to reach the tenant database.
     *
     * Set to `null` to use the default connection.
     */
    'tenant_database_connection_name' => null,

    /*
     * The connection name to reach the landlord database.
     */
    'landlord_database_connection_name' => null,

    /*
     * This key will be used to associate the current tenant in the context
     */
    'current_tenant_context_key' => 'tenantId',

    /*
     * This key will be used to bind the current tenant in the container.
     */
    'current_tenant_container_key' => 'currentTenant',

    /**
     * Set it to `true` if you like to cache the tenant(s) routes
     * in a shared file using the `SwitchRouteCacheTask`.
     */
    'shared_routes_cache' => false,

    /*
     * You can customize some of the behavior of this package by using your own custom action.
     * Your custom action should always extend the default one.
     */
    'actions' => [
        'make_tenant_current_action' => MakeTenantCurrentAction::class,
        'forget_current_tenant_action' => ForgetCurrentTenantAction::class,
        'make_queue_tenant_aware_action' => MakeQueueTenantAwareAction::class,
        'migrate_tenant' => MigrateTenantAction::class,
    ],

    /*
     * Jobs tenant aware even if these don't implement the TenantAware interface.
     */
    'tenant_aware_jobs' => [
        // ...
    ],

    /*
     * Jobs not tenant aware even if these don't implement the NotTenantAware interface.
     */
    'not_tenant_aware_jobs' => [
        // ...
    ],
];
```

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

### Schedule a tenant callback with $tenant->callback()

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Returns a closure that can be used with the scheduler. The example schedules a daily cache flush.

```php
$schedule->call($tenant->callback(fn () => cache()->flush()))->daily();
```

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

### Custom tenant finder with IsTenant return type

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/upgrade-guide.md

When using a custom tenant finder, update the findForRequest method to return ?IsTenant instead of the previous type. The example shows the required signature and imports.

```php
use Illuminate\Http\Request;
use Spatie\Multitenancy\Contracts\IsTenant;

class YourCustomTenantFinder extends TenantFinder
{
    public function findForRequest(Request $request): ?IsTenant
    {
        // ...
    }
}
```

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

### DatabaseSeeder with tenant and landlord logic

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/using-multiple-databases.md

Example DatabaseSeeder that uses Tenant::checkCurrent() to run tenant-specific or landlord-specific seeders. This is used when seeding tenant databases.

```php
<?php

use Illuminate\Database\Seeder;
use Spatie\Multitenancy\Models\Tenant;

class DatabaseSeeder extends Seeder
{
    public function run()
    {
        Tenant::checkCurrent()
           ? $this->runTenantSpecificSeeders()
           : $this->runLandlordSpecificSeeders();
    }

    public function runTenantSpecificSeeders()
    {
        // run tenant specific seeders
    }

    public function runLandlordSpecificSeeders()
    {
        // run landlord specific seeders
    }
}
```

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

### Implement IsTenant interface with ImplementsTenant trait

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/using-a-custom-tenant-model.md

Use your own model (e.g., Jetstream's Team) as tenant model by implementing the 'IsTenant' interface and using the 'ImplementsTenant' trait. The example shows a Team model extending JetstreamTeam.

```php
namespace App\Models;

use Laravel\Jetstream\Team as JetstreamTeam;
use Spatie\Multitenancy\Contracts\IsTenant;
use Spatie\Multitenancy\Models\Concerns\ImplementsTenant;

class Team extends JetstreamTeam implements IsTenant
{
    use HasFactory;
    use UsesLandlordConnection;
    use ImplementsTenant;
}
```

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

### Default DomainTenantFinder implementation

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/automatically-determining-the-current-tenant.md

Shows how the default 'DomainTenantFinder' is implemented. It uses 'getTenantModel' to get an instance of the class specified in the 'tenant_model' key of the config file.

```php
namespace Spatie\Multitenancy\TenantFinder;

use Illuminate\Http\Request;
use Spatie\Multitenancy\Contracts\IsTenant;

class DomainTenantFinder extends TenantFinder
{
    public function findForRequest(Request $request): ?IsTenant
    {
        $host = $request->getHost();

        return app(IsTenant::class)::whereDomain($host)->first();
    }
}
```

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

### Apply connection traits to Eloquent models

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Use UsesTenantConnection for models in the tenant DB and UsesLandlordConnection for models in the landlord DB. Shown with Post and Tenant model examples.

```php
// Models whose table lives in the tenant DB
use Spatie\Multitenancy\Models\Concerns\UsesTenantConnection;

class Post extends Model
{
    use UsesTenantConnection;
}

// Models whose table lives in the landlord DB
use Spatie\Multitenancy\Models\Concerns\UsesLandlordConnection;

class Tenant extends Model
{
    use UsesLandlordConnection;
}
```

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

### Use eachCurrent to loop over tenants and make each current

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/looping-over-a-collection-of-tenants.md

TenantCollection extends Illuminate\Database\Eloquent\Collection and adds eachCurrent, mapCurrent, filterCurrent, and rejectCurrent. These methods work like the regular collection methods but automatically make each tenant the current one. In this example, Tenant::current() returns the same tenant passed to the callback.

```php
Tenant::all()->eachCurrent(function(Tenant $tenant) {
    // the passed tenant has been made current
    Tenant::current()->is($tenant); // returns true;
});
```

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

### Reset state between tenant executions in TenantAware command

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/making-artisan-commands-tenant-aware.md

When using TenantAware, the same command instance is reused for each tenant, so instance properties retain values unless reset. Reset state at the start of handle() to avoid leakage.

```php
use Illuminate\Console\Command;
use Spatie\Multitenancy\Commands\Concerns\TenantAware;

class YourFavoriteCommand extends Command
{
use TenantAware;

    protected $signature = 'your-favorite-command {--tenant=*}';

    protected int $counter = 0;

    public function handle()
    {
        // Reset state at the beginning of each tenant execution
        $this->counter = 0;

        // Without the reset above, $counter would start at the value 
        // from the previous tenant's execution
        $this->incrementCounter();

        return $this->line('Counter: '. $this->counter);
    }

    public function incrementCounter()
    {
        $this->counter++;
    }
}
```

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

### SwitchTenantTask interface method signature

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/upgrade-guide.md

Custom tasks must update their makeCurrent method to accept IsTenant instead of Tenant, as shown in the new interface definition.

```php
public function makeCurrent(IsTenant $tenant): void;
```

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

### Get current tenant from container with 'currentTenant' key

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/working-with-the-current-tenant.md

Access the current tenant via the Laravel service container using the 'currentTenant' key; returns null if no tenant is current.

```php
app('currentTenant'); // returns the current tenant, or if no tenant is current, `null`
```

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

### Clear tenant and landlord cache using Landlord::execute

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/executing-code-for-tenants-and-landlords.md

Executes landlord code from inside a tenant request using `Spatie\Multitenancy\Landlord::execute`. Inside the closure passed to `execute`, the landlord is made active by forgetting the current tenant. The example clears the tenant cache first, then the landlord cache.

```php
use  Spatie\Multitenancy\Landlord;

// ...

Tenant::first()->execute(function (Tenant $tenant) {
    // it will clear the tenant cache
    Artisan::call('cache:clear');

    // it will clear the landlord cache
    Landlord::execute(fn () => Artisan::call('cache:clear'));
});
```

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

### Run package tests with Composer

Source: https://github.com/spatie/laravel-multitenancy/blob/main/README.md

Executes the package's test suite. Requires the three MySQL databases and Redis with PHP extension for cache tests.

```bash
composer test
```

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

### Provision database on tenant creation

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Use a 'creating' hook to automatically create a database when a tenant is created.

```php
protected static function booted(): void
{
    static::creating(fn (Tenant $tenant) => $tenant->createDatabase());
}
```

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

### Run landlord migration

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/using-multiple-databases.md

Executes the published migration against the landlord database connection. Use the landlord connection name as the --database value.

```bash
php artisan migrate --path=database/migrations/landlord --database=landlord
```

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

### Implement findForRequest abstract method

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/automatically-determining-the-current-tenant.md

A valid tenant finder must extend 'Spatie\Multitenancy\TenantFinder\TenantFinder' and implement this abstract method.

```php
abstract public function findForRequest(Request $request): ?IsTenant;
```

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

### Migrate tenant databases with dedicated path

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/using-multiple-databases.md

Run migrations from a dedicated tenant migrations directory using the tenants:artisan command with a --path option.

```bash
php artisan tenants:artisan "migrate --path=database/migrations/tenant --database=tenant"
```

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

### Make a command tenant-aware with TenantAware

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Add the `TenantAware` concern and a `{--tenant=*}` option to your command. Omitting `--tenant` runs for every tenant; the command instance is reused, so reset state at the top of `handle()`.

```php
use Illuminate\Console\Command;
use Spatie\Multitenancy\Commands\Concerns\TenantAware;

class SendReports extends Command
{
    use TenantAware;

    protected $signature = 'reports:send {--tenant=*}';

    public function handle(): void
    {
        $this->line('Sending for tenant: ' . Tenant::current()->name);
    }
}
```

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

### Working with the current tenant

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Shows how to make a tenant current, read it via Tenant::current() or app('currentTenant'), check status, and forget it. makeCurrent fires events and runs tasks; forgetCurrent runs forget tasks.

```php
use Spatie\Multitenancy\Models\Tenant;

// Make a tenant current (fires events, runs tasks)
$tenant->makeCurrent();

// Read the current tenant
Tenant::current();        // returns ?Tenant
app('currentTenant');     // same, via container

// Check and forget
Tenant::checkCurrent();   // bool
$tenant->isCurrent();     // bool
Tenant::forgetCurrent();  // runs forget tasks, returns the tenant
```

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

### Run artisan commands for tenants

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Use `tenants:artisan` to run a command for all tenants or specific ones with `--tenant` options.

```bash
php artisan tenants:artisan "migrate --database=tenant"
php artisan tenants:artisan "cache:clear" --tenant=1 --tenant=2
```

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

### $tenant->makeCurrent()

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/working-with-the-current-tenant.md

Manually makes a tenant the current one. When called, the package runs the makeCurrent method of all tasks configured in the switch_tenant_tasks key of the multitenancy config file.

```APIDOC
## $tenant->makeCurrent()

### Description
Manually makes a tenant the current one. When called, the package runs the makeCurrent method of all tasks configured in the switch_tenant_tasks key of the multitenancy config file.

### Method
`$tenant->makeCurrent()`

### Parameters
None (called on a Tenant instance)

### Return Value
- **void** - No return value.

### Usage Example
```php
$tenant->makeCurrent();
```
```

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

### Mark a job as TenantAware

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Implement the `TenantAware` interface on a job to make it tenant-aware.

```php
use Illuminate\Contracts\Queue\ShouldQueue;
use Spatie\Multitenancy\Jobs\TenantAware;

class ProcessReport implements ShouldQueue, TenantAware
{
    public function handle(): void { /* ... */ }
}
```

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

### Migrate tenant databases with tenants:artisan

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/using-multiple-databases.md

Run migrations for all tenants using the tenants:artisan command. This loops over all rows in the tenants table and makes each tenant current before migrating.

```bash
php artisan tenants:artisan "migrate --database=tenant"
```

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

### Manually set the current tenant with makeCurrent()

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/working-with-the-current-tenant.md

Call $tenant->makeCurrent() to set a tenant as current. This triggers the 'makeCurrent' method of all tasks configured in the 'switch_tenant_tasks' key of the multitenancy config.

```php
$tenant->makeCurrent();
```

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

### Task constructor accepting config parameters

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/using-tasks-to-prepare-the-environment/creating-your-own-task.md

Shows how a task can accept parameters from the multitenancy config file via its constructor. Parameter names must match those used in the config file.

```php
namespace App\Support\SwitchTenantTasks\YourTask

use Spatie\Multitenancy\Tasks\SwitchTenantTask;

class SwitchTenantDatabaseTask implements SwitchTenantTask
{
    public function __construct(string $name, string $anotherName)
    {
        // do something
    }
}
```

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

### Pass arguments and options to tenants:artisan

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/making-artisan-commands-tenant-aware.md

Wrap the command in quotes to pass arguments and options, such as --seed.

```bash
php artisan tenants:artisan "migrate --seed"
```

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

### Dispatch a tenant-aware closure

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/making-queues-tenant-aware.md

Use this when queues are not tenant aware by default and you need to dispatch a closure. Capture the current tenant and execute the closure within that tenant's context.

```php
$tenant = Tenant::current();

dispatch(function () use ($tenant) {
    $tenant->execute(function () {
        // Your job
    });
});
```

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

### Configure custom tenant model in multitenancy config

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/using-a-custom-tenant-model.md

Set the 'tenant_model' key in the 'multitenancy' config file to your custom model class. The model must extend or be 'Spatie\Multitenancy\Models\Tenant'.

```php
/*
 * This class is the model used for storing configuration on tenants.
 *
 * It must be or extend `Spatie\Multitenancy\Models\Tenant::class`
 */
'tenant_model' => \App\Models\CustomTenantModel::class,
```

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

### Task constructor with dependency injection

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/using-tasks-to-prepare-the-environment/creating-your-own-task.md

Shows how to inject dependencies via the constructor in addition to config parameters. Ensure the variable name does not conflict with any parameter name from the config file.

```php
namespace App\Support\SwitchTenantTasks\YourTask

use Spatie\Multitenancy\Tasks\SwitchTenantTask;

class SwitchTenantDatabaseTask implements SwitchTenantTask
{
    public function __construct(string $name, string $anotherName, MyDepencency $myDependency)
    {
        // do something
    }
}
```

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

### Execute tenant-aware command for all tenants

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/making-artisan-commands-tenant-aware.md

Runs the command for all tenants when no tenant option is provided. The handle method is called for each tenant, and the name of each tenant is written to the output.

```bash
php artisan your-favorite-command
```

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

### Implement NotTenantAware interface for a job class

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/making-queues-tenant-aware.md

Use this when queues are tenant aware by default. The job must implement the empty marker interface Spatie\Multitenancy\Jobs\NotTenantAware to prevent it from being tenant aware.

```php
use Illuminate\Contracts\Queue\ShouldQueue;
use Spatie\Multitenancy\Jobs\NotTenantAware;

class TestJob implements ShouldQueue, NotTenantAware
{
    public function handle()
    {
        // do the work
    }
}
```

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

### Execute code for a tenant with $tenant->execute()

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Makes the tenant current, runs the callable, then restores the previous state. Useful for running code in a tenant context.

```php
$result = $tenant->execute(function (Tenant $tenant) {
    return cache()->get('stats');
});
```

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

### Seed tenant databases with tenants:artisan

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/using-multiple-databases.md

Seed tenant databases by adding --seed to the migrate command. This will run all seeders, and you can use Tenant::checkCurrent() to differentiate between tenant and landlord seeding.

```bash
php artisan tenants:artisan "migrate --database=tenant --seed"
```

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

### Find the current tenant using Tenant model and service container

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/working-with-the-current-tenant.md

Use Tenant::current() or app(IsTenant::class)::current() to retrieve the current tenant, returning null if none is set.

```php
// Model
Tenant::current(); // returns the current tenant, or if no tenant is current, `null`

// Service Container
app(IsTenant::class)::current(); // returns the current tenant, or if no tenant is current, `null`
```

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

### Add SwitchTenantDatabaseTask to switch_tenant_tasks in config/multitenancy.php

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/using-tasks-to-prepare-the-environment/switching-databases.md

Configure the SwitchTenantDatabaseTask to switch the tenant database connection's database name. Add this task to the 'switch_tenant_tasks' key in the multitenancy config file. The database name is taken from the 'database' attribute of the Tenant model.

```php
// in config/multitenancy.php

'switch_tenant_tasks' => [
    \Spatie\Multitenancy\Tasks\SwitchTenantDatabaseTask::class,
    // other tasks
],
```

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

### Custom SubdomainTenantFinder implementing findForRequest

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Extend TenantFinder and implement findForRequest to resolve a tenant by subdomain from the request host. Returns null if no tenant matches.

```php
use Illuminate\Http\Request;
use Spatie\Multitenancy\Contracts\IsTenant;
use Spatie\Multitenancy\TenantFinder\TenantFinder;

class SubdomainTenantFinder extends TenantFinder
{
    public function findForRequest(Request $request): ?IsTenant
    {
        $subdomain = explode('.', $request->getHost())[0];

        return app(IsTenant::class)::whereSubdomain($subdomain)->first();
    }
}
```

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

### Execute tenant-aware command for a specific tenant

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/making-artisan-commands-tenant-aware.md

Runs the command for a specific tenant by passing the tenant ID with the --tenant option.

```bash
php artisan your-favorite-command --tenant=1
```

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

### Implement TenantAware interface for a job class

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/making-queues-tenant-aware.md

Use this when queues are not tenant aware by default. The job must implement the empty marker interface Spatie\Multitenancy\Jobs\TenantAware to be made tenant aware.

```php
use Illuminate\Contracts\Queue\ShouldQueue;
use Spatie\Multitenancy\Jobs\TenantAware;

class TestJob implements ShouldQueue, TenantAware
{
    public function handle()
    {
        // do the work
    }
}
```

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

### Clear Specific Facade Instances on Tenant Switch

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/using-tenant-specific-facades.md

Clears resolved instances of a specified list of facades when switching tenants. Use this when only a few facades are tenant-specific. The makeCurrent method is intentionally empty because the tenant is already current.

```php
namespace App\Tenancy\SwitchTasks;

use Illuminate\Support\Facades\Facade;
use Illuminate\Support\Str;
use Spatie\Multitenancy\Contracts\IsTenant;
use Spatie\Multitenancy\Tasks\SwitchTenantTask;

class ClearFacadeInstancesTask implements SwitchTenantTask
{
    public function makeCurrent(IsTenant $tenant): void
    {
        // tenant is already current
    }

    public function forgetCurrent(): void
    {
        $facadeClasses = [
            // array containing class names of faces you wish to clear
        ];

        collect($facadeClasses)
            ->each(
                fn (string $facade) => $facade::clearResolvedInstance($facade::getFacadeAccessor);
            );
    }
}
```

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

### Schedule tenant callback with Tenant::callback

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/executing-code-for-tenants-and-landlords.md

Defines a callback that executes in the correct tenant context every time it is called, using the `callback` method on the `Tenant` model. Useful for Laravel scheduler to loop through tenants and schedule callbacks. Same caveat applies: if the callback dispatches a job, call `dispatch()` as a statement, not as a return value.

```php
protected function schedule(Schedule $schedule)
{
    Tenant::all()->eachCurrent(function(Tenant $tenant) use ($schedule) {
        $schedule->call($tenant->callback(fn() => cache()->flush()))->daily();
    });
}
```

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

### Register switch tenant tasks in config/multitenancy.php

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

List tasks to run on makeCurrent() and forgetCurrent(). Includes SwitchTenantDatabaseTask and commented-out alternatives.

```php
'switch_tenant_tasks' => [
    \Spatie\Multitenancy\Tasks\SwitchTenantDatabaseTask::class,
    // \Spatie\Multitenancy\Tasks\PrefixCacheTask::class,
    // \Spatie\Multitenancy\Tasks\SwitchRouteCacheTask::class,
],
```

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

### Run tenants:artisan for a specific tenant

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/making-artisan-commands-tenant-aware.md

Pass the tenant ID to the --tenant option to run the command only for that tenant.

```bash
php artisan tenants:artisan "migrate --seed" --tenant=123
```

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

### Configure tenant and landlord database connections in config/database.php

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/using-multiple-databases.md

Adds two database connections: 'tenant' with a null database name (dynamically set per current tenant) and 'landlord' pointing to the system-wide database. Required when each tenant has its own database.

```php
// in config/database.php

'connections' => [
    'tenant' => [
        'driver' => 'mysql',
        'database' => null,
        'host' => '127.0.0.1',
        'username' => 'root',
        'password' => '',
        // And other options if needed ...
    ],

    'landlord' => [
        'driver' => 'mysql',
        'database' => 'name_of_landlord_db',
        'host' => '127.0.0.1',
        'username' => 'root',
        'password' => '',
        // And other options if needed ...
    ],
],
```

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

### Registering a task in multitenancy config

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/using-tasks-to-prepare-the-environment/creating-your-own-task.md

Shows how to register a task by adding its class name to the 'switch_tenant_tasks' key in the multitenancy config file. This is required after creating a task.

```php
'switch_tenant_tasks' => [
    \App\Support\SwitchTenantTasks\YourTask::class => ['name' => 'value', 'anotherName' => 'value'],
    // other tasks
],
```

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

### Clear All Facade Instances in App Namespace on Tenant Switch

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/using-tenant-specific-facades.md

Clears resolved instances of all facades in the App namespace when switching tenants. This code loops through all declared classes and filters for facades in the App or Facades\App namespaces. Provided by Adrian Brown.

```php
namespace App\Tenancy\SwitchTasks;

use Illuminate\Support\Facades\Facade;
use Illuminate\Support\Str;
use Spatie\Multitenancy\Contracts\IsTenant;
use Spatie\Multitenancy\Tasks\SwitchTenantTask;

class ClearFacadeInstancesTask implements SwitchTenantTask
{
    public function makeCurrent(IsTenant $tenant): void
    {
        // tenant is already current
    }

    public function forgetCurrent(): void
    {
        $this->clearFacadeInstancesInTheAppNamespace();
    }

    protected function clearFacadeInstancesInTheAppNamespace(): void
    {
        // Discovers all facades in the App namespace and clears their resolved instance:
        collect(get_declared_classes())
            ->filter(fn ($className) => is_subclass_of($className, Facade::class))
            ->filter(fn ($className) => Str::startsWith($className, 'App') || Str::startsWith($className, 'Facades\\App'))
            ->each(fn ($className) => $className::clearResolvedInstance(
                $className::getFacadeAccessor()
            ));
    }
}
```

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

### Dispatch closure with explicit tenant

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

For closures dispatched to the queue, pass the tenant explicitly and use `$tenant->execute()` to activate tenant context.

```php
$tenant = Tenant::current();

dispatch(function () use ($tenant) {
    $tenant->execute(function () {
        // tenant context is active here
    });
});
```

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

### Opt out of tenant awareness with NotTenantAware

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Implement the `NotTenantAware` interface to exclude a job from tenant awareness.

```php
use Spatie\Multitenancy\Jobs\NotTenantAware;

class SyncGlobalData implements ShouldQueue, NotTenantAware
{
    public function handle(): void { /* ... */ }
}
```

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

### Enable tenant-aware queues globally

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Set `queues_are_tenant_aware_by_default` to `true` in `config/multitenancy.php` to make all queues tenant-aware by default.

```php
'queues_are_tenant_aware_by_default' => true,
```

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

### Apply tenant middleware to routes

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/ensuring-a-current-tenant-has-been-set.md

Uses the registered 'tenant' middleware group in a routes file to protect routes that require a current tenant. Throws Spatie\Multitenancy\Exceptions\NoCurrentTenant if no tenant is set.

```php
// in a routes file

Route::middleware('tenant')->group(function() {
    // routes
})
```

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

### Forget the current tenant

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/working-with-the-current-tenant.md

Use Tenant::forgetCurrent() or app(IsTenant::class)::forgetCurrent() to clear the current tenant. If no tenant is current, the method does nothing.

```php
// Model
Tenant::forgetCurrent();
Tenant::current() // return null;

// Service Container
app(IsTenant::class)::forgetCurrent();
app(IsTenant::class)::current(); // return null
```

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

### Use tenants:artisan to run a command for all tenants

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/making-artisan-commands-tenant-aware.md

Use tenants:artisan to run an Artisan command for each tenant, making each tenant current. Useful for commands you cannot modify, like Laravel's migrate.

```bash
php artisan tenants:artisan migrate
```

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

### Configure DomainTenantFinder in multitenancy.php

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/determining-current-tenant.md

Specify the tenant finder class in the 'tenant_finder' key of the multitenancy config file. The package ships with DomainTenantFinder, which matches the tenant's 'domain' attribute to the request host.

```php
// in multitenancy.php
/*
 * This class is responsible for determining which tenant should be current
 * for the given request.
 *
 * This class should extend `Spatie\Multitenancy\TenantFinder\TenantFinder`
 *
 */
'tenant_finder' => Spatie\Multitenancy\TenantFinder\DomainTenantFinder::class,
```

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

### Apply TenantAware trait to an Artisan command

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/making-artisan-commands-tenant-aware.md

Use the TenantAware trait to make a command tenant aware. The signature must include {--tenant=*} or {--tenant=}. If {--tenant=*} is used and no tenant option is provided, the command runs for all tenants.

```php
use Illuminate\Console\Command;
use Spatie\Multitenancy\Commands\Concerns\TenantAware;

class YourFavoriteCommand extends Command
{
    use TenantAware;

    protected $signature = 'your-favorite-command {--tenant=*}';

    public function handle()
    {
        return $this->line('The tenant is '. Tenant::current()->name);
    }
}
```

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

### Programmatic migrations with MigrateTenantAction

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Use MigrateTenantAction to programmatically run migrations, optionally fresh and with seed, for a given tenant.

```php
use Spatie\Multitenancy\Actions\MigrateTenantAction;

app(MigrateTenantAction::class)->fresh()->seed()->execute($tenant);
```

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

### Configure tenant-aware jobs in config

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

List job classes in `tenant_aware_jobs` and `not_tenant_aware_jobs` arrays in `config/multitenancy.php` to control tenant awareness.

```php
'tenant_aware_jobs'     => [\App\Jobs\ProcessReport::class],
'not_tenant_aware_jobs' => [\App\Jobs\SyncGlobalData::class],
```

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

### Add job to not_tenant_aware_jobs config

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/making-queues-tenant-aware.md

Alternative to implementing the NotTenantAware interface. Add the job class to the 'not_tenant_aware_jobs' array in the multitenancy.php config file.

```php
'not_tenant_aware_jobs' => [
    TestJob::class,
],
```

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

### Check if a current tenant exists

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/working-with-the-current-tenant.md

Use Tenant::checkCurrent() or app(IsTenant::class)::checkCurrent() to return a boolean indicating whether a tenant is set as current.

```php
// Model
Tenant::checkCurrent(); // returns `true` or `false`

// Service Container
app(IsTenant::class)::checkCurrent(); // returns `true` or `false`
```

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

### Configure tenant finder in config/multitenancy.php

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Set the tenant finder class to DomainTenantFinder, which matches the request host against a 'domain' column on the tenants table.

```php
'tenant_finder' => \Spatie\Multitenancy\TenantFinder\DomainTenantFinder::class,
```

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

### Add job to tenant_aware_jobs config

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/making-queues-tenant-aware.md

Alternative to implementing the TenantAware interface. Add the job class to the 'tenant_aware_jobs' array in the multitenancy.php config file.

```php
'tenant_aware_jobs' => [
    TestJob::class,
],
```

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

### Tenant::current()

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/working-with-the-current-tenant.md

Returns the current tenant, or null if no tenant is current. This method is available on the Tenant model and through the service container.

```APIDOC
## Tenant::current()

### Description
Returns the current tenant, or null if no tenant is current.

### Method
`Tenant::current()`

### Parameters
None

### Return Value
- **Tenant|null** - The current tenant instance, or null if no tenant is current.

### Usage Example
```php
Tenant::current();
```

### Service Container Usage
```php
app(IsTenant::class)::current();
```

### Container Binding
```php
app('currentTenant');
```
```

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

### SwitchTenantTask interface definition

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/using-tasks-to-prepare-the-environment/creating-your-own-task.md

Defines the contract for a tenant-switching task. Implement makeCurrent() to apply tenant-specific changes and forgetCurrent() to restore the original environment. Tasks are singletons, so you can store original values as properties for later restoration.

```php
namespace Spatie\Multitenancy\Tasks;

use Spatie\Multitenancy\Contracts\IsTenant;

interface SwitchTenantTask
{
    public function makeCurrent(IsTenant $tenant): void;

    public function forgetCurrent(): void;
}
```

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

### Set connection names in config/multitenancy.php

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Specify the tenant and landlord database connection names for the package to use.

```php
'tenant_database_connection_name'   => 'tenant',
'landlord_database_connection_name' => 'landlord',
```

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

### Branch seeders on Tenant::checkCurrent()

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

In seeders, use Tenant::checkCurrent() to run tenant-specific or landlord-specific seeders depending on the current context.

```php
public function run(): void
{
    Tenant::checkCurrent()
        ? $this->runTenantSpecificSeeders()
        : $this->runLandlordSpecificSeeders();
}
```

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

### Add SwitchTenantDatabaseTask to switch_tenant_tasks

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/installation/using-multiple-databases.md

Registers the built-in task that switches the tenant connection to the database named in the tenant's 'database' attribute. Add to the 'switch_tenant_tasks' key in the multitenancy config.

```php
/*
 * These tasks will be performed to make a tenant current.
 *
 * A valid task is any class that implements Spatie\Multitenancy\Tasks\SwitchTenantTask
 */
'switch_tenant_tasks' => [
    Spatie\Multitenancy\Tasks\SwitchTenantDatabaseTask::class,
],
```

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

### Add PrefixCacheTask to switch_tenant_tasks in config/multitenancy.php

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/using-tasks-to-prepare-the-environment/prefixing-cache.md

Add the PrefixCacheTask class to the switch_tenant_tasks array in the multitenancy config file to enable separate caches per tenant. This task only works with memory-based caches like APC and Redis; the Octane cache driver ignores the prefix.

```php
// in config/multitenancy.php

'switch_tenant_tasks' => [
    \Spatie\Multitenancy\Tasks\PrefixCacheTask::class,
    // other tasks
],
```

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

### Dispatch job for tenant via landlord API using Tenant::execute

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/executing-code-for-tenants-and-landlords.md

Executes tenant code in a landlord request to dispatch a job. The closure passed to `execute` runs with the given `$tenant` as the current one. Warning: do not return the result of `dispatch()` from the closure, as the job may be queued for the wrong tenant; call it as its own statement.

```php
Route::post('/api/{tenant}/reminder', function (Tenant $tenant) {
    $tenant->execute(function () {
        ExpirationReminder::dispatch();
    });

    return json_encode(['success' => true]);
});
```

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

### Implement IsTenant with ImplementsTenant trait

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Use an existing model (e.g., Jetstream Team) as a tenant by implementing the IsTenant contract and using the ImplementsTenant trait. Also uses UsesLandlordConnection to ensure the model uses the landlord connection.

```php
use Spatie\Multitenancy\Contracts\IsTenant;
use Spatie\Multitenancy\Models\Concerns\ImplementsTenant;
use Spatie\Multitenancy\Models\Concerns\UsesLandlordConnection;

class Team extends JetstreamTeam implements IsTenant
{
    use UsesLandlordConnection;
    use ImplementsTenant;
}
```

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

### Tenant::checkCurrent()

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/working-with-the-current-tenant.md

Checks if there is a current tenant set. Returns true if a tenant is current, false otherwise.

```APIDOC
## Tenant::checkCurrent()

### Description
Checks if there is a current tenant set.

### Method
`Tenant::checkCurrent()`

### Parameters
None

### Return Value
- **bool** - `true` if a tenant is current, `false` otherwise.

### Usage Example
```php
Tenant::checkCurrent();
```

### Service Container Usage
```php
app(IsTenant::class)::checkCurrent();
```
```

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

### Current tenant restored after dispatchSync

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/basic-usage/making-queues-tenant-aware.md

Shows that after dispatching a non-tenant-aware job synchronously, the current tenant is restored to the one that was current before the dispatch.

```php
$tenant->makeCurrent();

SomeNotTenantAwareJob::dispatchSync(); // runs without a current tenant

Tenant::current(); // still $tenant
```

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

### Update TestCase.php for DatabaseTransactions with Tenant

Source: https://github.com/spatie/laravel-multitenancy/blob/main/docs/advanced-usage/executing-code-for-tenants-and-landlords.md

Modifies the default `TestCase.php` to ensure database transactions are performed on the `Tenant` connection when using the `DatabaseTransactions` trait. It overrides `connectionsToTransact` to include both landlord and tenant connections, and listens for `MadeTenantCurrentEvent` to begin a transaction when a tenant becomes current.

```php
namespace Tests;

use Illuminate\Foundation\Testing\DatabaseTransactions;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
use Illuminate\Support\Facades\Event;
use Spatie\Multitenancy\Concerns\UsesMultitenancyConfig;
use Spatie\Multitenancy\Events\MadeTenantCurrentEvent;

abstract class TestCase extends BaseTestCase
{
    use CreatesApplication, DatabaseTransactions, UsesMultitenancyConfig;

    protected function connectionsToTransact()
    {
        return [
            $this->landlordDatabaseConnectionName(),
            $this->tenantDatabaseConnectionName(),
        ];
    }

    protected function setUp(): void
    {
        parent::setUp();

        Event::listen(MadeTenantCurrentEvent::class, function () {
            $this->beginDatabaseTransaction();
        });
    }
}
```

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

### Run code outside tenant context with Landlord::execute()

Source: https://github.com/spatie/laravel-multitenancy/blob/main/resources/boost/skills/laravel-multitenancy-development/SKILL.md

Executes code without any tenant context, useful for global operations like clearing the cache.

```php
use Spatie\Multitenancy\Landlord;

Landlord::execute(function () {
    Artisan::call('cache:clear');
});
```
Tokens:
Raw