CakePHP 2.3　ID以外のカラムでアソシエーション（連携）をさせる場合

2013/12/17 2017/03/11

ID以外のカラムでアソシエーション

アソシエーションさせるサンプルコード

　
CakePHPで ID以外のカラム同士でテーブルをアソシエーション（連携）させたい場合の方法について書いておきます。
　
　
そもそもは baserCMSでプラグインを作っているとき、いずれの項目もユニークではありつつ、IDにはしたくない項目同士を連携させたい、と思ったことがきっかけでした。
ただ、baserCMSのテーブル連携は、CakePHPとは少し仕様が違うようですので、baserCMSで悩んでいる方は、「baserCMS　ID以外のカラムでアソシエーション（連携）をさせる場合」を参照してください。
（baserCMSは、CakePHPをベースに作られている CMSですので、本来はプラグインを作る際も CakePHPのルールに則って作っていきます。）
　
　
下記の「details.post_id」と「posts.id」の項目を連携させることは、CakePHPのルールに命名規約に則っていますので、「$hasOne」でも「$belongsTo」でもどちらでも簡単に連携させることができます。
　
ですが、「details.sec_code」と「posts.sec_code」を連携させたい場合にはどうすればいいの？という場合の対応が今回の主題です。
　
　
まず、下記 2つのテーブルを生成します。
データは、適当に登録してください。その際、それぞれのテーブルの「sec_code」の項目で連携をさせますので、いくつかのレコードは連携できるよう同じ情報を編集してください。
　
—————–テーブル「posts」

CREATE TABLE IF NOT EXISTS `posts` (
  `id` int(8) NOT NULL AUTO_INCREMENT,
  `sec_code` char(4) DEFAULT NULL,
  `name` varchar(255) DEFAULT NULL,
  `created` datetime NOT NULL,
  `modified` datetime NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB  DEFAULT CHARSET=utf8;

CREATE TABLE IF NOT EXISTS `posts` (

`id` int(8) NOT NULL AUTO_INCREMENT,

`sec_code` char(4) DEFAULT NULL,

`name` varchar(255) DEFAULT NULL,

`created` datetime NOT NULL,

`modified` datetime NOT NULL,

PRIMARY KEY (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8;

—————–
　
—————–テーブル「details」

CREATE TABLE IF NOT EXISTS `details` (
  `id` int(8) NOT NULL AUTO_INCREMENT,
  `post_id` int(8) NOT NULL,
  `sec_code` char(4) DEFAULT NULL,
  `list` varchar(255) DEFAULT NULL,
  `created` datetime DEFAULT NULL,
  `modified` datetime DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB  DEFAULT CHARSET=utf8;

CREATE TABLE IF NOT EXISTS `details` (

`id` int(8) NOT NULL AUTO_INCREMENT,

`post_id` int(8) NOT NULL,

`sec_code` char(4) DEFAULT NULL,

`list` varchar(255) DEFAULT NULL,

`created` datetime DEFAULT NULL,

`modified` datetime DEFAULT NULL,

PRIMARY KEY (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8;

—————–
　
続いて、Modelの設定です。
今回の件においては、この Modelの設定が一番大事な処理になります。
　
「$primaryKey」は、「/model/Detail.php」「/model/Post.php」の両方に書いてありますが、「Detail2」の「$belongsTo」で連携させる場合は、連携先の「/model/Post.php」の方に記述します。
「$hasOne」で連携させる場合は、自身の「/model/Detail.php」の中に記述をします。
　
その動きを確認するために、どちらかの「$primaryKey」の行を消してみると、消した方の変数が表示されなくなりますので、動きの内容が理解できるでしょう。
　
—————–（/Model/Detail.php）

<?php
class Detail extends AppModel {

  var $primaryKey = 'sec_code';

  var $belongsTo = array(
    "Detail2" => array(
      "className" => "Post",
      "foreignKey" => "sec_code",
    ),
  );

  var $hasOne = array(
    "Detail3" => array(
      "className" => "Post",
      "foreignKey" => "sec_code",
    ),
  );
}
?>

<?php

class Detail extends AppModel {

var $primaryKey = 'sec_code';

var $belongsTo = array(

"Detail2" => array(

"className" => "Post",

"foreignKey" => "sec_code",

);

var $hasOne = array(

"Detail3" => array(

"className" => "Post",

"foreignKey" => "sec_code",

);

}

—————–
　
—————–（/model/Post.php）

<?php
class Post extends AppModel {

  var $primaryKey = 'sec_code';

}
?>

<?php

class Post extends AppModel {

var $primaryKey = 'sec_code';

}

—————–
　
続いて、Controllerです。
こちらは、単にテーブルの値を表示させる処理とするため、簡単に記述しています。
　
—————–/Controllers/DetailsController.php

<?php
class DetailsController extends AppController {
  function index() {
    $datas = $this->Detail->find('all');
    $this->set('datas', $datas);
  }
}
?>

<?php

class DetailsController extends AppController {

function index() {

$datas = $this->Detail->find('all');

$this->set('datas', $datas);

}

—————–
　
最後に View。
こちらも受け取った値を表示させるだけですので、「print_r」コマンドで簡単に表示しています。
　
—————–/Views/Details/index.ctp

<?php
  echo "<pre>\n";
  print_r($datas);
  echo "＜/pre>\n";
?>

<?php

echo "<pre>\n";

print_r($datas);

echo "＜/pre>\n";

—————–
　※一部全角「＜」を使用しています。
　
　

PHPフレームワーク CakePHP 3入門

参考サイト

　
また、今回の記事を書くのに参考にしたのは下記のサイトですが、下記のサイトには Model内に記述する方法の他に、Controllerで記述する方法も書かれています。
http://labo.tsuchinokopro.com/2010/02/287/
　
※この方法で「$primaryKey = ‘sec_code’」を指定すると、個別の詳細ページを表示させる際のキーになるカラムが「sec_code」になりますので注意が必要です。
　詳しくは CakePHP 2.3　ID以外のカラムでアソシエーション（連携）をさせる場合の詳細ページの注意点を参照ください。
　
　
　
【Cakephp 2.3・baserCMS　テーブルの連携（アソシエーション）関連記事】
baserCMSでオリジナルのデータベースから情報を取得する場合
 CakePHP 2.3　ID以外のカラムでアソシエーション（連携）をさせる場合
 CakePHP 2.3　ID以外のカラムでアソシエーション（連携）をさせる場合の詳細ページの注意点
 CakePHP 2.3　連携先のテーブルの項目で条件抽出する場合
 CakePHP 2.3　テーブルの項目を演算した結果を条件として抽出する方法
 baserCMS　ID以外のカラムでアソシエーション（連携）をさせる場合

- CakePHP 2.x　3.x

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3チュートリアルで日付と時刻のDateTimeでエラーが出たときの対処方法

CakePHP3のブックマークチュートリアルには記載ミスもあり、そのまま動かない個所もある。CakePHP3では namespaceを使うようになったので、classを呼び出すときに￥を追加する必要が！

: CakePHP 2.3　bakeの超初心者向けフォロー講座

CakePHP 2.3　bakeの超初心者向けフォロー講座

: CakePHP3で画像・ファイルのアップロード処理を自作・解説付き・その２

ファイルのアップロード機能の自作サンプルコードとその解説のその２。アップロード機能に関連するファイルの更新や削除の処理や画像、フォルダのパスの指定方法などを含めて解説。

: CakePHP3のcontroller内でテンプレート、レイアウトを変更する際の指定方法

CakePHP3でテンプレートファイルやレイアウトファイルをデフォルトのものから別のものに変更したい場合の指定方法を解説。

: CakePHP3ログファイルの出力方法・$this->log()の解説

コントロール、モデルの変数の中身を見るときはログに出力する方法が有効です。$this->log()を利用すると変数だけじゃなく、連想配列、オブジェクトも簡単にログ出力ができます。

: CakePHP3のビューで受取ったテーブルのオブジェクトを連想配列に変換する方法

コントローラーからビューに送ったテーブルのオブジェクトを連想配列に変換し、ビューの中で自由に使えるようにするメソッド「toArray()」の解説。連想配列に変換できれば利用度アップ！

: CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数

CakePHP3で特定フォルダのパスの定数を解説。root、DocumentRoot、app、config、webroot、tests、tmp、cache、vendor、コア、コアの srcが設定済み。realpath()関数を使うと柔軟なパス指定が可能。