source: branches/version-2_5-dev/data/class/helper/SC_Helper_CSV.php @ 20734

Revision 20734, 16.9 KB checked in by AMUAMU, 11 years ago (diff)

#657 (CSVダウンロードの改善) カテゴリCSVの共通ルーチン利用に変更

  • 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   * Copyright(c) 2000-2010 LOCKON CO.,LTD. All Rights Reserved.
4   *
5   * http://www.lockon.co.jp/
6   */
7
8  /**
9   * CSV 関連 のヘルパークラス.
10   *
11   * @package Page
12   * @author LOCKON CO.,LTD.
13   * @version $Id$
14   */
15class SC_Helper_CSV {
16
17    // {{{ properties
18
19    /** 項目英名 */
20    var $arrSubnavi;
21
22    /** 項目名 */
23    var $arrSubnaviName;
24
25    /** レビュー管理項目 */
26    var $arrREVIEW_CVSCOL;
27
28    /** レビュータイトル */
29    var $arrREVIEW_CVSTITLE;
30
31    // }}}
32    // {{{ constructor
33
34    /**
35     * デフォルトコンストラクタ.
36     */
37    function SC_Helper_CSV() {
38        $this->init();
39
40        $masterData = new SC_DB_MasterData_Ex();
41        $this->arrPref = $masterData->getMasterData('mtb_pref');
42        $this->arrSex = $masterData->getMasterData("mtb_sex");
43        $this->arrDISP = $masterData->getMasterData("mtb_disp");
44        $this->arrRECOMMEND = $masterData->getMasterData("mtb_recommend");
45    }
46
47    // }}}
48    // {{{ functions
49
50    /**
51     * 項目情報を初期化する.
52     *
53     * @access private
54     * @return void
55     */
56    function init() {
57        $this->arrSubnavi = array(
58                                  1 => 'product',
59                                  2 => 'customer',
60                                  3 => 'order',
61                                  5 => 'category'
62                                  );
63
64        $this->arrSubnaviName = array(
65                                      1 => '商品管理',
66                                      2 => '顧客管理',
67                                      3 => '受注管理',
68                                      5 => 'カテゴリ'
69                                      );
70
71        $this->arrREVIEW_CVSCOL = array(
72                                        'B.name',
73                                        'A.status',
74                                        'A.create_date',
75                                        'A.reviewer_name',
76                                        'A.sex',
77                                        'A.recommend_level',
78                                        'A.title',
79                                        'A.comment'
80                                        );
81
82        $this->arrREVIEW_CVSTITLE = array(
83                                          '商品名',
84                                          'レビュー表示',
85                                          '投稿日',
86                                          '投稿者名',
87                                          '性別',
88                                          'おすすめレベル',
89                                          'タイトル',
90                                          'コメント'
91                                          );
92    }
93
94    /**
95     * CSV 項目を出力する.
96     *
97     * @param integer $csv_id CSV ID
98     * @param string $where SQL の WHERE 句
99     * @param array $arrVal WHERE 句の要素
100     * @param array $order SQL の ORDER BY 句
101     * @return array CSV 項目の配列
102     */
103    function sfGetCsvOutput($csv_id = "", $where = '', $arrVal = array(), $order = 'rank, no'){
104        $objQuery =& SC_Query_Ex::getSingletonInstance();
105
106        $cols = 'no, csv_id, col, disp_name, rank, status, rw_flg, mb_convert_kana_option, size_const_type, error_check_types';
107        $table = 'dtb_csv';
108
109        if(SC_Utils_Ex::sfIsInt($csv_id)){
110            if($where == "") {
111                $where = "csv_id = ?";
112            }else{
113                $where = "$where AND csv_id = ?";
114            }
115            $arrVal[] = $csv_id;
116        }
117        $objQuery->setOrder($order);
118
119        $arrRet = $objQuery->select($cols, $table, $where, $arrVal);
120        return $arrRet;
121    }
122
123    /**
124     * CSVが出力設定でインポート可能かのチェック
125     *
126     * @param array sfGetCsvOutputで取得した内容(またはそれと同等の配列)
127     * @return boolean true:インポート可能、false:インポート不可
128     */
129    function sfIsImportCSVFrame(&$arrCSVFrame) {
130        $result = true;
131        foreach($arrCSVFrame as $key => $val) {
132            if($val['status'] != CSV_COLUMN_STATUS_FLG_ENABLE
133                    and $val['rw_flg'] == CSV_COLUMN_RW_FLG_READ_WRITE
134                    and $val['error_check_types'] != ""
135                    and strpos(strtoupper($val['error_check_types']), "EXIST_CHECK") !== FALSE) {
136                //必須フィールド
137                $result = false;
138            }
139        }
140        return $result;
141    }
142
143    /**
144     * CSVが出力設定で更新可能かのチェック
145     *
146     * @param array sfGetCsvOutputで取得した内容(またはそれと同等の配列)
147     * @return boolean true:更新可能、false:新規追加のみ不可
148     */
149    function sfIsUpdateCSVFrame(&$arrCSVFrame) {
150        $result = true;
151        foreach($arrCSVFrame as $key => $val) {
152            if($val['status'] != CSV_COLUMN_STATUS_FLG_ENABLE
153                    and $val['rw_flg'] == CSV_COLUMN_RW_FLG_KEY_FIELD) {
154                //キーフィールド
155                $result = false;
156            }
157        }
158        return $result;
159    }
160
161    /**
162     * CSVファイルのカウント数を得る.
163     *
164     * @param resource $fp fopenを使用して作成したファイルポインタ
165     * @return integer CSV のカウント数
166     */
167    function sfGetCSVRecordCount($fp) {
168        $count = 0;
169        while(!feof($fp)) {
170            $arrCSV = fgetcsv($fp, CSV_LINE_MAX);
171            $count++;
172        }
173        // ファイルポインタを戻す
174        if (rewind($fp)) {
175            return $count-1;
176        } else {
177            return FALSE;
178        }
179    }
180
181    /**
182     * CSV作成 テンポラリファイル出力 コールバック関数
183     *
184     * @param mixed $data 出力データ
185     * @return boolean true (true:固定 false:中断)
186     */
187    function cbOutputCSV($data) {
188        $line = $this->sfArrayToCSV($data);
189        $line = mb_convert_encoding($line, 'SJIS-Win');
190        $line .= "\r\n";
191        fwrite($this->fpOutput, $line);
192        return true;
193    }
194
195    /**
196     * CSVファイルを送信する
197     *
198     * @param integer $csv_id CSVフォーマットID
199     * @param string $where WHERE条件文
200     * @param array $arrVal プリペアドステートメントの実行時に使用される配列。配列の要素数は、クエリ内のプレースホルダの数と同じでなければなりません。
201     * @param string $order ORDER文
202     * @param boolean $is_download true:ダウンロード用出力までさせる false:CSVの内容を返す(旧方式、メモリを食います。)
203     * @return mixed $is_download = true時 成功失敗フラグ(boolean) 、$is_downalod = false時 string
204     */
205    function sfDownloadCsv($csv_id, $where = "", $arrVal = array(), $order = "", $is_download = false) {
206        // 実行時間を制限しない
207        @set_time_limit(0);
208
209        // CSV出力タイトル行の作成
210        $arrOutput = SC_Utils_Ex::sfSwapArray($this->sfGetCsvOutput($csv_id, 'status = ' . CSV_COLUMN_STATUS_FLG_ENABLE));
211        if (count($arrOutput) <= 0) return false; // 失敗終了
212        $arrOutputCols = $arrOutput['col'];
213
214        $objQuery =& SC_Query_Ex::getSingletonInstance();
215        $objQuery->setOrder($order);       
216        $cols = SC_Utils_Ex::sfGetCommaList($arrOutputCols, true);
217
218        // TODO: 固有処理 なんかエレガントな処理にしたい
219        if($csv_id == '1') {
220            //商品の場合
221            $objProduct = new SC_Product_Ex();
222            // このWhereを足さないと無効な規格も出力される。現行仕様と合わせる為追加。
223            $inner_where = 'dtb_products_class.del_flg = 0';
224            $sql = $objQuery->getSql($cols, $objProduct->prdclsSQL($inner_where),$where);
225        }else if($csv_id == '2') {
226            // 顧客の場合
227            $sql = "SELECT " . $cols . " FROM dtb_customer " . $where;
228
229        }else if($csv_id == '5') {
230            // カテゴリの場合
231            $sql = "SELECT " . $cols . " FROM dtb_category " . $where;
232        }
233        // 固有処理ここまで
234        return $this->sfDownloadCsvFromSql($sql, $arrVal, $this->arrSubnavi[$csv_id], $arrOutput['disp_name'], $is_download);
235    }
236
237    /**
238     * SQL文からクエリ実行し CSVファイルを送信する
239     *
240     * @param integer $sql SQL文
241     * @param array $arrVal プリペアドステートメントの実行時に使用される配列。配列の要素数は、クエリ内のプレースホルダの数と同じでなければなりません。
242     * @param string $file_head ファイル名の頭に付ける文字列
243     * @param array $arrHeader ヘッダ出力列配列
244     * @param boolean $is_download true:ダウンロード用出力までさせる false:CSVの内容を返す(旧方式、メモリを食います。)
245     * @return mixed $is_download = true時 成功失敗フラグ(boolean) 、$is_downalod = false時 string
246     */
247    function sfDownloadCsvFromSql($sql, $arrVal = array(), $file_head = 'csv', $arrHeader = array(), $is_download = false) {
248        $objQuery =& SC_Query_Ex::getSingletonInstance();
249
250        // 実行時間を制限しない
251        @set_time_limit(0);
252        // ヘッダ構築
253        if(is_array($arrHeader)) {
254            $header = $this->sfArrayToCSV($arrHeader);
255            $header = mb_convert_encoding($header, 'SJIS-Win');
256            $header .= "\r\n";
257        }
258
259        //テンポラリファイル作成
260        // TODO: パフォーマンス向上には、ストリームを使うようにすると良い
261        //  環境要件がPHPバージョン5.1以上になったら使うように変えても良いかと
262        //  fopen('php://temp/maxmemory:'. (5*1024*1024), 'r+');
263        $tmp_filename = tempnam(CSV_TEMP_REALDIR, $file_head . '_csv');
264        $this->fpOutput = fopen($tmp_filename, "w+");
265        fwrite($this->fpOutput, $header);
266        $objQuery->doCallbackAll(array(&$this, 'cbOutputCSV'), $sql, $arrVal);
267
268        fclose($this->fpOutput);
269
270        if($is_download) {
271            // CSVを送信する。
272            $this->lfDownloadCSVFile($tmp_filename, $file_head . "_");
273            $res = true;
274        }else{
275            $res = SC_Utils_Ex::sfReadFile($tmp_filename);
276        }
277
278        //テンポラリファイル削除
279        unlink($tmp_filename);
280        return $res;
281    }
282
283    // CSV出力データを作成する。(レビュー)
284    function lfGetReviewCSV($where, $option, $arrval) {
285
286        $from = "dtb_review AS A INNER JOIN dtb_products AS B on A.product_id = B.product_id ";
287        $cols = SC_Utils_Ex::sfGetCommaList($this->arrREVIEW_CVSCOL);
288
289        $objQuery =& SC_Query_Ex::getSingletonInstance();
290        $objQuery->setOption($option);
291
292        $list_data = $objQuery->select($cols, $from, $where, $arrval);
293
294        $max = count($list_data);
295        if (!isset($data)) $data = "";
296        for($i = 0; $i < $max; $i++) {
297            // 各項目をCSV出力用に変換する。
298            $data .= $this->lfMakeReviewCSV($list_data[$i]);
299        }
300        return $data;
301    }
302
303    // CSV出力データを作成する。
304    function lfGetCSV($from, $where, $option, $arrval, $arrCsvOutputCols = "", $arrCsvOutputConverts = array()) {
305
306        $cols = SC_Utils_Ex::sfGetCommaList($arrCsvOutputCols);
307
308        $objQuery =& SC_Query_Ex::getSingletonInstance();
309        $objQuery->setOption($option);
310
311        $list_data = $objQuery->select($cols, $from, $where, $arrval, MDB2_FETCHMODE_ORDERED);
312
313        $csv = '';
314        foreach ($list_data as $row) {
315            $row = SC_Utils_Ex::mbConvertKanaWithArray($row, $arrCsvOutputConverts);
316            // 各項目をCSV出力用に変換する。
317            $line = $this->sfArrayToCsv($row);
318            $csv .= "$line\r\n";
319        }
320        return $csv;
321    }
322
323    // 各項目をCSV出力用に変換する。
324    function lfMakeCSV($list) {
325        $line = "";
326
327        foreach($list as $key => $val) {
328            $tmp = "";
329            switch($key) {
330                case 'order_pref':
331                case 'deliv_pref':
332                    $tmp = $this->arrPref[$val];
333                    break;
334                default:
335                    $tmp = $val;
336                    break;
337            }
338
339            $tmp = preg_replace('/[",]/', " ", $tmp);
340            $line .= "\"".$tmp."\",";
341        }
342        // 文末の","を変換
343        $line = $this->replaceLineSuffix($line);
344        return $line;
345    }
346
347    // 各項目をCSV出力用に変換する。(レビュー)
348    function lfMakeReviewCSV($list) {
349        $line = "";
350
351        foreach($list as $key => $val) {
352            $tmp = "";
353            switch($key) {
354            case 'sex':
355                $tmp = isset($this->arrSex[$val]) ? $this->arrSex[$val] : "";
356                break;
357            case 'recommend_level':
358                $tmp = isset($this->arrRECOMMEND[$val]) ? $this->arrRECOMMEND[$val]
359                                                        : "";
360                break;
361            case 'status':
362                $tmp = isset($this->arrDISP[$val]) ? $this->arrDISP[$val] : "";
363                break;
364            default:
365                $tmp = $val;
366                break;
367            }
368
369            $tmp = preg_replace('/[",]/', " ", $tmp);
370            $line .= "\"".$tmp."\",";
371        }
372        // 文末の","を変換
373        $line = $this->replaceLineSuffix($line);
374        return $line;
375    }
376
377    /**
378     * 行末の ',' を CRLF へ変換する.
379     *
380     * @access private
381     * @param string $line CSV出力用の1行分の文字列
382     * @return string 行末の ',' を CRLF に変換した文字列
383     */
384    function replaceLineSuffix($line) {
385        return preg_replace('/,$/',"\r\n",$line);
386    }
387
388    /**
389     * 1次元配列を1行のCSVとして返す
390     * 参考: http://jp.php.net/fputcsv
391     */
392    function sfArrayToCsv($fields, $delimiter = ',', $enclosure = '"', $arrayDelimiter = '|') {
393        if( strlen($delimiter) != 1 ) {
394            trigger_error('delimiter must be a single character', E_USER_WARNING);
395            return "";
396        }
397
398        if( strlen($enclosure) < 1 ) {
399            trigger_error('enclosure must be a single character', E_USER_WARNING);
400            return "";
401        }
402
403        foreach (array_keys($fields) as $key) {
404            $field =& $fields[$key];
405
406            // 配列を「|」区切りの文字列に変換する
407            if (is_array($field)) {
408                $field = implode($arrayDelimiter, $field);
409            }
410
411            /* enclose a field that contains a delimiter, an enclosure character, or a newline */
412            if (
413                   is_string($field)
414                && preg_match('/[' . preg_quote($delimiter) . preg_quote($enclosure) . '\\s]/', $field)
415            ) {
416                $field = $enclosure . preg_replace('/' . preg_quote($enclosure) . '/', $enclosure . $enclosure, $field) . $enclosure;
417            }
418        }
419
420        return implode($delimiter, $fields);
421    }
422
423    /**
424     * CSVを送信する。
425     */
426    function lfDownloadCsv($arrayData, $prefix = ""){
427
428        if($prefix == "") {
429            $dir_name = SC_Utils_Ex::sfUpDirName();
430            $file_name = $dir_name . date('ymdHis') .".csv";
431        } else {
432            $file_name = $prefix . date('ymdHis') .".csv";
433        }
434
435        /* HTTPヘッダの出力 */
436        Header("Content-disposition: attachment; filename=${file_name}");
437        Header("Content-type: application/octet-stream; name=${file_name}");
438        Header("Cache-Control: ");
439        Header("Pragma: ");
440
441        /* データを出力 */
442        foreach ($arrayData as $lineArray) {
443            $lineString = $this->sfArrayToCsv($lineArray);
444            $lineString = mb_convert_encoding($lineString, 'SJIS-Win');
445            echo $lineString . "\r\n";
446        }
447    }
448
449    /**
450     * CSVファイルを送信する。
451     */
452    function lfDownloadCSVFile($filepath, $prefix = "") {
453        $file_name = $prefix . date('YmdHis') . ".csv";
454
455        /* HTTPヘッダの出力 */
456        Header("Content-disposition: attachment; filename=${file_name}");
457        Header("Content-type: application/octet-stream; name=${file_name}");
458        Header("Cache-Control: ");
459        Header("Pragma: ");
460
461        /* データを出力 */
462        // file_get_contentsはメモリマッピングも自動的に使ってくれるので高速&省メモリ
463        echo file_get_contents($filepath);
464    }
465
466    /**
467     * CSVデータを取得する。
468     */
469    function lfGetCsv2($arrayData, $prefix = "") {
470
471        if($prefix == "") {
472            $dir_name = SC_Utils_Ex::sfUpDirName();
473            $file_name = $dir_name . date('ymdHis') .".csv";
474        } else {
475            $file_name = $prefix . date('ymdHis') .".csv";
476        }
477
478        /* データを出力 */
479        foreach ($arrayData as $lineArray) {
480            $lineString = $this->sfArrayToCsv($lineArray);
481            $lineString = mb_convert_encoding($lineString, 'SJIS-Win');
482            $lineString .= "\r\n";
483        }
484        return array($file_name, $lineString);
485    }
486}
487?>
Note: See TracBrowser for help on using the repository browser.