cakephp3 アソシエーションの設定におけるカラム名の明示的な設定について

Question

テーブルクラス内にアソシエーションの設定をする場合に、"テーブル名_id"の形式の場合は規約に従ってアソシエーションの設定がされますが、明示的に"***_id" 以外の形式のカラムと紐づける場合にはどのように記述すればよいのでしょか。

Themes.staffs_template = Templates.id
Themes.talks_template = Templates.id
のように「テーマ」テーブルの●●テンプレートカラムとテンプレートマスタのIDを紐づけたいです。

ThemesTable.php

$this->belongsTo('Templates', [
    'foreignKey' => 'staffs_template',
    'joinType' => 'INNER'
]);

よろしくお願いします。

Answer 1

第1引数はアソシエーションの名前です。そのまま Theme エンティティーのフィールド名になります(ただし lower_snake 単数形)。

[ThemesTable]

$this->belongsTo('StaffsTemplates', [
    'foreignKey' => 'staffs_template_id',
    'className' => 'Templates',
    'joinType' => 'INNER'
]);
$this->belongsTo('TalksTemplates', [
    'foreignKey' => 'talks_template_id',
    'className' => 'Templates',
    'joinType' => 'INNER'
]);

[ThemesController]

$theme = $this->Themes->get($id, [
    'contain' => ['StaffsTemplates', 'TalksTemplates'] // アソシエーション名を指定
]);
debug($themes); /*
object(App\Model\Entity\Theme) {
  'id' => (int) 1,
  'staffs_template_id' => (int) 2,
  'talks_template_id' => (int) 1,
  'talks_template' => object(App\Model\Entity\Template) {
  	'id' => (int) 1,
  },
  'staffs_template' => object(App\Model\Entity\Template) {
  	'id' => (int) 2,
  },
}
*/// …みたいな構造が返ってくる

ちなみに cake 上で変数を出すなら debug 関数が超絶便利です。(layoutなどの環境にもよりますが)

Comments

[tozjp]

> (ただし lower_snake 単数形)
many 系アソシエーションの場合は複数形のままだったかもしれません。ほんと頭いい。

[Shinroh]

ありがとうございます。試してみます。
結果はまた報告しますね。

Answer 2

// モデル
public $primaryKey = '紐付けたいカラム名';

で主キーを切り替えれます。
戻るのを忘れないように！

Comments

[Shinroh]

すみません、もう少し具体的にどのように使うかを教えていただけないでしょうか…。
経験不足で申し訳ありません…。

少しCookbookで調べて、ThemesTable.phpに以下のように書いたのですが、

$this->belongsTo('Templates', [
'className' => 'Templates',
'foreignKey' => 'staffs_template',
"bindingKey" => "id",
'joinType' => 'INNER',
'propertyName' => 'staffs_template'
]);
$this->belongsTo('Templates', [
'className' => 'Templates',
'foreignKey' => 'talks_template',
"bindingKey" => "id",
'joinType' => 'INNER',
'propertyName' => 'talks_template'

ThemesController.phpから以下のように書いてやると、

$themes = $this->Themes->get($id, ["contain" => ["Templates"]]);
var_dump($themes);

themes.staffs_template => 1　（取得したいtemplate.idの値が保存されていてそのまま出力された）
themes.talks_template => templateのエンティティオブジェクト

IDの異なる一つのエンティティクラスを複数返すようなアソシエーションの設定はできないんでしょうか？