Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions source/docs/v3/tenant-aware-commands.blade.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Even though [`tenants:run`]({{ $page->link('console-commands#run') }}) lets you

To make a command tenant-aware, utilize the `TenantAwareCommand` trait:
```php
use Stancl\Tenancy\Concerns\TenantAwareCommand;

class MyCommand extends Command
{
use TenantAwareCommand;
Expand All @@ -20,8 +22,8 @@ class MyCommand extends Command
However, this trait requires you to implement a `getTenants()` method that returns an array of `Tenant` instances.

If you don't want to implement the options/arguments yourself, you may use one of these two traits:
- `HasATenantsOption` - accepts multiple tenant IDs, optional -- by default the command is executed for all tenants
- `HasATenantArgument` - accepts a single tenant ID, required argument
- `Stancl\Tenancy\Concerns\HasATenantsOption` - accepts multiple tenant IDs, optional -- by default the command is executed for all tenants
- `Stancl\Tenancy\Concerns\HasATenantArgument` - accepts a single tenant ID, required argument

These traits implement the `getTenants()` method needed by `TenantAwareCommand`.

Expand All @@ -30,6 +32,10 @@ These traits implement the `getTenants()` method needed by `TenantAwareCommand`.
So if you use these traits in combination with `TenantAwareCommand`, you won't have to change a thing in your command:

```php

use Stancl\Tenancy\Concerns\TenantAwareCommand;
use Stancl\Tenancy\Concerns\HasATenantsOption;

class FooCommand extends Command
{
use TenantAwareCommand, HasATenantsOption;
Expand All @@ -40,6 +46,9 @@ class FooCommand extends Command
}
}

use Stancl\Tenancy\Concerns\TenantAwareCommand;
use Stancl\Tenancy\Concerns\HasATenantArgument;

class BarCommand extends Command
{
use TenantAwareCommand, HasATenantArgument;
Expand Down