1. interface
  2. Stancl
  3. \
  4. Tenancy
  5. \
  6. Contracts
  7. \
  8. Tenant

Tenant

interface Tenant mixin Model (View source)

Methods

string
getTenantKeyName()

Get the name of the key used for identifying the tenant.

int|string
getTenantKey()

Get the value of the key used for identifying the tenant.

mixed
getInternal(string $key)

Get the value of an internal key.

Tenant
setInternal(string $key, mixed $value)

Set the value of an internal key.

mixed
run(Closure $callback)

Run a callback in this tenant's environment.

Details

at line 17
string getTenantKeyName()

Get the name of the key used for identifying the tenant.

Return Value

string

at line 20
int|string getTenantKey()

Get the value of the key used for identifying the tenant.

Return Value

int|string

at line 23
mixed getInternal(string $key)

Get the value of an internal key.

Parameters

string $key

Return Value

mixed

at line 26
Tenant setInternal(string $key, mixed $value)

Set the value of an internal key.

Parameters

string $key
mixed $value

Return Value

Tenant

at line 29
mixed run(Closure $callback)

Run a callback in this tenant's environment.

Parameters

Closure $callback

Return Value

mixed