atk14/csv-writer

Writes CSV into string output or a file. Also provides export to XLSX format.

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: *

MIT

• ATK14 Development Team

• xls
• xlsx
• csv
• export
• writer
• exporter

README

Writes CSV into string output or a file. Also provides export to XLSX format.

Basic usage

$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

The header can be added automatically with the "with_header" option set to "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 implements ArrayAccess for easier rows adding:

$writer[] = ["k1" => "v1","k2" => "v2"];
$writer[] = ["k1" => "v3","k2" => "v4"];

XLSX format

header("Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
header("Content-Disposition: attachment; filename=data.xlsx");
echo $writer->writeToString(["format" => "xlsx"]);

Export to a file

$writer->writeToFile("/path/to/a/file.csv",["with_header" => true]);
$writer->writeToFile("/path/to/a/file.xlsx",["with_header" => true, "format" => "xlsx"]);

Special options

In case of exporting to CSV, the BOM sequence is automatically written at the beginning of the file. It can be disabled by the options write_bom set to false.

$write->writeToFile("/path/to/a/file.csv",[
  "format" => "csv",
  "write_bom" => false
]);

Sheet name can be set for XLSX export.

$write->writeToFile("/path/to/a/file.xlsx",[
  "format" => "xlsx",
  "sheet_name" => "Order history"
]);

Installation

composer require atk14/cvs-writer

Testing

composer update --dev
./vendor/bin/run_unit_tests test

License

CsvWriter is free software distributed under the terms of the MIT license