source: branches/version-2_12-dev/data/class/SC_Query.php @ 21514

Revision 21514, 33.7 KB checked in by Seasoft, 10 years ago (diff)

#1625 (typo修正・ソース整形・ソースコメントの改善)

  • Property svn:eol-style set to LF
  • Property svn:keywords set to Id
  • Property svn:mime-type set to text/x-httpd-php; charset=UTF-8
Line 
1<?php
2/*
3 * This file is part of EC-CUBE
4 *
5 * Copyright(c) 2000-2011 LOCKON CO.,LTD. All Rights Reserved.
6 *
7 * http://www.lockon.co.jp/
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22 */
23
24/**
25 * SQLの構築・実行を行う
26 *
27 * TODO エラーハンドリング, ロギング方法を見直す
28 *
29 * @author LOCKON CO.,LTD.
30 * @version $Id$
31 */
32class SC_Query {
33
34    var $option = '';
35    var $where = '';
36    var $arrWhereVal = array();
37    var $conn;
38    var $groupby = '';
39    var $order = '';
40    var $force_run;
41
42    /**
43     * コンストラクタ.
44     *
45     * @param string $dsn データソース名
46     * @param boolean $force_run エラーが発生しても処理を続行する場合 true
47     * @param boolean $new 新規に接続を行うかどうか
48     */
49    function SC_Query($dsn = '', $force_run = false, $new = false) {
50
51        if ($dsn == '') {
52            $dsn = DEFAULT_DSN;
53        }
54
55        // Debugモード指定
56        // 常時ONにするとメモリが解放されない。
57        // 連続クエリ実行時に問題が生じる。
58        if (DEBUG_MODE) {
59            $options['debug'] = PEAR_DB_DEBUG;
60        } else {
61            $options['debug'] = 0;
62        }
63
64        // 持続的接続オプション
65        $options['persistent'] = PEAR_DB_PERSISTENT;
66
67        // バッファリング trueにするとメモリが解放されない。
68        // 連続クエリ実行時に問題が生じる。
69        $options['result_buffering'] = false;
70
71        if ($new) {
72            $this->conn = MDB2::connect($dsn, $options);
73        } else {
74            $this->conn = MDB2::singleton($dsn, $options);
75        }
76        if (!PEAR::isError($this->conn)) {
77            $this->conn->setCharset('utf8');
78            $this->conn->setFetchMode(MDB2_FETCHMODE_ASSOC);
79        }
80        $this->dbFactory = SC_DB_DBFactory_Ex::getInstance();
81        $this->force_run = $force_run;
82    }
83
84    /**
85     * シングルトンの SC_Query インスタンスを取得する.
86     *
87     * @param string $dsn データソース名
88     * @param boolean $force_run エラーが発生しても処理を続行する場合 true
89     * @param boolean $new 新規に接続を行うかどうか
90     * @return SC_Query シングルトンの SC_Query インスタンス
91     */
92    function getSingletonInstance($dsn = '', $force_run = false, $new = false) {
93        if (!isset($GLOBALS['_SC_Query_instance'])
94            || is_null($GLOBALS['_SC_Query_instance'])) {
95            $GLOBALS['_SC_Query_instance'] =& new SC_Query_Ex($dsn, $force_run, $new);
96        }
97        $GLOBALS['_SC_Query_instance']->where = '';
98        $GLOBALS['_SC_Query_instance']->arrWhereVal = array();
99        $GLOBALS['_SC_Query_instance']->order = '';
100        $GLOBALS['_SC_Query_instance']->groupby = '';
101        $GLOBALS['_SC_Query_instance']->option = '';
102        return $GLOBALS['_SC_Query_instance'];
103    }
104
105    /**
106     * エラー判定を行う.
107     *
108     * @deprecated PEAR::isError() を使用して下さい
109     * @return boolean
110     */
111    function isError() {
112        if (PEAR::isError($this->conn)) {
113            return true;
114        }
115        return false;
116    }
117
118    /**
119     * COUNT文を実行する.
120     *
121     * @param string $table テーブル名
122     * @param string $where where句
123     * @param array $arrWhereVal プレースホルダ
124     * @return integer 件数
125     */
126    function count($table, $where = '', $arrWhereVal = array()) {
127        return $this->get('COUNT(*)', $table, $where, $arrWhereVal);
128    }
129
130    /**
131     * EXISTS文を実行する.
132     *
133     * @param string $table テーブル名
134     * @param string $where where句
135     * @param array $arrWhereVal プレースホルダ
136     * @return boolean 有無
137     */
138    function exists($table, $where = '', $arrWhereVal = array()) {
139        $sql_inner = $this->getSql('*', $table, $where, $arrWhereVal);
140        $sql = "SELECT CASE WHEN EXISTS($sql_inner) THEN 1 ELSE 0 END";
141        $res = $this->getOne($sql, $arrWhereVal);
142        return (bool)$res;
143    }
144
145    /**
146     * SELECT文を実行する.
147     *
148     * @param string $col カラム名. 複数カラムの場合はカンマ区切りで書く
149     * @param string $table テーブル名
150     * @param string $where WHERE句
151     * @param array $arrWhereVal プレースホルダ
152     * @param integer $fetchmode 使用するフェッチモード。デフォルトは MDB2_FETCHMODE_ASSOC。
153     * @return array|null
154     */
155    function select($col, $table, $where = '', $arrWhereVal = array(), $fetchmode = MDB2_FETCHMODE_ASSOC) {
156        $sqlse = $this->getSql($col, $table, $where, $arrWhereVal);
157        return $this->getAll($sqlse, $arrWhereVal, $fetchmode);
158    }
159
160    /**
161     * 直前に実行されたSQL文を取得する.
162     *
163     * @param boolean $disp trueの場合、画面出力を行う.
164     * @return string SQL文
165     */
166    function getLastQuery($disp = true) {
167        $sql = $this->conn->last_query;
168        if ($disp) {
169            echo $sql . ";<br />\n";
170        }
171        return $sql;
172    }
173
174    /**
175     * トランザクションをコミットする.
176     *
177     * @return MDB2_OK 成功した場合は MDB2_OK;
178     *         失敗した場合は PEAR::Error オブジェクト
179     */
180    function commit() {
181        return $this->conn->commit();
182    }
183
184    /**
185     * トランザクションを開始する.
186     *
187     * @return MDB2_OK 成功した場合は MDB2_OK;
188     *         失敗した場合は PEAR::Error オブジェクト
189     */
190    function begin() {
191        return $this->conn->beginTransaction();
192    }
193
194    /**
195     * トランザクションをロールバックする.
196     *
197     * @return MDB2_OK 成功した場合は MDB2_OK;
198     *         失敗した場合は PEAR::Error オブジェクト
199     */
200    function rollback() {
201        return $this->conn->rollback();
202    }
203
204    /**
205     * トランザクションが開始されているかチェックする.
206     *
207     * @return boolean トランザクションが開始されている場合 true
208     */
209    function inTransaction() {
210        return $this->conn->inTransaction();
211    }
212
213    /**
214     * 更新系の SQL を実行する.
215     *
216     * この関数は SC_Query::query() のエイリアスです.
217     *
218     * FIXME MDB2::exec() の実装であるべき
219     */
220    function exec($str, $arrval = array()) {
221        return $this->query($str, $arrval);
222    }
223
224    /**
225     * クエリを実行し、結果行毎にコールバック関数を適用する
226     *
227     * @param callback $function コールバック先
228     * @param string $sql SQL クエリ
229     * @param array $arrVal プリペアドステートメントの実行時に使用される配列。配列の要素数は、クエリ内のプレースホルダの数と同じでなければなりません。
230     * @param integer $fetchmode 使用するフェッチモード。デフォルトは DB_FETCHMODE_ASSOC。
231     * @return boolean 結果
232     */
233    function doCallbackAll($cbFunc, $sql, $arrval = array(), $fetchmode = MDB2_FETCHMODE_ASSOC) {
234
235        $sql = $this->dbFactory->sfChangeMySQL($sql);
236
237        $sth =& $this->prepare($sql);
238        if (PEAR::isError($sth) && $this->force_run) {
239            return;
240        }
241
242        $affected =& $this->execute($sth, $arrval);
243        if (PEAR::isError($affected) && $this->force_run) {
244            return;
245        }
246
247        while ($data = $affected->fetchRow($fetchmode)) {
248            $result = call_user_func($cbFunc, $data);
249            if ($result === false) {
250                break;
251            }
252        }
253        $sth->free();
254        return $result;
255    }
256
257    /**
258     * クエリを実行し、全ての行を返す
259     *
260     * @param string $sql SQL クエリ
261     * @param array $arrVal プリペアドステートメントの実行時に使用される配列。配列の要素数は、クエリ内のプレースホルダの数と同じでなければなりません。
262     * @param integer $fetchmode 使用するフェッチモード。デフォルトは DB_FETCHMODE_ASSOC。
263     * @return array データを含む2次元配列。失敗した場合に 0 または DB_Error オブジェクトを返します。
264     */
265    function getAll($sql, $arrval = array(), $fetchmode = MDB2_FETCHMODE_ASSOC) {
266
267        $sql = $this->dbFactory->sfChangeMySQL($sql);
268
269        $sth =& $this->prepare($sql);
270        if (PEAR::isError($sth) && $this->force_run) {
271            return;
272        }
273
274        $affected =& $this->execute($sth, $arrval);
275        if (PEAR::isError($affected) && $this->force_run) {
276            return;
277        }
278
279        // MySQL での不具合対応のため、一旦変数に退避
280        $arrRet = $affected->fetchAll($fetchmode);
281
282        // PREPAREの解放
283        $sth->free();
284
285        return $arrRet;
286    }
287
288    /**
289     * 構築した SELECT 文を取得する.
290     *
291     * クラス変数から WHERE 句を組み立てる場合、$arrWhereVal を経由してプレースホルダもクラス変数のもので上書きする。
292     * @param string $col SELECT 文に含めるカラム名
293     * @param string $table SELECT 文に含めるテーブル名
294     * @param string $where SELECT 文に含める WHERE 句
295     * @param mixed $arrWhereVal プレースホルダ(参照)
296     * @return string 構築済みの SELECT 文
297     */
298    function getSql($col, $table, $where = '', &$arrWhereVal = null) {
299        $sqlse = "SELECT $col FROM $table";
300
301        // 引数の$whereを優先する。
302        if (strlen($where) >= 1) {
303            $sqlse .= " WHERE $where";
304        } elseif (strlen($this->where) >= 1) {
305            $sqlse .= ' WHERE ' . $this->where;
306            // 実行時と同じくキャストしてから評価する (空文字を要素1の配列と評価させる意図)
307            $arrWhereValForEval = (array)$arrWhereVal;
308            if (empty($arrWhereValForEval)) {
309                $arrWhereVal = $this->arrWhereVal;
310            }
311        }
312
313        $sqlse .= ' ' . $this->groupby . ' ' . $this->order . ' ' . $this->option;
314
315        return $sqlse;
316    }
317
318    /**
319     * SELECT 文の末尾に付与する SQL を設定する.
320     *
321     * この関数で設定した値は SC_Query::getSql() で使用されます.
322     *
323     * @param string $str 付与する SQL 文
324     * @return SC_Query 自分自身のインスタンス
325     */
326    function setOption($str) {
327        $this->option = $str;
328        return $this;
329    }
330
331    /**
332     * SELECT 文に付与する LIMIT, OFFSET 句を設定する.
333     *
334     * この関数で設定した値は SC_Query::getSql() で使用されます.
335     * TODO MDB2::setLimit() を使用する
336     *
337     * @param integer $limit LIMIT 句に付与する値
338     * @param integer $offset OFFSET 句に付与する値
339     * @return SC_Query 自分自身のインスタンス
340     */
341    function setLimitOffset($limit, $offset = 0) {
342        if (is_numeric($limit) && is_numeric($offset)) {
343
344            $option = ' LIMIT ' . $limit;
345            $option.= ' OFFSET ' . $offset;
346            $this->option .= $option;
347        }
348        return $this;
349    }
350
351    /**
352     * SELECT 文に付与する GROUP BY 句を設定する.
353     *
354     * この関数で設定した値は SC_Query::getSql() で使用されます.
355     *
356     * @param string $str GROUP BY 句に付与する文字列
357     * @return SC_Query 自分自身のインスタンス
358     */
359    function setGroupBy($str) {
360        if (strlen($str) == 0) {
361            $this->groupby = '';
362        } else {
363            $this->groupby = 'GROUP BY ' . $str;
364        }
365        return $this;
366    }
367
368    /**
369     * SELECT 文の WHERE 句に付与する AND 条件を設定する.
370     *
371     * この関数で設定した値は SC_Query::getSql() で使用されます.
372     *
373     * @param string $str WHERE 句に付与する AND 条件の文字列
374     * @return SC_Query 自分自身のインスタンス
375     */
376    function andWhere($str) {
377        if ($this->where != '') {
378            $this->where .= ' AND ' . $str;
379        } else {
380            $this->where = $str;
381        }
382        return $this;
383    }
384
385    /**
386     * SELECT 文の WHERE 句に付与する OR 条件を設定する.
387     *
388     * この関数で設定した値は SC_Query::getSql() で使用されます.
389     *
390     * @param string $str WHERE 句に付与する OR 条件の文字列
391     * @return SC_Query 自分自身のインスタンス
392     */
393    function orWhere($str) {
394        if ($this->where != '') {
395            $this->where .= ' OR ' . $str;
396        } else {
397            $this->where = $str;
398        }
399        return $this;
400    }
401
402    /**
403     * SELECT 文に付与する WHERE 句を設定する.
404     *
405     * この関数で設定した値は SC_Query::getSql() で使用されます.
406     *
407     * @param string $where WHERE 句に付与する文字列
408     * @param mixed $arrWhereVal プレースホルダ
409     * @return SC_Query 自分自身のインスタンス
410     */
411    function setWhere($where = '', $arrWhereVal = array()) {
412        $this->where = $where;
413        $this->arrWhereVal = $arrWhereVal;
414        return $this;
415    }
416
417    /**
418     * SELECT 文に付与する ORDER BY 句を設定する.
419     *
420     * この関数で設定した値は SC_Query::getSql() で使用されます.
421     *
422     * @param string $str ORDER BY 句に付与する文字列
423     * @return SC_Query 自分自身のインスタンス
424     */
425    function setOrder($str) {
426        if (strlen($str) == 0) {
427            $this->order = '';
428        } else {
429            $this->order = 'ORDER BY ' . $str;
430        }
431        return $this;
432    }
433
434    /**
435     * SELECT 文に付与する LIMIT 句を設定する.
436     *
437     * この関数で設定した値は SC_Query::getSql() で使用されます.
438     *
439     * @param integer $limit LIMIT 句に設定する値
440     * @return SC_Query 自分自身のインスタンス
441     */
442    function setLimit($limit) {
443        if (is_numeric($limit)) {
444            $this->option = ' LIMIT ' .$limit;
445        }
446        return $this;
447    }
448
449    /**
450     * SELECT 文に付与する OFFSET 句を設定する.
451     *
452     * この関数で設定した値は SC_Query::getSql() で使用されます.
453     *
454     * @param integer $offset LIMIT 句に設定する値
455     * @return SC_Query 自分自身のインスタンス
456     */
457    function setOffset($offset) {
458        if (is_numeric($offset)) {
459            $this->offset = ' OFFSET ' .$offset;
460        }
461        return $this;
462    }
463
464    /**
465     * INSERT文を実行する.
466     *
467     * @param string $table テーブル名
468     * @param array $sqlval array('カラム名' => '値', ...)の連想配列
469     * @param array $arrSql array('カラム名' => 'SQL文', ...)の連想配列
470     * @param array $arrSqlVal SQL文の中で使用するプレースホルダ配列
471     * @return
472     */
473    function insert($table, $sqlval, $arrSql = array(), $arrSqlVal = array()) {
474        $strcol = '';
475        $strval = '';
476        $find = false;
477        $arrVal = array();
478
479        if(count($sqlval) <= 0) return false;
480        foreach ($sqlval as $key => $val) {
481            $strcol .= $key . ',';
482            if (strcasecmp('Now()', $val) === 0) {
483                $strval .= 'Now(),';
484            } else if (strcasecmp('CURRENT_TIMESTAMP', $val) === 0) {
485                $strval .= 'CURRENT_TIMESTAMP,';
486            } else {
487                $strval .= '?,';
488                $arrVal[] = $val;
489            }
490            $find = true;
491        }
492
493        foreach ($arrSql as $key => $val) {
494            $strcol .= $key . ',';
495            $strval .= $val . ',';
496        }
497
498        $arrVal = array_merge($arrVal, $arrSqlVal);
499
500        if (!$find) {
501            return false;
502        }
503        // 文末の','を削除
504        $strcol = preg_replace("/,$/", "", $strcol);
505        $strval = preg_replace("/,$/", "", $strval);
506        $sqlin = "INSERT INTO $table(" . $strcol. ") VALUES (" . $strval . ")";
507        // INSERT文の実行
508        $ret = $this->query($sqlin, $arrVal, false, null, MDB2_PREPARE_MANIP);
509
510        return $ret;
511    }
512
513    /**
514     * UPDATE文を実行する.
515     *
516     * @param string $table テーブル名
517     * @param array $sqlval array('カラム名' => '値', ...)の連想配列
518     * @param string $where WHERE句
519     * @param array $arrWhereVal WHERE句用のプレースホルダ配列 (従来は追加カラム用も兼ねていた)
520     * @param array $arrRawSql 追加カラム
521     * @param array $arrRawSqlVal 追加カラム用のプレースホルダ配列
522     * @return
523     */
524    function update($table, $sqlval, $where = '', $arrWhereVal = array(), $arrRawSql = array(), $arrRawSqlVal = array()) {
525        $arrCol = array();
526        $arrVal = array();
527        $find = false;
528
529        foreach ($sqlval as $key => $val) {
530            if (strcasecmp('Now()', $val) === 0) {
531                $arrCol[] = $key . '= Now()';
532            } else if (strcasecmp('CURRENT_TIMESTAMP', $val) === 0) {
533                $arrCol[] = $key . '= CURRENT_TIMESTAMP';
534            } else {
535                $arrCol[] = $key . '= ?';
536                $arrVal[] = $val;
537            }
538            $find = true;
539        }
540
541        if ($arrRawSql != '') {
542            foreach ($arrRawSql as $key => $val) {
543                $arrCol[] = "$key = $val";
544            }
545        }
546
547        $arrVal = array_merge($arrVal, $arrRawSqlVal);
548
549        if (empty($arrCol)) {
550            return false;
551        }
552
553        // 文末の','を削除
554        $strcol = implode(', ', $arrCol);
555
556        if (is_array($arrWhereVal)) { // 旧版との互換用
557            // プレースホルダー用に配列を追加
558            $arrVal = array_merge($arrVal, $arrWhereVal);
559        }
560
561        $sqlup = "UPDATE $table SET $strcol";
562        if (strlen($where) >= 1) {
563            $sqlup .= " WHERE $where";
564        }
565
566        // UPDATE文の実行
567        return $this->query($sqlup, $arrVal, false, null, MDB2_PREPARE_MANIP);
568    }
569
570    /**
571     * MAX文を実行する.
572     *
573     * @param string $table テーブル名
574     * @param string $col カラム名
575     * @param string $where 付与する WHERE 句
576     * @param array $arrval プレースホルダに挿入する値
577     * @return integer MAX文の実行結果
578     */
579    function max($col, $table, $where = '', $arrval = array()) {
580        $ret = $this->get("MAX($col)", $table, $where, $arrval);
581        return $ret;
582    }
583
584    /**
585     * MIN文を実行する.
586     *
587     * @param string $table テーブル名
588     * @param string $col カラム名
589     * @param string $where 付与する WHERE 句
590     * @param array $arrval プレースホルダに挿入する値
591     * @return integer MIN文の実行結果
592     */
593    function min($col, $table, $where = '', $arrval = array()) {
594        $ret = $this->get("MIN($col)", $table, $where, $arrval);
595        return $ret;
596    }
597
598    /**
599     * SQL を構築して, 特定のカラムの値を取得する.
600     *
601     * @param string $table テーブル名
602     * @param string $col カラム名
603     * @param string $where 付与する WHERE 句
604     * @param array $arrWhereVal プレースホルダに挿入する値
605     * @return mixed SQL の実行結果
606     */
607    function get($col, $table, $where = '', $arrWhereVal = array()) {
608        $sqlse = $this->getSql($col, $table, $where, $arrWhereVal);
609        // SQL文の実行
610        $ret = $this->getOne($sqlse, $arrWhereVal);
611        return $ret;
612    }
613
614    /**
615     * SQL を指定して, 特定のカラムの値を取得する.
616     *
617     * @param string $sql 実行する SQL
618     * @param array $arrval プレースホルダに挿入する値
619     * @return mixed SQL の実行結果
620     */
621    function getOne($sql, $arrval = array()) {
622
623        $sql = $this->dbFactory->sfChangeMySQL($sql);
624
625        $sth =& $this->prepare($sql);
626        if (PEAR::isError($sth) && $this->force_run) {
627            return;
628        }
629
630        $affected =& $this->execute($sth, $arrval);
631        if (PEAR::isError($affected) && $this->force_run) {
632            return;
633        }
634
635        // MySQL での不具合対応のため、一旦変数に退避
636        $arrRet = $affected->fetchOne();
637
638        // PREPAREの解放
639        $sth->free();
640
641        return $arrRet;
642    }
643
644    /**
645     * 一行をカラム名をキーとした連想配列として取得
646     *
647     * @param string $table テーブル名
648     * @param string $col カラム名
649     * @param string $where WHERE句
650     * @param array $arrWhereVal プレースホルダ配列
651     * @param integer $fetchmode 使用するフェッチモード。デフォルトは MDB2_FETCHMODE_ASSOC。
652     * @return array array('カラム名' => '値', ...)の連想配列
653     */
654    function getRow($col, $table, $where = '', $arrWhereVal = array(), $fetchmode = MDB2_FETCHMODE_ASSOC) {
655
656        $sql = $this->getSql($col, $table, $where, $arrWhereVal);
657        $sql = $this->dbFactory->sfChangeMySQL($sql);
658
659        $sth =& $this->prepare($sql);
660        if (PEAR::isError($sth) && $this->force_run) {
661            return;
662        }
663
664        $affected =& $this->execute($sth, $arrWhereVal);
665        if (PEAR::isError($affected) && $this->force_run) {
666            return;
667        }
668
669        // MySQL での不具合対応のため、一旦変数に退避
670        $arrRet = $affected->fetchRow($fetchmode);
671
672        // PREPAREの解放
673        $sth->free();
674
675        return $arrRet;
676    }
677
678    /**
679     * SELECT 文の実行結果を 1列のみ取得する.
680     *
681     * @param string $table テーブル名
682     * @param string $col カラム名
683     * @param string $where 付与する WHERE 句
684     * @param array $arrWhereVal プレースホルダに挿入する値
685     * @return array SQL の実行結果の配列
686     */
687    function getCol($col, $table, $where = '', $arrWhereVal = array()) {
688        $sql = $this->getSql($col, $table, $where, $arrWhereVal);
689        $sql = $this->dbFactory->sfChangeMySQL($sql);
690
691        $sth =& $this->prepare($sql);
692        if (PEAR::isError($sth) && $this->force_run) {
693            return;
694        }
695
696        $affected =& $this->execute($sth, $arrWhereVal);
697        if (PEAR::isError($affected) && $this->force_run) {
698            return;
699        }
700
701        // MySQL での不具合対応のため、一旦変数に退避
702        $arrRet = $affected->fetchCol();
703
704        // PREPAREの解放
705        $sth->free();
706
707        return $arrRet;
708    }
709
710    /**
711     * レコードの削除
712     *
713     * @param string $table テーブル名
714     * @param string $where WHERE句
715     * @param array $arrval プレースホルダ
716     * @return
717     */
718    function delete($table, $where = '', $arrval = array()) {
719        if (strlen($where) <= 0) {
720            $sqlde = "DELETE FROM $table";
721        } else {
722            $sqlde = "DELETE FROM $table WHERE $where";
723        }
724        $ret = $this->query($sqlde, $arrval, false, null, MDB2_PREPARE_MANIP);
725        return $ret;
726    }
727
728    /**
729     * 次のシーケンス値を取得する.
730     *
731     * @param string $seq_name 取得するシーケンス名
732     * @param integer 次のシーケンス値
733     */
734    function nextVal($seq_name) {
735        return $this->conn->nextID($seq_name);
736    }
737
738    /**
739     * 現在のシーケンス値を取得する.
740     *
741     * @param string $seq_name 取得するシーケンス名
742     * @return integer 現在のシーケンス値
743     */
744    function currVal($seq_name) {
745        return $this->conn->currID($seq_name);
746    }
747
748    /**
749     * シーケンス値を設定する.
750     *
751     * @param string $seq_name シーケンス名
752     * @param integer $start 設定するシーケンス値
753     * @return MDB2_OK
754     */
755    function setVal($seq_name, $start) {
756        $objManager =& $this->conn->loadModule('Manager');
757        // XXX エラーハンドリングを行う
758        $objManager->dropSequence($seq_name);
759        return $objManager->createSequence($seq_name, $start);
760    }
761
762    /**
763     * SQL を実行する.
764     *
765     * FIXME $ignore_errが無視されるようになっているが互換性として問題が無いか確認が必要
766     *
767     * @param string $n 実行する SQL 文
768     * @param array $arr プレースホルダに挿入する値
769     * @param boolean $ignore_err MDB2切替で無効化されている (エラーが発生しても処理を続行する場合 true)
770     * @param mixed $types プレースホルダの型指定 デフォルトnull = string
771     * @param mixed $result_types 返値の型指定またはDML実行(MDB2_PREPARE_MANIP)
772     * @return array SQL の実行結果の配列
773     */
774    function query($n ,$arr = array(), $ignore_err = false, $types = null, $result_types = MDB2_PREPARE_RESULT) {
775
776        $n = $this->dbFactory->sfChangeMySQL($n);
777
778        $sth =& $this->prepare($n, $types, $result_types);
779        if (PEAR::isError($sth) && $this->force_run) {
780            return $sth;
781        }
782
783        $result = $this->execute($sth, $arr);
784        if (PEAR::isError($result) && $this->force_run) {
785            return $sth;
786        }
787
788        // PREPAREの解放
789        $sth->free();
790
791        return $result;
792    }
793
794    /**
795     * シーケンスの一覧を取得する.
796     *
797     * @return array シーケンス名の配列
798     */
799    function listSequences() {
800        $objManager =& $this->conn->loadModule('Manager');
801        return $objManager->listSequences();
802    }
803
804    /**
805     * テーブル一覧を取得する.
806     *
807     * @return array テーブル名の配列
808     */
809    function listTables() {
810        $objManager =& $this->conn->loadModule('Manager');
811        return $objManager->listTables();
812    }
813
814    /**
815     * テーブルのカラム一覧を取得する.
816     *
817     * @param string $table テーブル名
818     * @return array 指定のテーブルのカラム名の配列
819     */
820    function listTableFields($table) {
821        $objManager =& $this->conn->loadModule('Manager');
822        return $objManager->listTableFields($table);
823    }
824
825    /**
826     * テーブルのインデックス一覧を取得する.
827     *
828     * @param string $table テーブル名
829     * @return array 指定のテーブルのインデックス一覧
830     */
831    function listTableIndexes($table) {
832        $objManager =& $this->conn->loadModule('Manager');
833        return $objManager->listTableIndexes($table);
834    }
835
836    /**
837     * テーブルにインデックスを付与する
838     *
839     * @param string $table テーブル名
840     * @param string $name インデックス名
841     * @param array $definition フィールド名など 通常のフィールド指定時は、$definition=array('fields' => array('フィールド名' => array()));
842     *               MySQLのtext型フィールドを指定する場合は $definition['length'] = 'text_field(NNN)' が必要
843     */
844    function createIndex($table, $name, $definition) {
845        $definition = $this->dbFactory->sfGetCreateIndexDefinition($table, $name, $definition);
846        $objManager =& $this->conn->loadModule('Manager');
847        return $objManager->createIndex($table, $name, $definition);
848    }
849
850    /**
851     * テーブルにインデックスを破棄する
852     *
853     * @param string $table テーブル名
854     * @param string $name インデックス名
855     */
856    function dropIndex($table, $name) {
857        $objManager =& $this->conn->loadModule('Manager');
858        return $objManager->dropIndex($table, $name);
859    }
860
861    /**
862     * テーブルの詳細情報を取得する。
863     *
864     * @param string $table テーブル名
865     * @return array テーブル情報の配列
866     */
867    function getTableInfo($table) {
868        $objManager =& $this->conn->loadModule('Reverse');
869        return $objManager->tableInfo($table, NULL);
870    }
871
872    /**
873     * 値を適切にクォートする.
874     *
875     * TODO MDB2 に対応するための暫定的な措置.
876     *      プレースホルダが使用できない実装があるため.
877     *      本来であれば, MDB2::prepare() を適切に使用するべき
878     *
879     * @see MDB2::quote()
880     * @param string $val クォートを行う文字列
881     * @return string クォートされた文字列
882     */
883    function quote($val) {
884        return $this->conn->quote($val);
885    }
886
887    /**
888     * パラメーターの連想配列から, テーブルに存在する列のみを取得する.
889     *
890     * @param string $table テーブル名
891     * @param array プレースホルダの連想配列
892     * @return array テーブルに存在する列のみ抽出した連想配列
893     */
894    function extractOnlyColsOf($table, $arrParams) {
895        $arrCols = $this->listTableFields($table);
896        $arrResults = array();
897        foreach ($arrParams as $key => $val) {
898            if (in_array($key, $arrCols)) {
899                $arrResults[$key] = $val;
900            }
901        }
902        return $arrResults;
903    }
904
905    /**
906     * プリペアドステートメントを構築する.
907     *
908     * @access private
909     * @param string $sql プリペアドステートメントを構築する SQL
910     * @param mixed $types プレースホルダの型指定 デフォルト null
911     * @param mixed $result_types 返値の型指定またはDML実行(MDB2_PREPARE_MANIP)、nullは指定無し
912     * @return MDB2_Statement_Common プリペアドステートメントインスタンス
913     */
914    function prepare($sql, $types = null, $result_types = MDB2_PREPARE_RESULT) {
915        $sth =& $this->conn->prepare($sql, $types, $result_types);
916        if (PEAR::isError($sth)) {
917            if (!$this->force_run) {
918                trigger_error($this->traceError($sth, $sql), E_USER_ERROR);
919            } else {
920                error_log($this->traceError($sth, $sql), 3, LOG_REALFILE);
921            }
922        }
923        return $sth;
924    }
925
926    /**
927     * プリペアドクエリを実行する.
928     *
929     * @access private
930     * @param MDB2_Statement_Common プリペアドステートメントインスタンス
931     * @param array $arrVal プレースホルダに挿入する配列
932     * @return MDB2_Result 結果セットのインスタンス
933     */
934    function execute(&$sth, $arrVal = array()) {
935        $timeStart = SC_Utils_Ex::sfMicrotimeFloat();
936        $affected =& $sth->execute((array)$arrVal);
937
938        // 一定以上時間かかったSQLの場合、ログ出力する。
939        if (defined('SQL_QUERY_LOG_MODE') && SQL_QUERY_LOG_MODE == true) {
940            $timeEnd = SC_Utils_Ex::sfMicrotimeFloat();;
941            $timeExecTime = $timeEnd - $timeStart;
942            if (defined('SQL_QUERY_LOG_MIN_EXEC_TIME') && $timeExecTime >= (float)SQL_QUERY_LOG_MIN_EXEC_TIME) {
943                $logMsg = sprintf("SQL_LOG [%.2fsec]\n%s", $timeExecTime, $sth->query) . "\n";
944                error_log($logMsg, 3, LOG_REALFILE);
945            }
946        }
947
948        if (PEAR::isError($affected)) {
949            $sql = isset($sth->query) ? $sth->query : '';
950            if (!$this->force_run) {
951                trigger_error($this->traceError($affected, $sql, $arrVal), E_USER_ERROR);
952            } else {
953                error_log($this->traceError($affected, $sql, $arrVal), 3, LOG_REALFILE);
954            }
955        }
956        $this->conn->last_query = stripslashes($sth->query);
957        return $affected;
958    }
959
960    /**
961     * エラーの内容をトレースする.
962     *
963     * @access private
964     * @param PEAR::Error $error PEAR::Error インスタンス
965     * @param string $sql エラーの発生した SQL 文
966     * @param array $arrVal プレースホルダ
967     * @return string トレースしたエラー文字列
968     */
969    function traceError($error, $sql = '', $arrVal = false) {
970        $scheme = '';
971        if (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] != 'off') {
972            $scheme = 'http://';
973        } else {
974            $scheme = 'https://';
975        }
976
977        $err = $scheme . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] . "\n\n"
978            . 'SERVER_ADDR: ' . $_SERVER['SERVER_ADDR'] . "\n"
979            . 'REMOTE_ADDR: ' . $_SERVER['REMOTE_ADDR'] . "\n"
980            . 'USER_AGENT: ' . $_SERVER['HTTP_USER_AGENT'] . "\n\n"
981            . 'SQL: ' . $sql . "\n\n";
982        if ($arrVal !== false) {
983            $err .= 'PlaceHolder: ' . var_export($arrVal, true) . "\n\n";
984        }
985        $err .= $error->getMessage() . "\n\n";
986        $err .= $error->getUserInfo() . "\n\n";
987
988        $err .= SC_Utils_Ex::sfBacktraceToString($error->getBackTrace());
989
990        return $err;
991    }
992
993    /**
994     * SQLクエリの結果セットのカラム名だけを取得する
995     *
996     * @param string $n 実行する SQL 文
997     * @param array $arr プレースホルダに挿入する値
998     * @param boolean エラーが発生しても処理を続行する場合 true
999     * @param mixed $types プレースホルダの型指定 デフォルトnull = string
1000     * @param mixed $result_types 返値の型指定またはDML実行(MDB2_PREPARE_MANIP)
1001     * @return array 実行結果の配列
1002     */
1003    function getQueryDefsFields($n ,$arr = array(), $ignore_err = false, $types = null, $result_types = MDB2_PREPARE_RESULT) {
1004
1005        $n = $this->dbFactory->sfChangeMySQL($n);
1006
1007        $sth =& $this->prepare($n, $types, $result_types);
1008        if (PEAR::isError($sth) && ($this->force_run || $ignore_err)) {
1009            return;
1010        }
1011
1012        $result = $this->execute($sth, $arr);
1013        if (PEAR::isError($result) && ($this->force_run || $ignore_err)) {
1014            return;
1015        }
1016        $arrRet = $result->getColumnNames();
1017        // PREPAREの解放
1018        $sth->free();
1019
1020        return $arrRet;
1021    }
1022
1023}
Note: See TracBrowser for help on using the repository browser.