Nowadays, Multi-Tenant or SaaS based applications are all over the web. Concept behind multi-tenancy is to use single code base to serve multiple clients with same functionality. Recently, we interacted with a client who was managing several schools. He wanted to keep every school separate from one another on different sub-domains with separate databases.
To achieve the required functionality, we performed the following steps:
Step 1: Database Types
We needed a main database and several other databases for each and every school. The main database was used to manage the following instances of schools:
- ID
- Name
- Domain Name
- Theme
- database_name
- database_user
- database password encoded
- Status
.
If a domain name would exist in main database and had an active status then the application would proceed normally. Database would likewise be loaded as per the provided information.
Step 2: Sub-Domains
Every sub-domain would point to the same code and same folder on Server.
Step 3: Select Database
The Database would be chosen by means of a filter (Laravel 4) or middleware (Laravel 5) contingent upon the version of Laravel framework. Every request would land on filter or middleware before reaching to any other page. To achieve this functionality, routes setup was needed.
A middleware was created where we implemented a code to check the sub-domain status if it is accessing the code (which exists in main database) or not. If the code existed in database then it would be fine or else sub-domain would be redirected to error page. The middleware example is given below:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
namespace App\Http\Middleware; use App\Sites; use Closure; class config { /** * Handle an incoming request. * * @param \Illuminate\Http\Request $request * @param \Closure $next * @return mixed */ public function handle($request, Closure $next) { $site_url = $_SERVER['SERVER_NAME']; $site = Sites::where('site_url',$site_url)->first(); $config = array(); if(!is_null($site)){ $config['id'] = $site["id"]; $config['site_url'] = $site["site_url"]; $config['theme'] = $site["theme"]; $config['host'] = $site["host"]; $config['db_name'] = $site["database"]; $config['user'] = $site["user"]; $config['password'] = $site["password"]; $config['prefix'] = $site["prefix"]; }else{ //default values $config['id'] = "0"; $config['site_url'] = "demo.local"; $config['theme'] = "theme"; $config['host'] = "localhost"; $config['db_name'] = "dbname"; $config['user'] = "username"; $config['password'] = "password"; $config['prefix'] = "tbl"; } //dd($config); // \Session::put('config', $config); \Config::set('database.connections.mysql.host', $config['host'] ); \Config::set('database.connections.mysql.database', $config['db_name'] ); \Config::set('database.connections.mysql.username', $config['user']); \Config::set('database.connections.mysql.password', $config['password']); \Config::set('database.connections.mysql.prefix', $config['prefix']); \Config::set('database.connections.mysql.theme', $config['theme']); \DB::reconnect(); return $next($request); } } |
Step 4: Update Routes
To use middle-ware, we had to update route as follows:
|
1 2 3 |
Route::group(['middleware' => 'config'],function (){ Route::get('/', ['uses' => 'HomeController@page']); }); |
Note: This route stated that if the application would try to access anything from the configured route then it would hit middleware and check if proper database was selected or not.
Conclusion:
To implement multi-tenancy functionality, the only change required is to use Middleware code in a Filter.