Tenancy bootstrappers page

This commit is contained in:
Samuel Štancl 2019-09-23 11:44:08 +02:00
parent 7b58d402a5
commit fd1695000b
3 changed files with 21 additions and 0 deletions

View file

@ -36,6 +36,8 @@ The following actions can be prevented:
- Redis prefix: `redis`
- CacheManager switch: `cache`
- Filesystem changes: `filesystem`
- Queue tenancy: `queue`
- and anything else listed in the [`tenancy.bootstrappers` config]({{ $page->link('configuration#bootstrappers') }})
### Tenant-specific configuration example {#tenant-specific-configuration-example}

View file

@ -0,0 +1,18 @@
---
title: Tenancy Bootstrappers
description: Tenancy Bootstrappers
extends: _layouts.documentation_v2
section: content
---
# Tenancy Bootstrappers {#tenancy-bootstrappers}
These are the classes that do the magic. When tenancy is initialized, TenancyBootstrappers are executed, making Laravel tenant-aware.
All Tenancy Bootstrappers must implement the `Stancl\Tenancy\Contracts\TenancyBootstrapper` interface.
When tenancy is [initialized]({{ $page->link('tenancy-initialization') }}), the `start()` method on the [enabled bootstrappers]({{ $page->link('configuration#bootstrappers') }}) is called.
Conversely, when tenancy is ended, the `end()` method is called.
In the [`tenancy.bootstrappers` configuration]( {{ $page->link('configuration#bootstrappers') }} ), bootstrappers have an alias configured (e.g. `database`) that is used by [events]({{ $page->link('event-system') }}) to say which bootstrappers are prevented.