stancl/tenancy-docs
1
0
Fork 0
mirror of https://github.com/stancl/tenancy-docs.git synced 2025-12-12 10:14:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
tenancy-docs/docs/source/v2/usage.blade.md
Samuel Štancl ae63f30be6 New routes
2019-09-21 22:10:32 +02:00

831 B
Raw Blame History

title description extends section
Usage Usage.. _layouts.documentation_v2 content

Usage

This chapter describes usage of the package. That includes creating tenants, deleting tenants, storing data in the tenant storage.

This package comes with two helpers - tenancy() and tenant(). tenancy() returns an instance of TenantManager and should be primarily used only for tenancy()->all(), but for legacy reasons it can be used to create tenants.

You can pass an argument to the helper function to get a value out of the tenant storage. tenant('plan') is identical to [tenant()->get('plan')]({{ $page->link('tenant-storage') }}).

The package also comes with two facades. Tenancy -- for TenantManager -- and Tenant -- for the current Tenant, or null if no tenant has been identified yet.