This extended version of HasManyThrough allows relationships with unlimited intermediate models and supports many-to-many and polymorphic relationships.
Requires Laravel 5.5.29+.
composer require staudenmeir/eloquent-has-many-deep
Using the documentation example with an additional level:
Country → has many → User → has many → Post → has many → Comment
class Country extends Model
{
use \Staudenmeir\EloquentHasManyDeep\HasRelationships;
public function comments()
{
return $this->hasManyDeep('App\Comment', ['App\User', 'App\Post']);
}
}Just like with hasManyThrough(), the first argument of hasManyDeep() is the related model. The second argument is an array of intermediate models, from the far parent (the model where the relationship is defined) to the related model.
By default, hasManyDeep() uses the Eloquent conventions for foreign and local keys. You can also specify custom foreign keys as the third argument and custom local keys as the fourth argument:
class Country extends Model
{
use \Staudenmeir\EloquentHasManyDeep\HasRelationships;
public function comments()
{
return $this->hasManyDeep(
'App\Comment',
['App\User', 'App\Post'], // Intermediate models, beginning at the far parent (Country).
[
'country_id', // Foreign key on the "users" table.
'user_id', // Foreign key on the "posts" table.
'post_id' // Foreign key on the "comments" table.
],
[
'id', // Local key on the "countries" table.
'id', // Local key on the "users" table.
'id' // Local key on the "posts" table.
]
);
}
}You can use null placeholders for the default keys:
class Country extends Model
{
use \Staudenmeir\EloquentHasManyDeep\HasRelationships;
public function comments()
{
return $this->hasManyDeep('App\Comment', ['App\User', 'App\Post'], [null, 'custom_user_id']);
}
}You can include BelongsToMany relationships in the intermediate path.
Using the documentation example with an additional level:
User → belongs to many → Role → has many → Permission
Add the pivot table to the intermediate models:
class User extends Model
{
use \Staudenmeir\EloquentHasManyDeep\HasRelationships;
public function permissions()
{
return $this->hasManyDeep('App\Permission', ['role_user', 'App\Role']);
}
}If you specify custom keys, remember to reverse the foreign and local key on the "right" side of the pivot table:
class User extends Model
{
use \Staudenmeir\EloquentHasManyDeep\HasRelationships;
public function permissions()
{
return $this->hasManyDeep(
'App\Permission',
['role_user', 'App\Role'], // Intermediate models and tables, beginning at the far parent (User).
[
'user_id', // Foreign key on the "role_user" table.
'id', // Foreign key on the "roles" table (local key).
'role_id' // Foreign key on the "permissions" table.
],
[
'id', // Local key on the "users" table.
'role_id', // Local key on the "role_user" table (foreign key).
'id' // Local key on the "roles" table.
]
);
}
}You can include MorphMany relationships in the intermediate path.
Using the documentation example with an additional level:
User → has many → Post → morph many → Comment
Specify the polymorphic foreign keys as an array, starting with the *_type column:
class User extends Model
{
use \Staudenmeir\EloquentHasManyDeep\HasRelationships;
public function postComments()
{
return $this->hasManyDeep(
'App\Comment',
['App\Post'],
[null, ['commentable_type', 'commentable_id']]
);
}
}You can include MorphToMany relationships in the intermediate path.
Using the documentation example with an additional level:
User → has many → Post → morph to many → Tag
Add the pivot table to the intermediate models and specify the polymorphic foreign keys as an array, starting with the *_type column:
class User extends Model
{
use \Staudenmeir\EloquentHasManyDeep\HasRelationships;
public function postTags()
{
return $this->hasManyDeep(
'App\Tag',
['App\Post', 'taggables'],
[null, ['taggable_type', 'taggable_id'], 'id'],
[null, null, 'tag_id']
);
}
}Remember to reverse the foreign and local key on the "right" side of the pivot table:
You can include MorphedByMany relationships in the intermediate path.
Using the documentation example with an additional level:
Tag → morphed by many → Post → has many → Comment
Add the pivot table to the intermediate models and specify the polymorphic local keys as an array, starting with the *_type column:
class Tag extends Model
{
use \Staudenmeir\EloquentHasManyDeep\HasRelationships;
public function postComments()
{
return $this->hasManyDeep(
'App\Comment',
['taggables', 'App\Post'],
[null, 'id'],
[null, ['taggable_type', 'taggable_id']]
);
}
}Use withIntermediate() to retrieve attributes from intermediate tables:
public function comments()
{
return $this->hasManyDeep('App\Comment', ['App\User', 'App\Post'])
->withIntermediate('App\Post');
}
foreach ($country->comments as $comment) {
// $comment->post->title
}By default, this will retrieve all the table's columns. Be aware that this executes a separate query to get the list of columns.
You can specify the selected columns as the second argument:
public function comments()
{
return $this->hasManyDeep('App\Comment', ['App\User', 'App\Post'])
->withIntermediate('App\Post', ['id', 'title']);
}As the third argument, you can specify a custom accessor:
public function comments()
{
return $this->hasManyDeep('App\Comment', ['App\User', 'App\Post'])
->withIntermediate('App\Post', ['id', 'title'], 'accessor');
}
foreach ($country->comments as $comment) {
// $comment->accessor->title
}If you retrieve data from multiple tables, you can use nested accessors:
public function comments()
{
return $this->hasManyDeep('App\Comment', ['App\User', 'App\Post'])
->withIntermediate('App\Post')
->withIntermediate('App\User', ['*'], 'post.user');
}
foreach ($country->comments as $comment) {
// $comment->post->title
// $comment->post->user->name
}Use withPivot() for the pivot tables of BelongsToMany and MorphToMany/MorphedByMany relationships:
public function permissions()
{
return $this->hasManyDeep('App\Permission', ['role_user', 'App\Role'])
->withPivot('role_user', ['expires_at']);
}
foreach ($user->permissions as $permission) {
// $permission->role_user->expires_at
}You can specify a custom pivot model as the third argument and a custom accessor as the fourth:
public function permissions()
{
return $this->hasManyDeep('App\Permission', ['role_user', 'App\Role'])
->withPivot('role_user', ['expires_at'], 'App\RoleUserPivot', 'pivot');
}
foreach ($user->permissions as $permission) {
// $permission->pivot->expires_at
}