Laravel merge relationships

Question

Is there a way to merge 2 relationships in laravel?

this is the way it's setup now, but Is there a way I could return both merged?

  public function CompetitionsHome() {
    return $this->HasMany( 'Competition', 'home_team_id' );
  }
  public function CompetitionsGuest() {
    return $this->HasMany( 'Competition', 'guest_team_id' );
  }
  public function Competitions() {
    // return both CompetitionsHome & CompetitionsGuest
  }

Andreyco · Accepted Answer · 2014-06-12T12:57:16.730

36

Try out getter method for property which returns merged collections returned from relations.

public function getCompetitionsAttribute($value)
{
    // There two calls return collections
    // as defined in relations.
    $competitionsHome = $this->competitionsHome;
    $competitionsGuest = $this->competitionsGuest;

    // Merge collections and return single collection.
    return $competitionsHome->merge($competitionsGuest);
}

Or you can call additional methods before collection is returned to get different result sets.

public function getCompetitionsAttribute($value)
{
    // There two calls return collections
    // as defined in relations.
    // `latest()` method is shorthand for `orderBy('created_at', 'desc')`
    // method call.
    $competitionsHome = $this->competitionsHome()->latest()->get();
    $competitionsGuest = $this->competitionsGuest()->latest()->get();

    // Merge collections and return single collection.
    return $competitionsHome->merge($competitionsGuest);
}

edited Jun 12 '14 at 12:57

answered Jun 12 '14 at 12:32

Andreyco

22,476
5
61
65

You can read more about available Collection methods here http://laravel.com/api/class-Illuminate.Support.Collection.html#methods – Andreyco Jun 12 '14 at 12:37
8

While this works, it should be noted that this doesn't return a relationship instance. Therefore you can't do something like `App\User::find(1)->with('competitions')`, but you can do `App\User::find(1)->with('competitions_guest')` (barring any syntax errors) – daraul Sep 26 '17 at 14:23
2

@daraul is there a possibility how to merge relations and use them in the querybuilder? – Adam May 16 '18 at 08:47
Wouldn't this also require an `protected $appends = ['competitions'];` property to be added to the Model class? – Potherca Aug 04 '21 at 12:57

score 9 · Answer 2 · answered Apr 15 '16 at 09:08

9

In case you prefer merge() method to combine two collections (relationships), it will override elements with the same index keys so you will loose some of your data gained from one relationship.

You should choose push() method instead, which creates new array keys by pushing one collection to the end of other collection

Here is a sample :

public function getCompetitionsAttribute($value) {
    $competitionsHome = $this->competitionsHome;
    $competitionsGuest = $this->competitionsGuest;

    // PUSH ONE TO OTHER!
    return $competitionsHome->push($competitionsGuest);
}

answered Apr 15 '16 at 09:08

spetsnaz

1,181
1
14
11

This is the correct answer, to prevent primary/index keys from overridding. – Mike Barwick Jan 23 '17 at 18:58
I don't agree, merging will also prevent double instances. – JoeriShoeby Mar 27 '18 at 11:24
1

This depends very much on whether the two relations return instances of the same model or of different ones. – AI0867 Aug 18 '18 at 13:15

score 5 · Answer 3 · answered Sep 17 '19 at 22:08

I've created a package for merging relationships using views:
https://github.com/staudenmeir/laravel-merged-relations

First, create the merge view in a migration:

use Staudenmeir\LaravelMergedRelations\Facades\Schema;

Schema::createMergeView(
    'competitions',
    [(new YourModel)->CompetitionsHome(), (new YourModel)->CompetitionsGuest()]
);

Then define the relationship:

class YourModel extends Model
{
    use \Staudenmeir\LaravelMergedRelations\Eloquent\HasMergedRelationships;

    public function competitions()
    {
        return $this->mergedRelationWithModel(Competition::class, 'competitions');
    }
}

Use it like any other relationship:

$model->competitions;

$model->competitions()->paginate();

YourModel::with('competitions')->get();

score 5 · Answer 4 · answered Feb 21 '21 at 23:10

I created a package for Laravel that allows you to create a relation that merges multiple hasMany relations, supports eager loading (->with(...)) and you do not need to create a view.

Package on GitHub: https://github.com/korridor/laravel-has-many-merged

Your question would be solved with something like this:

use Korridor\LaravelHasManyMerged\HasManyMergedRelation;

class Example extends Model
{

  use HasManyMergedRelation;

  // ...
  
  public function Competitions() {
    return $this->hasManyMerged('Competition', ['home_team_id', 'guest_team_id']);
  }

}

score 2 · Answer 5 · answered Aug 07 '21 at 13:52

2

In Laravel 8 you can do it like this:


  public function Competitions() {
    $home= $this->CompetitionsHome();
    $guest => $this->CompetitionsGuest();

    $all = $home->union($guest)
                ->orderBy('created_at')
                ->get();
  }

answered Aug 07 '21 at 13:52

Arsii Rasheed

324
1
5
18

this worked but when I used where is seems it only affect one side of the union not both sides – basel juma Jul 03 '22 at 11:40

score 0 · Answer 6 · answered Apr 21 '19 at 23:39

If anyone landed here like me due to google: As neither merge() nor push() allow eager loading (and other nice relation features), the discussion didn't end with this thread but was continued here: Laravel Eloquent Inner Join on Self Referencing Table

I proposed a solution here, any further ideas and contributions to this issue welcome.

Laravel merge relationships

6 Answers6

Linked