atk14 / csv-writer
将CSV写入字符串输出或文件。还提供导出到XLSX格式的功能。
v1.2.1
2023-12-11 16:18 UTC
Requires
- php: >=5.4.0
- ellumilel/php-excel-writer: ^0.1.9
Requires (Dev)
- atk14/files: ^1.4.2
- atk14/tester: *
This package is auto-updated.
Last update: 2024-09-05 15:24:51 UTC
README
将CSV写入字符串输出或文件。还提供导出到XLSX格式的功能。
基本用法
$writer = new CsvWriter([
"delimiter" => ";",
"quote" => '"',
"escape_char" => "\\",
]);
$writer->addRow([
"product_no" => "CAN_G1X",
"price" => 4999.0,
]);
$writer->addRow([
"product_no" => "CAN_G15",
"price" => 2099.99,
]);
echo $writer->writeToString();
// CAN_G1X;4999
// CAN_G15;2099.99
echo $writer->writeToString(["with_header" => true]);
// product_no;price
// CAN_G1X;4999
// CAN_G15;2099.99
echo $writer->writeToString(["with_header" => ["Product No.","Price"]]);
// "Product No.";Price
// CAN_G1X;4999
// CAN_G15;2099.99
可以通过将"with_header"选项设置为"auto"来自动添加表头。
$writer = new CsvWriter();
$writer->addRow(["k1" => "v1", "k2" => "v2"]);
echo $writer->writeToString(["with_header" => "auto"]);
// k1;k2
// v2;v2
$writer = new CsvWriter();
$writer->addRow(["v1","v2"]);
echo $writer->writeToString(["with_header" => "auto"]);
// v2;v2
CsvWriter实现了ArrayAccess,以便更容易地添加行。
$writer[] = ["k1" => "v1","k2" => "v2"];
$writer[] = ["k1" => "v3","k2" => "v4"];
XLSX格式
header("Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
header("Content-Disposition: attachment; filename=data.xlsx");
echo $writer->writeToString(["format" => "xlsx"]);
导出到文件
$writer->writeToFile("/path/to/a/file.csv",["with_header" => true]);
$writer->writeToFile("/path/to/a/file.xlsx",["with_header" => true, "format" => "xlsx"]);
特殊选项
在导出到CSV的情况下,BOM序列会自动写入文件开头。可以通过将write_bom选项设置为false来禁用。
$write->writeToFile("/path/to/a/file.csv",[
"format" => "csv",
"write_bom" => false
]);
可以为XLSX导出设置工作表名称。
$write->writeToFile("/path/to/a/file.xlsx",[
"format" => "xlsx",
"sheet_name" => "Order history"
]);
安装
composer require atk14/cvs-writer
测试
composer update --dev
./vendor/bin/run_unit_tests test
许可证
CsvWriter是免费软件,根据MIT许可证分发。