A

TenantAssetsController::asset() — Method in class TenantAssetsController
$ TenantManager#app — Property in class TenantManager

The application instance.

TenantManager::all() — Method in class TenantManager

Get all tenants.

B

TenancyServiceProvider::boot() — Method in class TenancyServiceProvider

Bootstrap services.

BootstrapsTenancy — Class in namespace Stancl\Tenancy\Traits
BootstrapsTenancy::bootstrap() — Method in class BootstrapsTenancy
TenantManagerEvents::bootstrapping() — Method in class TenantManagerEvents

Register a listener that will be executed before tenancy is bootstrapped.

TenantManagerEvents::bootstrapped() — Method in class TenantManagerEvents

Register a listener that will be executed after tenancy is bootstrapped.

C

CacheManager — Class in namespace Stancl\Tenancy
DatabaseManager::connect() — Method in class DatabaseManager
DatabaseManager::connectToTenant() — Method in class DatabaseManager
DatabaseManager::create() — Method in class DatabaseManager

Create a database.

DatabaseManager::createTenantConnection() — Method in class DatabaseManager
CannotChangeUuidOrDomainException — Class in namespace Stancl\Tenancy\Exceptions
StorageDriver::createTenant() — Method in class StorageDriver
TenantDatabaseManager::createDatabase() — Method in class TenantDatabaseManager

Create a database.

DatabaseStorageDriver::createTenant() — Method in class DatabaseStorageDriver
RedisStorageDriver::createTenant() — Method in class RedisStorageDriver
Tenant::customColumns() — Method in class Tenant
MySQLDatabaseManager::createDatabase() — Method in class MySQLDatabaseManager

Create a database.

PostgreSQLDatabaseManager::createDatabase() — Method in class PostgreSQLDatabaseManager

Create a database.

SQLiteDatabaseManager::createDatabase() — Method in class SQLiteDatabaseManager

Create a database.

TenantManager::create() — Method in class TenantManager

Create a tenant.

TenantManager::currentDomain() — Method in class TenantManager

D

$ Install#description — Property in class Install

The console command description.

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

The console command description.

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

The console command description.

$ Run#description — Property in class Run

The console command description.

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

The console command description.

$ TenantList#description — Property in class TenantList

The console command description.

DatabaseManager — Class in namespace Stancl\Tenancy
$ DatabaseManager#defaultTenantConnectionName — Property in class DatabaseManager
DatabaseManager::disconnect() — Method in class DatabaseManager
DatabaseManager::delete() — Method in class DatabaseManager

Delete a database.

DatabaseManagerNotRegisteredException — Class in namespace Stancl\Tenancy\Exceptions
StorageDriver::deleteTenant() — Method in class StorageDriver
TenantDatabaseManager::deleteDatabase() — Method in class TenantDatabaseManager

Delete a database.

$ QueuedTenantDatabaseCreator#databaseManager — Property in class QueuedTenantDatabaseCreator
$ QueuedTenantDatabaseCreator#databaseName — Property in class QueuedTenantDatabaseCreator
$ QueuedTenantDatabaseDeleter#databaseManager — Property in class QueuedTenantDatabaseDeleter
$ QueuedTenantDatabaseDeleter#databaseName — Property in class QueuedTenantDatabaseDeleter
DatabaseStorageDriver — Class in namespace Stancl\Tenancy\StorageDrivers
DatabaseStorageDriver::deleteTenant() — Method in class DatabaseStorageDriver
RedisStorageDriver::deleteTenant() — Method in class RedisStorageDriver
Tenant::dataColumn() — Method in class Tenant
Tenant::decoded() — Method in class Tenant
Tenant::decodeData() — Method in class Tenant

Return a tenant array with data decoded into separate keys.

MySQLDatabaseManager::deleteDatabase() — Method in class MySQLDatabaseManager

Delete a database.

PostgreSQLDatabaseManager::deleteDatabase() — Method in class PostgreSQLDatabaseManager

Delete a database.

SQLiteDatabaseManager::deleteDatabase() — Method in class SQLiteDatabaseManager

Delete a database.

$ TenantManager#database — Property in class TenantManager

Database manager.

TenantManager::delete() — Method in class TenantManager
TenantManager::disconnectDatabase() — Method in class TenantManager

Reconnects to the default database.

DealsWithMigrations — Class in namespace Stancl\Tenancy\Traits

E

BootstrapsTenancy::end() — Method in class BootstrapsTenancy
TenantManagerEvents::ending() — Method in class TenantManagerEvents

Register a listener that will be executed before tenancy is ended.

TenantManagerEvents::ended() — Method in class TenantManagerEvents

Register a listener that will be executed after tenancy is ended.

TenantManagerEvents::event() — Method in class TenantManagerEvents

Fire an event.

F

TenantManager::find() — Method in class TenantManager

Alias for getTenantById().

TenantManager::findByDomain() — Method in class TenantManager

Get tenant information based on his domain.

G

DatabaseManager::getDriver() — Method in class DatabaseManager
GlobalCacheFacade — Class in namespace Stancl\Tenancy
GlobalCacheFacade::getFacadeAccessor() — Method in class GlobalCacheFacade
StorageDriver::getAllTenants() — Method in class StorageDriver
StorageDriver::getTenantById() — Method in class StorageDriver
StorageDriver::getTenantIdByDomain() — Method in class StorageDriver
StorageDriver::get() — Method in class StorageDriver
StorageDriver::getMany() — Method in class StorageDriver
DatabaseStorageDriver::getTenantById() — Method in class DatabaseStorageDriver

Get information about the tenant based on his uuid.

DatabaseStorageDriver::getTenantIdByDomain() — Method in class DatabaseStorageDriver
DatabaseStorageDriver::getAllTenants() — Method in class DatabaseStorageDriver
DatabaseStorageDriver::get() — Method in class DatabaseStorageDriver
DatabaseStorageDriver::getMany() — Method in class DatabaseStorageDriver
RedisStorageDriver::getTenantById() — Method in class RedisStorageDriver

Get information about the tenant based on his uuid.

RedisStorageDriver::getTenantIdByDomain() — Method in class RedisStorageDriver
RedisStorageDriver::getAllTenants() — Method in class RedisStorageDriver
RedisStorageDriver::get() — Method in class RedisStorageDriver
RedisStorageDriver::getMany() — Method in class RedisStorageDriver
TenancyFacade::getFacadeAccessor() — Method in class TenancyFacade
$ Tenant#guarded — Property in class Tenant
Tenant::getConnectionName() — Method in class Tenant
Tenant::getAllTenants() — Method in class Tenant
Tenant::getFromData() — Method in class Tenant
Tenant::get() — Method in class Tenant
Tenant::getMany() — Method in class Tenant
$ TenantManager#generator — Property in class TenantManager

Unique identifier generator.

TenantManager::generateUniqueIdentifier() — Method in class TenantManager
TenantManager::getTenantById() — Method in class TenantManager

Return an array with information about a tenant based on his uuid.

TenantManager::getTenantIdByDomain() — Method in class TenantManager

Get tenant uuid based on the domain that belongs to him.

TenantManager::getIdByDomain() — Method in class TenantManager

Alias for getTenantIdByDomain().

TenantManager::getDatabaseName() — Method in class TenantManager
TenantManager::get() — Method in class TenantManager

Get a value from the storage for a tenant.

DealsWithMigrations::getMigrationPaths() — Method in class DealsWithMigrations
HasATenantsOption::getOptions() — Method in class HasATenantsOption

H

Install::handle() — Method in class Install

Execute the console command.

Migrate::handle() — Method in class Migrate

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.

UniqueIdentifierGenerator::handle() — Method in class UniqueIdentifierGenerator

Generate a unique identifier.

QueuedTenantDatabaseCreator::handle() — Method in class QueuedTenantDatabaseCreator

Execute the job.

QueuedTenantDatabaseDeleter::handle() — Method in class QueuedTenantDatabaseDeleter

Execute the job.

InitializeTenancy::handle() — Method in class InitializeTenancy

Handle an incoming request.

PreventAccessFromTenantDomains::handle() — Method in class PreventAccessFromTenantDomains

Handle an incoming request.

HasATenantsOption — Class in namespace Stancl\Tenancy\Traits
UUIDGenerator::handle() — Method in class UUIDGenerator

Generate a unique identifier.

I

Install — Class in namespace Stancl\Tenancy\Commands
StorageDriver::identifyTenant() — Method in class StorageDriver
InitializeTenancy — Class in namespace Stancl\Tenancy\Middleware
DatabaseStorageDriver::identifyTenant() — Method in class DatabaseStorageDriver
RedisStorageDriver::identifyTenant() — Method in class RedisStorageDriver
$ Tenant#incrementing — Property in class Tenant
TenantManager::init() — Method in class TenantManager
TenantManager::identify() — Method in class TenantManager
TenantManager::initById() — Method in class TenantManager

Initialize tenancy based on tenant uuid.

$ BootstrapsTenancy#initialized — Property in class BootstrapsTenancy

Was tenancy initialized/bootstrapped?

$ TenantManagerEvents#integrationListeners — Property in class TenantManagerEvents

Integration listeners.

TenantManagerEvents::integrationEvent() — Method in class TenantManagerEvents

Register a callback for an integration event.

TenantManagerEvents::integration() — Method in class TenantManagerEvents

Return callbacks for an integration event.

J

TenantManager::jsonDecodeArrayValues() — Method in class TenantManager

L

$ TenantManagerEvents#listeners — Property in class TenantManagerEvents

Event listeners.

M

Migrate — Class in namespace Stancl\Tenancy\Commands
$ CannotChangeUuidOrDomainException#message — Property in class CannotChangeUuidOrDomainException
$ PhpRedisNotInstalledException#message — Property in class PhpRedisNotInstalledException
TenancyServiceProvider::makeQueuesTenantAware() — Method in class TenancyServiceProvider
MySQLDatabaseManager — Class in namespace Stancl\Tenancy\TenantDatabaseManagers
TenantRouteServiceProvider::map() — Method in class TenantRouteServiceProvider

O

$ DatabaseManager#originalDefaultConnection — Property in class DatabaseManager
$ BootstrapsTenancy#originalSettings — Property in class BootstrapsTenancy

P

PhpRedisNotInstalledException — Class in namespace Stancl\Tenancy\Exceptions
StorageDriver::put() — Method in class StorageDriver
StorageDriver::putMany() — Method in class StorageDriver
PreventAccessFromTenantDomains — Class in namespace Stancl\Tenancy\Middleware
DatabaseStorageDriver::put() — Method in class DatabaseStorageDriver
DatabaseStorageDriver::putMany() — Method in class DatabaseStorageDriver
RedisStorageDriver::put() — Method in class RedisStorageDriver
RedisStorageDriver::putMany() — Method in class RedisStorageDriver
$ Tenant#primaryKey — Property in class Tenant
Tenant::put() — Method in class Tenant
PostgreSQLDatabaseManager — Class in namespace Stancl\Tenancy\TenantDatabaseManagers
TenantManager::put() — Method in class TenantManager

Puts a value into the storage for a tenant.

Q

QueuedTenantDatabaseCreator — Class in namespace Stancl\Tenancy\Jobs
QueuedTenantDatabaseDeleter — Class in namespace Stancl\Tenancy\Jobs

R

Rollback — Class in namespace Stancl\Tenancy\Commands
Run — Class in namespace Stancl\Tenancy\Commands
RedisStorageDriver — Class in namespace Stancl\Tenancy\StorageDrivers
TenancyServiceProvider::registerTenantRedirectMacro() — Method in class TenancyServiceProvider
TenancyServiceProvider::register() — Method in class TenancyServiceProvider

Register services.

BootstrapsTenancy::resetPhpRedisPrefix() — Method in class BootstrapsTenancy
BootstrapsTenancy::resetFilesystemRootPaths() — Method in class BootstrapsTenancy

S

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

StorageDriver — Class in namespace Stancl\Tenancy\Interfaces
TenancyServiceProvider::setTelescopeTags() — Method in class TenancyServiceProvider
SQLiteDatabaseManager — Class in namespace Stancl\Tenancy\TenantDatabaseManagers
$ TenantManager#storage — Property in class TenantManager

Storage driver for tenant metadata.

TenantManager::setTenant() — Method in class TenantManager

Set the tenant property to a JSON decoded version of the tenant's data obtained from storage.

TenantManager::set() — Method in class TenantManager

Alias for put().

BootstrapsTenancy::switchDatabaseConnection() — Method in class BootstrapsTenancy
BootstrapsTenancy::setPhpRedisPrefix() — Method in class BootstrapsTenancy
BootstrapsTenancy::suffixFilesystemRootPaths() — Method in class BootstrapsTenancy

T

TenantList — Class in namespace Stancl\Tenancy\Commands
TenantAssetsController — Class in namespace Stancl\Tenancy\Controllers
TenantCouldNotBeIdentifiedException — Class in namespace Stancl\Tenancy\Exceptions
TenantDatabaseManager — Class in namespace Stancl\Tenancy\Interfaces
TenancyFacade — Class in namespace Stancl\Tenancy
TenancyServiceProvider — Class in namespace Stancl\Tenancy
Tenant — Class in namespace Stancl\Tenancy
$ Tenant#timestamps — Property in class Tenant
TenantManager — Class in namespace Stancl\Tenancy
$ TenantManager#tenant — Property in class TenantManager

Current tenant.

TenantRouteServiceProvider — Class in namespace Stancl\Tenancy
BootstrapsTenancy::tagCache() — Method in class BootstrapsTenancy
TenantManagerEvents — Class in namespace Stancl\Tenancy\Traits

U

DatabaseManager::useConnection() — Method in class DatabaseManager
UniqueIdentifierGenerator — Class in namespace Stancl\Tenancy\Interfaces
$ DatabaseStorageDriver#useJson — Property in class DatabaseStorageDriver
TenantManager::useJson() — Method in class TenantManager
BootstrapsTenancy::untagCache() — Method in class BootstrapsTenancy
UUIDGenerator — Class in namespace Stancl\Tenancy

_

CacheManager::__call() — Method in class CacheManager
Migrate::__construct() — Method in class Migrate

Create a new command instance.

Rollback::__construct() — Method in class Rollback

Create a new command instance.

Seed::__construct() — Method in class Seed

Create a new command instance.

TenantAssetsController::__construct() — Method in class TenantAssetsController
DatabaseManager::__construct() — Method in class DatabaseManager
DatabaseManagerNotRegisteredException::__construct() — Method in class DatabaseManagerNotRegisteredException
TenantCouldNotBeIdentifiedException::__construct() — Method in class TenantCouldNotBeIdentifiedException
QueuedTenantDatabaseCreator::__construct() — Method in class QueuedTenantDatabaseCreator

Create a new job instance.

QueuedTenantDatabaseDeleter::__construct() — Method in class QueuedTenantDatabaseDeleter

Create a new job instance.

InitializeTenancy::__construct() — Method in class InitializeTenancy
RedisStorageDriver::__construct() — Method in class RedisStorageDriver
TenantManager::__construct() — Method in class TenantManager
TenantManager::__invoke() — Method in class TenantManager

Return the identified tenant's attribute(s).