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

Revision 21710, 36.4 KB checked in by Seasoft, 9 years ago (diff)

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