mirror of
https://github.com/stancl/tenancy-docs.git
synced 2025-12-12 18:24:03 +00:00
a4645b3abd
* chore: (Improve documentation search for V3) * fix: checks for mispelled words * fix: mispelled words * fix spaces and syntax * Update multi-database-tenancy.blade.md Co-authored-by: Samuel Stancl <samuel.stancl@gmail.com>
95 lines
No EOL
4.2 KiB
Markdown
95 lines
No EOL
4.2 KiB
Markdown
---
|
|
title: Tenancy bootstrappers
|
|
extends: _layouts.documentation
|
|
section: content
|
|
---
|
|
|
|
# Tenancy bootstrappers {#tenancy-bootstrappers}
|
|
|
|
Tenancy bootstrappers are classes which make your application tenant-aware in such a way that you don't have to change a line of your code, yet things will be scoped to the current tenant.
|
|
|
|
The package comes with these bootstrappers out of the box:
|
|
|
|
## Database tenancy bootstrapper {#database-tenancy-bootstrapper}
|
|
|
|
The database tenancy bootstrapper switches the **default** database connection to `tenant` after it constructs the connection for that tenant.
|
|
|
|
[Customizing databases]({{ $page->link('customizing-databases') }})
|
|
|
|
Note that only the **default** connection is switched. If you use another connection explicitly, be it using `DB::connection('...')`, a model `getConnectionName()` method, or a model trait like `CentralConnection`, **it will be respected.** The bootstrapper doesn't **force** any connections, it merely switches the default one.
|
|
|
|
## Cache tenancy bootstrapper {#cache-tenancy-bootstrapper}
|
|
|
|
The cache tenancy bootstrapper replaces the Laravel's CacheManager instance with a custom CacheManager that adds tags with the current tenant's ids to each cache call. This scopes cache calls and lets you selectively clear tenants' caches:
|
|
|
|
```php
|
|
php artisan cache:clear --tag=tenant_123
|
|
```
|
|
|
|
Note that you must use a cache store that supports tagging, e.g. Redis.
|
|
|
|
## Filesystem tenancy bootstrapper {#filesystem-tenancy-boostrapper}
|
|
|
|
This bootstrapper does the following things:
|
|
|
|
- Suffixes roots of disks used by the `Storage` facade
|
|
- Suffixes `storage_path()` (useful if you're using the local disk for storing tenant data)
|
|
- Makes `asset()` calls use the TenantAssetController to retrieve tenant-specific data
|
|
- Note: For some assets, e.g. images, you may want to use `global_asset()` (if the asset is shared for all tenants). And for JS/CSS assets, you should use `mix()` or again `global_asset()`.
|
|
|
|
This bootstrapper is the most complex one, by far. We will have a — better written — explanation in v3 docs soon, but for now, refer to the 2.x docs for information about filesystem tenancy. [https://tenancyforlaravel.com/docs/v2/filesystem-tenancy/](https://tenancyforlaravel.com/docs/v2/filesystem-tenancy/)
|
|
|
|
If you don't want to bootstrap filesystem tenancy in this way, and want to — for example — provision an S3 bucket for each tenant, you can absolutely do that. Look at the package's bootstrappers to get an idea of how to write one yourself, and feel free to implement it any way you want.
|
|
|
|
## Queue tenancy bootstrapper {#queue-tenancy-bootstrapper}
|
|
|
|
This bootstrapper adds the current tenant's ID to the queued job payloads, and initializes tenancy based on this ID when jobs are being processed.
|
|
|
|
You can read more about this on the *Queues* page:
|
|
|
|
[Queues]({{ $page->link('queues') }})
|
|
|
|
## Redis tenancy bootstrapper {#redis-tenancy-bootstrapper}
|
|
|
|
If you're using `Redis` calls (not cache calls, **direct** Redis calls) inside the tenant app, you will want to scope Redis data too. To do this, use this bootstrapper. It changes the Redis prefix for each tenant.
|
|
|
|
Note that you need phpredis, predis won't work.
|
|
|
|
## Writing custom bootstrappers {#writing-custom-bootstrappers}
|
|
|
|
If you want to bootstrap tenancy for something not covered by this package — or something covered by this package, but you want different behavior — you can do that by creating a bootstrapper class.
|
|
|
|
The class must implement the `Stancl\Tenancy\Contracts\TenancyBootstrapper` interface:
|
|
|
|
```php
|
|
namespace App;
|
|
|
|
use Stancl\Tenancy\Contracts\TenancyBootstrapper;
|
|
use Stancl\Tenancy\Contracts\Tenant;
|
|
|
|
class MyBootstrapper implements TenancyBootstrapper
|
|
{
|
|
public function bootstrap(Tenant $tenant)
|
|
{
|
|
// ...
|
|
}
|
|
|
|
public function revert()
|
|
{
|
|
// ...
|
|
}
|
|
}
|
|
```
|
|
|
|
Then, register it in the `tenancy.bootstrappers` config:
|
|
|
|
```php
|
|
'bootstrappers' => [
|
|
Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper::class,
|
|
Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper::class,
|
|
Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper::class,
|
|
Stancl\Tenancy\Bootstrappers\QueueTenancyBootstrapper::class,
|
|
|
|
App\MyBootstrapper::class,
|
|
],
|
|
``` |