Eloquentのmorphとwithの併用は可能か？

Question

EloquentのPolymorphic RelationsでHogeとFugaを使い分けているデータがあるとします。

hoge

id	name	number
1	hoge	0
```php
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Hoge extends Model
{

public function base() {
    return $this->morphMany(Base::class, 'ref');
}

}

### fuga
|id|name|text|
|:--|:--|
|1|fuga|a|
```php
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class fuga extends Model
{
    public function base() {
        return $this->morphMany(Base::class, 'ref');
    }
}

base

id	ref_id	ref_type
1	1	Hoge
2	1	Fuga
```php
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Base extends Model
{

public function ref() {
    return $this->morphTo();
}

}

このとき、withメソッドを使わずBaseを得たときの挙動はこうなります。
```php
$base_list = Base::all();
// [
//   ['id' => 1, 'ref_id' => 1, 'ref_type' => 'Hoge'],
//   ['id' => 2, 'ref_id' => 1, 'ref_type' => 'Fuga']
// ]

さらに、withを使うとこうなります。

$base_list = Base::with(['ref'])->all();
// [
//   ['id' => 1, 'ref_id' => 1, 'ref_type' => 'Hoge', 'ref' => [id  => 1, 'name' => 'hoge', 'number' => 0]],
//   ['id' => 2, 'ref_id' => 1, 'ref_type' => 'Fuga', 'ref' => [id  => 1, 'name' => 'fuga', 'text' => 'a']],
// ]

ここまではいいのですが、例えばHogeにだけ新たにImageモデルのリレーションを加えたとします。

image

id	hoge_id	path
1	1	image.jpg

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Image extends Model
{
    public function hoge() {
        return $this->belongsTo();
    }
}

Hoge(改変)

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Hoge extends Model
{
    public function base() {
        return $this->morphMany(Base::class, 'ref');
    }
    public function images() {
        return $this->hasMany(Image::class);
    }
}

このあと、HogeのImageも欲しいので以下のようにwithを書き直すとエラーになります。

$base_list = Base::with(['ref', 'ref.images'])->all();
// Hogeにはimagesがあるが、Fugaにはimagesのリレーションがないのでエラー

当たり前だ、と言われればそれまでなのですが、「あったら取る」「なければnull、またはプロパティ自体が無い」状態のデータが取得したいのです。なんとか方法はないでしょうか。

試したこと

• Hogeモデルのappendsにimageを加え、getImageAttributeを実装する

class Hoge extends Model
{
    public function base() {
        return $this->morphMany(Base::class, 'ref');
    }
    public function images() {
        return $this->hasMany(Image::class);
    }
    protected $appends = ['images'];
    public function getImagesAttribute($value) {
        return $this->images; // なぜかここでimagesというattributeは無いとエラーになる。
        // なお外部から$hoge->imagesとアクセスした場合はエラーにならない
    }
}

Answer 1

試した方法の「$appendsにimageを加える」で、なぜエラーになるのかをコードを追っていったところ、以下のコードを見つけました。

// Illuminate\Database\Eloquent\Concerns\HasAttribute

    public function getAttribute($key)
    {
        if (! $key) {
            return;
        }

        // If the attribute exists in the attribute array or has a "get" mutator we will
        // get the attribute's value. Otherwise, we will proceed as if the developers
        // are asking for a relationship's value. This covers both types of values.
        if (array_key_exists($key, $this->attributes) ||
            $this->hasGetMutator($key)) {
            return $this->getAttributeValue($key);
        }

        // Here we will determine if the model base class itself contains this given key
        // since we do not want to treat any of those methods are relationships since
        // they are all intended as helper methods and none of these are relations.
        if (method_exists(self::class, $key)) {
            return;
        }

        return $this->getRelationValue($key);
    }

このgetAttributeというメソッドはモデルに対し__getの呼び出し時に呼ばれるメソッドで、$appendsで加えたいプロパティ名と、リレーションのメソッド名が同一である場合、以下のifに引っかかってしまうようです。

        if (method_exists(self::class, $key)) {
            return;
        }

なので、このgetAttributeの最後で呼ばれているgetRelationValueを直接呼べばいいんじゃないか？と思って試したところ、希望通りの動作をしました。

class Hoge extends Model
{
    public function base() {
        return $this->morphMany(Base::class, 'ref');
    }
    public function images() {
        return $this->hasMany(Image::class);
    }
    protected $appends = ['images'];
    public function getImagesAttribute($value) {
        return $this->getRelationValue('images');
    }
}

やはり多少面倒でもコードを追うことは大事だということをまた実感させられました。

Comments

[masaya_ohashi]

嫌がらせでマイナスつけていくのやめてもらえませんかね…

Answer 2

以下のように、一度対象のプロパティにアクセスすれば、強引に値を読み込ませることができ、以降はimageもtoArrayに含まれるようになりました。

$base_list = Base::with(['ref'])->all();
foreach($base_list as $index => $base) {
    if($base->ref_type == 'Hoge') {
        $base->images;
    }
}
// [
//   ['id' => 1, 'ref_id' => 1, 'ref_type' => 'Hoge', 'ref' => [id  => 1, 'name' => 'hoge', 'number' => 0, 'images' => [['id' => 1, 'hoge_id' => 1, 'path' => 'image.jpg']]]],
//   ['id' => 2, 'ref_id' => 1, 'ref_type' => 'Fuga', 'ref' => [id  => 1, 'name' => 'fuga', 'text' => 'a']],
// ]

とても泥臭いので、もう少しだけ他の方の意見を待ちたいと思います。