作業用モデルビヘイビア｜加藤正人｜デベロッパーズブログ

DEVELOPERS BLOGデベロッパーズブログ

2016/02/27

CakePHP 2.x の話で恐縮だが、(依然として開発は 2.x が主) 以前CakePHP の AppModel を拡張する形で作成した作業用テーブルモデルをもう少し使いやすくしたいということで、今回は CakePHP のビヘイビアとして実装してみた。

これにより、機能を bind/unbind できる点と、作成中のソースを読んだときに acts as TmpModel (作業用モデルとして動作する) のように分かり易くなることが期待できる。

使い方は次の通り。

■事前準備 (モデルの宣言時)

マスターモデルと作業用モデルを定義する。作業用モデル名は、マスターモデル名の先頭に「Tmp」を追加したものとなる。例えば、マスターモデルが User なら作業用モデルは TmpUser となる。モデルの定義ファイルを以下それぞれ User.php、TmpUser.php とする。
作業用モデルの定義ファイル (TmpUser.php) のビヘイビア定義に TmpModel を追加し、public $actsAs = array('TmpModel'); のようにする。

■新規登録時

コントローラではユーザ登録編集フォームからのデータは TmpUser モデルでバリデーションおよび保存を行なう。
TmpUser モデルに保存後マスターモデルにデータをコピーするため、コントローラで
$this->TmpUser->copyTmpToMaster($tmp_id,$master_id);
を実行する。($master_id が NULL の場合は新規作成、id番号が与えられていれば更新になる)

■更新時

コントローラで編集対象のレコードを、マスターモデル User から作業用モデル TmpUser にコピーする。
$this->TmpUser->copyMasterToTmp($master_id, $tmp_id);
TmpUser モデルのデータをフォームで編集し保存する。
TmpUser モデルから User モデルにレコードをコピーするため、コントローラで
$this->TmpUser->copyTmpToMaster($tmp_id, $master_id);
を実行する。

なお、作業用モデルからマスターモデルへのコピー時やマスターモデルから作業用モデルへのコピー時にデータベース操作以外の操作 (例えばファイルシステムの操作など) が必要な場合は、作業用モデル (この例では TmpUser モデル) の定義に以下のメソッドを定義することで対応する。

public function beforeCopyTmpToMaster($tmp_id, $master_id): 作業用モデルからマスターモデルへレコードをコピーする前に実行する処理を記述する。
public function afterCopyTmpToMaster($tmp_id, $master_id): 作業用モデルからマスターモデルへレコードをコピーした後に実行する処理を記述する。
public function beforeCopyMasterToTmp($master_id, $tmp_id): マスターモデルから作業用モデルへレコードをコピーする前に実行する処理を記述する。
public function afterCopyMasterToTmp($master_id, $tmp_id): マスターモデルから作業用モデルへレコードをコピーした後に実行する処理を記述する。