1. class
  2. Eccube
  3. Framework
  4. Helper
  5. CsvHelper

CsvHelper

class CsvHelper

CSV 関連 のヘルパークラス.

Properties

$arrSubnavi 項目英名
$arrSubnaviName 項目名

Methods

__construct()

デフォルトコンストラクタ.

void
init()

項目情報を初期化する.

boolean|string
sfDownloadCsv(integer $csv_id, string $where = '', array $arrVal = array(), string $order = '', boolean $is_download = false)

CSVファイルを送信する

array
sfGetCsvOutput(integer $csv_id = '', string $where = '', array $arrVal = array(), array $order = 'rank, no')

CSV 項目を出力する.

boolean
sfIsImportCSVFrame(array $arrCSVFrame)

CSVが出力設定でインポート可能かのチェック

boolean
sfIsUpdateCSVFrame(array $arrCSVFrame)

CSVが出力設定で更新可能かのチェック

integer
sfGetCSVRecordCount(resource $fp)

CSVファイルのカウント数を得る.

boolean
cbOutputCSV(mixed $data)

CSV作成 テンポラリファイル出力 コールバック関数

boolean|string
sfDownloadCsvFromSql(integer $sql, array $arrVal = array(), string $file_head = 'csv', array|null $arrHeader = null, boolean $is_download = false)

SQL文からクエリ実行し CSVファイルを送信する

sfArrayToCsv($fields, $delimiter = ',', $enclosure = '"', $arrayDelimiter = '|') deprecated

前方互換用

lfDownloadCsv($arrData, $prefix = '') deprecated

前方互換用

lfDownloadCSVFile($filepath, $prefix = '') deprecated

前方互換用

static resource
fopen_for_output_csv($filename = 'php://output')

CSV 出力用のファイルポインタリソースを開く

Details

at line 41
__construct()

デフォルトコンストラクタ.

at line 52
void init()

項目情報を初期化する.

Return Value

void

at line 81
boolean|string sfDownloadCsv(integer $csv_id, string $where = '', array $arrVal = array(), string $order = '', boolean $is_download = false)

CSVファイルを送信する

Parameters

integer $csv_id CSVフォーマットID
string $where WHERE条件文
array $arrVal プリペアドステートメントの実行時に使用される配列。配列の要素数は、クエリ内のプレースホルダの数と同じでなければなりません。
string $order ORDER文
boolean $is_download true:ダウンロード用出力までさせる false:CSVの内容を返す(旧方式、メモリを食います。）

Return Value

boolean|string $isdownload = true時 成功失敗フラグ(boolean) 、$isdownalod = false時 string

at line 126
array sfGetCsvOutput(integer $csv_id = '', string $where = '', array $arrVal = array(), array $order = 'rank, no')

CSV 項目を出力する.

Parameters

integer $csv_id CSV ID
string $where SQL の WHERE 句
array $arrVal WHERE 句の要素
array $order SQL の ORDER BY 句

Return Value

array CSV 項目の配列

at line 154
boolean sfIsImportCSVFrame(array $arrCSVFrame)

CSVが出力設定でインポート可能かのチェック

Parameters

array $arrCSVFrame sfGetCsvOutputで取得した内容（またはそれと同等の配列)

Return Value

boolean true:インポート可能、false:インポート不可

at line 177
boolean sfIsUpdateCSVFrame(array $arrCSVFrame)

CSVが出力設定で更新可能かのチェック

Parameters

array $arrCSVFrame sfGetCsvOutputで取得した内容（またはそれと同等の配列)

Return Value

boolean true:更新可能、false:新規追加のみ不可

at line 198
integer sfGetCSVRecordCount(resource $fp)

CSVファイルのカウント数を得る.

Parameters

resource $fp fopenを使用して作成したファイルポインタ

Return Value

integer CSV のカウント数

at line 219
boolean cbOutputCSV(mixed $data)

CSV作成 テンポラリファイル出力 コールバック関数

Parameters

mixed $data 出力データ

Return Value

boolean true (true:固定 false:中断)

at line 242
boolean|string sfDownloadCsvFromSql(integer $sql, array $arrVal = array(), string $file_head = 'csv', array|null $arrHeader = null, boolean $is_download = false)

SQL文からクエリ実行し CSVファイルを送信する

Parameters

integer $sql SQL文
array $arrVal プリペアドステートメントの実行時に使用される配列。配列の要素数は、クエリ内のプレースホルダの数と同じでなければなりません。
string $file_head ファイル名の頭に付ける文字列
array|null $arrHeader ヘッダ出力列配列。null の場合、SQL 文の列名を出力する。
boolean $is_download true:ダウンロード用出力までさせる false:CSVの内容を返す(旧方式、メモリを食います。）

Return Value

boolean|string $isdownload = true時 成功失敗フラグ(boolean) 、$isdownalod = false時 string

at line 291
sfArrayToCsv($fields, $delimiter = ',', $enclosure = '"', $arrayDelimiter = '|') deprecated

deprecated 2.13.2 fputcsv を使うこと。(sfDownloadCsvFromSql や cbOutputCSV の実装を参照)

前方互換用

Parameters

$fields
$delimiter
$enclosure
$arrayDelimiter

at line 330
lfDownloadCsv($arrData, $prefix = '') deprecated

deprecated 2.13.2

前方互換用

Parameters

$arrData
$prefix

at line 354
lfDownloadCSVFile($filepath, $prefix = '') deprecated

deprecated 2.13.2

前方互換用

Parameters

$filepath
$prefix

at line 370
static resource fopen_for_output_csv($filename = 'php://output')

CSV 出力用のファイルポインタリソースを開く

Parameters

$filename

Return Value

resource ファイルポインタリソース