source: branches/version-2_13-dev/data/class/helper/SC_Helper_CSV.php @ 22738

Revision 22738, 12.4 KB checked in by Seasoft, 8 years ago (diff)

#2043 (typo修正・ソース整形・ソースコメントの改善 for 2.13.0)
#2044 (無駄な処理を改善する for 2.13.0)

  • 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-2013 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
18    // {{{ properties
19
20    /** 項目英名 */
21    var $arrSubnavi;
22
23    /** 項目名 */
24    var $arrSubnaviName;
25
26    // }}}
27    // {{{ constructor
28
29    /**
30     * デフォルトコンストラクタ.
31     */
32    function __construct()
33    {
34        $this->init();
35    }
36
37    // }}}
38    // {{{ functions
39
40    /**
41     * 項目情報を初期化する.
42     *
43     * @access private
44     * @return void
45     */
46    function init()
47    {
48        $this->arrSubnavi = array(
49            1 => 'product',
50            2 => 'customer',
51            3 => 'order',
52            4 => 'review',
53            5 => 'category',
54        );
55
56        $this->arrSubnaviName = array(
57            1 => '商品管理',
58            2 => '会員管理',
59            3 => '受注管理',
60            4 => 'レビュー',
61            5 => 'カテゴリ',
62        );
63    }
64
65    /**
66     * CSVファイルを送信する
67     *
68     * @param integer $csv_id CSVフォーマットID
69     * @param string $where WHERE条件文
70     * @param array $arrVal プリペアドステートメントの実行時に使用される配列。配列の要素数は、クエリ内のプレースホルダの数と同じでなければなりません。
71     * @param string $order ORDER文
72     * @param boolean $is_download true:ダウンロード用出力までさせる false:CSVの内容を返す(旧方式、メモリを食います。)
73     * @return mixed $is_download = true時 成功失敗フラグ(boolean) 、$is_downalod = false時 string
74     */
75    function sfDownloadCsv($csv_id, $where = '', $arrVal = array(), $order = '', $is_download = false)
76    {
77        // CSV出力タイトル行の作成
78        $arrOutput = SC_Utils_Ex::sfSwapArray($this->sfGetCsvOutput($csv_id, 'status = ' . CSV_COLUMN_STATUS_FLG_ENABLE));
79        if (count($arrOutput) <= 0) return false; // 失敗終了
80        $arrOutputCols = $arrOutput['col'];
81
82        $objQuery =& SC_Query_Ex::getSingletonInstance();
83        $objQuery->setOrder($order);
84        $cols = SC_Utils_Ex::sfGetCommaList($arrOutputCols, true);
85
86        // TODO: 固有処理 なんかエレガントな処理にしたい
87        // 商品の場合
88        if ($csv_id == 1) {
89            $objProduct = new SC_Product_Ex();
90            // このWhereを足さないと無効な規格も出力される。現行仕様と合わせる為追加。
91            $inner_where = 'dtb_products_class.del_flg = 0';
92            $from = $objProduct->prdclsSQL($inner_where);
93            $sql = $objQuery->getSql($cols, $from, $where);
94        }
95        // 商品以外の場合
96        else {
97            // 会員の場合
98            if ($csv_id == 2) {
99                $from = 'dtb_customer';
100            }
101            // 注文の場合
102            else if ($csv_id == 3) {
103                $from = 'dtb_order';
104            }
105            // レビューの場合
106            else if ($csv_id == 4) {
107                $from = 'dtb_review AS A INNER JOIN dtb_products AS B on A.product_id = B.product_id';
108            }
109            // カテゴリの場合
110            else if ($csv_id == 5) {
111                $from = 'dtb_category';
112            }
113
114            $sql = "SELECT $cols FROM $from $where";
115            // 「getSqlを使っているcsv_id=1」以外で「order指定」がある場合は末尾に付与
116            // 全csv_idでgetSqlを使用して生成するよう統一する場合は当メソッドの呼び元も要修正
117            if ($csv_id != 1 && strlen($order) >= 1) {
118                $sql .= " ORDER BY $order";
119            }
120        }
121        // 固有処理ここまで
122
123        return $this->sfDownloadCsvFromSql($sql, $arrVal, $this->arrSubnavi[$csv_id], $arrOutput['disp_name'], $is_download);
124    }
125
126    /**
127     * CSV 項目を出力する.
128     *
129     * @param integer $csv_id CSV ID
130     * @param string $where SQL の WHERE 句
131     * @param array $arrVal WHERE 句の要素
132     * @param array $order SQL の ORDER BY 句
133     * @return array CSV 項目の配列
134     */
135    function sfGetCsvOutput($csv_id = '', $where = '', $arrVal = array(), $order = 'rank, no')
136    {
137        $objQuery =& SC_Query_Ex::getSingletonInstance();
138
139        $cols = 'no, csv_id, col, disp_name, rank, status, rw_flg, mb_convert_kana_option, size_const_type, error_check_types';
140        $table = 'dtb_csv';
141
142        if (SC_Utils_Ex::sfIsInt($csv_id)) {
143            if ($where == '') {
144                $where = 'csv_id = ?';
145            } else {
146                $where = "$where AND csv_id = ?";
147            }
148            $arrVal[] = $csv_id;
149        }
150        $objQuery->setOrder($order);
151
152        $arrRet = $objQuery->select($cols, $table, $where, $arrVal);
153        return $arrRet;
154    }
155
156    /**
157     * CSVが出力設定でインポート可能かのチェック
158     *
159     * @param array sfGetCsvOutputで取得した内容(またはそれと同等の配列)
160     * @return boolean true:インポート可能、false:インポート不可
161     */
162    function sfIsImportCSVFrame(&$arrCSVFrame)
163    {
164        $result = true;
165        foreach ($arrCSVFrame as $val) {
166            if ($val['status'] != CSV_COLUMN_STATUS_FLG_ENABLE
167                && $val['rw_flg'] == CSV_COLUMN_RW_FLG_READ_WRITE
168                && $val['error_check_types'] != ''
169                && strpos(strtoupper($val['error_check_types']), 'EXIST_CHECK') !== FALSE
170            ) {
171                //必須フィールド
172                $result = false;
173            }
174        }
175        return $result;
176    }
177
178    /**
179     * CSVが出力設定で更新可能かのチェック
180     *
181     * @param array sfGetCsvOutputで取得した内容(またはそれと同等の配列)
182     * @return boolean true:更新可能、false:新規追加のみ不可
183     */
184    function sfIsUpdateCSVFrame(&$arrCSVFrame)
185    {
186        $result = true;
187        foreach ($arrCSVFrame as $val) {
188            if ($val['status'] != CSV_COLUMN_STATUS_FLG_ENABLE
189                && $val['rw_flg'] == CSV_COLUMN_RW_FLG_KEY_FIELD
190            ) {
191                //キーフィールド
192                $result = false;
193            }
194        }
195        return $result;
196    }
197
198    /**
199     * CSVファイルのカウント数を得る.
200     *
201     * @param resource $fp fopenを使用して作成したファイルポインタ
202     * @return integer CSV のカウント数
203     */
204    function sfGetCSVRecordCount($fp)
205    {
206        $count = 0;
207        while (!feof($fp)) {
208            $arrCSV = fgetcsv($fp, CSV_LINE_MAX);
209            $count++;
210        }
211        // ファイルポインタを戻す
212        if (rewind($fp)) {
213            return $count-1;
214        } else {
215            return FALSE;
216        }
217    }
218
219    /**
220     * CSV作成 テンポラリファイル出力 コールバック関数
221     *
222     * @param mixed $data 出力データ
223     * @return boolean true (true:固定 false:中断)
224     */
225    function cbOutputCSV($data)
226    {
227        $line = $this->sfArrayToCSV($data);
228        $line = mb_convert_encoding($line, 'SJIS-Win');
229        $line .= "\r\n";
230        fwrite($this->fpOutput, $line);
231        SC_Utils_Ex::extendTimeOut();
232        return true;
233    }
234
235    /**
236     * SQL文からクエリ実行し CSVファイルを送信する
237     *
238     * @param integer $sql SQL文
239     * @param array $arrVal プリペアドステートメントの実行時に使用される配列。配列の要素数は、クエリ内のプレースホルダの数と同じでなければなりません。
240     * @param string $file_head ファイル名の頭に付ける文字列
241     * @param array $arrHeader ヘッダ出力列配列
242     * @param boolean $is_download true:ダウンロード用出力までさせる false:CSVの内容を返す(旧方式、メモリを食います。)
243     * @return mixed $is_download = true時 成功失敗フラグ(boolean) 、$is_downalod = false時 string
244     */
245    function sfDownloadCsvFromSql($sql, $arrVal = array(), $file_head = 'csv', $arrHeader = array(), $is_download = false)
246    {
247        $objQuery =& SC_Query_Ex::getSingletonInstance();
248
249        // ヘッダ構築
250        if (is_array($arrHeader)) {
251            $header = $this->sfArrayToCSV($arrHeader);
252            $header = mb_convert_encoding($header, 'SJIS-Win');
253            $header .= "\r\n";
254        }
255
256        //テンポラリファイル作成
257        // TODO: パフォーマンス向上には、ストリームを使うようにすると良い
258        //  環境要件がPHPバージョン5.1以上になったら使うように変えても良いかと
259        //  fopen('php://temp/maxmemory:'. (5*1024*1024), 'r+');
260        $tmp_filename = tempnam(CSV_TEMP_REALDIR, $file_head . '_csv');
261        $this->fpOutput = fopen($tmp_filename, 'w+');
262        fwrite($this->fpOutput, $header);
263        $objQuery->doCallbackAll(array(&$this, 'cbOutputCSV'), $sql, $arrVal);
264
265        fclose($this->fpOutput);
266
267        if ($is_download) {
268            // CSVを送信する。
269            $this->lfDownloadCSVFile($tmp_filename, $file_head . '_');
270            $res = true;
271        } else {
272            $res = SC_Helper_FileManager_Ex::sfReadFile($tmp_filename);
273        }
274
275        //テンポラリファイル削除
276        unlink($tmp_filename);
277        return $res;
278    }
279
280    /**
281     * 1次元配列を1行のCSVとして返す
282     * 参考: http://jp.php.net/fputcsv
283     *
284     * @param array $fields データ1次元配列
285     * @param string $delimiter
286     * @param string $enclosure
287     * @param string $arrayDelimiter
288     * @return string 結果行
289     */
290    function sfArrayToCsv($fields, $delimiter = ',', $enclosure = '"', $arrayDelimiter = '|')
291    {
292        if (strlen($delimiter) != 1) {
293            trigger_error('delimiter must be a single character', E_USER_WARNING);
294            return '';
295        }
296
297        if (strlen($enclosure) < 1) {
298            trigger_error('enclosure must be a single character', E_USER_WARNING);
299            return '';
300        }
301
302        foreach ($fields as $key => $value) {
303            $field =& $fields[$key];
304
305            // 配列を「|」区切りの文字列に変換する
306            if (is_array($field)) {
307                $field = implode($arrayDelimiter, $field);
308            }
309
310            /* enclose a field that contains a delimiter, an enclosure character, or a newline */
311            if (is_string($field)
312                && preg_match('/[' . preg_quote($delimiter) . preg_quote($enclosure) . '\\s]/', $field)
313            ) {
314                $field = $enclosure . preg_replace('/' . preg_quote($enclosure) . '/', $enclosure . $enclosure, $field) . $enclosure;
315            }
316        }
317
318        return implode($delimiter, $fields);
319    }
320
321    /**
322     * 配列データのCSVを送信する。
323     *
324     * @param array $fields データ配列
325     * @param string $prefix
326     * @return void
327     */
328    function lfDownloadCsv($arrData, $prefix = '')
329    {
330
331        if ($prefix == '') {
332            $dir_name = SC_Utils_Ex::sfUpDirName();
333            $file_name = $dir_name . date('ymdHis') .'.csv';
334        } else {
335            $file_name = $prefix . date('ymdHis') .'.csv';
336        }
337
338        /* HTTPヘッダの出力 */
339        Header("Content-disposition: attachment; filename=${file_name}");
340        Header("Content-type: application/octet-stream; name=${file_name}");
341        Header('Cache-Control: ');
342        Header('Pragma: ');
343
344        /* データを出力 */
345        foreach ($arrData as $lineArray) {
346            $lineString = $this->sfArrayToCsv($lineArray);
347            $lineString = mb_convert_encoding($lineString, 'SJIS-Win');
348            echo $lineString . "\r\n";
349        }
350    }
351
352    /**
353     * CSVファイルを送信する。
354     *
355     * @param string $filepath 送信するファイルのフルパス
356     * @param string $prefix
357     * @return void
358     */
359    function lfDownloadCSVFile($filepath, $prefix = '')
360    {
361        $file_name = $prefix . date('YmdHis') . '.csv';
362
363        /* HTTPヘッダの出力 */
364        Header("Content-disposition: attachment; filename={$file_name}");
365        Header("Content-type: application/octet-stream; name={$file_name}");
366        Header('Cache-Control: ');
367        Header('Pragma: ');
368
369        /* データを出力 */
370        // file_get_contentsはメモリマッピングも自動的に使ってくれるので高速&省メモリ
371        echo file_get_contents($filepath);
372    }
373}
Note: See TracBrowser for help on using the repository browser.