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

Revision 21867, 36.8 KB checked in by nakanishi, 12 years ago (diff)

#1831 Copyright Update

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