README

基于 HipsterJazzbo/Landlord，一个为Laravel & Lumen 5.2+提供的单数据库多租户包。

安装

要开始使用，请要求此包

composer require victormacedo/landlord

Laravel

在 config/app.php 中添加 ServiceProvider

    'providers' => [
        ...
        HipsterJazzbo\Landlord\LandlordServiceProvider::class,
    ],

如果您想的话，可以注册 Facade

    'aliases' => [
        ...
        'Landlord'   => HipsterJazzbo\Landlord\Facades\Landlord::class,
    ],

您还可以发布配置文件

php artisan vendor:publish --provider="HipsterJazzbo\Landlord\LandlordServiceProvider"

并设置您的 default_tenant_columns 设置，如果您有一个应用级别的默认设置。Landlord 将使用此设置来范围那些没有设置 $tenantColumns 属性的模型。

Lumen

您需要在您的 bootstrap/app.php 中设置服务提供者

$app->register(HipsterJazzbo\Landlord\LandlordServiceProvider::class);

并确保您已取消注释 $app->withEloquent()。

使用

此包假设您在所有租户范围表中至少有一个列引用了属于哪个租户的每一行。

例如，您可能有一个 companies 表，以及其他一些具有 company_id 列的其他表。

添加和删除租户

重要提示： Landlord 是无状态的。这意味着当您调用 addTenant() 时，它只会范围到 当前请求。

确保您以这种方式添加租户，使其在每次请求时发生，并在您需要范围模型之前，如中间件或作为无状态认证方法（如OAuth）的一部分。

您可以通过调用 addTenant() 来告诉 Landlord 自动通过给定的租户范围，无论是从 Landlord Facade 还是注入 TenantManager() 实例。

您可以通过传入租户列和 id

Landlord::addTenant('tenant_id', 1);

或租户模型的实例

$tenant = Tenant::find(1);

Landlord::addTenant($tenant);

如果您传递模型实例，Landlord 将使用 Eloquent 的 getForeignKey() 方法来决定租户列名称。

您可以添加所需数量的租户，但是 Landlord 一次只允许 一种 类型的租户。

要删除租户并停止通过它范围，只需调用 removeTenant()

Landlord::removeTenant('tenant_id');

// Or you can again pass a Model instance:
$tenant = Tenant::find(1);

Landlord::removeTenant($tenant);

您还可以检查 Landlord 当前是否正在通过给定的租户范围

// As you would expect by now, $tenant can be either a string column name or a Model instance
Landlord::hasTenant($tenant);

如果出于某种原因需要，您可以检索 Landlord 的租户

// $tenants is a Laravel Collection object, in the format 'tenant_id' => 1
$tenants = Landlord::getTenants();

设置您的模型

要设置一个自动范围的模型，只需使用 BelongsToTenants 特性

use Illuminate\Database\Eloquent\Model;
use HipsterJazzbo\Landlord\BelongsToTenants;

class ExampleModel extends Model
{
    use BelongsToTenants;
}

如果您想为特定模型覆盖适用租户，您可以设置 $tenantColumns 属性

use Illuminate\Database\Eloquent\Model;
use HipsterJazzbo\Landlord\BelongsToTenants;

class ExampleModel extends Model
{
    use BelongsToTenants;
    
    public $tenantColumns = ['tenant_id'];
}

创建新的租户范围模型

当您创建一个使用 BelongsToTenants 的模型的新实例时，Landlord 会自动添加任何适用的租户 ID，如果它们尚未设置

// 'tenant_id' will automatically be set by Landlord
$model = ExampleModel::create(['name' => 'whatever']);

查询租户范围模型

添加租户后，对使用 BelongsToTenant 的模型的所有查询都将自动范围

// This will only include Models belonging to the current tenant(s)
ExampleModel::all();

// This will fail with a ModelNotFoundForTenantException if it belongs to the wrong tenant
ExampleModel::find(2);

注意：当您开发多租户应用时，有时您会不断收到针对实际存在的行的 ModelNotFound 异常，因为这些行属于错误的租户。

Landlord 会捕获这些异常，并将它们重新抛出为 ModelNotFoundForTenantException，以帮助您：<)

如果您需要查询所有租户，您可以使用 allTenants()

// Will include results from ALL tenants, just for this query
ExampleModel::allTenants()->get()

在底层，Landlord 使用 Laravel 的 匿名全局作用域。这意味着如果你同时针对多个租户进行作用域限定，并且想要在单个查询中排除其中一个，你可以这样做

// Will not scope by 'tenant_id', but will continue to scope by any other tenants that have been set
ExampleModel::withoutGlobalScope('tenant_id')->get();

贡献

如果你发现了一个问题，或者有更好的方法来完成某事，请随时提交一个 issue 或 pull request。