- Timestamp:
- 2011/06/10 19:27:24 (13 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
branches/version-2_11-dev/data/class/db/SC_DB_MasterData.php
r20764 r20970 23 23 24 24 /** 25 * マスタ データを扱うクラス.26 * 27 * プルダウン等で使用するマスタ データを扱う.28 * マスタ データは, DB に格納されているが, パフォーマンスを得るため,25 * マスターデータを扱うクラス. 26 * 27 * プルダウン等で使用するマスターデータを扱う. 28 * マスターデータは, DB に格納されているが, パフォーマンスを得るため, 29 29 * 初回のみ DBへアクセスし, データを定義したキャッシュファイルを生成する. 30 30 * 31 * マスタ データのテーブルは, 下記のようなカラムが必要がある.31 * マスターデータのテーブルは, 下記のようなカラムが必要がある. 32 32 * 1. キーとなる文字列 33 33 * 2. 表示文字列 … … 35 35 * 上記カラムのデータ型は特に指定しないが, 1 と 2 は常に string 型となる. 36 36 * 37 * マスタ データがキャッシュされると, key => value 形式の配列として使用できる.38 * マスタ データのキャッシュは, MASTER_DATA_REALDIR/マスタデータ名.php というファイルが生成される.37 * マスターデータがキャッシュされると, key => value 形式の配列として使用できる. 38 * マスターデータのキャッシュは, MASTER_DATA_REALDIR/マスターデータ名.php というファイルが生成される. 39 39 * 40 40 * @package DB … … 56 56 57 57 /** 58 * マスタ データを取得する.59 * 60 * 以下の順序でマスタ データを取得する.61 * 1. MASTER_DATA_REALDIR にマスタ データキャッシュが存在しない場合、62 * DBからマスタ データを取得して、マスタデータキャッシュを生成する。63 * 2. マスタ データキャッシュを読み込み、変数に格納し返す。58 * マスターデータを取得する. 59 * 60 * 以下の順序でマスターデータを取得する. 61 * 1. MASTER_DATA_REALDIR にマスターデータキャッシュが存在しない場合、 62 * DBからマスターデータを取得して、マスターデータキャッシュを生成する。 63 * 2. マスターデータキャッシュを読み込み、変数に格納し返す。 64 64 * 65 65 * 返り値は, key => value 形式の配列である. 66 66 * 67 * @param string $name マスタ データ名68 * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順 69 * を表すカラム名を格納した配列 70 * @return array マスタ データ67 * @param string $name マスターデータ名 68 * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順 69 * を表すカラム名を格納した配列 70 * @return array マスターデータ 71 71 */ 72 72 function getMasterData($name, $columns = array()) { … … 88 88 89 89 /** 90 * マスタ データをDBに追加する.91 * 92 * 引数 $masterData をマスタ データとしてDBに追加し,90 * マスターデータをDBに追加する. 91 * 92 * 引数 $masterData をマスターデータとしてDBに追加し, 93 93 * キャッシュを生成する. 94 94 * 既存のキャッシュが存在する場合は上書きする. 95 95 * $masterData は key => value 形式の配列である必要がある. 96 96 * 97 * @param string $name マスタ データ名98 * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順 99 * を表すカラム名を格納した配列 100 * @param array $masterData マスタ データ97 * @param string $name マスターデータ名 98 * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順 99 * を表すカラム名を格納した配列 100 * @param array $masterData マスターデータ 101 101 * @param bool $autoCommit トランザクションを自動的に commit する場合 true 102 * @return integer マスタ データの登録数102 * @return integer マスターデータの登録数 103 103 */ 104 104 function registMasterData($name, $columns, $masterData, $autoCommit = true) { … … 125 125 126 126 /** 127 * マスタ データを更新する.128 * 129 * 引数 $masterData の値でマスタ データを更新する.127 * マスターデータを更新する. 128 * 129 * 引数 $masterData の値でマスターデータを更新する. 130 130 * $masterData は key => value 形式の配列である必要がある. 131 131 * 132 * @param string $name マスタ データ名133 * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順 134 * を表すカラム名を格納した配列 135 * @param array $masterData マスタ データ132 * @param string $name マスターデータ名 133 * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順 134 * を表すカラム名を格納した配列 135 * @param array $masterData マスターデータ 136 136 * @param bool $autoCommit トランザクションを自動的に commit する場合 true 137 * @return integer マスタ データの更新数137 * @return integer マスターデータの更新数 138 138 */ 139 139 function updateMasterData($name, $columns, $masterData, $autoCommit = true) { … … 160 160 161 161 /** 162 * マスタ データを追加する.163 * 164 * 引数 $masterData の値でマスタ データを更新する.162 * マスターデータを追加する. 163 * 164 * 引数 $masterData の値でマスターデータを更新する. 165 165 * $masterData は key => value 形式の配列である必要がある. 166 166 * 167 * @param string $name マスタ データ名167 * @param string $name マスターデータ名 168 168 * @param string $key キー名 169 169 * @param string $comment コメント 170 170 * @param bool $autoCommit トランザクションを自動的に commit する場合 true 171 * @return integer マスタ データの更新数171 * @return integer マスターデータの更新数 172 172 */ 173 173 function insertMasterData($name, $key, $value, $comment, $autoCommit = true) { … … 194 194 195 195 /** 196 * マスタ データを削除する.197 * 198 * 引数 $name のマスタ データを削除し,196 * マスターデータを削除する. 197 * 198 * 引数 $name のマスターデータを削除し, 199 199 * キャッシュも削除する. 200 200 * 201 * @param string $name マスタ データ名201 * @param string $name マスターデータ名 202 202 * @param bool $autoCommit トランザクションを自動的に commit する場合 true 203 * @return integer マスタ データの削除数203 * @return integer マスターデータの削除数 204 204 */ 205 205 function deleteMasterData($name, $autoCommit = true) { … … 220 220 221 221 /** 222 * マスタ データのキャッシュを消去する.223 * 224 * @param string $name マスタ データ名222 * マスターデータのキャッシュを消去する. 223 * 224 * @param string $name マスターデータ名 225 225 * @return bool 消去した場合 true 226 226 */ … … 237 237 238 238 /** 239 * マスタ データのキャッシュを生成する.240 * 241 * 引数 $name のマスタ データキャッシュを生成する.239 * マスターデータのキャッシュを生成する. 240 * 241 * 引数 $name のマスターデータキャッシュを生成する. 242 242 * 既存のキャッシュが存在する場合は上書きする. 243 243 * … … 245 245 * 定数コメントを生成する場合は, $commentColumn を指定する. 246 246 * 247 * @param string $name マスタ データ名248 * @param array $masterData マスタ データ247 * @param string $name マスターデータ名 248 * @param array $masterData マスターデータ 249 249 * @param bool $isDefine 定数を生成する場合 true 250 250 * @param array $commentColumn [0] => キー, [1] => コメント文字列, … … 255 255 $commentColumn = array()) { 256 256 257 // マスタ データを取得257 // マスターデータを取得 258 258 $masterData = $this->getDbMasterData($name, $columns); 259 259 260 // マスタ データを文字列にする260 // マスターデータを文字列にする 261 261 // 定数を生成する場合 262 262 if ($isDefine) { … … 292 292 293 293 /** 294 * DBからマスタ データを取得する.295 * 296 * キャッシュの有無に関係なく, DBからマスタ データを検索し, 取得する.294 * DBからマスターデータを取得する. 295 * 296 * キャッシュの有無に関係なく, DBからマスターデータを検索し, 取得する. 297 297 * 298 298 * 返り値は, key => value 形式の配列である. 299 299 * 300 * @param string $name マスタ データ名301 * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順 302 * を表すカラム名を格納した配列 303 * @return array マスタ データ300 * @param string $name マスターデータ名 301 * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順 302 * を表すカラム名を格納した配列 303 * @return array マスターデータ 304 304 */ 305 305 function getDbMasterData($name, $columns = array()) { … … 345 345 346 346 /** 347 * マスタ データの配列を定数定義の文字列として出力する.347 * マスターデータの配列を定数定義の文字列として出力する. 348 348 * 349 349 * @access private 350 * @param array $masterData マスタ データの配列350 * @param array $masterData マスターデータの配列 351 351 * @param array $comments コメントの配列 352 352 * @return string 定数定義の文字列
Note: See TracChangeset
for help on using the changeset viewer.