CakePHP アソシエーションについて

初めに

個人的にアソシエーションに関して、非常に苦戦したと同時に、わかってきたのでアウトプット兼備忘録としてここに書く。

アソシエーションとは

モデル同士の繋がりの事。
アソシエーションには4つの種類があります。
- hasOne
- hasMany
- belongsTo
- belongsToMany

この4種類を一個ずつ噛み砕いていきます。

hasOneとは

関係性としては、１対１となる。

Cookbookの例をテーブル構造にして見てみる。
[https://book.cakephp.org/3.0/ja/orm/associations.html#hasone]

例：ユーザーは１つのプロフィールを持っている。

usersテーブル

profileテーブル

profileテーブルには、usersテーブルのidに対する外部キーuser_idが存在する。

山田太郎は、２というプロフィールをもち、佐藤花子は、3というプロフィールをもっている。
ユーザー（山田太郎や佐藤花子）は、一つのプロフィール（２や３）をもっているが、プロフィールは、一人のユーザーをもっている訳ではない。

テーブルオブジェクトのinitialize()メソッドには、以下のように定義する。

<?php
namespace App\Model\Table;

use Cake\ORM\Table;

class UsersTable extends Table
{
    public function initialize(array $config)
    {
        //　モデル名を入れる
        $this->hasOne('Profile');
    }
}

hasMany

関係性は、１対多。

Cookbookの例をテーブル構造にして見てみる。
[https://book.cakephp.org/3.0/ja/orm/associations.html#hasmany]

例：ユーザーは複数の記事を持つことができる。

usersテーブル

articlesテーブル

山田太郎は、こんばんはとまた明日という記事をもつ。
佐藤花子は、初めましてとよろしくという記事をもつ。
usersテーブルのidに対し、user_idを外部キーとして、articlesテーブルに置く必要があります。

テーブルオブジェクトのinitialize()メソッドには、以下のように定義する。

<?php
namespace App\Model\Table;

use Cake\ORM\Table;

class UsersTable extends Table
{
    public function initialize(array $config)
    {
        //　モデル名を入れる
        $this->hasMany('Articles');
    }
}

belongsTo

関係性は、多対１。

Cookbookの例をテーブル構造にして見てみる。
[https://book.cakephp.org/3.0/ja/orm/associations.html#belongsto]

例：多くの記事がユーザーに属している。

usersテーブル

articlesテーブル

関係性としては、hasManyと逆のイメージ。

こんばんはとまた明日という記事は、山田太郎というユーザーに属している。（山田太郎というユーザーの記事だ。という事）
同様に、初めましてとよろしくという記事は、佐藤花子というユーザーに属している。

テーブルオブジェクトのinitialize()メソッドには、以下のように定義する。

<?php
namespace App\Model\Table;

use Cake\ORM\Table;

class ArticlesTable extends Table
{
    public function initialize(array $config)
    {
        //　モデル名を入れる
        $this->belongsTo('Article');
    }
}

belongsToMany

関係性としては、多対多。

Cookbookの例をテーブル構造にして見てみる。
[https://book.cakephp.org/3.0/ja/orm/associations.html#belongstomany]

例：タグは多くの記事に属している。

articlesテーブル

article_tagsテーブル

tagsテーブル

この関係性をテーブル構造で表すと中間テーブルが必要になる。

記事の情報をもつarticlesテーブル、タグの情報をもつtagsテーブル、この二つのテーブルの架け橋的存在として、article_tagsテーブルがある。

articleテーブルのidに対し、article_idを外部キーとしてarticle_tagsテーブルに置き、tagsテーブルのidに対し、article_idを外部キーとしてarticle_tagsテーブルに置く必要がある。

article_tagsテーブルを見ると、初心者というタグ（id = 100）は、初めましてという記事に属していれば、こんにちはという記事にも属している事がわかる。

article_tagsテーブル(中間テーブル)から見ると、articlesテーブルとtagsテーブルはそれぞれ多対1の関係性になる。

<?php
namespace App\Model\Table;

use Cake\ORM\Table;

class ArticlesTable extends Table
{
    public function initialize(array $config)
    {
        $this->belongsToMany('モデル名');
    }
}

追記

今回記載しなかったが、アソシエーションを定義する時には、第二引数を連想配列の形または、関数呼び出し（->関数名()）の形で条件を指定できる。
例として、第二引数を連想配列の形として定義した場合を記載する。

<?php
namespace App\Model\Table;

use Cake\ORM\Table;

class ArticlesTable extends Table
{
    public function initialize(array $config)
    {
        // 第二引数を連想配列として条件を定義
        $this->アソシエーション名('モデル名', [
            'foreignKey'　=> 'hoge_id',
            'joinType' => 'INNER'
        ]);
    }
}

foreignKeyや、joinType、が何を示しているのかわからない、または、他にどんな条件を定義できるかは、Cookbookを参考にして下さい。

参考：[https://book.cakephp.org/3.0/ja/orm/associations.html]

まとめ

アソシエーションに関わらず、モデルの繋がり（関係性）の理解は非常に大切です。インターン先でそれを実感しています。基礎的な事を中心に書きましたが、応用的に使えるような事をもっと自分の中で落とし込める事ができたら、この記事に追記していこうと思います。

これらの内容に不備、間違った情報等記載してましたら、コメント貰えると嬉しいです。