interface StorageDriver (View source)

Methods

void
createTenant(Tenant $tenant)

No description

void
updateTenant(Tenant $tenant)

No description

void
deleteTenant(Tenant $tenant)

No description

findById(string $id)

Find a tenant using an id.

findByDomain(string $domain)

Find a tenant using a domain name.

array
all(array $ids = [])

Get all tenants.

void
ensureTenantCanBeCreated(Tenant $tenant)

Ensure a tenant can be created.

withDefaultTenant(Tenant $tenant)

Set default tenant (will be used for get/put when no tenant is supplied).

mixed
get(string $key, Tenant $tenant = null)

Get a value from storage.

void
getMany(array $keys, Tenant $tenant = null)

Get multiple values from storage.

void
put(string $key, mixed $value, Tenant $tenant = null)

Put a value into storage.

void
putMany(array $kvPairs, Tenant $tenant = null)

Put multiple values into storage.

Details

void createTenant(Tenant $tenant)

No description

Parameters

Tenant $tenant

Return Value

void

void updateTenant(Tenant $tenant)

No description

Parameters

Tenant $tenant

Return Value

void

void deleteTenant(Tenant $tenant)

No description

Parameters

Tenant $tenant

Return Value

void

Tenant findById(string $id)

Find a tenant using an id.

Parameters

string $id

Return Value

Tenant

Exceptions

TenantCouldNotBeIdentifiedException

Tenant findByDomain(string $domain)

Find a tenant using a domain name.

Parameters

string $domain

Return Value

Tenant

array all(array $ids = [])

Get all tenants.

Parameters

array $ids

Return Value

array

void ensureTenantCanBeCreated(Tenant $tenant)

Ensure a tenant can be created.

Parameters

Tenant $tenant

Return Value

void

Exceptions

TenantCannotBeCreatedException

StorageDriver withDefaultTenant(Tenant $tenant)

Set default tenant (will be used for get/put when no tenant is supplied).

Parameters

Tenant $tenant

Return Value

StorageDriver

mixed get(string $key, Tenant $tenant = null)

Get a value from storage.

Parameters

string $key
Tenant $tenant

Return Value

mixed

void getMany(array $keys, Tenant $tenant = null)

Get multiple values from storage.

Parameters

array $keys
Tenant $tenant

Return Value

void

void put(string $key, mixed $value, Tenant $tenant = null)

Put a value into storage.

Parameters

string $key
mixed $value
Tenant $tenant

Return Value

void

void putMany(array $kvPairs, Tenant $tenant = null)

Put multiple values into storage.

Parameters

array $kvPairs
Tenant $tenant

Return Value

void