archtechx/tenancy
1
0
Fork 0
mirror of https://github.com/archtechx/tenancy.git synced 2026-02-05 15:14:04 +00:00
Code Activity

Update config comments

Browse source
This commit is contained in:
lukinovec 2022-07-25 11:58:54 +02:00
parent 4d7831d6f6
commit 83f2cab944
1 changed files with 7 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

16
assets/config.php
View file

@ -42,24 +42,22 @@ return [
*/ */
'pending' => [ 'pending' => [
/** /**
* If disabled, pending tenants will be excluded from all tenant queries. Unless if * If disabled, pending tenants will be excluded from all tenant queries.
* told otherwise with ::withPending() or ::onlyPending(). * You can still use ::withPending(), ::withoutPending() and ::onlyPending() to include or exclude the pending tenants regardless of this setting.
* Note: when disabled, this will also ignore tenants when runnings any tenants commands (migration, seed, etc.) * Note: when disabled, this will also ignore pending tenants when running any tenant commands (migration, seed, etc.)
*/ */
'include_in_queries' => true, 'include_in_queries' => true,
/** /**
* Defines how many tenants you want to be in a pending state. * Defines how many tenants you want to be in a pending state.
* This value should be changed depending on how often a new tenant is created * This depends on the volume of tenants you're creating.
* and how often you run the `tenancy:pending` command via the scheduler.
*/ */
'count' => env('TENANCY_PENDING_COUNT', 5), 'count' => env('TENANCY_PENDING_COUNT', 5),
/** /**
* If needed, you can define a time limite after when an unused pending tenant * You can define time constraints for automatically deleting unused
* will automatically be deleted. * pending tenants (schedule the `tenancy:pending-clear` command to make this work automatically).
* For this to work automatically, make sure to call the `tenancy:pending-clear` command in the scheduler.
* *
* If both values are set to null, not time limit will be set and all pending tenants will be deleted. * If both values are set to null, the time limit won't be set and all pending tenants will be deleted.
*/ */
'older_than_days' => env('TENANCY_PENDING_OLDER_THAN_DAYS', null), 'older_than_days' => env('TENANCY_PENDING_OLDER_THAN_DAYS', null),