1. interface
  2. Stancl
  3. \
  4. Tenancy
  5. \
  6. Database
  7. \
  8. Contracts
  9. \
  10. TenantWithDatabase

TenantWithDatabase

interface TenantWithDatabase implements Tenant (View source)

Methods

string
getTenantKeyName()

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

from  Tenant
int|string
getTenantKey()

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

from  Tenant
mixed
getInternal(string $key)

Get an internal key.

Tenant
setInternal(string $key, mixed $value)

Set internal key.

mixed
run(Closure $callback)

Run a callback in this tenant's environment.

from  Tenant
DatabaseConfig
database()

Get the tenant's database config.

static string
internalPrefix()

Get the internal prefix.

Details

in Tenant at line 17
string getTenantKeyName()

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

Return Value

string

in Tenant at line 20
int|string getTenantKey()

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

Return Value

int|string

at line 19
mixed getInternal(string $key)

Get an internal key.

Parameters

string $key

Return Value

mixed

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

Set internal key.

Parameters

string $key
mixed $value

Return Value

Tenant

in Tenant at line 29
mixed run(Closure $callback)

Run a callback in this tenant's environment.

Parameters

Closure $callback

Return Value

mixed

at line 13
DatabaseConfig database()

Get the tenant's database config.

Return Value

DatabaseConfig

at line 16
static string internalPrefix()

Get the internal prefix.

Return Value

string