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

Revision 21904, 37.1 KB checked in by Seasoft, 10 years ago (diff)

#1860 (SC_Query#getSingletonInstance 第1引数($dsn)の差を適切に処理できない)

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