Index

A

$ FilesystemTenancyBootstrapper#app — Property in class FilesystemTenancyBootstrapper
Install::askForSupport() — Method in class Install

If the user accepts, opens the GitHub project in the browser.

Run::argvInput() — Method in class Run
TenantAssetController::asset() — Method in class TenantAssetController
PendingScope::apply() — Method in class PendingScope

Apply the scope to a given Eloquent query builder.

PendingScope::addWithPending() — Method in class PendingScope

Add the with-pending extension to the builder.

PendingScope::addWithoutPending() — Method in class PendingScope

Add the without-pending extension to the builder.

PendingScope::addOnlyPending() — Method in class PendingScope

Add the only-pending extension to the builder.

$ ImpersonationToken#auth_guard — Property in class ImpersonationToken
Tenant::all() — Method in class Tenant
ParentModelScope::apply() — Method in class ParentModelScope
TenantScope::apply() — Method in class TenantScope
$ ViteBundler#app — Property in class ViteBundler
$ PreventAccessFromUnwantedDomains#abortRequest — Property in class PreventAccessFromUnwantedDomains

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

BatchTenancyBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers
BatchTenancyBootstrapper::bootstrap() — Method in class BatchTenancyBootstrapper
BroadcastTenancyBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers
$ BroadcastTenancyBootstrapper#broadcaster — Property in class BroadcastTenancyBootstrapper
BroadcastTenancyBootstrapper::bootstrap() — Method in class BroadcastTenancyBootstrapper
CacheTagsBootstrapper::bootstrap() — Method in class CacheTagsBootstrapper
DatabaseTenancyBootstrapper::bootstrap() — Method in class DatabaseTenancyBootstrapper
FilesystemTenancyBootstrapper::bootstrap() — Method in class FilesystemTenancyBootstrapper
ScoutTenancyBootstrapper::bootstrap() — Method in class ScoutTenancyBootstrapper
MailTenancyBootstrapper::bootstrap() — Method in class MailTenancyBootstrapper
PrefixCacheTenancyBootstrapper::bootstrap() — Method in class PrefixCacheTenancyBootstrapper
QueueTenancyBootstrapper::bootstrap() — Method in class QueueTenancyBootstrapper
RedisTenancyBootstrapper::bootstrap() — Method in class RedisTenancyBootstrapper
SessionTenancyBootstrapper::bootstrap() — Method in class SessionTenancyBootstrapper
UrlTenancyBootstrapper::bootstrap() — Method in class UrlTenancyBootstrapper
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
HasPending::bootHasPending() — Method in class HasPending

Boot the trait.

InvalidatesResolverCache::bootInvalidatesResolverCache() — Method in class InvalidatesResolverCache
InvalidatesTenantsResolverCache::bootInvalidatesTenantsResolverCache() — Method in class InvalidatesTenantsResolverCache
MaintenanceMode::bringUpFromMaintenance() — Method in class MaintenanceMode
ResourceSyncing::bootResourceSyncing() — Method in class ResourceSyncing
TriggerSyncEvent::booted() — Method in class TriggerSyncEvent
ImpersonationToken::booted() — Method in class ImpersonationToken
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
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

C

CreateStorageSymlinksAction — Class in namespace Stancl\Tenancy\Actions
CreateStorageSymlinksAction::createLink() — Method in class CreateStorageSymlinksAction
$ BroadcastTenancyBootstrapper#credentialsMap — Property in class BroadcastTenancyBootstrapper

Tenant properties to be mapped to config (similarly to the TenantConfig feature).

CacheTagsBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers

todo name.

$ CacheTagsBootstrapper#cacheManagerWithTags — Property in class CacheTagsBootstrapper
$ MailTenancyBootstrapper#credentialsMap — Property in class MailTenancyBootstrapper

Tenant properties to be mapped to config (similarly to the TenantConfig feature).

$ QueueTenancyBootstrapper#config — Property in class QueueTenancyBootstrapper
$ RedisTenancyBootstrapper#config — Property in class RedisTenancyBootstrapper
SessionTenancyBootstrapper::createDatabaseHandler() — Method in class SessionTenancyBootstrapper
CacheManager — Class in namespace Stancl\Tenancy
ClearPendingTenants — Class in namespace Stancl\Tenancy\Commands
CreatePendingTenants — Class in namespace Stancl\Tenancy\Commands
Link::createLinks() — Method in class Link
CentralConnection — Class in namespace Stancl\Tenancy\Database\Concerns
ConvertsDomainsToLowercase — Class in namespace Stancl\Tenancy\Database\Concerns
CreatesDatabaseUsers — Class in namespace Stancl\Tenancy\Database\Concerns
CreatesDatabaseUsers::createDatabase() — Method in class CreatesDatabaseUsers
HasDomains::createDomain() — Method in class HasDomains
HasPending::createPending() — Method in class HasPending

Create a pending tenant.

ManagesDatabaseUsers::createUser() — Method in class ManagesDatabaseUsers

Create a database user.

TenantDatabaseManager::createDatabase() — Method in class TenantDatabaseManager

Create a database.

DatabaseConfig::connection() — Method in class DatabaseConfig

Tenant's own database connection config.

DatabaseConfig::connectionDriverManager() — Method in class DatabaseConfig

todo come up with a better name Get database manager class from the given connection config's driver.

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
$ ImpersonationToken#created_at — Property in class ImpersonationToken
$ Tenant#created_at — Property in class Tenant
Tenant::current() — Method in class Tenant

Get the current tenant.

Tenant::currentOrFail() — Method in class Tenant

Get the current tenant or throw an exception if tenancy is not initialized.

MicrosoftSQLDatabaseManager::createDatabase() — Method in class MicrosoftSQLDatabaseManager

Create a database.

MySQLDatabaseManager::createDatabase() — Method in class MySQLDatabaseManager

Create a database.

PermissionControlledMySQLDatabaseManager::createUser() — Method in class PermissionControlledMySQLDatabaseManager

Create a database user.

PostgreSQLDatabaseManager::createDatabase() — Method in class PostgreSQLDatabaseManager

Create a database.

PostgreSQLSchemaManager::createDatabase() — Method in class PostgreSQLSchemaManager

Create a database.

SQLiteDatabaseManager::createDatabase() — Method in class SQLiteDatabaseManager

Create a database.

$ TenantDatabaseManager#connection — Property in class TenantDatabaseManager

The database connection to the server.

CreatingDatabase — Class in namespace Stancl\Tenancy\Events
CreatingDomain — Class in namespace Stancl\Tenancy\Events
CreatingPendingTenant — Class in namespace Stancl\Tenancy\Events
CreatingStorageSymlink — Class in namespace Stancl\Tenancy\Events
CreatingTenant — Class in namespace Stancl\Tenancy\Events
CrossDomainRedirect — Class in namespace Stancl\Tenancy\Features
ClearPendingTenants — Class in namespace Stancl\Tenancy\Jobs
CreateDatabase — Class in namespace Stancl\Tenancy\Jobs
CreatePendingTenants — Class in namespace Stancl\Tenancy\Jobs
CreateStorageSymlinks — Class in namespace Stancl\Tenancy\Jobs
CreateTenantConnection — Class in namespace Stancl\Tenancy\Listeners
CreateTenantStorage — Class in namespace Stancl\Tenancy\Listeners
CheckTenantForMaintenanceMode — Class in namespace Stancl\Tenancy\Middleware
$ InitializeTenancyByRequestData#cookie — Property in class InitializeTenancyByRequestData
CachedTenantResolver — Class in namespace Stancl\Tenancy\Resolvers\Contracts
$ CachedTenantResolver#cache — Property in class CachedTenantResolver
CachedTenantResolver::cacheTTL() — Method in class CachedTenantResolver
CachedTenantResolver::cacheStore() — Method in class CachedTenantResolver
$ DomainTenantResolver#currentDomain — Property in class DomainTenantResolver

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

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

Tenancy::cachedResolvers() — Method in class Tenancy

Cached tenant resolvers used by the package.

D

DatabaseTenancyBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers
$ DatabaseTenancyBootstrapper#database — Property in class DatabaseTenancyBootstrapper
$ ClearPendingTenants#description — Property in class ClearPendingTenants
$ CreatePendingTenants#description — Property in class CreatePendingTenants
Down — Class in namespace Stancl\Tenancy\Commands
$ Down#description — Property in class Down
$ Install#description — Property in class Install
$ Link#description — Property in class Link
$ Migrate#description — Property in class Migrate
$ MigrateFresh#description — Property in class MigrateFresh
$ Rollback#description — Property in class Rollback
$ Run#description — Property in class Run
$ Seed#description — Property in class Seed
$ TenantList#description — Property in class TenantList
TenantList::domainsCLI() — Method in class TenantList

Generate the visual CLI output for the domain names.

$ Up#description — Property in class Up
DealsWithMigrations — Class in namespace Stancl\Tenancy\Concerns
DealsWithTenantSymlinks — Class in namespace Stancl\Tenancy\Concerns
Domain — Class in namespace Stancl\Tenancy\Contracts
TenantCouldNotBeIdentifiedException::description() — Method in class TenantCouldNotBeIdentifiedException

Set the solution description.

CreatesDatabaseUsers::deleteDatabase() — Method in class CreatesDatabaseUsers
HasDatabase::database() — Method in class HasDatabase
$ HasDomains#domains — Property in class HasDomains
HasDomains::domains() — Method in class HasDomains
ManagesDatabaseUsers::deleteUser() — Method in class ManagesDatabaseUsers

Delete a database user.

StatefulTenantDatabaseManager::database() — Method in class StatefulTenantDatabaseManager

Get the DB connection used by the tenant database manager.

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

Get the tenant's database config.

DatabaseConfig — Class in namespace Stancl\Tenancy\Database
$ DatabaseConfig#databaseNameGenerator — Property in class DatabaseConfig

Database name generator (can be set by the developer.)

DatabaseManager — Class in namespace Stancl\Tenancy\Database
DatabaseManagerNotRegisteredException — Class in namespace Stancl\Tenancy\Database\Exceptions
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
MicrosoftSQLDatabaseManager::deleteDatabase() — Method in class MicrosoftSQLDatabaseManager

Delete a database.

MicrosoftSQLDatabaseManager::databaseExists() — Method in class MicrosoftSQLDatabaseManager

Does a database exist?

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

Delete a database user.

PostgreSQLDatabaseManager::deleteDatabase() — Method in class PostgreSQLDatabaseManager

Delete a database.

PostgreSQLDatabaseManager::databaseExists() — Method in class PostgreSQLDatabaseManager

Does a database exist?

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?

TenantDatabaseManager::database() — Method in class TenantDatabaseManager

Get the DB connection used by the tenant database manager.

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
DomainOccupiedByOtherTenantException — Class in namespace Stancl\Tenancy\Exceptions
DeleteDatabase — Class in namespace Stancl\Tenancy\Jobs
DeleteDomains — Class in namespace Stancl\Tenancy\Jobs
DeleteTenantStorage — Class in namespace Stancl\Tenancy\Listeners
DomainTenantResolver — Class in namespace Stancl\Tenancy\Resolvers
Tenancy::defaultMiddleware() — Method in class Tenancy

Default tenant identification middleware used by the package.

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
InitializationHelpers::enter() — Method in class InitializationHelpers
$ PendingScope#extensions — Property in class PendingScope

All of the extensions to be added to the builder.

PendingScope::extend() — Method in class PendingScope

Extend the query builder with the needed functions.

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

Try to find a tenant using an ID.

G

ScoutTenancyBootstrapper::getTenantPrefix() — Method in class ScoutTenancyBootstrapper
PrefixCacheTenancyBootstrapper::generatePrefix() — Method in class PrefixCacheTenancyBootstrapper
PrefixCacheTenancyBootstrapper::generatePrefixUsing() — Method in class PrefixCacheTenancyBootstrapper
QueueTenancyBootstrapper::getPayload() — Method in class QueueTenancyBootstrapper
CreatePendingTenants::getPendingTenantCount() — Method in class CreatePendingTenants

Calculate the number of currently available pending tenants.

Down::getDownDatabasePayload() — Method in class Down

Get the payload to be placed in the "down" file. This payload is the same as the original function but without the 'template' option.

Migrate::getTenantCommandName() — Method in class Migrate
Rollback::getTenantCommandName() — Method in class Rollback
TenantDump::getOptions() — Method in class TenantDump
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
HasTenantOptions::getOptions() — Method in class HasTenantOptions
HasTenantOptions::getTenants() — Method in class HasTenantOptions
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
Syncable::getSyncedCreationAttributes() — Method in class Syncable

Get the attributes used for creating the other model (i.e. tenant if this is the central one, and central if this is the tenant one).

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.

TenantCouldNotBeIdentifiedException::getSolution() — Method in class TenantCouldNotBeIdentifiedException

Get the Ignition description.

UniqueIdentifierGenerator::generate() — Method in class UniqueIdentifierGenerator

Generate a unique identifier for a model.

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
ResourceSyncing::getSyncedCreationAttributes() — Method in class ResourceSyncing
TenantConnection::getConnectionName() — Method in class TenantConnection
TenantWithDatabase::getInternal() — Method in class TenantWithDatabase

Get an internal key.

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::getTemplateConnectionDriver() — Method in class DatabaseConfig
DatabaseConfig::getTemplateConnection() — Method in class DatabaseConfig
DatabaseConfig::getCentralConnection() — Method in class DatabaseConfig
DatabaseConfig::getTenantHostConnectionName() — Method in class DatabaseConfig
$ 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.

$ PermissionControlledMySQLDatabaseManager#grants — Property in class PermissionControlledMySQLDatabaseManager
SQLiteDatabaseManager::getPath() — Method in class SQLiteDatabaseManager
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
UpdateSyncedResource::getAttributesForCreation() — Method in class UpdateSyncedResource
UpdateSyncedResource::getAttributeNamesAndDefaultValues() — Method in class UpdateSyncedResource

Split the attribute names (sequential index items) and default values (key => values).

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
TenancyBroadcastManager::get() — Method in class TenancyBroadcastManager

Override the get method so that the broadcasters in $tenantBroadcasters always get freshly resolved even when they're cached and available in the $broadcasters property, and that the resolved broadcaster will override the BroadcasterContract::class singleton.

UUIDGenerator::generate() — Method in class UUIDGenerator

Generate a unique identifier for a model.

H

CreateStorageSymlinksAction::handle() — Method in class CreateStorageSymlinksAction
RemoveStorageSymlinksAction::handle() — Method in class RemoveStorageSymlinksAction
ClearPendingTenants::handle() — Method in class ClearPendingTenants
CreatePendingTenants::handle() — Method in class CreatePendingTenants
Down::handle() — Method in class Down
Install::handle() — Method in class Install
Link::handle() — Method in class Link
Migrate::handle() — Method in class Migrate
MigrateFresh::handle() — Method in class MigrateFresh
MigrateFreshOverride::handle() — Method in class MigrateFreshOverride
Rollback::handle() — Method in class Rollback
Run::handle() — Method in class Run
Seed::handle() — Method in class Seed
TenantDump::handle() — Method in class TenantDump
TenantList::handle() — Method in class TenantList
Up::handle() — Method in class Up
HasATenantArgument — Class in namespace Stancl\Tenancy\Concerns
HasTenantOptions — Class in namespace Stancl\Tenancy\Concerns

Adds 'tenants' and 'with-pending' options.

HasDatabase — Class in namespace Stancl\Tenancy\Database\Concerns
HasDomains — Class in namespace Stancl\Tenancy\Database\Concerns
HasInternalKeys — Class in namespace Stancl\Tenancy\Database\Concerns
HasPending — Class in namespace Stancl\Tenancy\Database\Concerns
HasScopedValidationRules — Class in namespace Stancl\Tenancy\Database\Concerns
DatabaseConfig::hostConnection() — Method in class DatabaseConfig

Tenant's host database connection config.

ClearPendingTenants::handle() — Method in class ClearPendingTenants
CreateDatabase::handle() — Method in class CreateDatabase
CreatePendingTenants::handle() — Method in class CreatePendingTenants
CreateStorageSymlinks::handle() — Method in class CreateStorageSymlinks
DeleteDatabase::handle() — Method in class DeleteDatabase
DeleteDomains::handle() — Method in class DeleteDomains
MigrateDatabase::handle() — Method in class MigrateDatabase
RemoveStorageSymlinks::handle() — Method in class RemoveStorageSymlinks

Execute the job.

SeedDatabase::handle() — Method in class SeedDatabase
BootstrapTenancy::handle() — Method in class BootstrapTenancy
CreateTenantConnection::handle() — Method in class CreateTenantConnection
CreateTenantStorage::handle() — Method in class CreateTenantStorage
DeleteTenantStorage::handle() — Method in class DeleteTenantStorage
QueueableListener::handle() — Method in class QueueableListener
RevertToCentralContext::handle() — Method in class RevertToCentralContext
UpdateSyncedResource::handle() — Method in class UpdateSyncedResource
UseCentralConnection::handle() — Method in class UseCentralConnection
UseTenantConnection::handle() — Method in class UseTenantConnection
CheckTenantForMaintenanceMode::handle() — Method in class CheckTenantForMaintenanceMode
InitializeTenancyByDomain::handle() — Method in class InitializeTenancyByDomain
InitializeTenancyByDomainOrSubdomain::handle() — Method in class InitializeTenancyByDomainOrSubdomain
InitializeTenancyByPath::handle() — Method in class InitializeTenancyByPath
$ InitializeTenancyByRequestData#header — Property in class InitializeTenancyByRequestData
InitializeTenancyByRequestData::handle() — Method in class InitializeTenancyByRequestData
InitializeTenancyBySubdomain::handle() — Method in class InitializeTenancyBySubdomain
PreventAccessFromUnwantedDomains::handle() — Method in class PreventAccessFromUnwantedDomains
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.

HasPending::initializeHasPending() — Method in class HasPending

Initialize the trait.

InitializationHelpers — Class in namespace Stancl\Tenancy\Database\Concerns
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.

TenantWithDatabase::internalPrefix() — Method in class TenantWithDatabase

Get the internal prefix.

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
PermissionControlledMySQLDatabaseManager::isVersion8() — Method in class PermissionControlledMySQLDatabaseManager
InitializingTenancy — Class in namespace Stancl\Tenancy\Events
UserImpersonation::isImpersonating() — Method in class UserImpersonation
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

Is tenancy fully initialized?

Tenancy::initialize() — Method in class Tenancy

Initialize tenancy for the passed tenant.

L

Link — Class in namespace Stancl\Tenancy\Commands
InitializationHelpers::leave() — Method in class InitializationHelpers
UserImpersonation::leave() — Method in class UserImpersonation

Logout from the current domain and forget impersonation session.

M

$ BroadcastTenancyBootstrapper#mapPresets — Property in class BroadcastTenancyBootstrapper
MailTenancyBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers
$ MailTenancyBootstrapper#mailer — Property in class MailTenancyBootstrapper
$ MailTenancyBootstrapper#mapPresets — Property in class MailTenancyBootstrapper
Migrate — Class in namespace Stancl\Tenancy\Commands
MigrateFresh — Class in namespace Stancl\Tenancy\Commands
MigrateFreshOverride — Class in namespace Stancl\Tenancy\Commands
$ TenantCannotBeCreatedException#message — Property in class TenantCannotBeCreatedException
MaintenanceMode — Class in namespace Stancl\Tenancy\Database\Concerns
ManagesDatabaseUsers — Class in namespace Stancl\Tenancy\Database\Contracts
TenantDatabaseManager::makeConnectionConfig() — Method in class TenantDatabaseManager

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

$ Tenant#modelsShouldPreventAccessingMissingAttributes — Property in class Tenant
MicrosoftSQLDatabaseManager — Class in namespace Stancl\Tenancy\Database\TenantDatabaseManagers
MySQLDatabaseManager — Class in namespace Stancl\Tenancy\Database\TenantDatabaseManagers
PostgreSQLSchemaManager::makeConnectionConfig() — Method in class PostgreSQLSchemaManager

Construct a DB connection config array.

SQLiteDatabaseManager::makeConnectionConfig() — Method in class SQLiteDatabaseManager

Construct a DB connection config array.

TenantDatabaseManager::makeConnectionConfig() — Method in class TenantDatabaseManager

Construct a DB connection config array.

MigratingDatabase — Class in namespace Stancl\Tenancy\Events
$ SyncedResourceChangedInForeignDatabase#model — Property in class SyncedResourceChangedInForeignDatabase
ModelNotSyncMasterException — Class in namespace Stancl\Tenancy\Exceptions
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
Tenancy::middleware() — Method in class Tenancy

Tenant identification middleware used by the package.

N

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

O

$ BroadcastTenancyBootstrapper#originalConfig — Property in class BroadcastTenancyBootstrapper
$ BroadcastTenancyBootstrapper#originalBroadcastManager — Property in class BroadcastTenancyBootstrapper
$ BroadcastTenancyBootstrapper#originalBroadcaster — Property in class BroadcastTenancyBootstrapper
$ CacheTagsBootstrapper#originalCache — Property in class CacheTagsBootstrapper
$ FilesystemTenancyBootstrapper#originalPaths — Property in class FilesystemTenancyBootstrapper
$ ScoutTenancyBootstrapper#originalScoutPrefix — Property in class ScoutTenancyBootstrapper
$ MailTenancyBootstrapper#originalConfig — Property in class MailTenancyBootstrapper
$ PrefixCacheTenancyBootstrapper#originalPrefix — Property in class PrefixCacheTenancyBootstrapper
$ RedisTenancyBootstrapper#originalPrefixes — Property in class RedisTenancyBootstrapper
$ UrlTenancyBootstrapper#originalRootUrl — Property in class UrlTenancyBootstrapper
HasPending::onlyPending() — Method in class HasPending
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

$ BatchTenancyBootstrapper#previousConnection — Property in class BatchTenancyBootstrapper

The previous database connection instance.

PrefixCacheTenancyBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers
$ PrefixCacheTenancyBootstrapper#prefixGenerator — Property in class PrefixCacheTenancyBootstrapper
RedisTenancyBootstrapper::prefixedConnections() — Method in class RedisTenancyBootstrapper
DealsWithTenantSymlinks::possibleTenantSymlinks() — Method in class DealsWithTenantSymlinks

Get all possible tenant symlinks, existing or not (array of ['public path' => 'storage path']).

$ HasPending#pending_since — Property in class HasPending
HasPending::pending() — Method in class HasPending

Determine if the model instance is in a pending state.

HasPending::pullPending() — Method in class HasPending

Pull a pending tenant.

HasPending::pullPendingFromPool() — Method in class HasPending

Try to pull a tenant from the pool of pending tenants.

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

Database password generator (can be set by the developer.)

DatabaseConfig::purgeHostConnection() — Method in class DatabaseConfig

Purge host database connection.

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
PermissionControlledMySQLDatabaseManager — Class in namespace Stancl\Tenancy\Database\TenantDatabaseManagers
PostgreSQLDatabaseManager — Class in namespace Stancl\Tenancy\Database\TenantDatabaseManagers
PostgreSQLSchemaManager — Class in namespace Stancl\Tenancy\Database\TenantDatabaseManagers
$ SQLiteDatabaseManager#path — Property in class SQLiteDatabaseManager

SQLite Database path without ending slash.

PendingTenantCreated — Class in namespace Stancl\Tenancy\Events
PendingTenantPulled — Class in namespace Stancl\Tenancy\Events
PullingPendingTenant — Class in namespace Stancl\Tenancy\Events
PreventAccessFromUnwantedDomains — Class in namespace Stancl\Tenancy\Middleware
PathTenantResolver — Class in namespace Stancl\Tenancy\Resolvers
TenancyBroadcastManager::passChannelsFromOriginalBroadcaster() — Method in class TenancyBroadcastManager

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

RemoveStorageSymlinksAction — Class in namespace Stancl\Tenancy\Actions
RemoveStorageSymlinksAction::removeLink() — Method in class RemoveStorageSymlinksAction
BatchTenancyBootstrapper::revert() — Method in class BatchTenancyBootstrapper
BroadcastTenancyBootstrapper::revert() — Method in class BroadcastTenancyBootstrapper
CacheTagsBootstrapper::revert() — Method in class CacheTagsBootstrapper
CacheTagsBootstrapper::resetFacadeCache() — Method in class CacheTagsBootstrapper

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
ScoutTenancyBootstrapper::revert() — Method in class ScoutTenancyBootstrapper
MailTenancyBootstrapper::revert() — Method in class MailTenancyBootstrapper
PrefixCacheTenancyBootstrapper::revert() — Method in class PrefixCacheTenancyBootstrapper
PrefixCacheTenancyBootstrapper::refreshStore() — Method in class PrefixCacheTenancyBootstrapper

Refresh cache driver's store.

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
SessionTenancyBootstrapper::revert() — Method in class SessionTenancyBootstrapper
SessionTenancyBootstrapper::resetDatabaseHandler() — Method in class SessionTenancyBootstrapper
$ UrlTenancyBootstrapper#rootUrlOverride — Property in class UrlTenancyBootstrapper
UrlTenancyBootstrapper::revert() — Method in class UrlTenancyBootstrapper
Link::removeLinks() — Method in class Link
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.

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.

TenantDatabaseAlreadyExistsException::reason() — Method in class TenantDatabaseAlreadyExistsException
TenantDatabaseUserAlreadyExistsException::reason() — Method in class TenantDatabaseUserAlreadyExistsException
$ ImpersonationToken#redirect_url — Property in class ImpersonationToken
$ ImpersonationToken#remember — Property in class ImpersonationToken
TenantCollection::runForEach() — Method in class TenantCollection
RemovingStorageSymlink — Class in namespace Stancl\Tenancy\Events
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
RemoveStorageSymlinks — Class in namespace Stancl\Tenancy\Jobs
RevertToCentralContext — Class in namespace Stancl\Tenancy\Listeners
$ IdentificationMiddleware#resolver — Property in class IdentificationMiddleware
InitializeTenancyByPath::route() — Method in class InitializeTenancyByPath
PreventAccessFromUnwantedDomains::routeHasMiddleware() — Method in class PreventAccessFromUnwantedDomains
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

S

BroadcastTenancyBootstrapper::setConfig() — Method in class BroadcastTenancyBootstrapper
ScoutTenancyBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers\Integrations
MailTenancyBootstrapper::setConfig() — Method in class MailTenancyBootstrapper
PrefixCacheTenancyBootstrapper::setCachePrefix() — Method in class PrefixCacheTenancyBootstrapper
QueueTenancyBootstrapper::setUpJobListener() — Method in class QueueTenancyBootstrapper
QueueTenancyBootstrapper::setUpPayloadGenerator() — Method in class QueueTenancyBootstrapper
SessionTenancyBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers

This resets the database connection used by the database session driver.

$ ClearPendingTenants#signature — Property in class ClearPendingTenants
$ CreatePendingTenants#signature — Property in class CreatePendingTenants
$ Down#signature — Property in class Down
$ Install#signature — Property in class Install
Install::step() — Method in class Install

Run a step of the installation process.

$ Link#signature — Property in class Link
$ Run#signature — Property in class Run
Seed — Class in namespace Stancl\Tenancy\Commands
$ TenantList#signature — Property in class TenantList
$ Up#signature — Property in class Up
DealsWithTenantSymlinks::symlinkExists() — Method in class DealsWithTenantSymlinks

Determine if the provided path is an existing symlink.

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

Set the value of an internal key.

$ TenantCouldNotBeIdentifiedException#solutionTitle — Property in class TenantCouldNotBeIdentifiedException

Default solution title.

$ TenantCouldNotBeIdentifiedException#solutionDescription — Property in class TenantCouldNotBeIdentifiedException

Default solution description.

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

Set internal key.

ResourceSyncing::shouldSync() — Method in class ResourceSyncing
StatefulTenantDatabaseManager — Class in namespace Stancl\Tenancy\Database\Contracts

Tenant database manager with a persistent connection.

StatefulTenantDatabaseManager::setConnection() — Method in class StatefulTenantDatabaseManager

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

TenantWithDatabase::setInternal() — Method in class TenantWithDatabase

Set internal key.

DatabaseManager::setDefaultConnection() — Method in class DatabaseManager

Change the default database connection config.

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

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

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
StorageSymlinkCreated — Class in namespace Stancl\Tenancy\Events
StorageSymlinkRemoved — Class in namespace Stancl\Tenancy\Events
SyncedResourceChangedInForeignDatabase — Class in namespace Stancl\Tenancy\Events
SyncedResourceSaved — Class in namespace Stancl\Tenancy\Events
StatefulGuardRequiredException — Class in namespace Stancl\Tenancy\Exceptions
$ 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
InitializeTenancyByPath::setDefaultTenantForRouteParametersWhenInitializingTenancy() — Method in class InitializeTenancyByPath
$ 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() — Method in class CachedTenantResolver
DomainTenantResolver::setCurrentDomain() — Method in class DomainTenantResolver
$ RequestDataTenantResolver#shouldCache — Property in class RequestDataTenantResolver

T

$ PrefixCacheTenancyBootstrapper#tenantCacheStores — Property in class PrefixCacheTenancyBootstrapper
TenantDump — Class in namespace Stancl\Tenancy\Commands
TenantList — Class in namespace Stancl\Tenancy\Commands
TenantList::tenantCLI() — Method in class TenantList

Generate the visual CLI output for the tenant name.

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
TenantCouldNotBeIdentifiedException::tenantCouldNotBeIdentified() — Method in class TenantCouldNotBeIdentifiedException

Set the message.

TenantCouldNotBeIdentifiedException::title() — Method in class TenantCouldNotBeIdentifiedException

Set the solution title.

TenantResolver — Class in namespace Stancl\Tenancy\Contracts
TenantAssetController — Class in namespace Stancl\Tenancy\Controllers
$ BelongsToTenant#tenant — Property in class BelongsToTenant
BelongsToTenant::tenant() — Method in class BelongsToTenant
ResourceSyncing::triggerSyncEvent() — Method in class ResourceSyncing
ResourceSyncing::tenants() — Method in class ResourceSyncing
TenantConnection — Class in namespace Stancl\Tenancy\Database\Concerns
TenantRun — Class in namespace Stancl\Tenancy\Database\Concerns
TriggerSyncEvent — Class in namespace Stancl\Tenancy\Database\Concerns
TenantDatabaseManager — Class in namespace Stancl\Tenancy\Database\Contracts
TenantWithDatabase — Class in namespace Stancl\Tenancy\Database\Contracts
$ DatabaseConfig#tenant — Property in class DatabaseConfig

The tenant whose database we're dealing with.

DatabaseConfig::tenantConfig() — Method in class DatabaseConfig

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

TenantDatabaseAlreadyExistsException — Class in namespace Stancl\Tenancy\Database\Exceptions
TenantDatabaseDoesNotExistException — Class in namespace Stancl\Tenancy\Database\Exceptions
TenantDatabaseUserAlreadyExistsException — Class in namespace Stancl\Tenancy\Database\Exceptions
$ 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
$ ImpersonationToken#token — Property in class ImpersonationToken
$ ImpersonationToken#tenant_id — Property in class ImpersonationToken
Tenant — Class in namespace Stancl\Tenancy\Database\Models
$ Tenant#table — Property in class Tenant
TenantMorphPivot — Class in namespace Stancl\Tenancy\Database\Models
TenantPivot — Class in namespace Stancl\Tenancy\Database\Models
TenantCollection — Class in namespace Stancl\Tenancy\Database
TenantCollection::toArray() — Method in class TenantCollection
TenantDatabaseManager — Class in namespace Stancl\Tenancy\Database\TenantDatabaseManagers
TenantScope — Class in namespace Stancl\Tenancy\Database
TenancyEvent — Class in namespace Stancl\Tenancy\Events\Contracts
TenantEvent — Class in namespace Stancl\Tenancy\Events\Contracts
$ TenantEvent#tenant — Property in class TenantEvent
$ SyncedResourceChangedInForeignDatabase#tenant — Property in class SyncedResourceChangedInForeignDatabase
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
TenantMaintenanceModeDisabled — Class in namespace Stancl\Tenancy\Events
TenantMaintenanceModeEnabled — 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
TenantCouldNotBeIdentifiedByIdException — 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
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

The lifespan of impersonation tokens (in seconds).

$ DeleteDomains#tenant — Property in class DeleteDomains
$ RemoveStorageSymlinks#tenant — Property in class RemoveStorageSymlinks
$ IdentificationMiddleware#tenancy — Property in class IdentificationMiddleware
$ ScopeSessions#tenantIdKey — Property in class ScopeSessions
PathTenantResolver::tenantParameterName() — Method in class PathTenantResolver
Tenancy — Class in namespace Stancl\Tenancy
$ Tenancy#tenant — Property in class Tenancy

The current tenant.

Tenancy::tenantKeyColumn() — Method in class Tenancy

Name of the column used to relate models to tenants.

TenancyBroadcastManager — Class in namespace Stancl\Tenancy
$ TenancyBroadcastManager#tenantBroadcasters — Property in class TenancyBroadcastManager

Names of broadcasters to always recreate using $this->resolve() (even when they're cached and available in the $broadcasters property).

TenancyServiceProvider — Class in namespace Stancl\Tenancy

U

BroadcastTenancyBootstrapper::unsetConfig() — Method in class BroadcastTenancyBootstrapper
MailTenancyBootstrapper::unsetConfig() — Method in class MailTenancyBootstrapper
UrlTenancyBootstrapper — Class in namespace Stancl\Tenancy\Bootstrappers
Up — Class in namespace Stancl\Tenancy\Commands
UniqueIdentifierGenerator — Class in namespace Stancl\Tenancy\Contracts
HasScopedValidationRules::unique() — Method in class HasScopedValidationRules
ManagesDatabaseUsers::userExists() — Method in class ManagesDatabaseUsers

Does a database user exist?

$ DatabaseConfig#usernameGenerator — Property in class DatabaseConfig

Database username generator (can be set by the developer.)

$ ImpersonationToken#user_id — Property in class ImpersonationToken
$ Tenant#updated_at — Property in class Tenant
PermissionControlledMySQLDatabaseManager::userExists() — Method in class PermissionControlledMySQLDatabaseManager

Does a database user exist?

UpdatingDomain — Class in namespace Stancl\Tenancy\Events
UpdatingTenant — Class in namespace Stancl\Tenancy\Events
TenantConfig::unsetTenantConfig() — Method in class TenantConfig
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
UseCentralConnection — Class in namespace Stancl\Tenancy\Listeners
UseTenantConnection — Class in namespace Stancl\Tenancy\Listeners
UUIDGenerator — Class in namespace Stancl\Tenancy

V

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

W

HasPending::withPending() — Method in class HasPending
HasPending::withoutPending() — Method in class HasPending

_

BatchTenancyBootstrapper::__construct() — Method in class BatchTenancyBootstrapper
BroadcastTenancyBootstrapper::__construct() — Method in class BroadcastTenancyBootstrapper
CacheTagsBootstrapper::__construct() — Method in class CacheTagsBootstrapper
DatabaseTenancyBootstrapper::__construct() — Method in class DatabaseTenancyBootstrapper
FilesystemTenancyBootstrapper::__construct() — Method in class FilesystemTenancyBootstrapper
ScoutTenancyBootstrapper::__construct() — Method in class ScoutTenancyBootstrapper
MailTenancyBootstrapper::__construct() — Method in class MailTenancyBootstrapper
PrefixCacheTenancyBootstrapper::__construct() — Method in class PrefixCacheTenancyBootstrapper
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
SessionTenancyBootstrapper::__construct() — Method in class SessionTenancyBootstrapper
UrlTenancyBootstrapper::__construct() — Method in class UrlTenancyBootstrapper
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
Seed::__construct() — Method in class Seed
TenantDump::__construct() — Method in class TenantDump
HasATenantArgument::__construct() — Method in class HasATenantArgument
HasTenantOptions::__construct() — Method in class HasTenantOptions
Domain::__call() — Method in class Domain

IDE support. This will be a model. // todo check if we can remove these now

Domain::__callStatic() — Method in class Domain

IDE support. This will be a model.

TenantCannotBeCreatedException::__construct() — Method in class TenantCannotBeCreatedException
TenantAssetController::__construct() — Method in class TenantAssetController
DatabaseConfig::__constructStatic() — Method in class DatabaseConfig
DatabaseConfig::__construct() — Method in class DatabaseConfig
DatabaseManager::__construct() — Method in class DatabaseManager
DatabaseManagerNotRegisteredException::__construct() — Method in class DatabaseManagerNotRegisteredException
NoConnectionSetException::__construct() — Method in class NoConnectionSetException
TenantDatabaseAlreadyExistsException::__construct() — Method in class TenantDatabaseAlreadyExistsException
TenantDatabaseDoesNotExistException::__construct() — Method in class TenantDatabaseDoesNotExistException
TenantDatabaseUserAlreadyExistsException::__construct() — Method in class TenantDatabaseUserAlreadyExistsException
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
DomainOccupiedByOtherTenantException::__construct() — Method in class DomainOccupiedByOtherTenantException
ModelNotSyncMasterException::__construct() — Method in class ModelNotSyncMasterException
NotASubdomainException::__construct() — Method in class NotASubdomainException
RouteIsMissingTenantParameterException::__construct() — Method in class RouteIsMissingTenantParameterException
StatefulGuardRequiredException::__construct() — Method in class StatefulGuardRequiredException
TenancyNotInitializedException::__construct() — Method in class TenancyNotInitializedException
TenantCouldNotBeIdentifiedByIdException::__construct() — Method in class TenantCouldNotBeIdentifiedByIdException
TenantCouldNotBeIdentifiedByPathException::__construct() — Method in class TenantCouldNotBeIdentifiedByPathException
TenantCouldNotBeIdentifiedByRequestDataException::__construct() — Method in class TenantCouldNotBeIdentifiedByRequestDataException
TenantCouldNotBeIdentifiedOnDomainException::__construct() — Method in class TenantCouldNotBeIdentifiedOnDomainException
TenantConfig::__construct() — Method in class TenantConfig
ViteBundler::__construct() — Method in class ViteBundler
CreateDatabase::__construct() — Method in class CreateDatabase
CreateStorageSymlinks::__construct() — Method in class CreateStorageSymlinks
DeleteDatabase::__construct() — Method in class DeleteDatabase
DeleteDomains::__construct() — Method in class DeleteDomains
MigrateDatabase::__construct() — Method in class MigrateDatabase
RemoveStorageSymlinks::__construct() — Method in class RemoveStorageSymlinks

Create a new job instance.

SeedDatabase::__construct() — Method in class SeedDatabase
CreateTenantConnection::__construct() — Method in class CreateTenantConnection
UseCentralConnection::__construct() — Method in class UseCentralConnection
UseTenantConnection::__construct() — Method in class UseTenantConnection
InitializeTenancyByDomain::__construct() — Method in class InitializeTenancyByDomain
InitializeTenancyByPath::__construct() — Method in class InitializeTenancyByPath
InitializeTenancyByRequestData::__construct() — Method in class InitializeTenancyByRequestData
CachedTenantResolver::__construct() — Method in class CachedTenantResolver