CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順

2019/12/15 2020/04/18

CakePHP3で「1対多」から「多対多」の連携に変更する手順

「1対多」と中間テーブルを使った「多対多」連携について

　
CakePHP3で「1対多」のテーブル連携を、中間テーブルを利用した「多対多」のテーブル連携方式に変えるときの手順を紹介します。
　

　
　
どのような場合に必要になるか、というと
　
例えば、
Topics、Categoriesというテーブルがあるとします。
Topicsは Categoryによって分類されています。
　
当初は、Topicsの記事はそれぞれに 1つの Categoryが割り当てられていました。
ですが、運用を始めてみたら、Topicsの記事は複数の Categoryにまたがるものもあることが判明しました。
　
そのため、それまでは「1対多」だったテーブル構成を、中間テーブル作成して「多対多」に対応できるようにすることにしました。
　
その時の対応方法の手順の紹介です。
　
　
サンプルの「categories」と「topics」のテーブルは以下の想定です。
　

CREATE TABLE `categories` (
 `id`             smallint(6)   NOT NULL AUTO_INCREMENT,
 `parent_id`      smallint(6)   DEFAULT NULL,
 `lft`            smallint(6)   NOT NULL,
 `rght`           smallint(6)   NOT NULL,
 `name`           varchar(100)  NOT NULL,
 `created`        datetime      NOT NULL,
 `modified`       datetime      NOT NULL,
 PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8

CREATE TABLE `topics` (
 `id`                   int(11) unsigned  NOT NULL AUTO_INCREMENT,
 `category_id`          smallint(6)       NOT NULL,
 `topics_date`          date              NOT NULL,
 `title`                text              NOT NULL,
 `body`                 text              NOT NULL,
 `created`              datetime          NOT NULL,
 `modified`             datetime          NOT NULL,
 PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

CREATE TABLE `categories` (

`id` smallint(6) NOT NULL AUTO_INCREMENT,

`parent_id` smallint(6) DEFAULT NULL,

`lft` smallint(6) NOT NULL,

`rght` smallint(6) NOT NULL,

`name` varchar(100) NOT NULL,

`created` datetime NOT NULL,

`modified` datetime NOT NULL,

PRIMARY KEY (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8

CREATE TABLE `topics` (

`id` int(11) unsigned NOT NULL AUTO_INCREMENT,

`category_id` smallint(6) NOT NULL,

`topics_date` date NOT NULL,

`title` text NOT NULL,

`body` text NOT NULL,

`created` datetime NOT NULL,

`modified` datetime NOT NULL,

PRIMARY KEY (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8;

　
　
カテゴリは、下記の記事でも紹介していますが、CakePHP3のブログチュートリアルにあるツリービヘイビアの機能を利用したカテゴリの構造になっています。
CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法
　
　

「1対多」から中間テーブルを使った「多対多」連携に変更する手順

　
先に、「例えば」と書いてしまいましたが、まさに、今回私が必要になった状況です。
最初は Topicsに対して 1つの Categoryで足りると思っていましたが、topicsの内容によっては複数の Categoryに属する場合があり、対応を迫られたのです。
　
　
CakePHP3で中間テーブルを利用した処理は下記の検索処理などで使っていました。
CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装
　
そのため、構築の仕方は理解していましたが、今回の対応を行うときに対応漏れがあり、うまく動かずに悩んだことがありました。
そのため、今後のためにも手順を記録しておくことにしました。
　
　

中間テーブルを作成する

　
まず最初に中間テーブルを作成します。
中間テーブルは、「topic_id」と「category_id」を持つテーブルです。
　

CREATE TABLE `topics_categories` (
 `topic_id`        int(11) unsigned  NOT NULL,
 `category_id`     smallint(6)       NOT NULL,
 PRIMARY KEY (`topic_id`,`category_id`),
 KEY `category_key` (`category_id`),
 CONSTRAINT `topic_category_key` FOREIGN KEY (`category_id`) REFERENCES `categories` (`id`),
 CONSTRAINT `topic_key`          FOREIGN KEY (`topic_id`)    REFERENCES `topics`     (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

CREATE TABLE `topics_categories` (

`topic_id` int(11) unsigned NOT NULL,

`category_id` smallint(6) NOT NULL,

PRIMARY KEY (`topic_id`,`category_id`),

KEY `category_key` (`category_id`),

CONSTRAINT `topic_category_key` FOREIGN KEY (`category_id`) REFERENCES `categories` (`id`),

CONSTRAINT `topic_key` FOREIGN KEY (`topic_id`) REFERENCES `topics` (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8;

「category_id」カラムを削除

　
Topicsテーブルから不要になる「category_id」カラムを削除します。
（削除しなくても問題は発生しませんが、不要なカラムは削除する方が望ましいでしょう。）
　

ALTER TABLE `topics` DROP `category_id`;

1	ALTER TABLE `topics` DROP `category_id`;

TopicTable.phpの更新

　
続いて、Tableファイルの更新になりますが、「TopicTable.php」と「CategoriesTable.php」とそれぞれ変更する箇所があります。
　
　
まず初めに「TopicTable.php」は、下記の通り、「Categories」テーブルとの「belongsTo」を止めて「belongsToMany」に変更します。
　
/src/Model/Table/TopicTable.php

//      追加
        $this->belongsToMany('Categories', [
            'foreignKey' => 'topic_id',
            'targetForeignKey' => 'category_id',
            'joinTable' => 'topics_categories'
        ]);

//      削除（古い設定を外す）
//        $this->belongsTo('Categories', [
//            'foreignKey' => 'category_id'
//        ]);

// 追加

$this->belongsToMany('Categories', [

'foreignKey' => 'topic_id',

'targetForeignKey' => 'category_id',

'joinTable' => 'topics_categories'

]);

// 削除（古い設定を外す）

// $this->belongsTo('Categories', [

// 'foreignKey' => 'category_id'

// ]);

CategoriesTable.phpの更新

　
「CategoriesTable.php」は、下記の通り、「Topics」テーブルとの「belongsToMany」を追加します。
今回は設定がありませんでしたが「hasMany」の設定をしている場合は、その処理は削除します。
　
/src/Model/Table/CategoriesTable.php

//      追加
        $this->belongsToMany('Topics', [
            'foreignKey' => 'category_id',
            'targetForeignKey' => 'topic_id',
            'joinTable' => 'topics_categories'
        ]);

// 追加

$this->belongsToMany('Topics', [

'foreignKey' => 'category_id',

'targetForeignKey' => 'topic_id',

'joinTable' => 'topics_categories'

]);

inputTopics.phpの更新

　
カテゴリの選択する箇所のテンプレートを更新します。
ここでは、マルチセレクト（複数選択式）のセレクトボックスを設定しています。
　
/src/Template/Element/inputTopics.php

//          変更
//          echo $this->Form->control('category_id', ['options' => $categories, 'empty' => true]);
            echo $this->Form->control('categories._ids', ["type"=>"select","multiple"=>"select",'options'=>$categories]);

// 変更

// echo $this->Form->control('category_id', ['options' => $categories, 'empty' => true]);

echo $this->Form->control('categories._ids', ["type"=>"select","multiple"=>"select",'options'=>$categories]);

Entity/Topic.phpの更新

　
ここ以降の項目が対応忘れが発生しやすい箇所になります。
　
まず 1つ目が「Entity」です。
下記のように「category」は「categories」のように複数形になります。
コメントにも書いていますが、これを記述していないと値が保存されません。エラーは出ませんので原因を特定しにくいエラーです。
　
「'*' => true,」で設定している場合は特に対応は必要ありません。
　
/src/Model/Entity/Topic.php

//      変更（※これがないと保存されない）
//        'category' => true
        'categories' => true

// 変更（※これがないと保存されない）

// 'category' => true

'categories' => true

TopicsController.phpの変更

　
コントローラーの変更ポイントです。
get()や find()で値を取得する際に、関連テーブルとして「Categories」を指定する必要があります。
コメントに書いていますが、これがないと、テーブルには保存されたレコードがあるのにも関わらず、その情報が更新画面に出てこない、というエラーになります。これもエラーが出ないため、原因を特定しにくいエラーです。
　
　
/src/Contorller/TopicsController.php

//      追加  ※contain に Categories を追加
//            ※これがないと保存された情報が更新画面に反映されない
        $topic = $this->Topics->get($id, [
            'contain' => ["Categories"]
        ]);

// 追加 ※contain に Categories を追加

// ※これがないと保存された情報が更新画面に反映されない

$topic = $this->Topics->get($id, [

'contain' => ["Categories"]

]);

中間テーブルを使った「多対多」の項目「category_id」を検索条件にする場合の TopicsController.phpの変更

　
単純に指定したレコードだけを get()で取得する場合は問題ありませんが、「category_id」を検索条件に検索する場合は記述する内容が大きく変わります。
　
/src/Contorller/TopicsController.phhp

//  変更  ※Category_id を条件にしていた箇所は下記のように修正
//        ※単純な where句ではなくなる
//  $condition = ["category_id"=>$categoryId];
//  $query = $this->Topics->find("Open")->contain(["Categories"])->where($condition);
    $query = $this->Topics->find()
                  ->matching("Categories",function($q) use($categoryId){
                      return $q->where(["category_id"=>$categoryId]);
                  });

// 変更 ※Category_id を条件にしていた箇所は下記のように修正

// ※単純な where句ではなくなる

// $condition = ["category_id"=>$categoryId];

// $query = $this->Topics->find("Open")->contain(["Categories"])->where($condition);

$query = $this->Topics->find()

->matching("Categories",function($q) use($categoryId){

return $q->where(["category_id"=>$categoryId]);

});

　
細かなところですが、条件の「"category_id"=>$categoryId]」の「$categoryId」を変数とするなら「use($categoryId)」の記述が必要です。
「$categoryId」を変数ではなく値を直接記述する場合は use句は記述する必要はありません。
　
　
CakePHP3の ORM matchingメソッドについて詳しく知りたい場合は、下記の記事などを参考にしてみてはいかがでしょうか？
https://s8a.jp/cakephp-3-matching
https://book.cakephp.org/3.0/ja/orm/query-builder.html#id17
　
　

view.ctpの変更

　
最後に、データの取り出しの際も変更の注意点があります。
「category」は複数入ることがあるためここも複数形の「categories」にする必要があります。
　
/src/Template/Topics/view.ctp

    // 変更
//  $topics = $topics->category;
    $topics = $topics->categories;

// 変更

// $topics = $topics->category;

$topics = $topics->categories;

CakePHP3で中間テーブルを扱う場合の関連記事

　
中間テーブルはちょっとだけ仕組みの理解が必要なため、中間テーブルについてもう少し理解を深めたい、という場合もあるでしょう。
そういう場合は下記の記事なども参考になるかと思います。
　
CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装
　
CakePHP3　ブログチュートリアル
https://book.cakephp.org/3/ja/tutorials-and-examples/blog/blog.html
　
　

- CakePHP 3.x 4.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3で値を入力直後にバリデーションする方法解説

CakePHP3でバリデーションの実行を保存する時から入力情報を受け取るときに変更する処理の解説。CakePHP3ではnewEntity()の処理でバリデートするため1行追加で対応可能。

: CakePHP4のcake cache clear_allでPermission deniedはパーミッションの変更が必要

CakePHP4でキャッシュをクリアするコマンドcake cache clear_allでPermission deniedのエラーが出るのはcakeにパーミッションが足りないとき。その対処方法を解説。

: CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。Usersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。

: CakePHP 2.3　Search Pluginで検索処理　その３入力エリア一つで複数の項目を同時に検索する方法

CakePHPの検索プラグイン Search Pluginの検索処理の中で入力エリア一つで複数の項目を同時に検索する方法を解説。

: CakePHP 2.3でファイルをアップロード・その2　ファイル名を乱数で設定

CakePHPのアップロードするファイル名を乱数で変更しセキュリティを高める方法を解説。

: CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP3のキャッシュファイルのパーミッションエラー Error: SplFileInfo::openFile()が発生した場合の対応方法解説。app.phpにキャッシュファイルのパーミッション設定を行い、既存のファイルは削除。

: CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールする

CakePHP4、CakePHP3でブラウザにキャッシュさせる設定の解説。CSS、JavaScript、画像をブラウザにキャッシュさせるのか、定期的にリロードする設定にするのかの設定が可能。

: CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()

CakePHP4でデフォルトのレイアウトファイル「default.php」は管理側に使用し、これとは別のデザインを公開側のページに設定したい、を実装する方法を解説。

: CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。CakePHP4で使う場合のUsersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。