CSV

Overview:

CSV provides CSV read/write utilities with auto delimiter detection and a row schema system.

Use CSV to import/export tabular data for admin tools, data migrations, and reporting jobs without rewriting delimiter, schema, and streaming logic each time.

Key behavior:

• Mode is read or write.
• Auto delimiter is supported for reading.
• The first row is treated as a header in read mode.

Public API:

• CSV::open($file, $format = CSV::AUTO) opens for read.
• CSV::create($file, $format = CSV::STANDARD) opens for write.
• CSV::fromSQL($sql, $format = CSV::AUTO) creates CSV from a SQL query.
• CSV::fromTable($table, $format = CSV::AUTO) creates CSV from array data.
• CSV::SQL($sql) writes rows from SQL query.
• CSV::write($row) writes a row, using the schema.
• CSV::read() yields rows as arrays.
• CSV::each(?callable $looper = null) iterates or returns all rows.
• CSV::convert($filename, $format = CSV::STANDARD) converts to another format.
• CSV::schema($schema = null) sets or gets the header schema.
• CSV::asString() returns the file contents.

Example:

$csv = CSV::create('out.csv');
$csv->write(['id' => 1, 'name' => 'Ada']);
$csv->write(['id' => 2, 'name' => 'Grace']);

The CSV module allow you to read and write Comma Separated Value data.

Open a CSV file

---

You can open a CSV file with the CSV::open factory. You can pass an optional separator or a format constant as a second parameter. Default value is auto-guessing of the separator.

$csv = CSV::open('mydata.csv')->each(function($row){
  print_r($row);
});

Get all data as an array

---

With a CSV object in read-mode, the each method will return all data if no parameters are passed to it.

$all_data = CSV::open('mydata.csv')->each();

Read a single row

---

With a CSV object in read-mode, the read method will return a single row from the CSV file.

$my_data = CSV::open('mydata.csv');

$first_row  = $my_data->read();
$second_row = $my_data->read();

Create a new CSV file

---

You can create a CSV file with the CSV::create factory. You can pass an optional separator or a format constant as a second parameter. Default value is CSV:STANDARD, that is a comma , separated.

$csv = CSV::create('characters.csv');

Write rows to the CSV

---

With a CSV object in write-mode, the write method will accept an array or an object and will write it to the CSV file.

The schema method defines the headers of the table to be written (if omitted the first row keys are used instead).

When a schema is defined, every written row will be reordered and filtered to be coherent with it.

$csv = CSV::create('characters.csv');

$csv->schema(['name','surname','email']);

$csv->write([
  'email'   => 'punisher@nyc.com',
  'name'    => 'Frank',
  'surname' => 'Castle',
]);

$csv->write([
  'name'    => 'King',
  'surname' => 'Pin',
  'dirty'   => 1234,
  'email'   => 'the_kingpin@nyc.com',
]);

echo $csv;

Returns:

name,surname,email
Frank,Castle,punisher@nyc.com
King,Pin,the_kingpin@nyc.com

Convert a CSV file to a defined format

---

// Convert an unknown-CSV to an Excel compatible one.
CSV::open('agents.csv')->convert('agents.xls',CSV::EXCEL);

This is pratically a shorthand for:

$csv = CSV::create('agents.xls',CSV::EXCEL);
CSV::open('agents.csv')->each(function($row) use ($csv) {
  $csv->write($row);
});