maintenance mode

This commit is contained in:
Samuel Štancl 2020-08-01 20:25:00 +02:00
parent 111ec91cfb
commit c5111ec00e
2 changed files with 30 additions and 0 deletions

View file

@ -210,6 +210,7 @@ return [
'Console commands' => 'console-commands',
'Cached lookup' => 'cached-lookup',
'Real-time facades' => 'realtime-facades',
'Tenant maintenance mode' => 'tenant-maintenance-facades',
],
],
],

View file

@ -0,0 +1,29 @@
---
title: Tenant maintenance mode
extends: _layouts.documentation
section: content
---
# Tenant maintenance mode {#tenant-maintenance-mode}
You may put specific tenants into maintenance mode using the `MaintenanceMode` trait.
Apply it on your [Tenant model]({{ $page->link('tenants') }}):
```php
use Stancl\Tenancy\Database\Concerns\MaintenanceMode;
class Tenant extends BaseTenant
{
use MaintenanceMode;
}
```
This will let you use the following method on each tenant object:
```php
$tenant->putDownForMaintenance();
```
## Middleware {#middleware}
You will also need to use the `Stancl\Tenancy\Middleware\CheckTenantForMaintenanceMode` middleware on your tenant routes.