Qore Tenant

This module adds Tenant functionality to your application. It can be added to any model of your choosing.

Installation

1. Install the package via composer:

composer require qore-works-business/qore-tenant

php artisan qore-tenant:install

For auto publish migrations on updates

{
    "scripts": {
        "post-update-cmd": [
            "@php artisan vendor:publish --tag=qore-tenant --ansi",
        ]
    }
}

2. Add the plugin to the plugins() section of the applications panel service provider:

use QoreWorksBusiness\QoreRelation\QoreTenantPlugin;

class QorePanelServiceProvider extends QorePanelServiceProviderBase
{

public function panel(QorePanel|Panel $panel): QorePanel

    return parent::panel($panel)
        // ....
        ->plugins([
            QoreTenantPlugin::make(),
        ]);
}

3. Add the Tenantable contract and HasTenant trait to your model.

use QoreWorksBusiness\QoreTenant\Concerns\HasTenant;
use QoreWorksBusiness\QoreTenant\Contracts\Tenantable;

class Company implements Tenantable
{
    use HasTenant;

    // ...

4. If you want to use the TenantRelationManager to manage Tenants from QWB, add the TenantRelationManager to your filament resource.

use QoreWorksBusiness\QoreTenant\Resources\RelationManagers\TenantRelationManager;

public static function getRelations(): array
{
    return [
        // ...
        TenantRelationManager::class,
    ];
}

5. If you want to use Tenant information in blade files, you can use the TenantComposer view composer in your AppServiceProvider.

use QoreWorksBusiness\QoreTenant\View\Composers\TenantComposer;

public function boot(): void
{
    view()->composer([
        // any blade files
        'application.portal.layouts.app',
        'application.portal.layouts.guest',
    ], TenantComposer::class);
}

The tenant is now available in specified blade files.

@if ($tenant)
    <div class="mx-auto max-w-7xl px-4 pb-6 sm:px-6 lg:px-8">
        {{ $tenant->tenantable->name }}
    </div>
@endif

6. To route to the correct subdomain, you can use the TenantBySubdomainMiddleware middleware. You can use this for most QWB applications (website, portal). Currently, Statamic websites are not supported out of the box but can work with Laravel subdomain routing.

//config/portal.php
use QoreWorksBusiness\QoreTenant\Http\Middleware\TenantBySubdomainMiddleware;

return [
    'middleware' => [
        'web',
        TenantBySubdomainMiddleware::class,
    ],
    // ...
];

7. Add your main domain to the .env

MAIN_DOMAIN=development.qw.local.dolphiq.eu

It is also possible to have multiple main domains for the same tenant.

MAIN_DOMAIN="development.qw.local.dolphiq.eu,portal.development.qw.local.dolphiq.eu"