Laravel polymorphic relationships with custom keys

Question

I'm having some problems getting a Polymorphic Relation to work in Laravel

Tables

Vacations
    id
    name

Posts
    id
    name

Images
    id
    type_id
    type

Images.type_id links to posts.id or vacations.id Images.type is either post or vacation

Posts and Vacations can have many images but each image belongs to only 1 Post or Vacation.

Vacation Model

namespace App;

use App\Vacation;

class Vacation extends Model
{
    public function images()
    {
        return $this->morphMany('App\Image', 'imageable', 'type', 'type_id');
    }
}

Image Model

namespace App;

use App\Image;

class Image extends Model
{
    public function imageable()
    {
        return $this->morphTo();
    }
}

When I run this, I get an empty array but there are matching records.

$vacation = Vacation::find(1);
dd($vacation->images);

I can see Laravel is trying to run:

select * from `images` where `images`.`type_id` = 1 
and `images`.`type_id` is not null 
and `images`.`type` = App\Vacation

When I run this "raw" and replace "App\Vacation" with vacation then I get my results.

Is it normal it's passing the namespaced class name to the raw sql query?

I've tried changing the Images.type value from plural to singular but it still fails.

What am I doing wrong?

EDIT: this is Laravel 5.4, the most recent version afaik.

You don't need those: `use App\Image;` and `use App\Vacation;`. Which version of laravel is this? — Ivanka Todorova, Apr 25 '17 at 13:49
@AmeerSalahAldeen the basic structure is in my post: images.id, images.type_id (links to the id of the vacation) and the images.type is "vacation", "post", etc. — stef, Apr 25 '17 at 13:57
@stef Yeah, I was only pointing it. Are your all table names `lowercase`? — Ivanka Todorova, Apr 25 '17 at 13:57
check this :- http://stackoverflow.com/questions/27866020/laravel-returning-the-namespaced-owner-of-a-polymorphic-relation — Ameer Salah Aldeen, Apr 25 '17 at 14:01
Can you confirm in your `images.type` column is stored `App\Vacation`? — Ivanka Todorova, Apr 25 '17 at 14:01
@IvankaTodorova not sure what you mean? ìmages.type`is not in the vacation table or model, it's a column in the images table. — stef, Apr 25 '17 at 14:04
Yes, and what's in this column? It should store the name of the model **including** the namespace. — Ivanka Todorova, Apr 25 '17 at 14:05
@IvankaTodorova wow that's weird. I had no idea the namespace had to be included. This fixes the issue of course. Post an answer and I'll accept it. — stef, Apr 25 '17 at 14:09

score 17 · Answer 1 · answered Feb 06 '18 at 10:25

17

For what it's worth, it's possible to achieve what you want without having to update your database.

I had the same issue with a legacy database, and I fixed it by adding the following to bootstrap/app.php.

\Illuminate\Database\Eloquent\Relations\Relation::morphMap([
    'vacation' => \App\Vacation::class,
    'post' => \App\Post::class
]);

answered Feb 06 '18 at 10:25

ankr

647
6
15

1

Thanks, you save my day. I was using old Eloquent `morphTo(...)` override with `getPolymorphicTypeAttribute($type)`. But it couldn't handle the Type with `morphedByMany`. – KeitelDOG Oct 31 '18 at 17:43
2

For what it is worth it is recommended that you put this boot function of your AppServiceProvider. You may register the morphMap in the boot function of your AppServiceProvider or create a separate service provider if you wish. https://laravel.com/docs/5.8/eloquent-relationships#polymorphic-relationships – Tim Wickstrom Apr 30 '19 at 01:13

score 0 · Answer 2 · answered Apr 25 '17 at 14:08

0

add to vacation class this line protected $morphClass = 'vacation';

if you want to sore the model name as vacation

answered Apr 25 '17 at 14:08

Ameer Salah Aldeen

281
1
11

Ivanka Todorova · Accepted Answer · 2017-04-25T14:28:45.377

0

In images, your column type should contain the model name, in your case either App\Vacation or App\Post.

edited Apr 25 '17 at 14:28

answered Apr 25 '17 at 14:11

Ivanka Todorova

9,964
16
66
103

Laravel polymorphic relationships with custom keys

3 Answers3