デベロッパーズブログ

  1. HOME > 
  2. 加藤 正人のデベロッパーズブログ > 
  3. 作業用テーブル処理を再利用可能なツール化してみる・その1

加藤 正人のデベロッパーズブログ

加藤 正人

氏名
加藤 正人
役職
多分SE
血液型
秘密
出没
美味しいもののあるところ
特色
タヒチ大好き。ちょいメタボ。

加藤 正人

2014/06/28

作業用テーブル処理を再利用可能なツール化してみる・その1

 

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

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

そこで、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 には確定値が与えられる。

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

【以下続く予定】

関連タグ: CakePHP2  MySQL 

関連エントリー

CakePHP 2.x の Cookie と js.cookie.js

時刻入力用 jQuery Plugin TimePicki の不具合調整

CakePHP プラグインで HTTPS 判定

作業用モデルビヘイビア

CakePHP のバリデーション時に状況に応じてバリデーションルールを変更する

CsvLoader ビヘイビアを使って CSV を一発でロードする Cake Shell

CakePHP の Security コンポーネント、ベーシック認証、CGI

形態素解析システム MeCab (めかぶ) を CakePHP から利用する

Google APIs Client Library を CakePHP から利用する

分数電卓を作ってみる・その2

分数電卓を作ってみる・その1

CsvLoaderBhavior - CSV データを CakePHP で扱うための一手法・その2

 CsvLoaderBhavior - CSV データを CakePHP で扱うための一手法

CakePHP でストアドファンクション

テキストフィールドを CSV として処理する CakePHP ビヘイビア・補足

テキストフィールドを CSV として処理する CakePHP ビヘイビア・その2

テキストフィールドを CSV として処理する CakePHP ビヘイビア・その1

Google Maps で郵便番号⇒住所変換・その2

テキストを自動整形する簡易 CakePHP ヘルパー

Google Chart へのアクセスをヘルパーで実装してみる【その2】

Google Chart へのアクセスをヘルパーで実装してみる【その1】

Google reCAPTCHA を使いやすくする

駅データ.jp のデータを CakePHP から使う

CakePHP の小ネタ

UploadPack を Exif Orientation 対応にする

クリックイベントが2回実行される?!

MySQL で「指定した順序で結果を取得」

CakePHP のフォームで required・その2

CakePHP の Paginator の sort() で昇順ソート時に NULL 値を最後にしたい

CakePHP のフォームで required

UploadPack のヘルパーメソッド名称が変わっていた

CakePHP 2.x の PaginatorHelper::sort の不思議

CakePHP で四苦八苦 - あるフィールドにだけ値が書き込まれない

UploadPack で四苦Hack その後

CakePHP の小ネタ

CakePHP v2 のエラー処理

IE10 と CKEditor

2013/03/23
IE10 と CKEditor

UploadPack で四苦Hack・その2

Paginator で見かけの URL を使用する方法

「Notes プラグインが見つかりません」

CakePHP v2 で HTTP エラー画面をカスタマイズする

UploadPack で四苦Hack

PHP 5.4 と CakePHP 2.x

お気軽にお電話ください 052-875-9930 年中無休にて対応しております

メールでのお問い合わせはこちら

お問い合わせフォーム

ページの先頭へ戻る

ページトップへ戻る