« vendor-patch/laravel-tenants details
Package name
vendor-patch/laravel-tenants
Description
A package to provide multi tenancy to laravel applications with minimal effort
Latest version
no stable release (released: 5 months ago)
Composer require command
Available versions
Version | Released | Reference | Size | |
---|---|---|---|---|
dev-master | 5 months ago | cae48b87d1a5a1fcd0f9097dd40d9bc6f9aa28ed | 14.23 KB |
|
Showing 1 to 1 of 1 entries
Requirements
- tenancy/db-driver-mysql: *
- tenancy/identification-driver-queue: *
- tenancy/hooks-migration: *
- tenancy/identification-driver-console: *
- tenancy/framework: *
Dev Requirements
NoneSuggestions
NoneProvides
- thisisdevelopment/laravel-tenants: *
Conflicts
NoneReplaces
NoneREADME
Laravel tenants
A package to provide easy multi tenancy in your laravel application
After a simple setup (see below) you will have a fully functional multi tenancy app which out of the box:
- allows for many-to-many relationship between your users and tenant objects.
- supports easy switching between multiple tenants for a user which has access to multiple tenants (via
x-selected-tenant
header or viaselected-tenant
cookie) - once switched by default only allows access to a single tenant object and you can easily implement tenant scoped models (see setup #4)
- allows to use tinker (or any other cli command) with a specific tenant (--tenant=
) - all jobs submitted from a context where a tenant is selected will use that tenant when executing from a queue
- when a tenant model is created the tenant database is automatically created
For an example see https://github.com/thisisdevelopment/laravel-tenants-example
Todo
- integrate with laravel-test-snapshot
- proper seed support
- support sqlite
- cleanup
- ..
Setup
To setup multi tenancy with this package you'll need the following steps
1) include this package
composer require thisisdevelopment/laravel-tenants
Tenant
contract
2) find the model which serves as tenant (eg: customer/user) and implement our use Illuminate\Database\Eloquent\Model;
use ThisIsDevelopment\LaravelTenants\Contracts\Tenant;
use ThisIsDevelopment\LaravelTenants\Traits\ProvidesTenant;
class Customer extends Model implements Tenant
{
use ProvidesTenant;
}
and register it in your AppServiceProvider
class
use Illuminate\Support\ServiceProvider;
use ThisIsDevelopment\LaravelTenants\TenantsProvider;
class AppServiceProvider extends ServiceProvider
{
public function register()
{
TenantsProvider::setup(Customer::class);
}
}
onTenantDB
trait
3) find the models which should live in tenant specific databases and use our use Illuminate\Database\Eloquent\Model;
use ThisIsDevelopment\LaravelTenants\Traits\OnTenantDB;
class Test extends Model
{
use OnTenantDB;
}
and move all of the migrations / seeders for these models to
the database/migrations/<tenant model name>
/ database/seeds/<tenant model name>
so they will only be used for tenant databases.
TenantScoped
trait
4) find the models which should be restricted once you switched to the tenant db and use our use Illuminate\Database\Eloquent\Model;
use ThisIsDevelopment\LaravelTenants\Traits\TenantScoped;
use Illuminate\Database\Eloquent\Builder;
class Settings extends Model
{
use TenantScoped;
public function scopeTenant(Builder $query, Customer $tenant): void
{
// custom filtering to limit this to what the current tenant is allowed to see
}
}
TenantAuth
interface by using the ProvidesTenantAuth
trait
5) (optional) find the model which you authenticate with and let it be responsible for providing the allowedTenants + defaultTenant by implementing the use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Support\Collection;
use ThisIsDevelopment\LaravelTenants\Contracts\TenantAuth;
use ThisIsDevelopment\LaravelTenants\Traits\ProvidesTenantAuth;
class User extends Authenticatable implements TenantAuth
{
use ProvidesTenantAuth;
public function getAllowedTenants(): ?Collection
{
return $this->customers()->get();
}
public function getDefaultTenant()
{
return $this->getAllowedTenants()->first()->id;
}
public function customers(): BelongsToMany
{
return $this->belongsToMany(Customer::class, 'customer_users', 'user_id', 'customer_id');
}
public function scopeTenant(Builder $query, Customer $tenant): void
{
$query->whereIn($this->getKeyName(), $tenant->users()->get()->pluck('id')->all());
}
}