lukapeharda/multitenancy

A single DB multitenancy package for Laravel based on subdomain routing.

MultiTenancy

Introduction

MultiTenancy is a Laravel single DB multitenancy package based on subdomain routing., _(*1)

Installation

Require this package, with Composer, in the root directory of your project., _(*2)

composer require lukapeharda/multitenancy

Add the service provider to config/app.php in the providers array., _(*3)

LukaPeharda\MultiTenancy\Providers\ContextServiceProvider::class,

Publish the config file and modify its params to fit your needs and installation., _(*4)

php artisan vendor:publish --provider="LukaPeharda\MultiTenancy\Providers\ContextServiceProvider"

Usage

Add the LukaPeharda\MultiTenancy\Scopes\Contextable trait to your models that are "tenant" dependable. This trait will automatically load global scope which will filter all your queries by defined tenant key., _(*5)

Beside adding trait to your models, your model DB schema needs to have the tenant key as its attribute (and most likely as its foreign key)., _(*6)

To disable tenant global scope use withoutGlobalScope builder method:, _(*7)

$model->withoutGlobalScope(\LukaPeharda\MultiTenancy\Scopes\TenantScope::class);

Fetching the current tenant (and all of its attributes) is available through helper function context., _(*8)

// To fetch entire tenant object
$tenant = context();

// To fetch one of its attribute
$tenantId = context('id');

License

MultiTenancy is open-sourced software licensed under the MIT license, _(*9)