Laravel フォームからPivot中間テーブルに保存する方法【attach・sync・detach】

Laravelデータベース

フォームで新規登録を行うときに、Pivot中間テーブルにも簡単にデータを保存する方法を紹介します。

中間テーブルにデータを保存する時には、 attach関数を使うと便利です。

Pivotで役立つattach, sync, detach関数を、実際のコードを使って解説していきますね。

Laravel フォームから中間Pivotテーブルにデータ保存【attach・sync】

実現したいこと

ユーザーテーブルとロールテーブルの間に、中間テーブルを作ってあるとします。

フォームを作り、ユーザー新規登録時にユーザーのロールも登録するようにします。

フォームの【登録】ボタンを押すと、下記の形で、ふたつのテーブルにデータが保存されるようにします。

  • ユーザーテーブルにはユーザーの名前・メールアドレス・パスワードを保存
  • 中間テーブルにはユーザーのIDとロールIDを保存

belongToManyリレーションを構築

あらかじめblongToManyリレーションを使って、中間テーブルを用意しておきましょう。

下記記事で詳しく手順を説明しているので、参考にしてください。

モデルファイルには、リレーションを作るために次のように記述しておきます。

【User】

【Role】

フォーム作成のポイント

新規ユーザーを登録する時に、ロールも選択する形にします。

ロール部分のコードは次のように記述します。

フォーム作成時のポイントは下記2点

  • nameには【role_id】という値を入れておきます。
  • valueにも【role->id】を設定しておきます。

コントローラーへの記述【attach】

コントローラーにはattachを使って保存のコードを書きます。

全体は次のようになります。

コントローラーを記述する際のポイントは下記2点。

  • 中間テーブルへの保存は、ユーザーの保存の後に記述する。
  • 中間テーブルへの保存には【attach】関数を使う。

attach関数は、多対多のリレーション用にLaravelが用意してくれているヘルパ関数。

attach を使うと、簡単に中間テーブルにデータを挿入できます。

公式マニュアルには、次のように書かれています。

多対多リレーションを操作時により便利なように、Eloquentはヘルパメソッドをいくつか用意しています。(略)
モデルを結びつけている中間テーブルにレコードを挿入することにより、ユーザーに役割を持たせるにはattachメソッドを使います。

*引用元:公式マニュアル

コントローラーへの記述【sync】

attachを使うと、Pivotテーブル内にデータの重複が起こります。

もしテーブル内の値を重複させたくないときは、syncを使います。

全体は次のようになります。

これで、同じユーザーが同じロールをもつデータが重複登録されることはなくなります。

ただし、同じユーザーが複数のロールを持つことは可能です。

削除するときは【detach】

あるroleやuserを削除するときには、Pivotテーブルにも反映させておきましょう。

こういった場合に使えるのが 【detach】。

IDを指定しない場合はこちら。

detachによって、連携を解除させることができます。

detachを行っても、各モデルのテーブルの値は削除されません。

反対にdetachを行わないと、実体を削除しても、Pivotテーブル上にだけデータが残ってしまいます。

さいごに

無事、あなたの実現したいことができることを願ってます!

Laravelのリレーションは他の記事でも紹介しているので、良かったら併せて見てみてくださいね。

Laravelデータベース

【Laravelの教科書・プレゼント】

Junko
Laravelの使い方を覚えたい!と思ったら、ぜひ、役立ててほしいです。 基礎編は無料でプレゼント中です♪
ひつじプログラマ
会員制サイトをいちから作っていくよ。ボタンをクリックして詳細を見てね。
Laravelの教科書の詳細を見る

最新のLaravel11版テキストに加え、Laravel8版・Laravel9版・Laravel10版もご用意しています♪

【無料プレゼント】

「LaravelでWebアプリをいちから作れるようになりたい!」

そんなLaravel初心者のあなたへ【Laravelの教科書】基礎編プレゼント中! 会員制フォーラムサイトを学習しながら作れます。

詳細はこちらをクリック

最新のLaravel11版テキストに加え、Laravel8版・Laravel9版・Laravel10版もご用意しています♪

【AWS関連・Webアプリ開発・生成AIのAPI活用のご相談承ってます】
お気軽にお声がけください。
御社にとって、最善の方法をご一緒に考えてまいります。
Zoomミーティング実施中。サンプルアプリご利用可能です。

お問合せフォーム

Laravelの本を書きました。


ひつじが目印♪
クリックするとamazonページへ。

Laravelの使い方を分かりやすく解説した書籍を出版しました。書店やAmazon等のオンラインショップにて販売中です。
Laravel10対応。Laravel11サポートガイドもご用意しています。詳しくは下記ボタンをクリック♪

書籍の詳細を見てみる

Laravelの本を書きました。


ひつじが目印♪
クリックするとamazonページへ。

最新版Laravel11用のサポートガイドご用意しています。

Laravelの使い方を分かりやすく解説した書籍を出版しました。書店やAmazon等のオンラインショップにて販売中です。

書籍の詳細を見てみる
Twitter始めました。
40代からプログラミング!

コメント

  1. 同じく40代からLaravel勉強中 より:

    はじめまして。
    Laravel8を勉強中にこちらの記事を見つけました。
    大変参考になり助かっております。
    ありがとうございます。

    少し質問がありましてコメントをさせていただきました。

    記事中の中間テーブルに「withPivot」でカラムを追加して
    追加カラムを含めたフォームからの登録や、データ表示というのはどのようにすると良いでしょうか?

    今私がそこのあたりで壁となっており行き詰まりを感じておりましたので
    いきなり失礼かと存じますが、もし記事作成のネタになりそうでしたら嬉しく思います。

    どうぞよろしくお願いいたします。

タイトルとURLをコピーしました