laravel Model の with() のリレーション先カラム名を変更して取得したい

Question

前提

以下のような構成のtable_a, table_bがあります。
table_aとtable_bは一対多の関係にあります。

• table_a

id (int)
name (string)

• table_b

id (int)
table_a_id (int)
name (string)

namespace App\Models;
use Illuminate\Database\Eloquent\Model;

Class TableA extends Model
{
    protected $table = 'table_a';
    public function b()
    {
        return $this->hasMany('App\Models\TableB');
    }
}

namespace App\Models;
use Illuminate\Database\Eloquent\Model;

Class TableB extends Model
{
    protected $table = 'table_b';
    protected $hidden = ['table_a_id',];
    public function a()
    {
        return $this->belongsTo('App\Models\TableA');
    }
}

知りたいこと

例えばtable_bから以下のようにModelを取得すると、

$model = TableB::with('a')->find($id);

{
    "id": 123,
    "name": "hoge",
    "a": {
        "id": 456,
        "name": "fuga"
    }
}

こんな感じになると思います。
ここで、

{
    "id": 123,
    "name": "hoge",
    "a": {
        "a_id": 456,
        "a_name": "fuga"
    }
}

上記のように
id -> a_id
name -> a_name
と、withでリレーション先テーブルのカラム名を任意に変更して取得したいのですが、どなたかご存知ないでしょうか？

version

laravel 5.6

Comments

[mix-peach]

マニュアルに書いてありますよ！
https://readouble.com/laravel/5.6/ja/eloquent-relationships.html
読んで試して、それでも分からない点があれば、改めてこの質問へ追記をしたらいいと思います^^

[takg]

ありがとうございます。
マニュアル見てみたのですが、該当箇所が見つけられませんでした。。。

[mix-peach]

「外部キー」とか、「ローカルキー」とか書いてあるあたりです！
最初から読まないと、似たような説明が省略されていることもあるので、気を付けてください。

[takg]

mix-peach様がおっしゃっているのは、ローカルキー/外部キーが`table名_id`になっていない場合などに明示的に指定する方法ではないでしょうか？

SQLで書くと、
SELECT a.id as a_id, a.name as a_name
FROM table_b AS b
LEFT JOIN table_a as a
ON b.a_id = a.id
WHERE b.id = ?;
における "a.name as a_name" の部分のように、
リレーション先の列名を任意のものに変更する方法が知りたいので、少し違う気がしたのですが。。。

もしも誤解であれば、申し訳ありません。

[mix-peach]

はっ！質問を読み違えていたようで、申し訳ないです；；
正しい回答を、書いてくださっている方がいるので、主には、そちらを参考に！
他の方法も回答に書いてみますね（あんまりオススメしない方法ですが）

[takg]

見直してみると、質問の文章が少しわかりにくかったです。
修正しておきます。
ご回答、ありがとうございました。

Answer 1

crhgさんが書かれている方法が、正しいと思いますので、主にはそちらを参考にしてください。

---

他の方法のお話。

いつでも

{
    "id": 123,
    "name": "hoge",
    "a": {
        "a_id": 456,
        "a_name": "fuga"
    }
}

の形で取得したくて、
つまり、「withするたびに、いちいちカスタマイズの指定を書くのはめんどくさい！」とかいう場合。

予め取得対象のカラムを指定するのと同じ要領で、TableBのModelのbelongsToに書いてしまう方法もあります。

public function a()
    {
        return $this->belongsTo('App\Models\TableA')
                    ->select([
                      'id as a_id',
                      'name as a_name',
                      'table_a_id']
                    );
    }

こんな感じで、いけたはず・・
※　外部キー「table_a_id」は、必ず含めてください。

コメントにも書いたのですが、この方法をオススメしないのは、

aの取得結果が、いつでもa_id,a_nameになってしまうので、「直感的にlaravelのwith」として使った場合に正しく参照できない可能性が高いことや、取得カラムを増やしたい場合に追記しなければいけないことなど、本来の利便性で失われる面があるからです。。。

「システム全体」で、このような共通の仕様（テーブルのリレーション先を見る時、カラム名はテーブル名が先頭に付く）があるのであれば、この方法でも特には問題ないかもですね。

Comments

[takg]

ご回答ありがとうございます。
なるほど、belongTo()の時点で設定しておくこともできるのですね。
勉強になりました。

Answer 2

マニュアルの「Eagerロードへの制約」のところに書いてあるクロージャでクエリビルダをもらっていろいろ操作を行うやり方は

もちろんEagerロード操作を更にカスタマイズするために、他のクエリビルダを呼び出すこともできます。

とあるように他のカスタマイズにも使えますので、selectを使って別名をつけることができます。

        $model = TableB::with(['a' => function ($query) {
            $query->select(
                'id AS a_id',
                'name AS a_name',
                'table_a_id'    // リレーションに使うカラムは必ず含める必要があります
            );
        }])->find($id);

Comments

[takg]

ご回答ありがとうございます。
教えていただいた方法で実現できました!