README

Compoships 允许在 Laravel 的 Eloquent ORM 中根据两列（或更多）指定关系。当使用第三方或现有的模式/数据库时，经常需要在 Eloquent 关系定义中匹配多列。

问题

Eloquent 不支持复合键。因此，无法通过匹配多列来定义一个模型到另一个模型的关系。尝试使用 where 子句（如下例所示）在预加载关系时不会工作，因为在处理关系时 $this->team_id 是 null。

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    public function tasks()
    {
        //WON'T WORK WITH EAGER LOADING!!!
        return $this->hasMany(Task::class)->where('team_id', $this->team_id);
    }
}

相关讨论

• 多键关系
• 查询关系时额外条件不起作用
• 在预加载中查询关系时额外条件不起作用
• 具有两个外键的BelongsTo关系
• Laravel Eloquent：关系的多个外键
• Laravel hasMany 关联与多列

安装

推荐通过 Composer 安装 Compoships

$ composer require awobaz/compoships

用法

使用 Awobaz\Compoships\Database\Eloquent\Model 类

只需让您的模型类继承 Awobaz\Compoships\Database\Eloquent\Model 基类。该 Awobaz\Compoships\Database\Eloquent\Model 扩展了 Eloquent 基类而不改变其核心功能。

使用 Awobaz\Compoships\Compoships 特性

如果由于某些原因您不能从 Awobaz\Compoships\Database\Eloquent\Model 继承模型，您可以使用 Awobaz\Compoships\Compoships 特性。只需在模型中使用特性。

注意： 要从模型 A 定义多列关系到另一个模型 B，两个模型都必须继承 Awobaz\Compoships\Database\Eloquent\Model 或使用 Awobaz\Compoships\Compoships 特性

语法

... 现在我们可以通过匹配两列或更多列（通过传递列数组而不是字符串）来定义从模型 A 到另一个模型 B 的关系。

namespace App;

use Illuminate\Database\Eloquent\Model;

class A extends Model
{
    use \Awobaz\Compoships\Compoships;
    
    public function b()
    {
        return $this->hasMany('B', ['foreignKey1', 'foreignKey2'], ['localKey1', 'localKey2']);
    }
}

我们可以使用相同的语法来定义关系的逆关系

namespace App;

use Illuminate\Database\Eloquent\Model;

class B extends Model
{
    use \Awobaz\Compoships\Compoships;
    
    public function a()
    {
        return $this->belongsTo('A', ['foreignKey1', 'foreignKey2'], ['ownerKey1', 'ownerKey2']);
    }
}

示例

例如，假设我们有一个任务列表，其中包含类别，由多个用户团队管理，其中

• 一个任务属于一个类别
• 一个任务分配给一个团队
• 一个团队有多个用户
• 一个用户属于一个团队
• 一个用户负责一个任务类别的任务

负责特定任务的用户是当前负责该类别内的团队的用户。

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use \Awobaz\Compoships\Compoships;
    
    public function tasks()
    {
        return $this->hasMany(Task::class, ['team_id', 'category_id'], ['team_id', 'category_id']);
    }
}

再次，使用相同的语法定义关系的逆关系

namespace App;

use Illuminate\Database\Eloquent\Model;

class Task extends Model
{
    use \Awobaz\Compoships\Compoships;
    
    public function user()
    {
        return $this->belongsTo(User::class, ['team_id', 'category_id'], ['team_id', 'category_id']);
    }
}

支持的关系

Compoships 只支持以下 Laravel 的 Eloquent 关系

• hasOne
• HasMany
• belongsTo

请注意，虽然 Compoships 支持可空列，但当前无法创建只有 null 值的关系。

2.x 版本中对可空列的支持

2.x 版本引入了对可空列的支持。当关系中的列为 null 时，结果可能与 1.x 版本不同，因此我们将版本提升到 2.x，因为这可能是一个破坏性更改。

免责声明

Compoships 并不支持 Laravel Eloquent 中的复合键。此包仅提供根据多个列指定关系的功能。在 Laravel 项目中，建议所有模型的表只使用一个主键。但是，即使在模型表只有一个主键的情况下，也可能会需要匹配多个列以定义关系。

贡献

请阅读 CONTRIBUTING.md 了解我们的行为准则和提交拉取请求的流程。

版本控制

我们使用 SemVer 进行版本控制。有关可用的版本，请参阅此存储库的 标签。

单元测试

要运行单元测试，您必须手动获取正确的 PHPUnit 版本。

• 如果您有 PHP 版本 7.1，请获取 PHPUnit 7
• 如果您有 PHP 版本 7.2，请获取 PHPUnit 8
• 如果您有 PHP 版本 7.3 及更高版本，请获取 PHPUnit 9

示例

curl -L -O https://phar.phpunit.de/phpunit-9.phar
mv phpunit-9.phar phpunit
chmod +x phpunit
./phpunit

作者

• Claudin J. Daniel - 初始工作

赞助商

• StockTreats - 提供交易技巧和窍门的股市洞察
• Awobaz - 位于加拿大蒙特利尔的 Web/移动代理机构

许可证

Compoships 基于 MIT 许可证。