You're looking at v1 documentation. The current version is v3. You can find the docs for the current version here.

Usage

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

Most pages will use the tenancy() helper function. This package comes with two helpers - tenancy() and tenant(). They do the same thing, so you can use the one that reads better given its context.

tenant()->create() reads better than tenancy()->create(), but tenancy()->init() reads better than tenant()->init().

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').

The package also comes with two facades. Tenancy and Tenant. Use what feels the best.

Both the helpers and the facades resolve the TenantManager from the service container.