CakePHP3リレーションまとめ

CakePHP3でリレーションの定義を書くときに、どれを書いていいかわからなくなってきたと耳にしたので簡単にまとめてみます。

テーブル同士の繋がり（リレーション）は大きく分けて一対一・一対多・多対多の３種類があります。
これらに関してまとめていきます。

一対一

カラムが沢山あるテーブルを分解するときとかに使いますね。

UsersTable.php

// ユーザー詳細を1件持っているのでhasOne
$this->hasOne('UserDetails', [
    'foreignKey' => 'user_id',
]);

UserDetailsTable.php

// ユーザーに所属するものなのでbelongsTo
$this->belongsTo('Users', [
    'foreignKey' => 'user_id',
]);

一対多

よく使うリレーションでね。一般的な親子関係のやつ。

ArticlesTable.php

// タグを沢山持っているのでhasMany
$this->hasMany('Tags', [
    'foreignKey' => 'tag_id',
]);

TagsTable.php

// 記事に所属するものなのでbelongsTo
$this->belongsTo('Articles', [
    'foreignKey' => 'article_id',
]);

多対多

ちょっと大きな設計になってくるとよく出現します。
同じタグは他の記事でも使いまわせるようにしたいとかの時。

ArticlesTable.php

// 中間テーブルをjoinTableに記載てbelongsToMany
$this->belongsToMany('Tags', [
    'joinTable' => 'ArticlesTags',
]);

TagsTable.php

// こっちも同じくbelongsToMany
$this->belongsToMany('Articles', [
    'joinTable' => 'ArticlesTags',
]);

belongsToManyが地味に楽ですね。
containで取得時も中間テーブルのレコードは省かれるので、不要な場合はこちらがいいかもしれないですね。