This plugin extends cakedc/users and introduces customer accounts and ability to scope application tables by specific customers (tenants).
For CakePHP 3, see (now archived) pronique/multitenant.
Read more about Multitenancy: en.wikipedia.org/wiki/Multitenancy.
Require this plugin using composer:
composer require bakeoff/multitenancy
Create required tables:
bin/cake migrations migrate -p Multitenancy
In your application's src/Application.php:
$this->addPlugin(\Bakeoff\Multitenancy\Plugin::class);
Add this Behavior to the tables where records belong to an account. (Table needs to have a column for account_id.)
$this->addBehavior('Bakeoff/Multitenancy.TenantScope');
Once the Behavior is added to a table, every find() call to that table will include a condition for account_id. The account it will be looking for needs to be in a user session: either set directly by user, or automatically by just looking up the last accessed account for that user.
Direct your users to \Cake\Routing\Router::url(['_name' => 'Bakeoff/Multitenancy:ChooseAccount']) where they can choose an existing accout or create a new one.
Use <?= $this->element('Bakeoff/Multitenancy.account') ?> in your view templates to display current account or link to the Choose Account page.
If you wish to manually set a specific account to be used.
// Load the accounts table. If you're in a controller, use fetchTable()
$accountsTable = $this->fetchTable('Bakeoff/Multitenancy.Accounts');
// Select the account
$account = $accountsTable->find('all')
->leftJoinWith('Users')
->where(['Users.id' => $user->get('id')])
->orderBy('accessed DESC')
->first();
// Update last accessed timestamp
$accountsTable->setAccessedNow($account);
// Cache a copy of this account we just found to session
\Bakeoff\Multitenancy\Account::set($account);
See \Bakeoff\Multitenancy\Model\Behavior\TenantScopeBehavior::detectAccount()
In some cases you would want to stop checking the ownership for records in a specific table, and just get all entries instead. To do that, simply remove the behavior from that table.
$this->Articles->removeBehavior('TenantScope');