WEBを駆使した売上UP/トータルサポートを提供　
株式会社パルムゲート

データベースのレコードを更新する際に、当該レコードが格納されているテーブル (本テーブル) を直接更新するのではなく、作業用テーブルに当該レコードのコピーを作成し、作業用テーブルに対してデータの変更を適用しタイミングを見計らって本テーブルに書き込む処理をすることがある。

このような処理はコードでべた書きすることが多いのだが、再利用できる形でクラス化すると便利かもしれない。

そこで、CakePHP でAppModel に1枚皮をかぶせたクラスを定義し、期待する機能をそのクラスに集約してみることにした。

	class TmpModel extends AppClass
	{
		// …【中略】…
	}

使う側 (モデル) では、親クラスとして AppModel の代わりに TmpModel を指定することで各種機能が利用可能となる。

モデル命名規則

作業用テーブルと本テーブルは、モデル名を通じて自動的に把握できるようにする。作業用モデル名は Tmp で始まるキャメルケースの名称とし、作業用モデル名から先頭の Tmp を取り去ったものが本モデル名となる。

例: 作業用モデルを TmpUser として定義すると、自動的に User モデルが親モデルと認識される。

外部とのインターフェイス

外部とのインターフェイスは、モデルのパブリックメソッドを介して行う。

■作業用モデルと本モデル間のレコードコピー用メソッド

TmpModel::copyTmpToMaster($tmp_id, $master_id=NULL, $preserveTmpDates=TRUE, $fields=array())

$tmp_id で指定される作業用モデルのレコードを、$master_id で指定される本モデルのレコードに上書きする。($master_id が NULL の場合は新規レコードとして追加)

戻り値は、作業用モデル側 ID と、本モデルに実際に保存したレコードの ID の組を返す。

TmpModel::copyMasterToTmp($master_id, $tmp_id=NULL, $preserveMasterModified=FALSE)

$master_id で指定される本モデルのレコードを、$tmp_id で指定される作業用レコードに保存する。 ($tmp_id が NULL の場合は新規レコードとして追加)

戻り値は、本モデル側 ID と、作業用モデルに実際にほぞにしたレコードの ID の組を返す。

■モデル間コピーに際して必要な補助操作が必要な場合に使用するコールバックメソッド

TmpModel::beforeCopyTmpToMaster($tmp_id, $master_id)

copyTmpToMaster() メソッドで、作業用テーブルから本テーブルにレコードコピーを行う前に実行する処理を記述する。なお、レコードのコピーに先立って行われることから $master_id は確定していない場合もある点に注意。

バリデーションルールの設定や、ビヘイビアの設定・解除等を行うことができる。

TmpModel::afterCopyTmpToMaster($tmp_id, $master_id)

copyTmpToMaster() メソッドで、テーブル間レコードコピーを行った後に実行する処理を記述する。$master_id には確定値が与えられる。

データベース以外のリソース、たとえばレコードに関連付けられている画像ファイルなどのコピーや後始末等を記述できる。

TmpModel::beforeCopyMasterToTmp($master_id, $tmp_id)

copyMasterToTmp() メソッドで、本テーブルから作業用テーブルにレコードコピーを行う前に実行する処理を記述する。レコードのコピーに先立って行われることから $tmp_id は確定していない場合もある点に注意。

TmpMOdel::afterCopyMasterToTmp($master_id, $tmp_id)

copyMasterToTmp() メソッドで、テーブル間レコードコピーを行った後に実行する処理を記述する。$tmp_id には確定値が与えられる。

データベース以外のリソース、たとえばレコードに関連付けられている画像ファイルのコピーや後始末等を記述できる。

【以下続く予定】