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/source/docs/v2/usage.blade.md
Samuel Štancl f8f354c323 3.x redesign
2020-06-08 21:20:15 +02:00

798 B
Raw Blame History

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

Usage

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

The package comes with two helpers - tenancy() and tenant().

  • tenancy() returns an instance of [TenantManager]({{ $page->link('tenant-manager') }})
  • tenant() returns an instance of the current tenant, or null if no tenant hs been identified yet. You can pass an argument to this helper, to get a value from 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.