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.

getTenantKey()

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

getInternal(string $key)

Get the value of an internal key.

setInternal(string $key, $value)

Set the value of an internal key.

run(callable $callback)

Run a callback in this tenant's environment.

void
__call(string $method, array $parameters)

IDE support. This will be a model.

static void
__callStatic(string $method, array $parameters)

IDE support. This will be a model.

Details

at line 17
string getTenantKeyName()

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

Return Value

string

at line 20
getTenantKey()

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

at line 23
getInternal(string $key)

Get the value of an internal key.

Parameters

string $key

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

Set the value of an internal key.

Parameters

string $key
$value

at line 29
run(callable $callback)

Run a callback in this tenant's environment.

Parameters

callable $callback

at line 14
void __call(string $method, array $parameters)

IDE support. This will be a model.

Parameters

string $method
array $parameters

Return Value

void

at line 14
static void __callStatic(string $method, array $parameters)

IDE support. This will be a model.

Parameters

string $method
array $parameters

Return Value

void