namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 设置用户的名字
     */
    public function setFirstNameAttribute($value)
    {
        $this->attributes['first_name'] = strtolower($value);
    }

    /**
     * 获取用户的全名
     */
    public function getFullNameAttribute()
    {
        return "{$this->first_name} {$this->last_name}";
    }
}

Schema::create('tenants', function (Blueprint $table) {
    $table->id();
    $table->string('name');
    $table->string('domain')->unique(); // 用于外部传入id以切换租户，可以改成自己需要的
    $table->string('database')->unique(); // 租户数据库
    $table->timestamps();
});

// config/multitenancy.php
return [
    /*
     * 这个类负责确定哪个租户应该是给定请求的最新租户。
     * 必须继承 `Spatie\Multitenancy\TenantFinder\TenantFinder`
     */
    'tenant_finder' => \App\Multitenancy\TenantFinder\HeaderTenantFinder::class,

    /*
     * 这些字段由`tender:artist`命令用于匹配一个或多个租户。
     */
    'tenant_artisan_search_fields' => [
        'id', 
        'tenant_code', // 默认是domain，根据自己需要修改
        'database'
    ],

    /*
     * 这些任务将在切换租户时执行。
     *
     * 有效的任务是实现 `Spatie\Multitenance\Tasks\SwitchTenantTask` 的任何类
     */
    'switch_tenant_tasks' => [
        \Spatie\Multitenancy\Tasks\PrefixCacheTask::class,
        \Spatie\Multitenancy\Tasks\SwitchTenantDatabaseTask::class,
        \Spatie\Multitenancy\Tasks\SwitchRouteCacheTask::class,
    ],

    /*
     * 这个类是用于在租户上存储配置的模型。
     *
     * 必须是或继承 `Spatie\Multitenancy\Models\Tenant::class`
     */
    'tenant_model' => \App\Models\Landlord\Tenant::class,

    /*
     * 如果在分派作业时有当前租户，则会在作业上自动设置当前租户的id。
     * 执行作业时，作业上设置的租户将变为当前租户。
     */
    'queues_are_tenant_aware_by_default' => true,

    /*
     * 用于连接租户数据库的连接名称。
     *
     * 如果设置为 `null`，则使用默认的数据库连接。
     */
    'tenant_database_connection_name' => 'tenant',

    /*
     * 用于连接主数据库（Landlord 数据库）的连接名称。
     */
    'landlord_database_connection_name' => 'landlord',

    /*
     * 此键名用于在 Laravel 服务容器（Container）中绑定当前租户实例。
     */
    'current_tenant_container_key' => 'currentTenant',

    /**
     * 如果你希望使用 `SwitchRouteCacheTask` 将租户的路由缓存
     * 到一个共享文件中，请将其设置为 `true`。
     */
    'shared_routes_cache' => false,

    /*
     * 你可以通过自定义 Action（动作类）来定制该包的部分行为。
     * 你的自定义 Action 必须继承自默认的 Action 类。
     */
    'actions' => [
        'make_tenant_current_action' => MakeTenantCurrentAction::class,
        'forget_current_tenant_action' => ForgetCurrentTenantAction::class,
        'make_queue_tenant_aware_action' => MakeQueueTenantAwareAction::class,
        'migrate_tenant' => MigrateTenantAction::class,
    ],

    /*
     * 你可以自定义该包将队列任务（Queueable）解析为具体 Job 的方式。
     *
     * 例如，使用 laravel-actions 包（作者：Loris Leiva）时，
     * 你可以将 JobDecorator 解析为 getAction()，配置如下：
     * JobDecorator::class => 'getAction'
     */
    'queueable_to_job' => [
        SendQueuedMailable::class => 'mailable',
        SendQueuedNotifications::class => 'notification',
        CallQueuedClosure::class => 'closure',
        CallQueuedListener::class => 'class',
        BroadcastEvent::class => 'event',
    ],

    /*
     * 即使以下 Job 没有实现 TenantAware 接口，也会自动使其具备租户感知能力。
     */
    'tenant_aware_jobs' => [
        // ...
    ],

    /*
     * 即使以下 Job 没有实现 NotTenantAware 接口，也会强制使其失去租户感知能力。
     */
    'not_tenant_aware_jobs' => [
        // ...
    ],
];

<?php
namespace App\Multitenancy\TenantFinder;

use App\Models\Landlord\Tenant;
use Illuminate\Http\Request;
use Spatie\Multitenancy\TenantFinder\TenantFinder;

class HeaderTenantFinder extends TenantFinder
{
    /**
     * 3.x 签名：必须返回 Tenant 实例
     */
    public function findForRequest(Request $request): \App\Models\Landlord\Tenant|null
    {
        // 这里可以换成子域名
        $id = (int)trim($request->headers->get('X-Tenant-ID', ''));

        if ($id === 0 || (!$tenant = Tenant::find($id))) {
            abort(400, '无效的商户ID');
        }

        return $tenant;
    }
}

'tenant' => [
    // 获取当前租户
    \Spatie\Multitenancy\Http\Middleware\NeedsTenant::class,
    // 用 session 的时候需要添加
    // \Spatie\Multitenancy\Http\Middleware\EnsureValidTenantSession::class,
],

Route::middleware(['tenant', 'auth:sanctum'])->group(function () {
    Route::get('/api/xxx', function () {
        // 这里已经切换到租户数据库连接
        $user = request()->user();
    });
});

$tenant = Spatie\Multitenancy\Models\Tenant::find(1);
$tenant->execute(function() {
    // 这里可以执行租户数据库的操作
});

$tenant = Spatie\Multitenancy\Models\Tenant::find(1);
// 直接把当前租户数据库连接切换到租户库
$tenant->makeCurrent();

Route::get('/api/{tenant}/other', function ($tenant) {
    $tenant->execute(function() {
        // 这里已经切换到租户数据库连接了
    });
});

// Illuminate\Database\Eloquent\Concerns\HasAttributes
protected function serializeDate(DateTimeInterface $date)
{
    return $date instanceof DateTimeImmutable ?
        CarbonImmutable::instance($date)->toJSON() :
        Carbon::instance($date)->toJSON();
}

// class Carbon\Traits\Converter
public function toJSON()
{
    return $this->toISOString();
}

// 新建一条数据 Post 的评论，save 将自动添加 post_id 字段
$comment = new Comment(['message' => 'A new comment.']);
$post = Post::find(1);
$post->comments()->save($comment);

// 保持多条记录
$post->comments()->saveMany([
    new Comment(['message' => 'A new comment.']),
    new Comment(['message' => 'Another new comment.']),
]);

// 更新后需要重新加载模型及其关联，才会加到 $post->comments 中
$post->refresh();

// 所有评论，包括新保存的评论...
$post->comments;

// App\Models\User
public function avatar(): HasOne
{
    // $this->hasOne('class_name', 'foreign_key', 'local_key');
    // foreign_key默认是表名去掉 s 加上 '_id' 后缀
    // local_key 默认是 id
    return $this->hasOne(Avatar::class);
    // 即 $this->hasOne(Avatar::class, 'user_id', 'id');
}

// App\Models\Avatar
public function user(): BelongsTo
{
    // $this->belongsTo(User::class, 'foreign_key', 'owner_key');
    // return $this->belongsTo(User::class, 'user_id', 'id');
    return $this->belongsTo(User::class); // 省略 'foreign_key', 'owner_key' 参数
}

// 新建
$user = User::create(['name', '...']);
Avatar::create([
    'user_id' => $user->id,
    'image' => '...',
]);

// 更新
$user = User::find(1);
// 更新关联数据
$user->avatar()->update(['image' => '...']);
// 更新模型
$user->update(['name' => '...']);

// 反向关联操作 belongsTo 的 associate/dissociate
$avatar = Avatar::find(1);
$avatar->user()->dissociate(); // 把 user_id 设为 null
$avatar->save(); // 保存更改

$user = User::find(10);
$avatar->user()->associate($user); // 把 user_id 改为 10
$avatar->save();

// App\Models\Post 关联
public function comments(): HasMany
{
    // return $this->hasMany('class_name', 'foreign_key', 'local_key');
    return $this->hasMany(Comment::class, 'post_id', 'id');
    return $this->hasMany(Comment::class); // 使用默认参数
}

// App\Models\Comment 反向关联
public function post(): BelongsTo
{
    // $this->belongsTo(Post::class, 'foreign_key', 'owner_key');
    return $this->belongsTo(Post::class, 'post_id', 'id');
    return $this->belongsTo(Post::class); // 省略 'foreign_key', 'owner_key' 参数
}

User::query()->whereIn(
    'id',
    UserRolePivot::query()
        ->select('user_id')
        ->where('role_id', $roleId)
)->get();
// SELECT * FROM user WHERE id IN( SELECT user_id FROM user_role_pivot WHERE role_id = $roleId)