Name | Updated at | |
---|---|---|
.github | ||
src | ||
.gitattributes | ||
LICENSE | ||
README.md | ||
composer.json |
Compoships offers the ability to specify relationships based on two (or more) columns in Hyperf's Model ORM. The need to match multiple columns in the definition of an Eloquent relationship often arises when working with third party or pre existing schema/database.
Eloquent doesn't support composite keys. As a consequence, there is no way to define a relationship from one model to another by matching more than one column. Trying to use where clauses
(like in the example below) won't work when eager loading the relationship because at the time the relationship is processed $this->team_id is null.
namespace App;
use Hyperf\Database\Model\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);
}
}
The recommended way to install Compoships is through Composer
composer require friendsofhyperf/compoships
FriendsOfHyperf\Compoships\Database\Eloquent\Model
classSimply make your model class derive from the FriendsOfHyperf\Compoships\Database\Eloquent\Model
base class. The FriendsOfHyperf\Compoships\Database\Eloquent\Model
extends the Eloquent
base class without changing its core functionality.
FriendsOfHyperf\Compoships\Compoships
traitIf for some reasons you can't derive your models from FriendsOfHyperf\Compoships\Database\Eloquent\Model
, you may take advantage of the FriendsOfHyperf\Compoships\Compoships
trait. Simply use the trait in your models.
Note: To define a multi-columns relationship from a model A to another model B, both models must either extend FriendsOfHyperf\Compoships\Database\Eloquent\Model
or use the FriendsOfHyperf\Compoships\Compoships
trait
... and now we can define a relationship from a model A to another model B by matching two or more columns (by passing an array of columns instead of a string).
namespace App;
use Hyperf\Database\Model\Model;
class A extends Model
{
use \FriendsOfHyperf\Compoships\Compoships;
public function b()
{
return $this->hasMany('B', ['foreignKey1', 'foreignKey2'], ['localKey1', 'localKey2']);
}
}
We can use the same syntax to define the inverse of the relationship:
namespace App;
use Hyperf\Database\Model\Model;
class B extends Model
{
use \FriendsOfHyperf\Compoships\Compoships;
public function a()
{
return $this->belongsTo('A', ['foreignKey1', 'foreignKey2'], ['ownerKey1', 'ownerKey2']);
}
}
As an example, let's pretend we have a task list with categories, managed by several teams of users where:
The user responsible for a particular task is the user currently in charge for the category inside the team.
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
use \FriendsOfHyperf\Compoships\Compoships;
public function tasks()
{
return $this->hasMany(Task::class, ['team_id', 'category_id'], ['team_id', 'category_id']);
}
}
Again, same syntax to define the inverse of the relationship:
namespace App;
use Hyperf\Database\Model\Model;
class Task extends Model
{
use \FriendsOfHyperf\Compoships\Compoships;
public function user()
{
return $this->belongsTo(User::class, ['team_id', 'category_id'], ['team_id', 'category_id']);
}
}
Compoships is licensed under the MIT License.
If you like this project, Buy me a cup of coffee. [ Alipay | WePay ]