tahoelimited / multi-tenancy-bundle
A multi tenancy bundle for symfony 2 apps
Installs: 1 579
Dependents: 0
Suggesters: 0
Security: 0
Stars: 25
Watchers: 5
Forks: 11
Type:symfony-bundle
Requires
- php: >=5.5
- doctrine/doctrine-bundle: ~1.2
- doctrine/orm: ~2.2,>=2.2.3
- friendsofsymfony/user-bundle: ~2.0@dev
- recurly/recurly-client: 2.3.*
- symfony/form: ~2.3
- symfony/framework-bundle: ~2.3
- symfony/security-bundle: ~2.3
- symfony/twig-bundle: ~2.3
This package is not auto-updated.
Last update: 2024-12-18 14:43:48 UTC
README
NOTE: This project is not maintained any more, and it's not compatible with Symfony 3.
Installation
Download MultiTenancyBundle using composer
Add MultiTenancy by running the command:
$ php composer.phar require "tahoelimited/multi-tenancy-bundle": "dev-master"
Composer will install the bundle to your project's vendor/tahoelimited
directory.
Enable the bundle
Enable the bundle in the kernel:
<?php // app/AppKernel.php public function registerBundles() { $bundles = array( // ... new Tahoe\Bundle\MultiTenancyBundle\TahoeMultiTenancyBundle(), ); }
Configure the bundle
Add the following settings to your config.yml
, you must preserve existing values, don't just overwrite an entire doctrine
parameters.yml
parameters: tahoe_multi_tenancy.user.class: Tahoe\ExampleBundle\Entity\User tahoe_multi_tenancy.tenant.class: Tahoe\ExampleBundle\Entity\Tenant domain: yourdomain.com
config.yml
doctrine: orm: resolve_target_entities: Tahoe\Bundle\MultiTenancyBundle\Model\MultiTenantUserInterface: %tahoe_multi_tenancy.user.class% Tahoe\Bundle\MultiTenancyBundle\Model\MultiTenantTenantInterface: %tahoe_multi_tenancy.tenant.class% entity_managers: default: filters: tenantAware: class: Tahoe\Bundle\MultiTenancyBundle\Query\Filter\SQLFilter\TenantAwareFilter enabled: true fos_user: registration: form: type: tahoe_multitenancy_user_registration tahoe_multi_tenancy: subdomain_strategy: tenant_aware # one of tenant_aware or fixed account_prefix: YOUR_ACCOUNT_PREFIX # optional, if you want to override the registration subscriber registration_subscriber: class: Your\Full\Domain\Class manager: your.manager.service # if you need a manager in the subscriber gateways: # for the moment, only recurly is supported recurly: subdomain: your-subdomain private_key: YOUR_PRIVATE_KEY plan_name: YOUR_PLAN_NAME
If you use the tenant_aware
subdomain strategy, your tenant's will get access to the APP through a subdomain they choose.
If, in the contrary, you choose fixed
, all tenant will access through the same endpoint, and tenant will be stored agains
the logged in user (instead of being resolved by the subdomain).
Note: you can use your own form type along with the registration_subscriber
to get a more powerful behaviour.
routing.yml
tahoe_multi_tenancy: resource: "@TahoeMultiTenancyBundle/Resources/config/routing.yml" prefix: /
Create your own tenant entity
You must create Tenant entity inside your bundle that extends one provided with the bundle. For example, something like this:
<?php namespace Tahoe\ExampleBundle\Entity; use Tahoe\Bundle\MultiTenancyBundle\Entity\Tenant as BaseTenant; use Tahoe\Bundle\MultiTenancyBundle\Model\MultiTenantTenantInterface; class Tenant extends BaseTenant implements MultiTenantTenantInterface { // your custom properties and methods }
# file is extending base tenant from multi tenancy bundle Tahoe\ExampleBundle\Entity\Tenant: type: entity table: th_ex_tenant fields: # your custom fields
Update your existing user entity.
Note: MultiTenancyBundle requires FOSUSERBundle.
<?php namespace Tahoe\ExampleBundle\Entity; use FOS\UserBundle\Model\User as BaseUser; use Tahoe\Bundle\MultiTenancyBundle\Model\MultiTenantUserInterface; class User extends BaseUser implements MultiTenantUserInterface { protected $id; protected $activeTenant; public function __construct() { parent::__construct(); } /** * @return mixed */ public function getId() { return $this->id; } /** * @return mixed */ public function getActiveTenant() { return $this->activeTenant; } /** * @param mixed $activeTenant * * @return $this */ public function setActiveTenant($activeTenant) { $this->activeTenant = $activeTenant; return $this; } }
Tahoe\ExampleBundle\Entity\User: type: entity table: th_ex_user repositoryClass: Tahoe\ExampleBundle\Repository\UserRepository id: id: type: integer generator: strategy: AUTO
Making other entities tenant aware
All entities that are specific to the tenant should have the following applied. Any entities that are applicable to all tenants should be left alone.
<?php namespace Tahoe\ExampleBundle\Entity; use Tahoe\Bundle\MultiTenancyBundle\Model\TenantAwareInterface; use Tahoe\Bundle\MultiTenancyBundle\Model\TenantTrait; class Customer implements TenantAwareInterface { use TenantTrait; }
Tahoe\ExampleBundle\Entity\Customer: type: entity table: th_ex_customer fields: id: type: integer id: true generator: strategy: AUTO name: type: string manyToOne: tenant: targetEntity: Tenant
Ensure / is free
/ is used for redirecting to tenants, so you cannot have any routes setup with just /
Using the bundle services
You can make use the services that this bundle provide to get the tenant that is connected.
When using the command line with this bundle, you may find that the tenantId
is not set. In order to avoid this error, you need to set the Tenant you want to work with manually, by calling the overrideTenant
from the TenantResolver
class.
$this->getContainer()->get('tahoe.multi_tenancy.tenant_resolver')->overrideTenant($tenant);