This commit is contained in:
Samuel Štancl 2019-11-10 15:42:13 +01:00
parent be8d1fa497
commit c69505a09a
8 changed files with 51 additions and 14 deletions

View file

@ -92,7 +92,7 @@ The aliases are used by the [event system]({{ $page->link('hooks') }})
### `features` {#bootstrappers}
Features are similar to bootstrappers, but they are executed regardless of whether tenancy has been initialized or not. Their purpose is to provide additional functionality beyond what is necessary for the package to work. Things like easy redirects to tenant domains, tags in Telescope, etc.
[Features]({{ $page->link('optional-features') }}) are similar to bootstrappers, but they are executed regardless of whether tenancy has been initialized or not. Their purpose is to provide additional functionality beyond what is necessary for the package to work. Things like easy redirects to tenant domains, tags in Telescope, etc.
### `home_url` {#home-url}

View file

@ -0,0 +1,12 @@
---
title: Optional Features
description: Optional Features
extends: _layouts.documentation
section: content
---
# Optional Features {#optional-features}
Similarly to [TenancyBootstrappers]({{ $page->link('tenancy-bootstrappers') }}), `Features` are classes that provide extra functionality and can be enabled in the config. They're all disabled by default, because they're not critical to the core tenancy scaffolding.
You may enable and disable `Features` in the `tenancy.features` configuration.

View file

@ -0,0 +1,17 @@
---
title: Tenant Redirect
description: Tenant Redirect
extends: _layouts.documentation
section: content
---
# Tenant Redirect {#tenant-redirect}
> To enable this feature, uncomment the `Stancl\Tenancy\Features\TenantRedirect::class` line in your `tenancy.features` config.
A customer has signed up on your website, you have created a new tenant and now you want to redirect the customer to their website. You can use the `tenant()` method on Redirect, like this:
```php
// tenant sign up controller
return redirect()->route('dashboard')->tenant($domain);
```

View file

@ -0,0 +1,12 @@
---
title: Timestamps
description: Timestamps
extends: _layouts.documentation
section: content
---
# Timestamps {#timestamps-redirect}
> To enable this feature, uncomment the `Stancl\Tenancy\Features\Timestamps::class` line in your `tenancy.features` config.
TODO

View file

@ -7,17 +7,6 @@ section: content
# Miscellaneous Tips {#misc-tips}
## Tenant Redirect {#tenant-redirect}
> To enable this feature, uncomment the `Stancl\Tenancy\Features\TenantRedirect::class` line in your `tenancy.features` config.
A customer has signed up on your website, you have created a new tenant and now you want to redirect the customer to their website. You can use the `tenant()` method on Redirect, like this:
```php
// tenant sign up controller
return redirect()->route('dashboard')->tenant($domain);
```
## Custom ID scheme
If you don't want to use UUIDs and want to use something more human-readable (even domain concatenated with uuid, for example), you can create a custom class for this:

View file

@ -51,6 +51,6 @@ If you're coming from 1.x, it's recommended to read (or at least skim through) t
## New Features
- [Tenant Config]({{ $page->link('tenant-config') }})
- [Tenant Config]({{ $page->link('features/tenant-config') }})
- [Migrate Fresh]({{ $page->link('console-commands#migrate-fresh') }})
- [`tenants:create`]({{ $page->link('console-commands#create-tenant') }})