1 | <?php |
---|
2 | /* |
---|
3 | * Copyright(c) 2000-2007 LOCKON CO.,LTD. All Rights Reserved. |
---|
4 | * |
---|
5 | * http://www.lockon.co.jp/ |
---|
6 | */ |
---|
7 | |
---|
8 | /** |
---|
9 | * マスタデータを扱うクラス. |
---|
10 | * |
---|
11 | * プルダウン等で使用するマスタデータを扱う. |
---|
12 | * マスタデータは, DB に格納されているが, パフォーマンスを得るため, |
---|
13 | * 初回のみ DBへアクセスし, データを定義したキャッシュファイルを生成する. |
---|
14 | * |
---|
15 | * マスタデータのテーブルは, 下記のようなカラムが必要がある. |
---|
16 | * 1. キーとなる文字列 |
---|
17 | * 2. 表示文字列 |
---|
18 | * 3. 表示順 |
---|
19 | * 上記カラムのデータ型は特に指定しないが, 1 と 2 は常に string 型となる. |
---|
20 | * |
---|
21 | * マスタデータがキャッシュされると, key => value 形式の配列として使用できる. |
---|
22 | * マスタデータのキャッシュは, MASTER_DATA_DIR/マスタデータ名.php というファイルが生成される. |
---|
23 | * |
---|
24 | * @package DB |
---|
25 | * @author LOCKON CO.,LTD. |
---|
26 | * @version $Id$ |
---|
27 | */ |
---|
28 | class SC_DB_MasterData { |
---|
29 | |
---|
30 | // {{{ properties |
---|
31 | |
---|
32 | /** SC_Query インスタンス */ |
---|
33 | var $objQuery; |
---|
34 | |
---|
35 | /** デフォルトのテーブルカラム名 */ |
---|
36 | var $columns = array("id", "name", "rank"); |
---|
37 | |
---|
38 | // }}} |
---|
39 | // {{{ functions |
---|
40 | |
---|
41 | /** |
---|
42 | * マスタデータを取得する. |
---|
43 | * |
---|
44 | * 以下の順序でマスタデータを取得する. |
---|
45 | * 1. MASTER_DATA_DIR のマスタデータキャッシュを include_once() で読み込む |
---|
46 | * 2. 1 で読み込んだ値をチェックし, 値が変数定義されていれば値を返す. |
---|
47 | * されていなければ, 次の処理を行う. |
---|
48 | * 3. 値が未定義の場合は, DBからマスタデータを取得する. |
---|
49 | * 4. 取得した後, マスタデータのキャッシュを生成し, 値を返す. |
---|
50 | * |
---|
51 | * 返り値は, key => value 形式の配列である. |
---|
52 | * |
---|
53 | * @param string $name マスタデータ名 |
---|
54 | * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順 |
---|
55 | * を表すカラム名を格納した配列 |
---|
56 | * @return array マスタデータ |
---|
57 | */ |
---|
58 | function getMasterData($name, $columns = array()) { |
---|
59 | |
---|
60 | $columns = $this->getDefaultColumnName($columns); |
---|
61 | |
---|
62 | // 可変変数を定義 |
---|
63 | $valiable = "_" . $name . "_master"; |
---|
64 | // キャッシュを読み込み |
---|
65 | @include_once(MASTER_DATA_DIR . $name . ".php"); |
---|
66 | |
---|
67 | // キャッシュがあれば, キャッシュの値を返す. |
---|
68 | if (!empty($$valiable)) { |
---|
69 | return $$valiable; |
---|
70 | } |
---|
71 | // マスタデータを取得 |
---|
72 | $masterData = $this->getDbMasterData($name, $columns); |
---|
73 | // キャッシュ生成 |
---|
74 | $this->createCache($name, $masterData); |
---|
75 | return $masterData; |
---|
76 | } |
---|
77 | |
---|
78 | /** |
---|
79 | * マスタデータをDBに追加する. |
---|
80 | * |
---|
81 | * 引数 $masterData をマスタデータとしてDBに追加し, |
---|
82 | * キャッシュを生成する. |
---|
83 | * 既存のキャッシュが存在する場合は上書きする. |
---|
84 | * $masterData は key => value 形式の配列である必要がある. |
---|
85 | * |
---|
86 | * @param string $name マスタデータ名 |
---|
87 | * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順 |
---|
88 | * を表すカラム名を格納した配列 |
---|
89 | * @param array $masterData マスタデータ |
---|
90 | * @param bool $autoCommit トランザクションを自動的に commit する場合 true |
---|
91 | * @return integer マスタデータの登録数 |
---|
92 | */ |
---|
93 | function registMasterData($name, $columns, $masterData, $autoCommit = true) { |
---|
94 | |
---|
95 | $columns = $this->getDefaultColumnName($columns); |
---|
96 | |
---|
97 | $this->objQuery = new SC_Query(); |
---|
98 | if ($autoCommit) { |
---|
99 | $this->objQuery->begin(); |
---|
100 | } |
---|
101 | $i = 0; |
---|
102 | foreach ($masterData as $key => $val) { |
---|
103 | $sqlVal = array($columns[0] => $key, |
---|
104 | $columns[1] => $val, |
---|
105 | $columns[2] => (string) $i); |
---|
106 | $this->objQuery->insert($name, $sqlVal); |
---|
107 | $i++; |
---|
108 | } |
---|
109 | if ($autoCommit) { |
---|
110 | $this->objQuery->commit(); |
---|
111 | } |
---|
112 | |
---|
113 | // キャッシュを消去 |
---|
114 | $this->clearCache($name); |
---|
115 | // 新規にデータを取得してキャッシュ生成 |
---|
116 | $newData = $this->getMasterData($name, $columns); |
---|
117 | return $i; |
---|
118 | } |
---|
119 | |
---|
120 | /** |
---|
121 | * マスタデータを更新する. |
---|
122 | * |
---|
123 | * 引数 $masterData の値でマスタデータを更新し, |
---|
124 | * キャッシュを更新する. |
---|
125 | * $masterData は key => value 形式の配列である必要がある. |
---|
126 | * |
---|
127 | * @param string $name マスタデータ名 |
---|
128 | * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順 |
---|
129 | * を表すカラム名を格納した配列 |
---|
130 | * @param array $masterData マスタデータ |
---|
131 | * @param bool $autoCommit トランザクションを自動的に commit する場合 true |
---|
132 | * @return integer マスタデータの更新数 |
---|
133 | */ |
---|
134 | function updateMasterData($name, $columns, $masterData, $autoCommit = true) { |
---|
135 | $this->objQuery = new SC_Query(); |
---|
136 | if ($autoCommit) { |
---|
137 | $this->objQuery->begin(); |
---|
138 | } |
---|
139 | // マスタデータを削除 |
---|
140 | $this->deleteMasterData($name, false); |
---|
141 | |
---|
142 | // マスタデータを追加 |
---|
143 | $this->registMasterData($name, $columns, $masterData, false); |
---|
144 | |
---|
145 | if ($autoCommit) { |
---|
146 | $this->objQuery->commit(); |
---|
147 | } |
---|
148 | return count($masterData); |
---|
149 | } |
---|
150 | |
---|
151 | /** |
---|
152 | * マスタデータを削除する. |
---|
153 | * |
---|
154 | * 引数 $name のマスタデータを削除し, |
---|
155 | * キャッシュも削除する. |
---|
156 | * |
---|
157 | * @param string $name マスタデータ名 |
---|
158 | * @param bool $autoCommit トランザクションを自動的に commit する場合 true |
---|
159 | * @return integer マスタデータの削除数 |
---|
160 | */ |
---|
161 | function deleteMasterData($name, $autoCommit = true) { |
---|
162 | $this->objQuery = new SC_Query(); |
---|
163 | if ($autoCommit) { |
---|
164 | $this->objQuery->begin(); |
---|
165 | } |
---|
166 | |
---|
167 | // DB の内容とキャッシュをクリア |
---|
168 | $result = $this->objQuery->delete($name); |
---|
169 | $this->clearCache($name); |
---|
170 | |
---|
171 | if ($autoCommit) { |
---|
172 | $this->objQuery->commit(); |
---|
173 | } |
---|
174 | return $result; |
---|
175 | } |
---|
176 | |
---|
177 | /** |
---|
178 | * マスタデータのキャッシュを消去する. |
---|
179 | * |
---|
180 | * @param string $name マスタデータ名 |
---|
181 | * @return bool 消去した場合 true |
---|
182 | */ |
---|
183 | function clearCache($name) { |
---|
184 | $masterDataFile = MASTER_DATA_DIR . $name . ".php"; |
---|
185 | if (is_file($masterDataFile)) { |
---|
186 | unlink($masterDataFile); |
---|
187 | } |
---|
188 | } |
---|
189 | |
---|
190 | /** |
---|
191 | * マスタデータのキャッシュを生成する. |
---|
192 | * |
---|
193 | * 引数 $name のマスタデータキャッシュを生成する. |
---|
194 | * 既存のキャッシュが存在する場合は上書きする. |
---|
195 | * |
---|
196 | * @param string $name マスタデータ名 |
---|
197 | * @param array $masterData マスタデータ |
---|
198 | * @return bool キャッシュの生成に成功した場合 true |
---|
199 | */ |
---|
200 | function createCache($name, $masterData) { |
---|
201 | |
---|
202 | // 配列の定義を文字列にする |
---|
203 | $data = "<?php\n" |
---|
204 | . "\$_" . $name . "_master = array(\n"; |
---|
205 | $i = count($masterData); |
---|
206 | foreach ($masterData as $key => $val) { |
---|
207 | $data .= "'" . $key . "' => '" . $val . "'"; |
---|
208 | if ($i > 1) { |
---|
209 | $data .= ",\n"; |
---|
210 | } |
---|
211 | $i--; |
---|
212 | } |
---|
213 | $data .= ");\n" |
---|
214 | . "?>\n"; |
---|
215 | |
---|
216 | // ファイルを書き出しモードで開く |
---|
217 | $path = MASTER_DATA_DIR . $name . ".php"; |
---|
218 | $handle = fopen($path, "w"); |
---|
219 | if (!$handle) { |
---|
220 | return false; |
---|
221 | } |
---|
222 | // ファイルの内容を書き出す. |
---|
223 | if (fwrite($handle, $data) === false) { |
---|
224 | return false; |
---|
225 | } |
---|
226 | return true; |
---|
227 | } |
---|
228 | |
---|
229 | // }}} |
---|
230 | // {{{ private functions |
---|
231 | |
---|
232 | /** |
---|
233 | * DBからマスタデータを取得する. |
---|
234 | * |
---|
235 | * キャッシュの有無に関係なく, DBからマスタデータを検索し, 取得する. |
---|
236 | * |
---|
237 | * 返り値は, key => value 形式の配列である. |
---|
238 | * |
---|
239 | * @access private |
---|
240 | * @param string $name マスタデータ名 |
---|
241 | * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順 |
---|
242 | * を表すカラム名を格納した配列 |
---|
243 | * @return array マスタデータ |
---|
244 | */ |
---|
245 | function getDbMasterData($name, $columns = array()) { |
---|
246 | |
---|
247 | $columns = $this->getDefaultColumnName($columns); |
---|
248 | |
---|
249 | $this->objQuery = new SC_Query(); |
---|
250 | $this->objQuery->setorder($columns[2]); |
---|
251 | $results = $this->objQuery->select($columns[0] . ", " . $columns[1], $name); |
---|
252 | |
---|
253 | // 結果を key => value 形式に格納 |
---|
254 | $masterData = array(); |
---|
255 | foreach ($results as $result) { |
---|
256 | |
---|
257 | $masterData[$result[$columns[0]]] = $result[$columns[1]]; |
---|
258 | } |
---|
259 | return $masterData; |
---|
260 | } |
---|
261 | |
---|
262 | /** |
---|
263 | * デフォルトのカラム名の配列を返す. |
---|
264 | * |
---|
265 | * 引数 $columns が空の場合, デフォルトのカラム名の配列を返す. |
---|
266 | * 空でない場合は, 引数の値をそのまま返す. |
---|
267 | * |
---|
268 | * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順 |
---|
269 | * を表すカラム名を格納した配列 |
---|
270 | * @return array カラム名を格納した配列 |
---|
271 | */ |
---|
272 | function getDefaultColumnName($columns = array()) { |
---|
273 | if (!empty($columns)) { |
---|
274 | return $columns; |
---|
275 | } |
---|
276 | return $this->columns; |
---|
277 | } |
---|
278 | } |
---|
279 | ?> |
---|