プログラミング

【Laravel】1対1リレーションをわかりやすく解説(hasOne)

Laravel PHP
【Laravel】1対1リレーションをわかりやすく解説(hasOne)

 

Laravelの1対1リレーションのhasOneについて、公式マニュアルでは専用単語ばかりでどうしてもわかりにくいと感じてしまっている方へ向けて、わかりやすく解説しました。

※例で紹介しているコードについては、一部英語を日本語表記で使用している部分もありますので、コピペで使用する方は必要に応じて置き換えてください。

 

今回は以下のLaravel7系の公式マニュアルを参考にしながらまとめています。

 

子から親へのリレーション(belongsTo)について詳しく知りたい方は、以下をご参考ください。

【Laravel】1対1リレーションをわかりやすく解説(belongsTo) 【Laravel】1対1リレーションをわかりやすく解説(belongsTo)

Laravelの1対1リレーションのbelongsToについて、公式マニュアルでは専用単語ばかりでどうしてもわかりにくいと感じてしまっている方へ向けて、わかりやすく解説しました。 ※例で紹介しているコードについては、一部英語を日本語表記で使用している部分もありますので、コピペで使用する方は必要に応じて置き換え...

 

 

hasOne(親から子へ)

 

# 公式より

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
    /**
     * ユーザーに関連する電話レコードを取得
     */
    public function phone()
    {
        return $this->hasOne('App\Phone');
    }

}

 

1対1のリレーションとは、とあるテーブルの1つの要素と別のテーブルの1つの要素の関係を結びつけることです。この時、どちらかが複数になることはありません

そのため、イレギュラーがなければ各テーブルの行数は以下の関係が成り立ちます。

親 ≧ 子

 

親のいない子が生まれるということは有りえませんので当然のことです。

※道徳的な意味は除きます

 

ここで重要になるのは、テーブル関係のどちらが親で、どちらが子に該当するかです。これはテーブル内の値の持ち方によって決められます。

 

 

公式マニュアル通り、ユーザーと電話のテーブルで考えてみましょう。

上記テーブル関係の場合、ユーザーが親電話が子になります。この見分け方は、判別するためのIDを持っているテーブルが子になるということです。電話テーブルにはユーザーを判別するための「ユーザー_id」がありますね。

判別するIDを持っている方が子になる

 

親と子の見分け方がわかったので、次にhasOneについて見ていきましょう。

公式マニュアルのコードをわかりやすく上記テーブルのように日本語へ置き換えて考えます。 

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class ユーザー extends Model
{
    public function 電話()
    {
        return $this->hasOne('App\電話);
    }
}

 

hasOneは親から子に結びつけるためのリレーションなので、ユーザーのモデルに記述します。この時、電話のモデルが存在しなければリレーションができないので、事前に準備しておきましょう。

 

 

引数の解説

 

hasOne('モデル', '外部キー[省略可]', 'ローカルキー[省略可]');

 

hasOneでは上記のように第3引数まで設定でき、第2、3引数は省略することが可能です。それでは1つずつ順番に確認していきましょう。

 

 

第1引数

 

モデルには、リレーション先(子)のモデルを指定します。今回であれば、親であるユーザーテーブルに「子の電話テーブルと結びつける」という指示を出したいので、第一引数には子に該当する電話モデルを指定します。

return $this->hasOne('App\電話');

 

Laravelのテーブル命名規則に従っていれば、これだけでリレーション関係を結びつけることができます。 

リレーションで役立つLaravelのテーブル命名規則をざっくり解説

  1. 親テーブル側の判別カラムが「id
    ※カスタムプライマリーキーでも可
  2. 子テーブル側の判別カラムが「親テーブル単数名 + _id

 

今回は上記の条件が満たされているので、第2、第3引数は省略可能です。

 

 

第2引数

 

第2引数では、外部キーを指定することができます。外部キーという表現がわかりにくい場合は「親を判別するための値が格納されている、子テーブルのカラム名」と考えてください。

hasOneの外部キーとは

親を判別するための値が格納されている、子テーブルのカラム名

 

今回のテーブル関係であれば親は「ユーザー」子が「電話」ですね。電話が持つユーザーを判別する値は「ユーザー_id」なので、省略した場合は第2引数にはこの値が初期値としてセットされることになります。

return $this->hasOne('App\電話', 'ユーザー_id');

 

例えば、テーブルのカラムが以下の用に設定されていたケースで考えてみましょう。

 

これだと第1引数でモデルを指定しても、命名規則に従っていなければどのユーザーのidと電話のどの値が一致する行と結びつければいいかわかりません。上記テーブルであれば、親であるユーザーを判別している値が格納されているリレーション先のカラムは「ユーザー番号」なので、以下のようにリレーションを指定します。 

return $this->hasOne('App\電話', 'ユーザー番号');

 

こうすることで、リレーション先のカラム名に関係なくリレーション関係を結ぶことができます。

 

 

第3引数

 

第3引数ではローカルキーを指定することができます。こちらもわかりやすく言い換えれば、「親を判別する値が格納された親テーブルが持つカラム」です。 

hasOneのローカルキーとは

親を判別する値が格納された親テーブルが持つカラム

 

以下のテーブルで考えてみましょう。

※idの値を使用して判別するのが一般的で、このような格納方法をしているケースはまずありませんが、hasOneをわかりやすく理解するために上記テーブル関係を使用します

 

第2引数では子(電話)が持つ親(ユーザー)を判別する値が格納されたカラムを指定するので「ユーザーの名前」が入ります。そして、第3引数では親(ユーザー)を判別する値が格納された親テーブルが持つカラムを指定するので「名前」を指定します。

return $this->hasOne('App\電話', 'ユーザーの名前', '名前');

 

これでリレーションを結ぶことができました。第3引数までを上手く利用すれば、1対1の関係性が成立していればリレーションを結べます。

 

 

条件の追加

 

モデルにリレーションを追加する際に、様々な条件に合わせて取得する値を変えたり、不要なデータはそもそも取り除いて取得したいというケースもありますね。そういったときにはリレーションに対して条件をつけることができます。そのいくつかをご紹介します。

 

 

論理削除を含む

 

もしsoft delete(論理削除)を使用している場合は、通常通りリレーションを結べばdeleted_atがセットされているデータは紐付けされません。しかし、場合によっては必要になるケースもあります。その使用頻度が高いのであれば、リレーションとして準備しておくことで開発がよりスムーズになります。

論理削除したデータも含めたい場合は、以下のように記述します。

return $this->hasOne('App\Phone')->withTrashed();

 

withTrashedというメソッドをつなげることで、論理削除した値も含めて取得してくれます。

 

 

条件に合わせた絞り込み

 

他にも、条件に応じて絞り込みをしたいケースもあるでしょう。その時は、Laravelのwhereメソッドなどを利用できます。

 以下のテーブルを参考に、statusが1の値だけをリレーションで取得します。

return $this->hasOne('App\Phone')->where('status', '1');

 

これでstatusの値が1になっている番号だけを紐付けすることができます。リレーション段階で安易につなげてしまえば、必要なデータが取得できないようなことにもなりますので、必要に応じてモデルのメソッドを増設するなどして対応しましょう。

 

 

まとめ

 

いかがだったでしょうか。

今回はLaravelの1対1リレーション「hasOneについて」をわかりやすく解説しました。

公式マニュアルを見ても専用単語ばかりで分かりづらいと感じて曖昧なままリレーションを使っていたり、断念してしまった方はぜひ参考にしてくださいね。

子から親へのリレーション(belongsTo)について詳しく知りたい方は、以下をご参考ください。

【Laravel】1対1リレーションをわかりやすく解説(belongsTo) 【Laravel】1対1リレーションをわかりやすく解説(belongsTo)

Laravelの1対1リレーションのbelongsToについて、公式マニュアルでは専用単語ばかりでどうしてもわかりにくいと感じてしまっている方へ向けて、わかりやすく解説しました。 ※例で紹介しているコードについては、一部英語を日本語表記で使用している部分もありますので、コピペで使用する方は必要に応じて置き換え...

 

Laravelの基礎を学習したい方は、以下の書籍が参考になります。

PHPフレームワークLaravel入門 第2版 PHPフレームワークLaravel入門 第2版

Laravel使って開発するなら読んでおいて損はないぞ! 入門という名の通り、最初に読むべき1冊や。PHPの最低限の知識は必要やから、そこがまだ十分じゃ無い人はPHPの入門書や実践書に目を通すんやで。 Viewの使い方やbladeの記述方法とか詳しく載ってるから、使ったこと有るけど詳しくは知らん人にとっても「おっ!便...

 

注目の記事

プログラミングでフリーランスを目指す人にPHP学習をオススメする3つの理由
プログラミング
Laravel,PHP,SEO,WordPress
プログラミングでフリーランスを目指す人にPHP学習をオススメする3つの理由

  「フリーランスになるためにプログラミングを身に着けたい」 「セカンドキャリアで技術を習得したい」 「副業でパソコン1台で稼げるものに挑戦したい」   終身雇用が危ぶまれている現在、スキルを身に着けて転職やフリーランスとして活躍したいと考える人が増え、プログラミングの需要は年々高まってきて...

【無料】早起きをして神戸へ行こう!「為になる雑談朝活」
イベント
三宮,朝活,神戸
【無料】早起きをして神戸へ行こう!「為になる雑談朝活」

  朝活を実施することになりましたので、その目的な概要をまとめました。 神戸三宮での開催を予定しておりますので、もしお近くにお住まいの方で日時が会いましたらご参加ください。 土日祝辺りで週1日程度の不定期開催を予定しています。学びにつながる、けど参加しやすい雑談形式ということを主としています...

ピカチュウから学ぶオブジェクト指向 〜レベルアップ編〜 5
プログラミング
PHP,PHPポケモン,オブジェクト指向,ポケモン
ピカチュウから学ぶオブジェクト指向 〜レベルアップ編〜 5

  第3回でレベルシステムを導入し、第4回では経験値システムの導入をしたので、今回はそれを合わせたレベルアップのシステムを導入します。 第1回から作成しているコードを使用しているので、もし最初から学習したい人は第1回の入門編をご覧ください。     レベルアップシステムの導入   レベル...

SNSだけじゃダメ!PV数アップのためにSEO対策する理由とは
SEO対策
Twitter
SNSだけじゃダメ!PV数アップのためにSEO対策する理由とは

  「SNSで集客しているけど中々伸びなくなってきた」 「たまにPV数がアップするけど安定しない」 「本当に月何十万も稼げるぐらいPVは伸びるの?」   PV数を稼ぐためにSNSを駆使したり、中には広告を使って集客しているサイトもあるでしょう。ですが、それだけでは疲弊しながらユーザーを獲得しているに...

これってスパム?amazon・paypalを装う悪質メールの対処方法とは
ネットワーク
amazon,Paypal,Xserver,スパム,三井住友,楽天,迷惑メール
これってスパム?amazon・paypalを装う悪質メールの対処方法とは

定期更新、役立つコラムのコーナー!   今回の注目したのは「迷惑(悪質)メールについて」です。   以前はamazonや楽天を名乗る業者から届いた迷惑メールについて紹介、その対処方法について取り上げましたが、今回は更にレベルアップしたスパムがいくつか届いたので、それらも紹介がてら、騙されないため...

経験値取得アニメーション編(動画有り) PHPポケモン 47
プログラミング
PHP,PHPポケモン,ポケモン
経験値取得アニメーション編(動画有り) PHPポケモン 47

経験値取得アニメーションの実装 最近は技の実装が続いていたので、気分転換にフロント側の演出づくりをしていきます。その中でも今回実装するのは「経験値取得アニメーション」です。 経験値バーはポケモンの第2世代から追加実装された演出です。初代では次のレベルにアップするまでの数値を、わざわざポケモンの...

ナンパしてたら独立できた「人間力の鍛え方」
フリーランス
コミュニケーション能力,ナンパ
ナンパしてたら独立できた「人間力の鍛え方」

  経験談から、人間力を鍛える方法をご紹介します。 今回は「ナンパ」がテーマです。なので、少し男性目線の内容になります。 女性の方は、「男性はこうやって考えている人もいるんだ」といった参考にしてください。   ナンパなんて、と思う人もいるでしょう。 ハラスメント規制も強くなる現代では、安易な...

PHPポケモン「わざ編〜わるあがき〜」35
プログラミング
PHP,PHPポケモン,ポケモン
PHPポケモン「わざ編〜わるあがき〜」35

わるあがき そろそろ技のPPを実装段階にきたので、その前に「わるあがき」という技を作成しましょう。「わるあがきって何?」という人のために、どういった技なのか簡単に説明します。 全ポケモン使用可能。ただし、レベルアップなどで普通のわざとして覚えることはできず、自分の技がすべて選択不能になった場合...

カテゴリ

SEO対策 イベント デザイン ネットワーク ビジネスモデル フリーランス プログラミング マーケティング ライティング 動画編集 雑記

タグ

5G Adobe AfterEffects AI ajax amazon Animate api artisan atom Automator AWS Bluetooth CSS CVR description EC-CUBE4 ECショップ ESLint Facebook feedly foreach function Google Google AdSense Honeycode htaccess HTML IEEE 802.11ax Illustrator Instagram IoT JavaScript jQuery jQuery UI keyword LAN Laravel Linux MacBook MAMP meta MLM MySQL NoCode note OS OSI参照モデル Paypal Photoshop PHP phpMyAdmin PHPポケモン PremierePro rss SEO SEO対策 Sequel Pro Skype SNS SSH Symfony TCP/IP title Toastr Trait Twig Twitter UCC V系 WAN WebSub Wi-Fi wiki Windows WordPress XAMPP xml Xserver YouTube YouTuber Zoom アーティスト アウトプット アクセス層 アニメーション アフィリエイト イーブイ インターネット インプット エンジニア オブジェクト指向 お金配り クリック単価 クリック数 コミュニケーション能力 コロナ コンサルティング サムネイル システムエンジニア スタートアップ スタイルシート スパム データベース ディープフェイク デザイナー デザイン テレワーク ナンパ ニュース ネットワークモデル ノマドワーク バナー ピカチュウ ビジネス フィード フリーランス ブロガー ブログ プログラマー プログラミング プログラミング学習 プログラミング教育 プロトコル ホームページ制作 ポケモン マークアップ マーケティング メール リモートワーク レンダリング 三井住友 三宮 仕事依頼 児童デイ 児童デイサービス 児童発達支援 公開鍵 初心者 助成金 勉強法 営業 広告 広告収入 必勝マニュアル 放課後等デイサービス 朝活 楽天 深層学習 無線LAN 独立 神戸 福祉 秘密鍵 翻訳 自己啓発 英語 見積書 計算機 読書 起業 迷惑メール 配列 銀の弾丸 集客 雑学力