source: branches/feature-module-update/data/class/db/SC_DB_MasterData.php @ 15169

Revision 15169, 10.9 KB checked in by nanasess, 17 years ago (diff)

定数を出力する場合にコメントも出力するように変更

  • Property charset set to UTF-8'
  • Property svn:keywords set to Id Revision Date
  • Property svn:mime-type set to 'application/x-httpd-php
Line 
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 */
28class 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     * 引数 $isDefine が true の場合は, 定数を生成する.
196     *
197     * @param string $name マスタデータ名
198     * @param array $masterData マスタデータ
199     * @param bool $isDefine 定数を生成する場合 true
200     * @return bool キャッシュの生成に成功した場合 true
201     */
202    function createCache($name, $masterData, $isDefine = false) {
203
204        // マスタデータを文字列にする
205        $data = "<?php\n";
206        if ($isDefine) {
207            $data .= $this->getMasterDataAsDefine($masterData,
208                    $this->getDbMasterData("mtb_constants", array("id", "remarks", "rank")));
209        } else {
210            $data .= $this->getMasterDataAsString($name, $masterData);
211        }
212        $data .=  "?>\n";
213
214        // ファイルを書き出しモードで開く
215        $path = MASTER_DATA_DIR . $name . ".php";
216        $handle = fopen($path, "w");
217        if (!$handle) {
218            return false;
219        }
220        // ファイルの内容を書き出す.
221        if (fwrite($handle, $data) === false) {
222            return false;
223        }
224        return true;
225    }
226
227    // }}}
228    // {{{ private functions
229
230    /**
231     * DBからマスタデータを取得する.
232     *
233     * キャッシュの有無に関係なく, DBからマスタデータを検索し, 取得する.
234     *
235     * 返り値は, key => value 形式の配列である.
236     *
237     * @access private
238     * @param string $name マスタデータ名
239     * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順
240     *                        を表すカラム名を格納した配列
241     * @return array マスタデータ
242     */
243    function getDbMasterData($name, $columns = array()) {
244
245        $columns = $this->getDefaultColumnName($columns);
246
247        $this->objQuery = new SC_Query();
248        $this->objQuery->setorder($columns[2]);
249        $results = $this->objQuery->select($columns[0] . ", " . $columns[1], $name);
250
251        // 結果を key => value 形式に格納
252        $masterData = array();
253        foreach ($results as $result) {
254
255            $masterData[$result[$columns[0]]] = $result[$columns[1]];
256        }
257        return $masterData;
258    }
259
260    /**
261     * デフォルトのカラム名の配列を返す.
262     *
263     * 引数 $columns が空の場合, デフォルトのカラム名の配列を返す.
264     * 空でない場合は, 引数の値をそのまま返す.
265     *
266     * @param array $columns [0] => キー, [1] => 表示文字列, [2] => 表示順
267     *                        を表すカラム名を格納した配列
268     * @return array カラム名を格納した配列
269     */
270    function getDefaultColumnName($columns = array()) {
271
272        if (!empty($columns)) {
273            return $columns;
274        } else {
275            return $this->columns;
276        }
277    }
278
279    /**
280     * マスタデータの配列を配列定義の文字列として出力する.
281     *
282     * @access private
283     * @param string $name マスタデータ名
284     * @param array $masterData マスタデータの配列
285     * @return string 配列定義の文字列
286     */
287    function getMasterDataAsString($name, $masterData) {
288        $data = "\$_" . $name . "_master = array(\n";
289        $i = count($masterData);
290        foreach ($masterData as $key => $val) {
291            $data .= "'" . $key . "' => '" . $val . "'";
292            if ($i > 1) {
293                $data .= ",\n";
294            }
295            $i--;
296        }
297        $data .= ");\n";
298        return $data;
299    }
300
301    /**
302     * マスタデータの配列を定数定義の文字列として出力する.
303     *
304     * @access private
305     * @param array $masterData マスタデータの配列
306     * @param array $comments コメントの配列
307     * @return string 定数定義の文字列
308     */
309    function getMasterDataAsDefine($masterData, $comments = array()) {
310        $data = "";
311        foreach ($masterData as $key => $val) {
312            if (isset($comments[$key])) {
313                $data .= "/** " . $comments[$key] . " */\n";
314            }
315            $data .= "define('" . $key . "', " . $val . ");\n";
316        }
317        return $data;
318    }
319}
320?>
Note: See TracBrowser for help on using the repository browser.