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

Revision 22739, 11.7 KB checked in by Seasoft, 11 years ago (diff)

#1710 (SC_Helper_CSV#sfDownloadCsv 第4引数($order)が無効となるケースがある)

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