Index

A

StorageDriver::all() — Method in class StorageDriver

Get all tenants.

TenantAssetsController::asset() — Method in class TenantAssetsController
$ DatabaseManager#app — Property in class DatabaseManager
$ DatabaseStorageDriver#app — Property in class DatabaseStorageDriver
DatabaseStorageDriver::all() — Method in class DatabaseStorageDriver

Get all tenants.

TenantRepository::all() — Method in class TenantRepository
$ RedisStorageDriver#app — Property in class RedisStorageDriver
RedisStorageDriver::all() — Method in class RedisStorageDriver

Return a list of all tenants.

$ CacheTenancyBootstrapper#app — Property in class CacheTenancyBootstrapper
$ FilesystemTenancyBootstrapper#app — Property in class FilesystemTenancyBootstrapper
Tenant::addDomains() — Method in class Tenant

Assign domains to the tenant.

$ TenantManager#app — Property in class TenantManager
$ TenantManager#artisan — Property in class TenantManager
TenantManager::all() — Method in class TenantManager

Get all tenants.

B

Feature::bootstrap() — Method in class Feature
TelescopeTags::bootstrap() — Method in class TelescopeTags
TenantConfig::bootstrap() — Method in class TenantConfig
TenantRedirect::bootstrap() — Method in class TenantRedirect
Timestamps::bootstrap() — Method in class Timestamps
TenancyServiceProvider::boot() — Method in class TenancyServiceProvider

Bootstrap services.

TenantManager::bootstrapTenancy() — Method in class TenantManager

Execute TenancyBootstrappers.

TenantManager::bootstrapFeatures() — Method in class TenantManager

C

CacheManager — Class in namespace Stancl\Tenancy
CreateTenant — Class in namespace Stancl\Tenancy\Commands
CanDeleteKeys — Class in namespace Stancl\Tenancy\Contracts\Future

This interface will be part of the StorageDriver interface in 3.x.

CanFindByAnyKey — Class in namespace Stancl\Tenancy\Contracts\Future

This interface might be part of the StorageDriver interface in 3.x.

CanSetConnection — Class in namespace Stancl\Tenancy\Contracts\Future

This interface might be part of the TenantDatabaseManager interface in 3.x.

StorageDriver::createTenant() — Method in class StorageDriver
TenantDatabaseManager::createDatabase() — Method in class TenantDatabaseManager

Create a database.

DatabaseManager::connect() — Method in class DatabaseManager

Connect to a tenant's database.

DatabaseManager::createTenantConnection() — Method in class DatabaseManager

Create the tenant database connection.

DatabaseManager::createDatabase() — Method in class DatabaseManager

Create a database for a tenant.

TenantFacade::create() — Method in class TenantFacade
$ TelescopeTags#callback — Property in class TelescopeTags
$ TenantConfig#config — Property in class TenantConfig
$ Timestamps#config — Property in class Timestamps
$ PreventAccessFromTenantDomains#central404 — Property in class PreventAccessFromTenantDomains
CachedTenantResolver — Class in namespace Stancl\Tenancy\StorageDrivers\Database
$ CachedTenantResolver#cache — Property in class CachedTenantResolver
$ CachedTenantResolver#config — Property in class CachedTenantResolver
CentralConnection — Class in namespace Stancl\Tenancy\StorageDrivers\Database
$ DatabaseStorageDriver#centralDatabase — Property in class DatabaseStorageDriver
$ DatabaseStorageDriver#cache — Property in class DatabaseStorageDriver
DatabaseStorageDriver::createTenant() — Method in class DatabaseStorageDriver
DatabaseStorageDriver::currentTenant() — Method in class DatabaseStorageDriver

Get the current tenant.

TenantRepository::customColumns() — Method in class TenantRepository
RedisStorageDriver::createTenant() — Method in class RedisStorageDriver
CacheTenancyBootstrapper — Class in namespace Stancl\Tenancy\TenancyBootstrappers
$ QueueTenancyBootstrapper#config — Property in class QueueTenancyBootstrapper
$ RedisTenancyBootstrapper#config — Property in class RedisTenancyBootstrapper
$ Tenant#config — Property in class Tenant
Tenant::create() — Method in class Tenant

Create a tenant in a single call.

Tenant::clearDomains() — Method in class Tenant

Unassign all domains from the tenant.

$ MySQLDatabaseManager#connection — Property in class MySQLDatabaseManager
MySQLDatabaseManager::createDatabase() — Method in class MySQLDatabaseManager

Create a database.

$ PostgreSQLDatabaseManager#connection — Property in class PostgreSQLDatabaseManager
PostgreSQLDatabaseManager::createDatabase() — Method in class PostgreSQLDatabaseManager

Create a database.

$ PostgreSQLSchemaManager#connection — Property in class PostgreSQLSchemaManager
PostgreSQLSchemaManager::createDatabase() — Method in class PostgreSQLSchemaManager

Create a database.

SQLiteDatabaseManager::createDatabase() — Method in class SQLiteDatabaseManager

Create a database.

TenantManager::createTenant() — Method in class TenantManager

Write a new tenant to storage.

TenantManager::create() — Method in class TenantManager

Alias for Stancl\Tenancy\Tenant::create.

D

$ CreateTenant#description — Property in class CreateTenant
$ Install#description — Property in class Install

The console command description.

$ Migrate#database — Property in class Migrate
$ Migrate#description — Property in class Migrate

The console command description.

$ MigrateFresh#description — Property in class MigrateFresh

The console command description.

$ Rollback#database — Property in class Rollback
$ Rollback#description — Property in class Rollback

The console command description.

$ Run#description — Property in class Run

The console command description.

$ Seed#database — Property in class Seed
$ Seed#description — Property in class Seed

The console command description.

$ TenantList#description — Property in class TenantList

The console command description.

CanDeleteKeys::deleteMany() — Method in class CanDeleteKeys

Delete keys from the storage.

StorageDriver::deleteTenant() — Method in class StorageDriver
TenantDatabaseManager::deleteDatabase() — Method in class TenantDatabaseManager

Delete a database.

TenantDatabaseManager::databaseExists() — Method in class TenantDatabaseManager

Does a database exist.

DatabaseManager — Class in namespace Stancl\Tenancy
$ DatabaseManager#database — Property in class DatabaseManager
DatabaseManager::deleteDatabase() — Method in class DatabaseManager

Delete a tenant's database.

DatabaseManagerNotRegisteredException — Class in namespace Stancl\Tenancy\Exceptions
DomainsOccupiedByOtherTenantException — Class in namespace Stancl\Tenancy\Exceptions
$ TenantDatabaseAlreadyExistsException#database — Property in class TenantDatabaseAlreadyExistsException
$ QueuedTenantDatabaseCreator#databaseManager — Property in class QueuedTenantDatabaseCreator
$ QueuedTenantDatabaseCreator#databaseName — Property in class QueuedTenantDatabaseCreator
$ QueuedTenantDatabaseDeleter#databaseManager — Property in class QueuedTenantDatabaseDeleter
$ QueuedTenantDatabaseDeleter#databaseName — Property in class QueuedTenantDatabaseDeleter
DatabaseStorageDriver — Class in namespace Stancl\Tenancy\StorageDrivers\Database
$ DatabaseStorageDriver#domains — Property in class DatabaseStorageDriver
DatabaseStorageDriver::deleteTenant() — Method in class DatabaseStorageDriver
DatabaseStorageDriver::deleteMany() — Method in class DatabaseStorageDriver

Delete keys from the storage.

DomainRepository — Class in namespace Stancl\Tenancy\StorageDrivers\Database
$ Repository#database — Property in class Repository
TenantRepository::deleteMany() — Method in class TenantRepository
TenantRepository::decodeFreshDataForTenant() — Method in class TenantRepository
TenantRepository::decodeData() — Method in class TenantRepository
TenantRepository::dataColumn() — Method in class TenantRepository
RedisStorageDriver::deleteTenant() — Method in class RedisStorageDriver
RedisStorageDriver::deleteMany() — Method in class RedisStorageDriver

Delete keys from the storage.

DatabaseTenancyBootstrapper — Class in namespace Stancl\Tenancy\TenancyBootstrappers
$ DatabaseTenancyBootstrapper#database — Property in class DatabaseTenancyBootstrapper
$ Tenant#data — Property in class Tenant

Tenant data. A "cache" of tenant storage.

$ Tenant#domains — Property in class Tenant

List of domains that belong to the tenant.

Tenant::delete() — Method in class Tenant

Delete a tenant from storage.

Tenant::deleteKey() — Method in class Tenant

Delete a key from the tenant's storage.

Tenant::deleteKeys() — Method in class Tenant

Delete keys from the tenant's storage.

MySQLDatabaseManager::database() — Method in class MySQLDatabaseManager
MySQLDatabaseManager::deleteDatabase() — Method in class MySQLDatabaseManager

Delete a database.

MySQLDatabaseManager::databaseExists() — Method in class MySQLDatabaseManager

Does a database exist.

PostgreSQLDatabaseManager::database() — Method in class PostgreSQLDatabaseManager
PostgreSQLDatabaseManager::deleteDatabase() — Method in class PostgreSQLDatabaseManager

Delete a database.

PostgreSQLDatabaseManager::databaseExists() — Method in class PostgreSQLDatabaseManager

Does a database exist.

PostgreSQLSchemaManager::database() — Method in class PostgreSQLSchemaManager
PostgreSQLSchemaManager::deleteDatabase() — Method in class PostgreSQLSchemaManager

Delete a database.

PostgreSQLSchemaManager::databaseExists() — Method in class PostgreSQLSchemaManager

Does a database exist.

SQLiteDatabaseManager::deleteDatabase() — Method in class SQLiteDatabaseManager

Delete a database.

SQLiteDatabaseManager::databaseExists() — Method in class SQLiteDatabaseManager

Does a database exist.

$ TenantManager#database — Property in class TenantManager
TenantManager::deleteTenant() — Method in class TenantManager

Delete a tenant from storage.

TenantManager::databaseCreationQueued() — Method in class TenantManager
DealsWithMigrations — Class in namespace Stancl\Tenancy\Traits

E

StorageDriver::ensureTenantCanBeCreated() — Method in class StorageDriver

Ensure a tenant can be created.

TenancyBootstrapper::end() — Method in class TenancyBootstrapper
DatabaseManager::ensureTenantCanBeCreated() — Method in class DatabaseManager

Check if a tenant can be created.

DatabaseStorageDriver::ensureTenantCanBeCreated() — Method in class DatabaseStorageDriver

Ensure a tenant can be created.

TenantRepository::exists() — Method in class TenantRepository
TenantRepository::encodeData() — Method in class TenantRepository
RedisStorageDriver::ensureTenantCanBeCreated() — Method in class RedisStorageDriver

Ensure a tenant can be created.

CacheTenancyBootstrapper::end() — Method in class CacheTenancyBootstrapper
DatabaseTenancyBootstrapper::end() — Method in class DatabaseTenancyBootstrapper
FilesystemTenancyBootstrapper::end() — Method in class FilesystemTenancyBootstrapper
QueueTenancyBootstrapper::end() — Method in class QueueTenancyBootstrapper
RedisTenancyBootstrapper::end() — Method in class RedisTenancyBootstrapper
$ TenantManager#eventListeners — Property in class TenantManager
TenantManager::ensureTenantCanBeCreated() — Method in class TenantManager

Ensure that a tenant can be created.

TenantManager::endTenancy() — Method in class TenantManager
TenantManager::end() — Method in class TenantManager
TenantManager::eventListener() — Method in class TenantManager

Add an event listener.

TenantManager::event() — Method in class TenantManager

Trigger an event and execute its listeners.

TenantAwareCommand::execute() — Method in class TenantAwareCommand

F

Feature — Class in namespace Stancl\Tenancy\Contracts

Additional features, like Telescope tags and tenant redirects.

CanFindByAnyKey::findBy() — Method in class CanFindByAnyKey

Find a tenant using an arbitrary key.

StorageDriver::findById() — Method in class StorageDriver

Find a tenant using an id.

StorageDriver::findByDomain() — Method in class StorageDriver

Find a tenant using a domain name.

DatabaseStorageDriver::findByDomain() — Method in class DatabaseStorageDriver

Find a tenant using a domain name.

DatabaseStorageDriver::findById() — Method in class DatabaseStorageDriver

Find a tenant using an id.

DatabaseStorageDriver::findBy() — Method in class DatabaseStorageDriver

Find a tenant using an arbitrary key.

TenantRepository::find() — Method in class TenantRepository
TenantRepository::findBy() — Method in class TenantRepository
RedisStorageDriver::findByDomain() — Method in class RedisStorageDriver

Find a tenant using a domain name.

RedisStorageDriver::findById() — Method in class RedisStorageDriver

Find a tenant using an id.

FilesystemTenancyBootstrapper — Class in namespace Stancl\Tenancy\TenancyBootstrappers
Tenant::fromStorage() — Method in class Tenant

DO NOT CALL THIS METHOD FROM USERLAND. Used by storage drivers to create persisted instances of Tenant.

TenantManager::find() — Method in class TenantManager

Find a tenant using an id.

TenantManager::findByDomain() — Method in class TenantManager

Find a tenant using a domain name.

TenantManager::findBy() — Method in class TenantManager

Find a tenant using an arbitrary key.

G

CreateTenant::getDomains() — Method in class CreateTenant
CreateTenant::getData() — Method in class CreateTenant
StorageDriver::get() — Method in class StorageDriver

Get a value from storage.

StorageDriver::getMany() — Method in class StorageDriver

Get multiple values from storage.

UniqueIdentifierGenerator::generate() — Method in class UniqueIdentifierGenerator

Generate a unique identifier.

DatabaseManager::getBaseConnection() — Method in class DatabaseManager

Get the name of the connection that $connectionName should be based on.

DatabaseManager::getDriver() — Method in class DatabaseManager

Get the driver of a database connection.

DatabaseManager::getTenantDatabaseManager() — Method in class DatabaseManager

Get the TenantDatabaseManager for a tenant's database connection.

TenantCouldNotBeIdentifiedException::getSolution() — Method in class TenantCouldNotBeIdentifiedException
GlobalCacheFacade — Class in namespace Stancl\Tenancy\Facades
GlobalCacheFacade::getFacadeAccessor() — Method in class GlobalCacheFacade
TenancyFacade::getFacadeAccessor() — Method in class TenancyFacade
TenantFacade::getFacadeAccessor() — Method in class TenantFacade
TelescopeTags::getTags() — Method in class TelescopeTags
TenantConfig::getStorageToConfigMap() — Method in class TenantConfig
CachedTenantResolver::getTenantIdByDomain() — Method in class CachedTenantResolver
CachedTenantResolver::getDataById() — Method in class CachedTenantResolver
CachedTenantResolver::getDomainsById() — Method in class CachedTenantResolver
CentralConnection::getConnectionName() — Method in class CentralConnection
DatabaseStorageDriver::getCentralConnection() — Method in class DatabaseStorageDriver

Get the central database connection.

DatabaseStorageDriver::getCentralConnectionName() — Method in class DatabaseStorageDriver
DatabaseStorageDriver::get() — Method in class DatabaseStorageDriver

Get a value from storage.

DatabaseStorageDriver::getMany() — Method in class DatabaseStorageDriver

Get multiple values from storage.

DomainRepository::getTenantIdByDomain() — Method in class DomainRepository
DomainRepository::getTenantDomains() — Method in class DomainRepository
DomainRepository::getTable() — Method in class DomainRepository
Repository::getTable() — Method in class Repository
TenantRepository::get() — Method in class TenantRepository
TenantRepository::getMany() — Method in class TenantRepository
TenantRepository::getTable() — Method in class TenantRepository
RedisStorageDriver::getTenantIdByDomain() — Method in class RedisStorageDriver
RedisStorageDriver::get() — Method in class RedisStorageDriver

Get a value from storage.

RedisStorageDriver::getMany() — Method in class RedisStorageDriver

Get multiple values from storage.

QueueTenancyBootstrapper::getPayload() — Method in class QueueTenancyBootstrapper
Tenant::generateId() — Method in class Tenant

Generate a random ID.

Tenant::getDatabaseName() — Method in class Tenant

Get the tenant's database's name.

Tenant::getConnectionName() — Method in class Tenant

Get the tenant's database connection's name.

Tenant::get() — Method in class Tenant

Get a value from tenant storage.

TenantManager::getTenant() — Method in class TenantManager

Get the current tenant.

TenantManager::getSeederParameters() — Method in class TenantManager
TenantManager::getMigrationParameters() — Method in class TenantManager
DealsWithMigrations::getMigrationPaths() — Method in class DealsWithMigrations
HasATenantArgument::getArguments() — Method in class HasATenantArgument
HasATenantArgument::getTenants() — Method in class HasATenantArgument
HasATenantsOption::getOptions() — Method in class HasATenantsOption
HasATenantsOption::getTenants() — Method in class HasATenantsOption
TenantAwareCommand::getTenants() — Method in class TenantAwareCommand

Get an array of tenants for which the command should be executed.

UUIDGenerator::generate() — Method in class UUIDGenerator

Generate a unique identifier.

H

CreateTenant::handle() — Method in class CreateTenant

Execute the console command.

Install::handle() — Method in class Install

Execute the console command.

Migrate::handle() — Method in class Migrate

Execute the console command.

MigrateFresh::handle() — Method in class MigrateFresh

Execute the console command.

Rollback::handle() — Method in class Rollback

Execute the console command.

Run::handle() — Method in class Run

Execute the console command.

Seed::handle() — Method in class Seed

Execute the console command.

TenantList::handle() — Method in class TenantList

Execute the console command.

QueuedTenantDatabaseCreator::handle() — Method in class QueuedTenantDatabaseCreator

Execute the job.

QueuedTenantDatabaseDeleter::handle() — Method in class QueuedTenantDatabaseDeleter

Execute the job.

QueuedTenantDatabaseMigrator::handle() — Method in class QueuedTenantDatabaseMigrator

Execute the job.

QueuedTenantDatabaseSeeder::handle() — Method in class QueuedTenantDatabaseSeeder

Execute the job.

InitializeTenancy::handle() — Method in class InitializeTenancy

Handle an incoming request.

$ InitializeTenancyByRequestData#header — Property in class InitializeTenancyByRequestData
InitializeTenancyByRequestData::handle() — Method in class InitializeTenancyByRequestData

Handle an incoming request.

PreventAccessFromTenantDomains::handle() — Method in class PreventAccessFromTenantDomains

Handle an incoming request.

TenantManager::hook() — Method in class TenantManager

Add an event hook.

HasATenantArgument — Class in namespace Stancl\Tenancy\Traits
HasATenantsOption — Class in namespace Stancl\Tenancy\Traits
HasArrayAccess — Class in namespace Stancl\Tenancy\Traits

I

Install — Class in namespace Stancl\Tenancy\Commands
$ TenantWithThisIdAlreadyExistsException#id — Property in class TenantWithThisIdAlreadyExistsException
InitializeTenancy — Class in namespace Stancl\Tenancy\Middleware
InitializeTenancyByRequestData — Class in namespace Stancl\Tenancy\Middleware
InitializeTenancyByRequestData::initializeTenancy() — Method in class InitializeTenancyByRequestData
CachedTenantResolver::invalidateTenant() — Method in class CachedTenantResolver
CachedTenantResolver::invalidateTenantData() — Method in class CachedTenantResolver
CachedTenantResolver::invalidateTenantDomains() — Method in class CachedTenantResolver
CachedTenantResolver::invalidateDomainToIdMapping() — Method in class CachedTenantResolver
DomainRepository::insertTenantDomains() — Method in class DomainRepository
TenantRepository::insert() — Method in class TenantRepository
$ Tenant#idGenerator — Property in class Tenant
Tenant::isPersisted() — Method in class Tenant

Does this model exist in the tenant storage.

$ TenantManager#initialized — Property in class TenantManager
TenantManager::init() — Method in class TenantManager

Find tenant by domain & initialize tenancy.

TenantManager::initById() — Method in class TenantManager

Find tenant by ID & initialize tenancy.

TenantManager::initializeTenancy() — Method in class TenantManager

Initialize tenancy.

TenantManager::initialize() — Method in class TenantManager

M

Migrate — Class in namespace Stancl\Tenancy\Commands
MigrateFresh — Class in namespace Stancl\Tenancy\Commands
$ TenantCannotBeCreatedException#message — Property in class TenantCannotBeCreatedException
$ QueuedTenantDatabaseMigrator#migrationParameters — Property in class QueuedTenantDatabaseMigrator
RedisStorageDriver::makeTenant() — Method in class RedisStorageDriver

Make a Tenant instance from low-level array data.

$ Tenant#manager — Property in class Tenant
MySQLDatabaseManager — Class in namespace Stancl\Tenancy\TenantDatabaseManagers
TenantRouteServiceProvider::map() — Method in class TenantRouteServiceProvider

N

NotImplementedException — Class in namespace Stancl\Tenancy\Exceptions
Timestamps::now() — Method in class Timestamps
Tenant::new() — Method in class Tenant

Public constructor.

O

$ DatabaseManager#originalDefaultConnectionName — Property in class DatabaseManager
$ TenantConfig#originalConfig — Property in class TenantConfig
$ InitializeTenancy#onFail — Property in class InitializeTenancy
$ InitializeTenancyByRequestData#onFail — Property in class InitializeTenancyByRequestData
DomainRepository::occupied() — Method in class DomainRepository
$ CacheTenancyBootstrapper#originalCache — Property in class CacheTenancyBootstrapper
$ FilesystemTenancyBootstrapper#originalPaths — Property in class FilesystemTenancyBootstrapper
$ RedisTenancyBootstrapper#originalPrefixes — Property in class RedisTenancyBootstrapper
HasArrayAccess::offsetExists() — Method in class HasArrayAccess
HasArrayAccess::offsetGet() — Method in class HasArrayAccess
HasArrayAccess::offsetSet() — Method in class HasArrayAccess
HasArrayAccess::offsetUnset() — Method in class HasArrayAccess

P

StorageDriver::put() — Method in class StorageDriver

Put a value into storage.

StorageDriver::putMany() — Method in class StorageDriver

Put multiple values into storage.

PreventAccessFromTenantDomains — Class in namespace Stancl\Tenancy\Middleware

Prevent access from tenant domains to central routes and vice versa.

DatabaseStorageDriver::put() — Method in class DatabaseStorageDriver

Put a value into storage.

DatabaseStorageDriver::putMany() — Method in class DatabaseStorageDriver

Put multiple values into storage.

TenantRepository::put() — Method in class TenantRepository
TenantRepository::putMany() — Method in class TenantRepository
RedisStorageDriver::put() — Method in class RedisStorageDriver

Put a value into storage.

RedisStorageDriver::putMany() — Method in class RedisStorageDriver

Put multiple values into storage.

RedisTenancyBootstrapper::prefixedConnections() — Method in class RedisTenancyBootstrapper
$ Tenant#persisted — Property in class Tenant

Does this tenant exist in the storage.

Tenant::persisted() — Method in class Tenant

DO NOT CALL THIS METHOD FROM USERLAND UNLESS YOU KNOW WHAT YOU ARE DOING.

Tenant::put() — Method in class Tenant

Set a value and write to storage.

PostgreSQLDatabaseManager — Class in namespace Stancl\Tenancy\TenantDatabaseManagers
PostgreSQLSchemaManager — Class in namespace Stancl\Tenancy\TenantDatabaseManagers

Q

QueuedTenantDatabaseCreator — Class in namespace Stancl\Tenancy\Jobs
QueuedTenantDatabaseDeleter — Class in namespace Stancl\Tenancy\Jobs
QueuedTenantDatabaseMigrator — Class in namespace Stancl\Tenancy\Jobs
QueuedTenantDatabaseSeeder — Class in namespace Stancl\Tenancy\Jobs
$ InitializeTenancyByRequestData#queryParameter — Property in class InitializeTenancyByRequestData
QueueTenancyBootstrapper — Class in namespace Stancl\Tenancy\TenancyBootstrappers

R

Rollback — Class in namespace Stancl\Tenancy\Commands
Run — Class in namespace Stancl\Tenancy\Commands
TenantCannotBeCreatedException::reason() — Method in class TenantCannotBeCreatedException
DatabaseManager::reconnect() — Method in class DatabaseManager

Reconnect to the default non-tenant connection.

DomainsOccupiedByOtherTenantException::reason() — Method in class DomainsOccupiedByOtherTenantException
TenantDatabaseAlreadyExistsException::reason() — Method in class TenantDatabaseAlreadyExistsException
TenantWithThisIdAlreadyExistsException::reason() — Method in class TenantWithThisIdAlreadyExistsException
PreventAccessFromTenantDomains::routeHasMiddleware() — Method in class PreventAccessFromTenantDomains
Repository — Class in namespace Stancl\Tenancy\StorageDrivers\Database
RedisStorageDriver — Class in namespace Stancl\Tenancy\StorageDrivers
$ RedisStorageDriver#redis — Property in class RedisStorageDriver
RedisTenancyBootstrapper — Class in namespace Stancl\Tenancy\TenancyBootstrappers
TenancyServiceProvider::register() — Method in class TenancyServiceProvider

Register services.

Tenant::removeDomains() — Method in class Tenant

Unassign domains from the tenant.

Tenant::run() — Method in class Tenant

Run a closure inside the tenant's environment.

S

$ CreateTenant#signature — Property in class CreateTenant
$ Install#signature — Property in class Install

The name and signature of the console command.

Install::setMiddlewarePriority() — Method in class Install
$ Run#signature — Property in class Run

The name and signature of the console command.

Seed — Class in namespace Stancl\Tenancy\Commands
$ TenantList#signature — Property in class TenantList

The name and signature of the console command.

CanSetConnection::setConnection() — Method in class CanSetConnection
StorageDriver — Class in namespace Stancl\Tenancy\Contracts
TenancyBootstrapper::start() — Method in class TenancyBootstrapper
DatabaseManager::setDefaultConnection() — Method in class DatabaseManager

Change the default database connection config.

DatabaseManager::switchConnection() — Method in class DatabaseManager

Switch the application's connection.

DatabaseManager::separateBy() — Method in class DatabaseManager

What key on the connection config should be used to separate tenants.

TelescopeTags::setCallback() — Method in class TelescopeTags
TenantConfig::setTenantConfig() — Method in class TenantConfig
CacheTenancyBootstrapper::start() — Method in class CacheTenancyBootstrapper
DatabaseTenancyBootstrapper::start() — Method in class DatabaseTenancyBootstrapper
FilesystemTenancyBootstrapper::start() — Method in class FilesystemTenancyBootstrapper
$ QueueTenancyBootstrapper#started — Property in class QueueTenancyBootstrapper
QueueTenancyBootstrapper::start() — Method in class QueueTenancyBootstrapper
RedisTenancyBootstrapper::start() — Method in class RedisTenancyBootstrapper
$ Tenant#storage — Property in class Tenant
Tenant::save() — Method in class Tenant

Write the tenant's state to storage.

Tenant::softDelete() — Method in class Tenant

Unassign all domains from the tenant and write to storage.

Tenant::set() — Method in class Tenant
MySQLDatabaseManager::setConnection() — Method in class MySQLDatabaseManager
PostgreSQLDatabaseManager::setConnection() — Method in class PostgreSQLDatabaseManager
PostgreSQLSchemaManager::setConnection() — Method in class PostgreSQLSchemaManager
SQLiteDatabaseManager — Class in namespace Stancl\Tenancy\TenantDatabaseManagers
$ TenantManager#storage — Property in class TenantManager
TenantManager::setTenant() — Method in class TenantManager
TenantManager::shouldCreateDatabase() — Method in class TenantManager
TenantManager::shouldMigrateAfterCreation() — Method in class TenantManager
TenantManager::shouldSeedAfterMigration() — Method in class TenantManager
TenantManager::shouldDeleteDatabase() — Method in class TenantManager

T

TenantList — Class in namespace Stancl\Tenancy\Commands
TenancyBootstrapper — Class in namespace Stancl\Tenancy\Contracts

TenancyBootstrappers are classes that make existing code tenant-aware.

TenantCannotBeCreatedException — Class in namespace Stancl\Tenancy\Contracts
TenantDatabaseManager — Class in namespace Stancl\Tenancy\Contracts
TenantAssetsController — Class in namespace Stancl\Tenancy\Controllers
$ DatabaseManager#tenancy — Property in class DatabaseManager
TenantCouldNotBeIdentifiedException — Class in namespace Stancl\Tenancy\Exceptions
TenantDatabaseAlreadyExistsException — Class in namespace Stancl\Tenancy\Exceptions
TenantDatabaseDoesNotExistException — Class in namespace Stancl\Tenancy\Exceptions
TenantDoesNotExistException — Class in namespace Stancl\Tenancy\Exceptions
TenantStorageException — Class in namespace Stancl\Tenancy\Exceptions
TenantWithThisIdAlreadyExistsException — Class in namespace Stancl\Tenancy\Exceptions
TenancyFacade — Class in namespace Stancl\Tenancy\Facades
TenantFacade — Class in namespace Stancl\Tenancy\Facades
TelescopeTags — Class in namespace Stancl\Tenancy\Features
TenantConfig — Class in namespace Stancl\Tenancy\Features
TenantRedirect — Class in namespace Stancl\Tenancy\Features
Timestamps — Class in namespace Stancl\Tenancy\Features
$ QueuedTenantDatabaseMigrator#tenantId — Property in class QueuedTenantDatabaseMigrator
$ QueuedTenantDatabaseSeeder#tenantId — Property in class QueuedTenantDatabaseSeeder
CachedTenantResolver::ttl() — Method in class CachedTenantResolver
$ DatabaseStorageDriver#tenants — Property in class DatabaseStorageDriver
$ DatabaseStorageDriver#tenant — Property in class DatabaseStorageDriver
$ Repository#tableName — Property in class Repository
Repository::table() — Method in class Repository
TenantRepository — Class in namespace Stancl\Tenancy\StorageDrivers\Database
$ RedisStorageDriver#tenant — Property in class RedisStorageDriver
RedisStorageDriver::tenant() — Method in class RedisStorageDriver

Get the current tenant.

TenancyServiceProvider — Class in namespace Stancl\Tenancy
Tenant — Class in namespace Stancl\Tenancy
TenantManager — Class in namespace Stancl\Tenancy
$ TenantManager#tenant — Property in class TenantManager
TenantManager::tenancyBootstrappers() — Method in class TenantManager

Return a list of TenancyBootstrappers.

TenantRouteServiceProvider — Class in namespace Stancl\Tenancy
TenantAwareCommand — Class in namespace Stancl\Tenancy\Traits

U

StorageDriver::updateTenant() — Method in class StorageDriver
UniqueIdentifierGenerator — Class in namespace Stancl\Tenancy\Contracts
TenantConfig::unsetTenantConfig() — Method in class TenantConfig
DatabaseStorageDriver::updateTenant() — Method in class DatabaseStorageDriver
DatabaseStorageDriver::usesCache() — Method in class DatabaseStorageDriver
DomainRepository::updateTenantDomains() — Method in class DomainRepository
TenantRepository::updateTenant() — Method in class TenantRepository
RedisStorageDriver::updateTenant() — Method in class RedisStorageDriver
TenantManager::updateTenant() — Method in class TenantManager

Update an existing tenant in storage.

UUIDGenerator — Class in namespace Stancl\Tenancy\UniqueIDGenerators

W

StorageDriver::withDefaultTenant() — Method in class StorageDriver

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

DatabaseManager::withTenantManager() — Method in class DatabaseManager

Set the TenantManager instance, used to dispatch tenancy events.

DatabaseStorageDriver::withDefaultTenant() — Method in class DatabaseStorageDriver

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

RedisStorageDriver::withDefaultTenant() — Method in class RedisStorageDriver

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

Tenant::withDomains() — Method in class Tenant

Set (overwrite) the tenant's domains.

Tenant::withData() — Method in class Tenant

Set (overwrite) tenant data.

Tenant::with() — Method in class Tenant

Set a value in the data array without saving into storage.

_

CacheManager::__call() — Method in class CacheManager

Add tags and forward the call to the inner cache store.

Migrate::__construct() — Method in class Migrate

Create a new command instance.

MigrateFresh::__construct() — Method in class MigrateFresh
Rollback::__construct() — Method in class Rollback

Create a new command instance.

Seed::__construct() — Method in class Seed

Create a new command instance.

TenantCannotBeCreatedException::__construct() — Method in class TenantCannotBeCreatedException
TenantAssetsController::__construct() — Method in class TenantAssetsController
DatabaseManager::__construct() — Method in class DatabaseManager
DatabaseManagerNotRegisteredException::__construct() — Method in class DatabaseManagerNotRegisteredException
NotImplementedException::__construct() — Method in class NotImplementedException
TenantCouldNotBeIdentifiedException::__construct() — Method in class TenantCouldNotBeIdentifiedException
TenantDatabaseAlreadyExistsException::__construct() — Method in class TenantDatabaseAlreadyExistsException
TenantDatabaseDoesNotExistException::__construct() — Method in class TenantDatabaseDoesNotExistException
TenantDoesNotExistException::__construct() — Method in class TenantDoesNotExistException
TenantWithThisIdAlreadyExistsException::__construct() — Method in class TenantWithThisIdAlreadyExistsException
TelescopeTags::__construct() — Method in class TelescopeTags
TenantConfig::__construct() — Method in class TenantConfig
Timestamps::__construct() — Method in class Timestamps
QueuedTenantDatabaseCreator::__construct() — Method in class QueuedTenantDatabaseCreator

Create a new job instance.

QueuedTenantDatabaseDeleter::__construct() — Method in class QueuedTenantDatabaseDeleter

Create a new job instance.

QueuedTenantDatabaseMigrator::__construct() — Method in class QueuedTenantDatabaseMigrator
QueuedTenantDatabaseSeeder::__construct() — Method in class QueuedTenantDatabaseSeeder
InitializeTenancy::__construct() — Method in class InitializeTenancy
InitializeTenancyByRequestData::__construct() — Method in class InitializeTenancyByRequestData
PreventAccessFromTenantDomains::__construct() — Method in class PreventAccessFromTenantDomains
CachedTenantResolver::__construct() — Method in class CachedTenantResolver
DatabaseStorageDriver::__construct() — Method in class DatabaseStorageDriver
Repository::__construct() — Method in class Repository
Repository::__call() — Method in class Repository
RedisStorageDriver::__construct() — Method in class RedisStorageDriver
CacheTenancyBootstrapper::__construct() — Method in class CacheTenancyBootstrapper
DatabaseTenancyBootstrapper::__construct() — Method in class DatabaseTenancyBootstrapper
FilesystemTenancyBootstrapper::__construct() — Method in class FilesystemTenancyBootstrapper
QueueTenancyBootstrapper::__construct() — Method in class QueueTenancyBootstrapper
RedisTenancyBootstrapper::__construct() — Method in class RedisTenancyBootstrapper
Tenant::__construct() — Method in class Tenant

Use new() if you don't want to swap dependencies.

Tenant::__get() — Method in class Tenant
Tenant::__set() — Method in class Tenant
Tenant::__call() — Method in class Tenant
MySQLDatabaseManager::__construct() — Method in class MySQLDatabaseManager
PostgreSQLDatabaseManager::__construct() — Method in class PostgreSQLDatabaseManager
PostgreSQLSchemaManager::__construct() — Method in class PostgreSQLSchemaManager
TenantManager::__construct() — Method in class TenantManager
TenantManager::__call() — Method in class TenantManager
HasATenantArgument::__construct() — Method in class HasATenantArgument
HasATenantsOption::__construct() — Method in class HasATenantsOption