mirror of
https://github.com/stancl/tenancy-docs.git
synced 2025-12-12 18:24:03 +00:00
improve hook & testing docs (fix #38)
This commit is contained in:
parent
90545f715e
commit
34a6b2cadd
2 changed files with 162 additions and 33 deletions
|
|
@ -7,7 +7,62 @@ section: content
|
|||
|
||||
# Hooks / The Event System
|
||||
|
||||
You can use event hooks to change the behavior of the tenancy bootstrapping and tenancy ending processes.
|
||||
You can use event hooks to change the behavior of the package.
|
||||
|
||||
All hook callbacks receive the `TenantManager` as the first argument.
|
||||
|
||||
## Tenant events
|
||||
|
||||
A common use case for these events is seeding the tenant data during creation:
|
||||
```php
|
||||
// AppServiceProvider::boot()
|
||||
tenancy()->hook('tenant.creating', function (TenantManager $tm, Tenant $tenant) {
|
||||
$tenant->put([
|
||||
'posts_per_page' => '15',
|
||||
]);
|
||||
});
|
||||
```
|
||||
|
||||
The following events are available:
|
||||
- `tenant.creating`
|
||||
- `tenant.created`
|
||||
- `tenant.updating`
|
||||
- `tenant.updated`
|
||||
- `tenant.deleting`
|
||||
- `tenant.deleted`
|
||||
- `tenant.softDeleting`
|
||||
- `tenant.softDeleted`
|
||||
|
||||
Callbacks for these events may accept the following arguments:
|
||||
```php
|
||||
TenantManager $tenantManager, Tenant $tenant
|
||||
```
|
||||
|
||||
## Database events
|
||||
|
||||
A use case for these events is executing something after the tenant database is created (& migrated/seeded) without running into race conditions.
|
||||
|
||||
Say you have a `AfterCreatingTenant` job that creates a superadmin user. You may use the `database.creating` event to add this job into the queue chain of the job that creates the tenant's database.
|
||||
```php
|
||||
tenancy()->hook('database.creating', function (TenantManager $tm, string $db, Tenant $tenant) {
|
||||
return [
|
||||
new AfterCreatingTenant($tenant->id);
|
||||
]
|
||||
});
|
||||
```
|
||||
|
||||
The following events are available:
|
||||
- `database.creating`
|
||||
- `database.created`
|
||||
- `database.deleting`
|
||||
- `database.deleted`
|
||||
|
||||
Callbacks for these events may accept the following arguments:
|
||||
```php
|
||||
TenantManager $tenantManager, string $db, Tenant $tenant
|
||||
```
|
||||
|
||||
## Bootstrapping/ending events
|
||||
|
||||
The following events are available:
|
||||
- `bootstrapping`
|
||||
|
|
@ -15,23 +70,7 @@ The following events are available:
|
|||
- `ending`
|
||||
- `ended`
|
||||
|
||||
### Tenant-specific database connection example {#tenant-specific-database-connection-example}
|
||||
|
||||
> Note: Tenant-specific DB connections can now be achieved using a first-class feature: [Custom DB connections]({{ $page->link('custom-db-connections') }})
|
||||
|
||||
You can hook into these events using `Tenancy::hook(<eventName>, function () {})`:
|
||||
```php
|
||||
\Tenancy::hook('bootstrapping', function ($tenantManager) {
|
||||
if ($tenantManager->tenant['id'] === 'someID') {
|
||||
config(['database.connections.someDatabaseConnection' => $tenantManager->tenant['databaseConnection']]);
|
||||
$tenantManager->database->useConnection('someDatabaseConnection');
|
||||
|
||||
return ['database'];
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
The example above checks whether the current tenant has an id of `someID`. If yes, it creates a new database connection based on data stored in the tenant's storage. Then it changes the default database connection. Finally, it returns an array of the events that this callback prevents.
|
||||
You may use the `bootstrapping` & `ending` events to prevent some bootstrappers from being executed.
|
||||
|
||||
The following actions can be prevented:
|
||||
- database connection switch: `database`
|
||||
|
|
@ -41,11 +80,7 @@ The following actions can be prevented:
|
|||
- Queue tenancy: `queue`
|
||||
- and anything else listed in the [`tenancy.bootstrappers` config]({{ $page->link('configuration#bootstrappers') }})
|
||||
|
||||
### Tenant-specific configuration example {#tenant-specific-configuration-example}
|
||||
|
||||
Another common use case for events is tenant-specific config:
|
||||
Callbacks for these events may accept the following arguments:
|
||||
```php
|
||||
\Tenancy::hook('bootstrapped', function ($tenantManager) {
|
||||
config(['some.api.key' => $tenantManager->tenant['api_key']);
|
||||
});
|
||||
```
|
||||
TenantManager $tenantManager, Tenant $tenant
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue