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 5.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説

CakePHP3でCSVファイルをアップロードしレコードを追加、更新する処理の作成方法の解説。モデルとは直接関連しないフォームからCSVファイルをアップロードするため汎用的に使用可能。

: CakePHP3の画像、ファイルアップロードプラグインUpload Plugin 3.0の設置解説・その１

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその1で基本的な導入方法の解説で読みながら簡単に導入が可能。

: CakePHP4、5の認証処理で認証が通らない際の確認方法と確認箇所の紹介

CakePHP4、5系の認証処理でログイン認証が通らない場合の確認方法、確認箇所を解説。ログ出力し、ステータスを確認するが、ステータスの内容も紹介。それはそのままusernameを変更する際のポイントでもある。

: CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説

CakePHP3でJavaScriptやCSSを編集する基本形から、それらやテンプレート（エレメント）を特定のテンプレートを読み込んだときのみ編集、実行するための方法、ブロック化について解説。

: CakePHP3のタイムゾーンを協定世界時UTCから日本標準時間JSTにずれを変更する方法

CakePHP3の標準設定のタイムゾーンは「UTC（協定世界時）」に設定されている。これを日本標準時に変更する方法（app.php、bootstrap.phpの変更方法）の解説。

: CakePHP3のインストールでURL rewriting……のエラーが！その解決方法解説

CakePHP3をインストールしたら URL rewriting is not properly configured.のエラーが。原因は.htaccessが有効になっていないこと。httpd.confに設定を追加すればOK。

: CakePHP3のHtmlHelperのLink設定のまとめ。mailto、URL、Root／Homeのリンクなども

CakePHP3でHtmlHelperを使ってリンクの設定をする方法のまとめ。基本形からURLを指定、class、id、targetを指定、mailtoのリンク、画像をアンカーに、JavaScriptのダイアログなどの解説。

: cakephp3 カスタムバリデーションを簡易的に実装する方法

CakePHP3の独自のバリデーションをテーブルクラス内に簡単に記述する方法を解説。他のテーブルクラスでは使えないが、記述する量は少なく実装できるため、他で使わない処理を書くのには便利。

: CakePHP3のCakeDC/Users、Authでログインなしでもアクセスを許可する設定

CakePHP3の Authコンポーネントや CakeDC/Usersプラグインなどを利用したユーザ管理・認証システムにおいて、ログインしていなくても見ることができるページの設定方法を解説。

: CakePHP3の検索プラグイン「friendsofcake/search」の設置方法・CakePHP3.6対応

CakePHP3で検索を担うプラグイン「friendsofcake/search」の紹介。基本的な設置方法の紹介のほか、処理の記述方法のバリエーション、エラーの解説など。CakeDC/searchより導入は簡単！