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

Revision 20280, 16.9 KB checked in by AMUAMU, 16 years ago (diff)

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