tenancy-docs/source/docs/v3/tenant-maintenance-mode.blade.md
Piyush Manolkar 0d66cd00cb
Update tenant-maintenance-mode.blade.md (#153)
Add documentation to remove tenant from maintainance mode.
2022-02-25 15:40:47 +01:00

34 lines
794 B
Markdown

---
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();
```
To remove specific tenant from maintainance mode:
```php
$tenant->update(['maintenance_mode' => null]);
```
## Middleware {#middleware}
You will also need to use the `Stancl\Tenancy\Middleware\CheckTenantForMaintenanceMode` middleware on your tenant routes.