エス技研

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


CakePHP3でテーブルにカラム(項目)を追加したときに変更するポイントのまとめ

      2019/06/08

CakePHP3でテーブルにカラムを追加したときに変更するポイント

 

システム開発途中でカラムの追加はよくある話

 
CakePHP3でシステムを開発するとき、Bakeを使ってベースとなる処理を作成しておくと作業を効率化することができます。
 
 
ですが、システム開発においては、途中でテーブルにカラムを追加する必要性が生まれることは日常茶飯事です。
 
開発があまり進んでいないときならば、テーブルにカラムを追加して Bakeからやり直す、という方法もありですが、相応に開発が進んでいたら、Bakeからやり直すのは非効率的ですし、バグが混入することにもなりかねません。
 
 
というわけで、テーブルにカラムを追加する前と後とで、Bakeして生成される Controller、Model、Templateファイルがどう変わるのか、を確認して、カラムを追加したときは何を変更すべきなのか、を明確にしていきます。
 
これを見て変更点をチェックすれば、カラムを追加しても抜けもれなく対応できます!
(処理の内容を理解していれば、修正すべき個所は分かるハズではあるんですが...)
 
 

作成するテーブルのサンプル

 
まず、最初に作成したテーブルは下記のとおりです。
 

 
これに対して、下記の ALTER TABLEで削除フラグのカラム「deleted」を追加します。
 

 
 

Bakeで作成されるファイル

 
Bakeを実行して作成されるファイルは、以下となります。
Bakeを再実行する際に「Do you want to overwrite? (y/n/a/q)」との確認があるファイルでもあります。
 
/src/Model/Table/TestsTable.php
/src/Model/Entity/Test.php
/tests/Fixture/TestsFixture.php
/tests/TestCase/Model/Table/TestsTableTest.php
/src/Controller/TestsController.php
/tests/TestCase/Controller/TestsControllerTest.php
/src/Template/Tests/index.ctp
/src/Template/Tests/view.ctp
/src/Template/Tests/add.ctp
/src/Template/Tests/edit.ctp
 
 
更新された内容は以下の通りとなります。
 

/src/Model/Entity/Test.php

 
13行目のコメント行が追加になっています。

 
34行目が追加になっています。

 
 

/src/Model/Table/TestsTable.php

 
74、75行目が追加になっています。

 
 

/src/Template/Tests/index.ctp

 
24行目が追加になっています。

 
37行目が追加になっています。

 
 

/src/Template/Tests/view.ctp

 
38~41行目が追加になっています。

 
 

/src/Template/Tests/add.ctp

 
23行目が追加になっています。

 
 

/src/Template/Tests/edit.ctp

 
29行目が追加になっています。

 
 

/tests/Fixture/TestsFixture.php

 
22行目が追加になっています。

 
42~52行目の、48行目が追加、45、49、50行目が変更になっています。

 
 
テーブルの構造を変更しても、Controllerは変更されていません。
テーブル構造を変更した場合の対応は、Modelの Entityと Tableのファイルでした。
 
Templateも変更がありますが、こちらは、必要に応じて項目を追加するといいでしょう。
 
 

テーブル構造を変更した場合はキャッシュをクリアする

 
テーブルの構造を変更した場合は、キャッシュをクリアしましょう。
 
キャッシュのクリア方法は、CakePHP 3.3以降であれば、下記のコマンドが便利です。

 
詳しくは、「CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う」に記事を書いていますので、参考にしてください。
 
 

関連テーブルがある時、ない時とでの記述内容の違い

 
アソシエーションしたテーブル(関連付けされたテーブル)がある場合は、関連テーブルを createする前に bakeする場合と、createしてから bakeした場合とでも作成されるファイルがやや違うことも確認しました。
 
 
差異があるファイルの内容は、以下の通りです。
 

/src/Template/Tests/add.ctp

 

 
上記の 4、5行目が追加になっています。
これは、「add.ctp」の 17行目、18行目ですが、「Tests」の画面でも「Users」への関連リンクが追加されています。
 
 

 
また、上記の 1行目も下記のように変更されています。
 

 
画面を表示させると分かるのですが、変更前はテキスト形式の入力ボックスなのですが、変更後はプルダウン形式に変更されています。
 
add.ctpと同じ様に、edit.ctp、index.ctp、view.ctpも同じような趣旨の変更が加わっています。
 
 

/src/Model/Entity/Test.php

 
16行目のコメントが下記のように変更になっています。

 
 

/src/Model/Table/TestsTable.php

 
12行目のコメントが下記のように変更になっています。

 
 

/tests/Fixture/TestsFixture.php

 
/tests/Fixture/TestsFixture.php も更新されていましたが、44、47、48行目のデータの値でしたので、ここでの説明は割愛します。
 
 
関連テーブルを作成する前後での違いを検証するつもりはありませんでした。
ですが、「tests」に CakeDC/Usersの user_idと連携させるためのカラムがあることを忘れていて、「tests」だけで Bakeをしてしまったため、「『user_id』に関連するテーブルがない」というエラーが表示されてしまいました。
 
そのため、ついでに確認をしてみることにした次第です。
 
 

CakePHP3の関連記事

CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールする
CakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介
CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3のInsert On Duplicate Key Update(upsert)構文を解説・バルク処理も
CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順
CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
 
その他の「CakePHP3」に関する記事一覧
 
 

 - CakePHP 3.x 4.x

GoogleAdwords

GoogleAdwords

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

Message

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

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

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

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

  関連記事

CakePHP 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」

CakePHPで PDFを編集、出力するには「mpdf」「TCPDF」「FPDF」といったプラグインがあり、使い勝手を比較検討しました。TCPDFが一番良さそうでした。

CakePHP4でcontrollerで実行したバリデーションエラーをmodelのにマージする方法
CakePHP4でcontrollerで実行したバリデーションエラーをmodelのにマージする方法

CakePHP4でcontrollerで実行したバリデーションの結果をModelのバリデーション結果に追加するメソッド「setError()」「setErrors()」の使い方の解説。

CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する
CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する

CakePHP3のkeywordsとdescriptionを設定する方法の解説。CakePHP3にはmetaタグを編集するHTMLヘルパーが用意されているためそれを利用すればOK!ポイントはブロック化を有効にすること。

CakePHP 2.3 主キー(ID)以外のキーで更新方法 updateAll

主キー(ID)以外のカラムをキーとして更新する方法、updateAllの使い方をサンプルを用いて解説します。

Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説
Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説

CakePHP3で Google Analytics APIからレポートデータを取得する処理の解説。PHPのサンプルソースをCakePHP3で動くように改造。加えて、ディメンションやメトリックスを条件に設定する方法なども。

CakePHP3で他のテーブルのマスタテーブルからセレクトボックス(プルダウンリスト)を作る
CakePHP3で他のテーブルのマスタテーブルからセレクトボックス(プルダウンリスト)を作る

他のテーブルのマスタのレコードからプルダウンリストを作成し、選択できるようにするサンプルプログラムと解説。ORMの設定によりデータベースの値を取得し、配列を作成し optionsに与える。

CakePHPで Auto Incrementを外すと Duplicate entry '0' for keyのエラーが出るかも
CakePHPで Auto Incrementを外すと Duplicate entry ‘0’ for keyのエラーが出るかも

CakePHPでAuto Incrementの設定を変更したときに「Duplicate entry ‘0’ for key」のエラーが出た。原因はModel内で IDを編集する処理の追加を忘れていたからだった。

CakePHP2、CakePHP3、CakePHP4、CakePHP5のバージョンを調べる 2つの方法
CakePHP2、CakePHP3、CakePHP4、CakePHP5のバージョンを調べる 2つの方法

CakePHPのバージョンの調べ方2点を紹介。CakePHP3~CakePHP5は共通だが CakePHP2はフォルダ構成が異なるためコマンドのパスもオプションも異なる。

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

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

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法
CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法を解説。複数の方法があるが、getParam()メソッドを使う方法が汎用性があって便利かも。