エス技研

WordPress、CakePHP、PHP、baserCMSなどの Web系システムを中心に情報を提供します!


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

      2017/10/28

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

 

関連データの想定イメージ

 
 EntryDatas ─┬─ JobDatas1
        ├─ JobDatas2
        └─ JobDatas3
 
求人情報サイトで、1回のエントリー(EntryDatas)で複数の求人(JobDatas)に応募するようなことを想定していまして、1つのエントリーに関連付けて、複数の求人情報もまとめて保存する方法を解説します。
 
 

想定のテーブルイメージ

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

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

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

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

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


 

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

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

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

コントローラーの変更

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

 
変更箇所は、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」でないかを確認することも必要かもしれません。
 
 

CakePHP3の関連記事

CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法
CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い
CakePHP3で生の SQLの実行はConnectionManagerを使う
CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説
CakePHP3のデバッグキット(DebugKit)を強制的に有効、無効に変更する方法
CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法
VirtualBoxにCakePHP3を設置。必要なCentOS、Apache、PHP、MySQL、Composerをインストールし設定する
CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説
CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説
CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説
 
その他の「CakePHP3」に関する記事一覧
 
 

 - CakePHP 2.x 3.x

GoogleAdwords

GoogleAdwords

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

Message

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

下記の空欄を埋めてください。 * Time limit is exhausted. Please reload CAPTCHA.

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)

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

  関連記事

CakePHP 2.3 Search Pluginで検索処理 その6ORDER、sortソートの機能

CakePHPの検索プラグイン Search Pluginの検索処理の中で order、ソートについての解説です。

CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除

CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。

CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説
CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説

WYSIWYGエディタであるCKEditor4をCDNを利用して簡単にCakePHP3に導入する方法とカスタマイズする方法を解説。CakePHP3にはページごとの振り分けを行うブロック化を利用する。

CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その3
CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その3

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。

CakePHPのバリデーションを入力値・項目の条件によって変える方法を解説
CakePHPのバリデーションを入力値・項目の条件によって変える方法を解説

入力された値によってバリデーション(入力チェック)の内容を切り替える。その処理をCakePHPで実装する方法を解説。条件ごとに unset関数を使ってバリデーションを削除する、という方法を採る。

CakePHP 2.3 ID以外のカラムでアソシエーション(連携)をさせる場合の詳細ページの注意点

ID以外のカラムでアソシエーション(連携)させて詳細ページを表示させる際の考え方と注意点をサンプルソースを用いて解説しています。

MySQL、CakePHP 2.3で「tinyint(1)」の Boolean型の動作を再確認

MySQL+CakePHPの環境で「tinyint(1)」を利用する際の動作を検証。「tinyint(1)」の Boolean型について CakePHPでは自動処理が実施されていることを確認しました。

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

CakePHP3でファイルをアップロードする処理を、php.netにある「エラーを起こさない」と説明がある処理を参考に作成。サンプルソースとその解説付きで、コピペでも動くし、カスタマイズも簡単!

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

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

CakePHP 2.3 テーブルの項目を演算した結果を条件として抽出する方法

アソシエーション(連携)している先のテーブルの項目で演算をする場合の考え方と注意点をサンプルソースを用いて説明しています。分かってしまえば簡単です。