Index

A

$ CacheTenancyBootstrapper#app — Property in class CacheTenancyBootstrapper
$ FilesystemTenancyBootstrapper#app — Property in class FilesystemTenancyBootstrapper
TenantAssetsController::asset() — Method in class TenantAssetsController
$ DatabaseManager#app — Property in class DatabaseManager
Tenant::all() — Method in class Tenant
ParentModelScope::apply() — Method in class ParentModelScope
TenantScope::apply() — Method in class TenantScope
$ ViteBundler#app — Property in class ViteBundler
$ PreventAccessFromCentralDomains#abortRequest — Property in class PreventAccessFromCentralDomains

Set this property if you want to customize the on-fail behavior.

Vite::assetPath() — Method in class Vite

Generate an asset path for the application.

B

CacheTenancyBootstrapper::bootstrap() — Method in class CacheTenancyBootstrapper
DatabaseTenancyBootstrapper::bootstrap() — Method in class DatabaseTenancyBootstrapper
FilesystemTenancyBootstrapper::bootstrap() — Method in class FilesystemTenancyBootstrapper
QueueTenancyBootstrapper::bootstrap() — Method in class QueueTenancyBootstrapper
RedisTenancyBootstrapper::bootstrap() — Method in class RedisTenancyBootstrapper
Feature::bootstrap() — Method in class Feature
TenancyBootstrapper::bootstrap() — Method in class TenancyBootstrapper
BelongsToPrimaryModel — Class in namespace Stancl\Tenancy\Database\Concerns
BelongsToPrimaryModel::bootBelongsToPrimaryModel() — Method in class BelongsToPrimaryModel
BelongsToTenant — Class in namespace Stancl\Tenancy\Database\Concerns
BelongsToTenant::bootBelongsToTenant() — Method in class BelongsToTenant
ConvertsDomainsToLowercase::bootConvertsDomainsToLowercase() — Method in class ConvertsDomainsToLowercase
EnsuresDomainIsNotOccupied::bootEnsuresDomainIsNotOccupied() — Method in class EnsuresDomainIsNotOccupied
GeneratesIds::bootGeneratesIds() — Method in class GeneratesIds
InvalidatesResolverCache::bootInvalidatesResolverCache() — Method in class InvalidatesResolverCache
InvalidatesTenantsResolverCache::bootInvalidatesTenantsResolverCache() — Method in class InvalidatesTenantsResolverCache
ResourceSyncing::bootResourceSyncing() — Method in class ResourceSyncing
ImpersonationToken::boot() — Method in class ImpersonationToken
TenantPivot::boot() — Method in class TenantPivot
BootstrappingTenancy — Class in namespace Stancl\Tenancy\Events
CrossDomainRedirect::bootstrap() — Method in class CrossDomainRedirect
TelescopeTags::bootstrap() — Method in class TelescopeTags
TenantConfig::bootstrap() — Method in class TenantConfig
UniversalRoutes::bootstrap() — Method in class UniversalRoutes
UserImpersonation::bootstrap() — Method in class UserImpersonation
ViteBundler::bootstrap() — Method in class ViteBundler
BootstrapTenancy — Class in namespace Stancl\Tenancy\Listeners
TenancyServiceProvider::boot() — Method in class TenancyServiceProvider

Bootstrap services.

C

CacheTenancyBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers
$ QueueTenancyBootstrapper#config — Property in class QueueTenancyBootstrapper
$ RedisTenancyBootstrapper#config — Property in class RedisTenancyBootstrapper
CacheManager — Class in namespace Stancl\Tenancy
CreatesDatabaseUsers — Class in namespace Stancl\Tenancy\Concerns
CreatesDatabaseUsers::createDatabase() — Method in class CreatesDatabaseUsers
ManagesDatabaseUsers::createUser() — Method in class ManagesDatabaseUsers
TenantDatabaseManager::createDatabase() — Method in class TenantDatabaseManager

Create a database.

DatabaseConfig::connection() — Method in class DatabaseConfig

Tenant's own database connection config.

CentralConnection — Class in namespace Stancl\Tenancy\Database\Concerns
ConvertsDomainsToLowercase — Class in namespace Stancl\Tenancy\Database\Concerns
HasDomains::createDomain() — Method in class HasDomains
$ DatabaseManager#config — Property in class DatabaseManager
DatabaseManager::connectToTenant() — Method in class DatabaseManager

Connect to a tenant's database.

DatabaseManager::createTenantConnection() — Method in class DatabaseManager

Create the tenant database connection.

$ ImpersonationToken#casts — Property in class ImpersonationToken
$ Tenant#created_at — Property in class Tenant
CreatingDatabase — Class in namespace Stancl\Tenancy\Events
CreatingDomain — Class in namespace Stancl\Tenancy\Events
CreatingTenant — Class in namespace Stancl\Tenancy\Events
CrossDomainRedirect — Class in namespace Stancl\Tenancy\Features
$ TenantConfig#config — Property in class TenantConfig
CreateDatabase — Class in namespace Stancl\Tenancy\Jobs
CreateTenantConnection — Class in namespace Stancl\Tenancy\Listeners
CheckTenantForMaintenanceMode — Class in namespace Stancl\Tenancy\Middleware
CachedTenantResolver — Class in namespace Stancl\Tenancy\Resolvers\Contracts
$ CachedTenantResolver#cacheTTL — Property in class CachedTenantResolver
$ CachedTenantResolver#cacheStore — Property in class CachedTenantResolver
$ CachedTenantResolver#cache — Property in class CachedTenantResolver
$ DomainTenantResolver#currentDomain — Property in class DomainTenantResolver

The model representing the domain that the tenant was identified on.

$ DomainTenantResolver#cacheTTL — Property in class DomainTenantResolver
$ DomainTenantResolver#cacheStore — Property in class DomainTenantResolver
$ PathTenantResolver#cacheTTL — Property in class PathTenantResolver
$ PathTenantResolver#cacheStore — Property in class PathTenantResolver
$ RequestDataTenantResolver#cacheTTL — Property in class RequestDataTenantResolver
$ RequestDataTenantResolver#cacheStore — Property in class RequestDataTenantResolver
Tenancy::central() — Method in class Tenancy

Run a callback in the central context.

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

Create a database.

PermissionControlledMySQLDatabaseManager::createUser() — Method in class PermissionControlledMySQLDatabaseManager
$ 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.

D

DatabaseTenancyBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers
$ DatabaseTenancyBootstrapper#database — Property in class DatabaseTenancyBootstrapper
$ Install#description — Property in class Install

The console command description.

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

The console command description.

$ Rollback#description — Property in class Rollback

The console command description.

$ Run#description — Property in class Run

The console command description.

$ Seed#description — Property in class Seed

The console command description.

$ TenantList#description — Property in class TenantList

The console command description.

CreatesDatabaseUsers::deleteDatabase() — Method in class CreatesDatabaseUsers
DealsWithMigrations — Class in namespace Stancl\Tenancy\Concerns
Domain — Class in namespace Stancl\Tenancy\Contracts
ManagesDatabaseUsers::deleteUser() — Method in class ManagesDatabaseUsers
TenantDatabaseManager::deleteDatabase() — Method in class TenantDatabaseManager

Delete a database.

TenantDatabaseManager::databaseExists() — Method in class TenantDatabaseManager

Does a database exist.

TenantWithDatabase::database() — Method in class TenantWithDatabase
DatabaseConfig — Class in namespace Stancl\Tenancy
$ DatabaseConfig#databaseNameGenerator — Property in class DatabaseConfig
HasDatabase::database() — Method in class HasDatabase
$ HasDomains#domains — Property in class HasDomains
HasDomains::domains() — Method in class HasDomains
DatabaseManager — Class in namespace Stancl\Tenancy\Database
$ DatabaseManager#database — Property in class DatabaseManager
Domain — Class in namespace Stancl\Tenancy\Database\Models
$ Domain#dispatchesEvents — Property in class Domain
$ Domain#domain — Property in class Domain
$ Tenant#dispatchesEvents — Property in class Tenant
$ Tenant#data — Property in class Tenant
DomainEvent — Class in namespace Stancl\Tenancy\Events\Contracts
$ DomainEvent#domain — Property in class DomainEvent
DatabaseCreated — Class in namespace Stancl\Tenancy\Events
DatabaseDeleted — Class in namespace Stancl\Tenancy\Events
DatabaseMigrated — Class in namespace Stancl\Tenancy\Events
DatabaseRolledBack — Class in namespace Stancl\Tenancy\Events
DatabaseSeeded — Class in namespace Stancl\Tenancy\Events
DeletingDatabase — Class in namespace Stancl\Tenancy\Events
DeletingDomain — Class in namespace Stancl\Tenancy\Events
DeletingTenant — Class in namespace Stancl\Tenancy\Events
DomainCreated — Class in namespace Stancl\Tenancy\Events
DomainDeleted — Class in namespace Stancl\Tenancy\Events
DomainSaved — Class in namespace Stancl\Tenancy\Events
DomainUpdated — Class in namespace Stancl\Tenancy\Events
DatabaseManagerNotRegisteredException — Class in namespace Stancl\Tenancy\Exceptions
DomainOccupiedByOtherTenantException — Class in namespace Stancl\Tenancy\Exceptions
$ TenantDatabaseAlreadyExistsException#database — Property in class TenantDatabaseAlreadyExistsException
DeleteDatabase — Class in namespace Stancl\Tenancy\Jobs
$ CreateTenantConnection#database — Property in class CreateTenantConnection
DomainTenantResolver — Class in namespace Stancl\Tenancy\Resolvers
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.

PermissionControlledMySQLDatabaseManager::deleteUser() — Method in class PermissionControlledMySQLDatabaseManager
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.

E

ExtendsLaravelCommand — Class in namespace Stancl\Tenancy\Concerns
TenantAwareCommand::execute() — Method in class TenantAwareCommand
EnsuresDomainIsNotOccupied — Class in namespace Stancl\Tenancy\Database\Concerns
HasScopedValidationRules::exists() — Method in class HasScopedValidationRules
DatabaseManager::ensureTenantCanBeCreated() — Method in class DatabaseManager

Check if a tenant can be created.

ParentModelScope::extend() — Method in class ParentModelScope
TenantScope::extend() — Method in class TenantScope
EndingTenancy — Class in namespace Stancl\Tenancy\Events
Tenancy::end() — Method in class Tenancy

F

FilesystemTenancyBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers
$ QueueTenancyBootstrapper#forceRefresh — Property in class QueueTenancyBootstrapper

Don't persist the same tenant across multiple jobs even if they have the same tenant ID.

Feature — Class in namespace Stancl\Tenancy\Contracts

Additional features, like Telescope tags and tenant redirects.

TenantCollection::first() — Method in class TenantCollection
Tenancy::find() — Method in class Tenancy

G

QueueTenancyBootstrapper::getPayload() — Method in class QueueTenancyBootstrapper
Migrate::getTenantCommandName() — Method in class Migrate
Rollback::getTenantCommandName() — Method in class Rollback
DealsWithMigrations::getMigrationPaths() — Method in class DealsWithMigrations
ExtendsLaravelCommand::getName() — Method in class ExtendsLaravelCommand
ExtendsLaravelCommand::getDefaultName() — Method in class ExtendsLaravelCommand
ExtendsLaravelCommand::getTenantCommandName() — Method in class ExtendsLaravelCommand
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.

SyncMaster::getTenantModelName() — Method in class SyncMaster
Syncable::getGlobalIdentifierKeyName() — Method in class Syncable
Syncable::getGlobalIdentifierKey() — Method in class Syncable
Syncable::getCentralModelName() — Method in class Syncable
Syncable::getSyncedAttributeNames() — Method in class Syncable
Tenant::getTenantKeyName() — Method in class Tenant

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

Tenant::getTenantKey() — Method in class Tenant

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

Tenant::getInternal() — Method in class Tenant

Get the value of an internal key.

TenantWithDatabase::getInternal() — Method in class TenantWithDatabase

Get an internal key.

UniqueIdentifierGenerator::generate() — Method in class UniqueIdentifierGenerator

Generate a unique identifier.

DatabaseConfig::generateDatabaseNamesUsing() — Method in class DatabaseConfig
DatabaseConfig::generateUsernamesUsing() — Method in class DatabaseConfig
DatabaseConfig::generatePasswordsUsing() — Method in class DatabaseConfig
DatabaseConfig::getName() — Method in class DatabaseConfig
DatabaseConfig::getUsername() — Method in class DatabaseConfig
DatabaseConfig::getPassword() — Method in class DatabaseConfig
DatabaseConfig::getTemplateConnectionName() — Method in class DatabaseConfig
BelongsToPrimaryModel::getRelationshipToPrimaryModel() — Method in class BelongsToPrimaryModel
CentralConnection::getConnectionName() — Method in class CentralConnection
GeneratesIds — Class in namespace Stancl\Tenancy\Database\Concerns
GeneratesIds::getIncrementing() — Method in class GeneratesIds
GeneratesIds::getKeyType() — Method in class GeneratesIds
HasInternalKeys::getInternal() — Method in class HasInternalKeys

Get an internal key.

PrimaryDomain::getPrimaryDomainHostnameAttribute() — Method in class PrimaryDomain
TenantConnection::getConnectionName() — Method in class TenantConnection
$ Domain#guarded — Property in class Domain
$ ImpersonationToken#guarded — Property in class ImpersonationToken
$ Tenant#guarded — Property in class Tenant
Tenant::getTenantKeyName() — Method in class Tenant

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

Tenant::getTenantKey() — Method in class Tenant

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

TenantCouldNotBeIdentifiedById::getSolution() — Method in class TenantCouldNotBeIdentifiedById
TenantCouldNotBeIdentifiedByPathException::getSolution() — Method in class TenantCouldNotBeIdentifiedByPathException
TenantCouldNotBeIdentifiedByRequestDataException::getSolution() — Method in class TenantCouldNotBeIdentifiedByRequestDataException
TenantCouldNotBeIdentifiedOnDomainException::getSolution() — Method in class TenantCouldNotBeIdentifiedOnDomainException
GlobalCache — Class in namespace Stancl\Tenancy\Facades
GlobalCache::getFacadeAccessor() — Method in class GlobalCache
Tenancy::getFacadeAccessor() — Method in class Tenancy
UpdateSyncedResource::getTenantsForCentralModel() — Method in class UpdateSyncedResource
InitializeTenancyByRequestData::getPayload() — Method in class InitializeTenancyByRequestData
CachedTenantResolver::getCacheKey() — Method in class CachedTenantResolver
CachedTenantResolver::getArgsForTenant() — Method in class CachedTenantResolver

Get all the arg combinations for resolve() that can be used to find this tenant.

DomainTenantResolver::getArgsForTenant() — Method in class DomainTenantResolver

Get all the arg combinations for resolve() that can be used to find this tenant.

PathTenantResolver::getArgsForTenant() — Method in class PathTenantResolver

Get all the arg combinations for resolve() that can be used to find this tenant.

RequestDataTenantResolver::getArgsForTenant() — Method in class RequestDataTenantResolver

Get all the arg combinations for resolve() that can be used to find this tenant.

$ Tenancy#getBootstrappersUsing — Property in class Tenancy
Tenancy::getBootstrappers() — Method in class Tenancy
$ PermissionControlledMySQLDatabaseManager#grants — Property in class PermissionControlledMySQLDatabaseManager
UUIDGenerator::generate() — Method in class UUIDGenerator

Generate a unique identifier.

H

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.

HasATenantArgument — Class in namespace Stancl\Tenancy\Concerns
HasATenantsOption — Class in namespace Stancl\Tenancy\Concerns
HasDataColumn — Class in namespace Stancl\Tenancy\Database\Concerns

Extends VirtualColumn for backwards compatibility. This trait will be removed in v4.

HasDatabase — Class in namespace Stancl\Tenancy\Database\Concerns
HasDomains — Class in namespace Stancl\Tenancy\Database\Concerns
HasInternalKeys — Class in namespace Stancl\Tenancy\Database\Concerns
HasScopedValidationRules — Class in namespace Stancl\Tenancy\Database\Concerns
CreateDatabase::handle() — Method in class CreateDatabase
DeleteDatabase::handle() — Method in class DeleteDatabase
MigrateDatabase::handle() — Method in class MigrateDatabase

Execute the job.

SeedDatabase::handle() — Method in class SeedDatabase

Execute the job.

BootstrapTenancy::handle() — Method in class BootstrapTenancy
CreateTenantConnection::handle() — Method in class CreateTenantConnection
QueueableListener::handle() — Method in class QueueableListener
RevertToCentralContext::handle() — Method in class RevertToCentralContext
UpdateSyncedResource::handle() — Method in class UpdateSyncedResource
CheckTenantForMaintenanceMode::handle() — Method in class CheckTenantForMaintenanceMode
InitializeTenancyByDomain::handle() — Method in class InitializeTenancyByDomain

Handle an incoming request.

InitializeTenancyByDomainOrSubdomain::handle() — Method in class InitializeTenancyByDomainOrSubdomain

Handle an incoming request.

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

Handle an incoming request.

InitializeTenancyBySubdomain::handle() — Method in class InitializeTenancyBySubdomain

Handle an incoming request.

PreventAccessFromCentralDomains::handle() — Method in class PreventAccessFromCentralDomains
ScopeSessions::handle() — Method in class ScopeSessions

I

QueueTenancyBootstrapper::initializeTenancyForQueue() — Method in class QueueTenancyBootstrapper
Install — Class in namespace Stancl\Tenancy\Commands
HasInternalKeys::internalPrefix() — Method in class HasInternalKeys

Get the internal prefix.

InvalidatesResolverCache — Class in namespace Stancl\Tenancy\Database\Concerns
InvalidatesTenantsResolverCache — Class in namespace Stancl\Tenancy\Database\Concerns

Meant to be used on models that belong to tenants.

ImpersonationToken — Class in namespace Stancl\Tenancy\Database\Models
$ ImpersonationToken#incrementing — Property in class ImpersonationToken
$ Tenant#id — Property in class Tenant
$ TenantCollection#items — Property in class TenantCollection
InitializingTenancy — Class in namespace Stancl\Tenancy\Events
$ UniversalRoutes#identificationMiddlewares — Property in class UniversalRoutes
IdentificationMiddleware — Class in namespace Stancl\Tenancy\Middleware
IdentificationMiddleware::initializeTenancy() — Method in class IdentificationMiddleware
InitializeTenancyByDomain — Class in namespace Stancl\Tenancy\Middleware
InitializeTenancyByDomainOrSubdomain — Class in namespace Stancl\Tenancy\Middleware
InitializeTenancyByDomainOrSubdomain::isSubdomain() — Method in class InitializeTenancyByDomainOrSubdomain
InitializeTenancyByPath — Class in namespace Stancl\Tenancy\Middleware
InitializeTenancyByRequestData — Class in namespace Stancl\Tenancy\Middleware
InitializeTenancyBySubdomain — Class in namespace Stancl\Tenancy\Middleware
CachedTenantResolver::invalidateCache() — Method in class CachedTenantResolver
$ Tenancy#initialized — Property in class Tenancy
Tenancy::initialize() — Method in class Tenancy

Initializes the tenant.

PermissionControlledMySQLDatabaseManager::isVersion8() — Method in class PermissionControlledMySQLDatabaseManager

M

Migrate — Class in namespace Stancl\Tenancy\Commands
MigrateFresh — Class in namespace Stancl\Tenancy\Commands
ManagesDatabaseUsers — Class in namespace Stancl\Tenancy\Contracts
$ TenantCannotBeCreatedException#message — Property in class TenantCannotBeCreatedException
TenantDatabaseManager::makeConnectionConfig() — Method in class TenantDatabaseManager

Make a DB connection config array.

DatabaseConfig::makeCredentials() — Method in class DatabaseConfig

Generate DB name, username & password and write them to the tenant model.

DatabaseConfig::manager() — Method in class DatabaseConfig

Get the TenantDatabaseManager for this tenant's connection.

MaintenanceMode — Class in namespace Stancl\Tenancy\Database\Concerns
$ Tenant#modelsShouldPreventAccessingMissingAttributes — Property in class Tenant
MigratingDatabase — Class in namespace Stancl\Tenancy\Events
$ SyncedResourceChangedInForeignDatabase#model — Property in class SyncedResourceChangedInForeignDatabase
$ SyncedResourceSaved#model — Property in class SyncedResourceSaved
ModelNotSyncMasterException — Class in namespace Stancl\Tenancy\Exceptions
$ UniversalRoutes#middlewareGroup — Property in class UniversalRoutes
UserImpersonation::makeResponse() — Method in class UserImpersonation

Impersonate a user and get an HTTP redirect response.

MigrateDatabase — Class in namespace Stancl\Tenancy\Jobs
InitializeTenancyBySubdomain::makeSubdomain() — Method in class InitializeTenancyBySubdomain
Tenancy::model() — Method in class Tenancy
MySQLDatabaseManager — Class in namespace Stancl\Tenancy\TenantDatabaseManagers
MySQLDatabaseManager::makeConnectionConfig() — Method in class MySQLDatabaseManager

Make a DB connection config array.

PermissionControlledMySQLDatabaseManager::makeConnectionConfig() — Method in class PermissionControlledMySQLDatabaseManager

Make a DB connection config array.

PostgreSQLDatabaseManager::makeConnectionConfig() — Method in class PostgreSQLDatabaseManager

Make a DB connection config array.

PostgreSQLSchemaManager::makeConnectionConfig() — Method in class PostgreSQLSchemaManager

Make a DB connection config array.

SQLiteDatabaseManager::makeConnectionConfig() — Method in class SQLiteDatabaseManager

Make a DB connection config array.

N

$ Seed#name — Property in class Seed
Tenant::newCollection() — Method in class Tenant
NoConnectionSetException — Class in namespace Stancl\Tenancy\Exceptions
NotASubdomainException — Class in namespace Stancl\Tenancy\Exceptions

O

$ CacheTenancyBootstrapper#originalCache — Property in class CacheTenancyBootstrapper
$ FilesystemTenancyBootstrapper#originalPaths — Property in class FilesystemTenancyBootstrapper
$ RedisTenancyBootstrapper#originalPrefixes — Property in class RedisTenancyBootstrapper
TenantCollection::offsetGet() — Method in class TenantCollection
$ TenantConfig#originalConfig — Property in class TenantConfig
$ IdentificationMiddleware#onFail — Property in class IdentificationMiddleware
$ InitializeTenancyByDomain#onFail — Property in class InitializeTenancyByDomain
$ InitializeTenancyByPath#onFail — Property in class InitializeTenancyByPath
$ InitializeTenancyByRequestData#onFail — Property in class InitializeTenancyByRequestData
$ InitializeTenancyBySubdomain#onFail — Property in class InitializeTenancyBySubdomain

P

RedisTenancyBootstrapper::prefixedConnections() — Method in class RedisTenancyBootstrapper
$ DatabaseConfig#passwordGenerator — Property in class DatabaseConfig
MaintenanceMode::putDownForMaintenance() — Method in class MaintenanceMode
PrimaryDomain — Class in namespace Stancl\Tenancy\Database\Concerns
$ PrimaryDomain#primary_domain_hostname — Property in class PrimaryDomain
DatabaseManager::purgeTenantConnection() — Method in class DatabaseManager

Purge the tenant database connection.

$ ImpersonationToken#primaryKey — Property in class ImpersonationToken
$ Tenant#primaryKey — Property in class Tenant
ParentModelScope — Class in namespace Stancl\Tenancy\Database
PreventAccessFromCentralDomains — Class in namespace Stancl\Tenancy\Middleware
PathTenantResolver — Class in namespace Stancl\Tenancy\Resolvers
PermissionControlledMySQLDatabaseManager — Class in namespace Stancl\Tenancy\TenantDatabaseManagers
PostgreSQLDatabaseManager — Class in namespace Stancl\Tenancy\TenantDatabaseManagers
PostgreSQLSchemaManager — Class in namespace Stancl\Tenancy\TenantDatabaseManagers

Q

QueueTenancyBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers
$ QueueTenancyBootstrapper#queue — Property in class QueueTenancyBootstrapper
QueueableListener — Class in namespace Stancl\Tenancy\Listeners
$ InitializeTenancyByRequestData#queryParameter — Property in class InitializeTenancyByRequestData
Tenancy::query() — Method in class Tenancy

R

CacheTenancyBootstrapper::revert() — Method in class CacheTenancyBootstrapper
CacheTenancyBootstrapper::resetFacadeCache() — Method in class CacheTenancyBootstrapper

This wouldn't be necessary, but is needed when a call to the facade has been made prior to bootstrapping tenancy. The facade has its own cache, separate from the container.

DatabaseTenancyBootstrapper::revert() — Method in class DatabaseTenancyBootstrapper
FilesystemTenancyBootstrapper::revert() — Method in class FilesystemTenancyBootstrapper
QueueTenancyBootstrapper::revertToPreviousState() — Method in class QueueTenancyBootstrapper
QueueTenancyBootstrapper::revert() — Method in class QueueTenancyBootstrapper
RedisTenancyBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers
RedisTenancyBootstrapper::revert() — Method in class RedisTenancyBootstrapper
Rollback — Class in namespace Stancl\Tenancy\Commands
Run — Class in namespace Stancl\Tenancy\Commands
TenancyBootstrapper::revert() — Method in class TenancyBootstrapper
Tenant::run() — Method in class Tenant

Run a callback in this tenant's environment.

TenantCannotBeCreatedException::reason() — Method in class TenantCannotBeCreatedException
TenantResolver::resolve() — Method in class TenantResolver

Resolve a tenant using some value.

$ InvalidatesResolverCache#resolvers — Property in class InvalidatesResolverCache
$ InvalidatesTenantsResolverCache#resolvers — Property in class InvalidatesTenantsResolverCache
PrimaryDomain::route() — Method in class PrimaryDomain
ResourceSyncing — Class in namespace Stancl\Tenancy\Database\Concerns
TenantRun::run() — Method in class TenantRun

Run a callback in this tenant's context.

DatabaseManager::reconnectToCentral() — Method in class DatabaseManager

Reconnect to the default non-tenant connection.

TenantCollection::runForEach() — Method in class TenantCollection
RevertedToCentralContext — Class in namespace Stancl\Tenancy\Events
RevertingToCentralContext — Class in namespace Stancl\Tenancy\Events
RollingBackDatabase — Class in namespace Stancl\Tenancy\Events
RouteIsMissingTenantParameterException — Class in namespace Stancl\Tenancy\Exceptions
TenantDatabaseAlreadyExistsException::reason() — Method in class TenantDatabaseAlreadyExistsException
TenantDatabaseUserAlreadyExistsException::reason() — Method in class TenantDatabaseUserAlreadyExistsException
UniversalRoutes::routeHasMiddleware() — Method in class UniversalRoutes
RevertToCentralContext — Class in namespace Stancl\Tenancy\Listeners
$ IdentificationMiddleware#resolver — Property in class IdentificationMiddleware
$ InitializeTenancyByDomain#resolver — Property in class InitializeTenancyByDomain
$ InitializeTenancyByPath#resolver — Property in class InitializeTenancyByPath
$ InitializeTenancyByRequestData#resolver — Property in class InitializeTenancyByRequestData
CachedTenantResolver::resolve() — Method in class CachedTenantResolver

Resolve a tenant using some value.

CachedTenantResolver::resolveWithoutCache() — Method in class CachedTenantResolver
CachedTenantResolver::resolved() — Method in class CachedTenantResolver
DomainTenantResolver::resolveWithoutCache() — Method in class DomainTenantResolver
DomainTenantResolver::resolved() — Method in class DomainTenantResolver
PathTenantResolver::resolveWithoutCache() — Method in class PathTenantResolver
RequestDataTenantResolver — Class in namespace Stancl\Tenancy\Resolvers
RequestDataTenantResolver::resolveWithoutCache() — Method in class RequestDataTenantResolver
Tenancy::runForMultiple() — Method in class Tenancy

Run a callback for multiple tenants.

TenancyServiceProvider::register() — Method in class TenancyServiceProvider

Register services.

S

QueueTenancyBootstrapper::setUpJobListener() — Method in class QueueTenancyBootstrapper
QueueTenancyBootstrapper::setUpPayloadGenerator() — Method in class QueueTenancyBootstrapper
$ Install#signature — Property in class Install

The name and signature of the console command.

$ 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.

ExtendsLaravelCommand::specifyTenantSignature() — Method in class ExtendsLaravelCommand
SyncMaster — Class in namespace Stancl\Tenancy\Contracts
Syncable — Class in namespace Stancl\Tenancy\Contracts
Tenant::setInternal() — Method in class Tenant

Set the value of an internal key.

TenantDatabaseManager::setConnection() — Method in class TenantDatabaseManager

Set the DB connection that should be used by the tenant database manager.

GeneratesIds::shouldGenerateId() — Method in class GeneratesIds
HasInternalKeys::setInternal() — Method in class HasInternalKeys

Set internal key.

DatabaseManager::setDefaultConnection() — Method in class DatabaseManager

Change the default database connection config.

SavedDomain — Class in namespace Stancl\Tenancy\Events
SavedTenant — Class in namespace Stancl\Tenancy\Events
SavingDomain — Class in namespace Stancl\Tenancy\Events
SavingTenant — Class in namespace Stancl\Tenancy\Events
SeedingDatabase — Class in namespace Stancl\Tenancy\Events
SyncedResourceChangedInForeignDatabase — Class in namespace Stancl\Tenancy\Events
SyncedResourceSaved — Class in namespace Stancl\Tenancy\Events
$ TenantConfig#storageToConfigMap — Property in class TenantConfig
TenantConfig::setTenantConfig() — Method in class TenantConfig
SeedDatabase — Class in namespace Stancl\Tenancy\Jobs
$ QueueableListener#shouldQueue — Property in class QueueableListener
QueueableListener::shouldQueue() — Method in class QueueableListener
$ UpdateSyncedResource#shouldQueue — Property in class UpdateSyncedResource
$ InitializeTenancyBySubdomain#subdomainIndex — Property in class InitializeTenancyBySubdomain

The index of the subdomain fragment in the hostname split by .. 0 for first fragment, 1 if you prefix your subdomain fragments with www.

ScopeSessions — Class in namespace Stancl\Tenancy\Middleware
$ CachedTenantResolver#shouldCache — Property in class CachedTenantResolver
$ DomainTenantResolver#shouldCache — Property in class DomainTenantResolver
DomainTenantResolver::setCurrentDomain() — Method in class DomainTenantResolver
$ PathTenantResolver#shouldCache — Property in class PathTenantResolver
$ RequestDataTenantResolver#shouldCache — Property in class RequestDataTenantResolver
MySQLDatabaseManager::setConnection() — Method in class MySQLDatabaseManager

Set the DB connection that should be used by the tenant database manager.

PostgreSQLDatabaseManager::setConnection() — Method in class PostgreSQLDatabaseManager

Set the DB connection that should be used by the tenant database manager.

PostgreSQLSchemaManager::setConnection() — Method in class PostgreSQLSchemaManager

Set the DB connection that should be used by the tenant database manager.

SQLiteDatabaseManager — Class in namespace Stancl\Tenancy\TenantDatabaseManagers
SQLiteDatabaseManager::setConnection() — Method in class SQLiteDatabaseManager

Set the DB connection that should be used by the tenant database manager.

T

TenantList — Class in namespace Stancl\Tenancy\Commands
TenantAwareCommand — Class in namespace Stancl\Tenancy\Concerns
$ Domain#tenant — Property in class Domain
Domain::tenant() — Method in class Domain
$ SyncMaster#tenants — Property in class SyncMaster
SyncMaster::tenants() — Method in class SyncMaster
Syncable::triggerSyncEvent() — Method in class Syncable
TenancyBootstrapper — Class in namespace Stancl\Tenancy\Contracts

TenancyBootstrappers are classes that make your application tenant-aware automatically.

Tenant — Class in namespace Stancl\Tenancy\Contracts
TenantCannotBeCreatedException — Class in namespace Stancl\Tenancy\Contracts
TenantCouldNotBeIdentifiedException — Class in namespace Stancl\Tenancy\Contracts
TenantDatabaseManager — Class in namespace Stancl\Tenancy\Contracts
TenantResolver — Class in namespace Stancl\Tenancy\Contracts
TenantWithDatabase — Class in namespace Stancl\Tenancy\Contracts
TenantAssetsController — Class in namespace Stancl\Tenancy\Controllers
$ TenantAssetsController#tenancyMiddleware — Property in class TenantAssetsController
$ DatabaseConfig#tenant — Property in class DatabaseConfig
DatabaseConfig::tenantConfig() — Method in class DatabaseConfig

Additional config for the database connection, specific to this tenant.

$ BelongsToTenant#tenantIdColumn — Property in class BelongsToTenant
$ BelongsToTenant#tenant — Property in class BelongsToTenant
BelongsToTenant::tenant() — Method in class BelongsToTenant
ResourceSyncing::triggerSyncEvent() — Method in class ResourceSyncing
TenantConnection — Class in namespace Stancl\Tenancy\Database\Concerns
TenantRun — Class in namespace Stancl\Tenancy\Database\Concerns
$ Domain#tenant_id — Property in class Domain
$ Domain#tenant — Property in class Domain
Domain::tenant() — Method in class Domain
$ ImpersonationToken#timestamps — Property in class ImpersonationToken
$ ImpersonationToken#table — Property in class ImpersonationToken
Tenant — Class in namespace Stancl\Tenancy\Database\Models
$ Tenant#table — Property in class Tenant
TenantPivot — Class in namespace Stancl\Tenancy\Database\Models
TenantCollection — Class in namespace Stancl\Tenancy\Database
TenantCollection::toArray() — Method in class TenantCollection
TenantScope — Class in namespace Stancl\Tenancy\Database
TenancyEvent — Class in namespace Stancl\Tenancy\Events\Contracts
$ TenancyEvent#tenancy — Property in class TenancyEvent
TenantEvent — Class in namespace Stancl\Tenancy\Events\Contracts
$ TenantEvent#tenant — Property in class TenantEvent
$ SyncedResourceChangedInForeignDatabase#tenant — Property in class SyncedResourceChangedInForeignDatabase
$ SyncedResourceSaved#tenant — Property in class SyncedResourceSaved
TenancyBootstrapped — Class in namespace Stancl\Tenancy\Events
TenancyEnded — Class in namespace Stancl\Tenancy\Events
TenancyInitialized — Class in namespace Stancl\Tenancy\Events
TenantCreated — Class in namespace Stancl\Tenancy\Events
TenantDeleted — Class in namespace Stancl\Tenancy\Events
TenantSaved — Class in namespace Stancl\Tenancy\Events
TenantUpdated — Class in namespace Stancl\Tenancy\Events
TenancyNotInitializedException — Class in namespace Stancl\Tenancy\Exceptions
TenantCouldNotBeIdentifiedById — Class in namespace Stancl\Tenancy\Exceptions
TenantCouldNotBeIdentifiedByPathException — Class in namespace Stancl\Tenancy\Exceptions
TenantCouldNotBeIdentifiedByRequestDataException — Class in namespace Stancl\Tenancy\Exceptions
TenantCouldNotBeIdentifiedOnDomainException — Class in namespace Stancl\Tenancy\Exceptions
TenantDatabaseAlreadyExistsException — Class in namespace Stancl\Tenancy\Exceptions
TenantDatabaseDoesNotExistException — Class in namespace Stancl\Tenancy\Exceptions
TenantDatabaseUserAlreadyExistsException — Class in namespace Stancl\Tenancy\Exceptions
Tenancy — Class in namespace Stancl\Tenancy\Facades
TelescopeTags — Class in namespace Stancl\Tenancy\Features
TenantConfig — Class in namespace Stancl\Tenancy\Features
$ UserImpersonation#ttl — Property in class UserImpersonation
$ CreateDatabase#tenant — Property in class CreateDatabase
$ DeleteDatabase#tenant — Property in class DeleteDatabase
$ MigrateDatabase#tenant — Property in class MigrateDatabase
$ SeedDatabase#tenant — Property in class SeedDatabase
$ IdentificationMiddleware#tenancy — Property in class IdentificationMiddleware
$ InitializeTenancyByDomain#tenancy — Property in class InitializeTenancyByDomain
$ InitializeTenancyByPath#tenancy — Property in class InitializeTenancyByPath
$ InitializeTenancyByRequestData#tenancy — Property in class InitializeTenancyByRequestData
$ ScopeSessions#tenantIdKey — Property in class ScopeSessions
$ PathTenantResolver#tenantParameterName — Property in class PathTenantResolver
Tenancy — Class in namespace Stancl\Tenancy
$ Tenancy#tenant — Property in class Tenancy
TenancyServiceProvider — Class in namespace Stancl\Tenancy

U

ManagesDatabaseUsers::userExists() — Method in class ManagesDatabaseUsers
UniqueIdentifierGenerator — Class in namespace Stancl\Tenancy\Contracts
$ DatabaseConfig#usernameGenerator — Property in class DatabaseConfig
HasScopedValidationRules::unique() — Method in class HasScopedValidationRules
$ Tenant#updated_at — Property in class Tenant
UpdatingDomain — Class in namespace Stancl\Tenancy\Events
UpdatingTenant — Class in namespace Stancl\Tenancy\Events
$ TenantDatabaseUserAlreadyExistsException#user — Property in class TenantDatabaseUserAlreadyExistsException
TenantConfig::unsetTenantConfig() — Method in class TenantConfig
UniversalRoutes — Class in namespace Stancl\Tenancy\Features
UserImpersonation — Class in namespace Stancl\Tenancy\Features
UpdateSyncedResource — Class in namespace Stancl\Tenancy\Listeners
UpdateSyncedResource::updateResourceInCentralDatabaseAndGetTenants() — Method in class UpdateSyncedResource
UpdateSyncedResource::updateResourceInTenantDatabases() — Method in class UpdateSyncedResource
PermissionControlledMySQLDatabaseManager::userExists() — Method in class PermissionControlledMySQLDatabaseManager
UUIDGenerator — Class in namespace Stancl\Tenancy

V

ViteBundler — Class in namespace Stancl\Tenancy\Features
Vite — Class in namespace Stancl\Tenancy

_

CacheTenancyBootstrapper::__construct() — Method in class CacheTenancyBootstrapper
DatabaseTenancyBootstrapper::__construct() — Method in class DatabaseTenancyBootstrapper
FilesystemTenancyBootstrapper::__construct() — Method in class FilesystemTenancyBootstrapper
QueueTenancyBootstrapper::__constructStatic() — Method in class QueueTenancyBootstrapper

The normal constructor is only executed after tenancy is bootstrapped.

QueueTenancyBootstrapper::__construct() — Method in class QueueTenancyBootstrapper
RedisTenancyBootstrapper::__construct() — Method in class RedisTenancyBootstrapper
CacheManager::__call() — Method in class CacheManager

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

Migrate::__construct() — Method in class Migrate
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.

HasATenantArgument::__construct() — Method in class HasATenantArgument
HasATenantsOption::__construct() — Method in class HasATenantsOption
Domain::__call() — Method in class Domain

IDE support. This will be a model.

Domain::__callStatic() — Method in class Domain

IDE support. This will be a model.

Tenant::__call() — Method in class Tenant

IDE support. This will be a model.

Tenant::__callStatic() — Method in class Tenant

IDE support. This will be a model.

TenantCannotBeCreatedException::__construct() — Method in class TenantCannotBeCreatedException
TenantAssetsController::__construct() — Method in class TenantAssetsController
DatabaseConfig::__constructStatic() — Method in class DatabaseConfig
DatabaseConfig::__construct() — Method in class DatabaseConfig
DatabaseManager::__construct() — Method in class DatabaseManager
TenantCollection::__construct() — Method in class TenantCollection
DomainEvent::__construct() — Method in class DomainEvent
TenancyEvent::__construct() — Method in class TenancyEvent
TenantEvent::__construct() — Method in class TenantEvent
SyncedResourceChangedInForeignDatabase::__construct() — Method in class SyncedResourceChangedInForeignDatabase
SyncedResourceSaved::__construct() — Method in class SyncedResourceSaved
DatabaseManagerNotRegisteredException::__construct() — Method in class DatabaseManagerNotRegisteredException
DomainOccupiedByOtherTenantException::__construct() — Method in class DomainOccupiedByOtherTenantException
ModelNotSyncMasterException::__construct() — Method in class ModelNotSyncMasterException
NoConnectionSetException::__construct() — Method in class NoConnectionSetException
NotASubdomainException::__construct() — Method in class NotASubdomainException
RouteIsMissingTenantParameterException::__construct() — Method in class RouteIsMissingTenantParameterException
TenancyNotInitializedException::__construct() — Method in class TenancyNotInitializedException
TenantCouldNotBeIdentifiedById::__construct() — Method in class TenantCouldNotBeIdentifiedById
TenantCouldNotBeIdentifiedByPathException::__construct() — Method in class TenantCouldNotBeIdentifiedByPathException
TenantCouldNotBeIdentifiedByRequestDataException::__construct() — Method in class TenantCouldNotBeIdentifiedByRequestDataException
TenantCouldNotBeIdentifiedOnDomainException::__construct() — Method in class TenantCouldNotBeIdentifiedOnDomainException
TenantDatabaseAlreadyExistsException::__construct() — Method in class TenantDatabaseAlreadyExistsException
TenantDatabaseDoesNotExistException::__construct() — Method in class TenantDatabaseDoesNotExistException
TenantDatabaseUserAlreadyExistsException::__construct() — Method in class TenantDatabaseUserAlreadyExistsException
TenantConfig::__construct() — Method in class TenantConfig
ViteBundler::__construct() — Method in class ViteBundler
CreateDatabase::__construct() — Method in class CreateDatabase
DeleteDatabase::__construct() — Method in class DeleteDatabase
MigrateDatabase::__construct() — Method in class MigrateDatabase
SeedDatabase::__construct() — Method in class SeedDatabase
CreateTenantConnection::__construct() — Method in class CreateTenantConnection
InitializeTenancyByDomain::__construct() — Method in class InitializeTenancyByDomain
InitializeTenancyByPath::__construct() — Method in class InitializeTenancyByPath
InitializeTenancyByRequestData::__construct() — Method in class InitializeTenancyByRequestData
CachedTenantResolver::__construct() — Method in class CachedTenantResolver