TenantManager
class TenantManager (View source)
| internal | Class is subject to breaking changes in minor and patch versions. |
Traits
Properties
| protected Tenant | $tenant | ||
| protected Application | $app | ||
| protected Kernel | $artisan | ||
| StorageDriver | $storage | ||
| DatabaseManager | $database | ||
| protected callable[][] | $eventListeners | ||
| bool | $initialized |
Methods
No description
Alias for Stancl\Tenancy\Tenant::create.
Find tenant by domain & initialize tenancy.
Find tenant by ID & initialize tenancy.
Find a tenant using a domain name.
No description
No description
No description
Return a list of TenancyBootstrappers.
No description
No description
No description
No description
No description
No description
Add an event listener.
Add an event hook.
Trigger an event and execute its listeners.
No description
Details
__construct(Application $app, Kernel $artisan, StorageDriver $storage, DatabaseManager $database)
No description
TenantManager
createTenant(Tenant $tenant)
Write a new tenant to storage.
TenantManager
deleteTenant(Tenant $tenant)
Delete a tenant from storage.
static Tenant
create(string|string[] $domains, array $data = [])
Alias for Stancl\Tenancy\Tenant::create.
void
ensureTenantCanBeCreated(Tenant $tenant)
Ensure that a tenant can be created.
TenantManager
updateTenant(Tenant $tenant)
Update an existing tenant in storage.
TenantManager
init(string $domain = null)
Find tenant by domain & initialize tenancy.
TenantManager
initById(string $id)
Find tenant by ID & initialize tenancy.
Tenant
find(string $id)
Find a tenant using an id.
Tenant
findByDomain(string $domain)
Find a tenant using a domain name.
Tenant
findBy(string $key, mixed $value)
Find a tenant using an arbitrary key.
Collection
all(Tenant[]|string[] $only = [])
Get all tenants.
TenantManager
initializeTenancy(Tenant $tenant)
Initialize tenancy.
TenantManager
initialize(Tenant $tenant)
No description
TenantManager
bootstrapTenancy(Tenant $tenant)
Execute TenancyBootstrappers.
TenantManager
endTenancy()
No description
TenantManager
end()
No description
Tenant|null|mixed
getTenant(string $key = null)
Get the current tenant.
protected TenantManager
setTenant(Tenant $tenant)
No description
protected TenantManager
bootstrapFeatures()
No description
array
tenancyBootstrappers(string[] $except = [])
Return a list of TenancyBootstrappers.
bool
shouldCreateDatabase(Tenant $tenant)
No description
bool
shouldMigrateAfterCreation()
No description
bool
shouldSeedAfterMigration()
No description
bool
databaseCreationQueued()
No description
bool
shouldDeleteDatabase()
No description
getSeederParameters()
No description
getMigrationParameters()
No description
TenantManager
eventListener(string $name, callable $listener)
Add an event listener.
TenantManager
hook(string $name, callable $listener)
Add an event hook.
array
event(string $name, mixed ...$args)
Trigger an event and execute its listeners.
__call($method, $parameters)
No description