Laravel eloquent with Trashed on relationship

Question

I need to be able to get a Models Relationship including its soft deleted elements, but only for this 1 instance. I do not want to change the model so that every time I use the relationship it returns all the soft deleted records too.

How can I achieve this?

User Model

class User extends Authenticatable
{
  public function contacts(){
    return $this->hasMany('App\Contacts','user_id','id');
  }
}

Controller

$user = User::findOrFail($id);
//Need to be able to get the trashed contacts too, but only for this instance and in this function
$user->contacts->withTrashed(); //Something like this
return $user;

How can I get the trashed rows only this 1 time inside my controller?

Thanks

The problem is using $user->contacts returns collection of related records of contacts to user, while $user->contacts() will make a new query` — omitobi
– omitobi, Commented Aug 2, 2018 at 13:29

Pusparaj · Accepted Answer · 2018-08-02 13:30:12Z

97

You can use withTrashed method in different ways.

To associate the call with your relationship you can do as follows:

public function roles() {
    return $this->hasMany(Role::class)->withTrashed();
}

To use the same in the fly:

$user->roles()->withTrashed()->get();

For your special scenario:

$user->contacts()->withTrashed()->get();

answered Aug 2, 2018 at 13:30

Pusparaj

1,6791 gold badge13 silver badges19 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

S_R Over a year ago

It completely wen't over my head to just run the withTrashed() method in the view itself where I am looping over it. Probably the cleanest way to achieve this, thanks!

hassanrazadev Over a year ago

How can I filter records when fetching records using withTrashed()? laracasts.com/discuss/channels/laravel/…

Alistair R · Accepted Answer · 2021-10-27 08:59:01Z

51

You can also eager load them by adding a clause to the with() method

$user = User
   ::with(['contacts' => fn($q) => $q->withTrashed()])
   ->findOrFail($id);

answered Oct 27, 2021 at 8:59

Alistair R

95610 silver badges16 bronze badges

1 Comment

Vahid Amiri Over a year ago

You can also do company.user for nested relations for example.

omitobi · Accepted Answer · 2018-08-02 13:31:22Z

4

Looking at the Laravel Documentation on Querying soft deleted models:

//The withTrashed method may also be used on a relationship query: 
$flight->history()->withTrashed()->get();

The problem is using $user->contacts returns collection of related records of contacts to user, while $user->contacts() will make a new query.

answered Aug 2, 2018 at 13:31

omitobi

7,3643 gold badges39 silver badges55 bronze badges

1 Comment

Julian Over a year ago

How would you go about nested relationships? A belongsToMany B and B hasMany C? I need a way to say "Give me ALL results for A (including trashed) where ALL relations (B and B->C) show trashed elements". Is this possible?

Robin Dirksen · Accepted Answer · 2018-08-02 13:30:33Z

1

You can do this with:

$user = User::findOrFail($id);

$user->contacts()->withTrashed()->get(); //get all results

return $user;

When you call the relation with (), you can append the withTrashed() method. After that you need to get() the results.

answered Aug 2, 2018 at 13:30

Robin Dirksen

3,42228 silver badges41 bronze badges

Collectives™ on Stack Overflow

Laravel eloquent with Trashed on relationship

4 Answers 4

2 Comments

1 Comment

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

2 Comments

1 Comment

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related