CakePHP3でassociatedを使って関連データをまとめて保存する方法（hasOne、hasMany、belongsTo）

2017/01/21 2017/10/28

CakePHP3でassociatedを使って関連データをまとめて保存

想定のテーブルイメージ

　
テーブル名は「entry_datas」「job_datas」で、それぞれ以下のような構造を想定しています。
　

CREATE TABLE `entry_datas` (
  `id` int(11) NOT NULL PRIMARY KEY AUTO_INCREMENT,
  `title` text NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

CREATE TABLE `job_datas` (
  `id` int(11) NOT NULL PRIMARY KEY AUTO_INCREMENT,
  `entry_datas_id` int(11) NOT NULL,
  `rank` int(11) NOT NULL,
  `entry_message` text,
  `title` text DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

CREATE TABLE `entry_datas` (

`id` int(11) NOT NULL PRIMARY KEY AUTO_INCREMENT,

`title` text NOT NULL

) ENGINE=InnoDB DEFAULT CHARSET=utf8;

CREATE TABLE `job_datas` (

`id` int(11) NOT NULL PRIMARY KEY AUTO_INCREMENT,

`entry_datas_id` int(11) NOT NULL,

`rank` int(11) NOT NULL,

`entry_message` text,

`title` text DEFAULT NULL

) ENGINE=InnoDB DEFAULT CHARSET=utf8;

　
このテーブルを基にして、「bake all」で各種ファイルを生成したものをベースにします。
　
　

モデルのテーブルファイルの変更

　
まず、モデルのテーブルファイルを修正します。
対象ファイルは「EntryDatasTable.php」です。
　

    public function initialize(array $config)
    {
          ：
          ：
        $this->hasMany('JobDatas', [
            'foreignKey' => 'entry_datas_id'
        ]);
    }

public function initialize(array $config)

{

：

$this->hasMany('JobDatas', [

'foreignKey' => 'entry_datas_id'

]);

}

　
bakeをしただけでは、「EntryDatasTable.php」ファイルには、テーブルの連携（アソシエーション）の情報が記載されませんので、上記の通り、「hasMany」の記述を追加します。
この際、連携先の「JobDatas」のテーブル名の指定は、「JobDatas」でも「job_datas」のどちらでも動きます。
が、規約に則った記述方法は「JobDatas」であろうと思います。
　
　

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

テンプレートファイルの生成

　
続いて、入力のフォームを生成します。
対象ファイルは、「EntryDatas」側の「add.ctp」です。
　

<?php
echo $this->Form->input('title');

echo $this->Form->input("job_datas.0.rank");
echo $this->Form->input("job_datas.0.entry_message");
echo $this->Form->input("job_datas.0.title");

echo $this->Form->input("job_datas.1.rank");
echo $this->Form->input("job_datas.1.entry_message");
echo $this->Form->input("job_datas.1.title");
?>

<?php

echo $this->Form->input('title');

echo $this->Form->input("job_datas.0.rank");

echo $this->Form->input("job_datas.0.entry_message");

echo $this->Form->input("job_datas.0.title");

echo $this->Form->input("job_datas.1.rank");

echo $this->Form->input("job_datas.1.entry_message");

echo $this->Form->input("job_datas.1.title");

　
「EntryDatas」側の入力フォームは変更しません。
「JobDatas」側の入力フォームを追加します。その際、「job_datas」のテーブル名を指定して記載します。
また、入力エリアを複数設ける場合は「0」「1」．．．と連番を振っていきます。
　
この際、テーブル名を追記するのは、「JobDatas」側だけです。
　
テーブル名を明記するため、「EntryDatas」側にも書いた方がいいような気もするのですが、「entry_datas.title」のように記述してしまうと、正しく保存されなくなります。
（記述してしまうと、save()関数を実行しても、エラーログは出力されず、falseの処理となるため、原因がよく分からず悩むことになります。）
　
　

コントローラーの変更

　
コントローラーの更新を行います。
対象ファイルは「EntryDatasController.php」です。
　

$entryData = $this->EntryDatas->newEntity();
if ($this->request->is('post')) {
    $entryData = $this->EntryDatas->patchEntity($entryData, $this->request->data, ['associated' => ['JobDatas']]);

    if ($this->EntryDatas->save($entryData)) {
        $this->Flash->success(__('The site name has been saved.'));

        return $this->redirect(['action' => 'index']);
    } else {
        $this->Flash->error(__('The entry data could not be saved. Please, try again.'));
    }
}

$entryData = $this->EntryDatas->newEntity();

if ($this->request->is('post')) {

$entryData = $this->EntryDatas->patchEntity($entryData, $this->request->data, ['associated' => ['JobDatas']]);

if ($this->EntryDatas->save($entryData)) {

$this->Flash->success(__('The site name has been saved.'));

return $this->redirect(['action' => 'index']);

} else {

$this->Flash->error(__('The entry data could not be saved. Please, try again.'));

}

　
変更箇所は、3行目の一番後ろに「, ['associated' => ['JobDatas']]」を追加するところです。
　
この記述の「JobDatas」の部分は、テーブルファイルに追記した「hasMany」で記述したテーブル名を指定します。
「JobDatas」なのか「job_datas」なのか、テーブルファイルと同じものを指定します。同じではない場合はエラーとなります。
　
　

CakePHP2の情報で CakePHP3でもそうなのか未確認の情報

　
下記の CakePHP2のマニュアルには、いくつか興味深い内容が記述されています。
　

CakePHP は1度に複数のモデルのバリデーションとデータ保存をしてくれる saveAssociated() という便利なメソッドを提供しています。また、 saveAssociated() はデータベースの整合性を確保するためにトランザクションの機能もサポートしています。 (つまり、あるモデルがデータ保存に失敗した場合は、他のモデルのデータも保存されません)

https://book.cakephp.org/2.0/ja/models/saving-your-data.html#hasone-hasmany-belongsto　より抜粋
　
つまりは、この「saveAssociated()」の処理を利用して保存することで、保存時に不具合が発生しても、一部のレコードだけが保存されて整合性が無くなるということはない、ということです。
　
おそらく、CakePHP3にもこの機能があるのだと思いますが、CakePHP3のマニュアルにはそのような明記がなく、具体的な検証は行っていません。
どなたかわかりますでしょうか？
　
また、このようなトランザクション処理を正常に処理するため、MySQLの場合は、データベースのエンジンは「InnoDB」の必要があるようです。
「MyISAM」はトランザクション処理をサポートしていないためです。
　
もし、データの保存がうまくいかない場合は、データベースのエンジンが「MyISAM」でないかを確認することも必要かもしれません。
　
　

- CakePHP 3.x 4.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3で環境変数を設定して本番環境と開発環境を分けて処理をする場合

CakePHP3で開発環境と本番環境とで違う設定ファイルを読み込ませて環境ごとに定数を切り替える方法を解説。Apacheのhttpd.confに環境変数を設定し、それを読み込み判別する。

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

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

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

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

: CakePHPのFlashエラーは出るが入力項目ごとのメッセージが出ないエラーの原因

Bakeして自動生成した入力フォーム処理を元に少し処理を追加したら、入力エラーがあってもエラーメッセージが表示されなくなった。原因はリダイレクトの処理にあった。

: CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。

CakePHP3でajaxを利用する処理の実装方法を解説。プルダウンを変更するとデータベースの値を取得し検索結果の内容を変更するというような処理を想定。CakePHP3.6以降の CSRF対策対応済。

: CakePHPを学ぶ際にはオブジェクト指向を学ぼう

CakePHPはオブジェクト指向で書かれていますので、CakePHPを学ぶにはオブジェクト指向も学びましょう。

: CakePHP 2.3　Search Pluginで検索処理　その１設置方法

CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。

: URL短縮サービス「TTTオンライン（https://ttt.onl）」公開

URL短縮サービス「TTTオンライン（https://ttt.onl）」を公開。メールやSNSでは使いにくい長いURLを短いURLに変換するサービス。QRコードも。Google URL Shortenerが2019年3月にサービス終了。