Goodby, CSV

What is "Goodby CSV"?

Goodby CSV is a highly memory efficient, flexible and extendable open-source CSV import/export library.

useGoodby\CSV\Import\Standard\Lexer;
useGoodby\CSV\Import\Standard\Interpreter;
useGoodby\CSV\Import\Standard\LexerConfig;
$lexer = newLexer(newLexerConfig());
$interpreter = newInterpreter();
$interpreter->addObserver(function(array$row) {
// do something here.// for example, insert $row to database.
});
$lexer->parse('data.csv', $interpreter);

Features

1. Memory Management Free

This library was designed for low memory usage. It will not accumulate all the rows in the memory. The importer reads a CSV file and executes a callback function line by line.

2. Multibyte support

This library supports mulitbyte input/output: for example, SJIS-win, EUC-JP and UTF-8.

3. Ready to Use for Enterprise Applications

Goodby CSV is fully unit-tested. The library is stable and ready to be used in large projects like enterprise applications.

Requirements

• PHP 5.3.2 or later
• mbstring

Installation

Install composer in your project:

curl -s http://getcomposer.org/installer | php

Create a composer.json file in your project root:

{
"require": {
"goodby/csv": "*"
}
}

Install via composer:

php composer.phar install

Documentation

Configuration

Import configuration:

useGoodby\CSV\Import\Standard\LexerConfig;
$config = newLexerConfig();
$config
->setDelimiter("\t") // Customize delimiter. Default value is comma(,)
->setEnclosure("'") // Customize enclosure. Default value is double quotation(")
->setEscape("\\") // Customize escape character. Default value is backslash(\)
->setToCharset('UTF-8') // Customize target encoding. Default value is null, no converting.
->setFromCharset('SJIS-win') // Customize CSV file encoding. Default value is null.
;

Export configuration:

useGoodby\CSV\Export\Standard\ExporterConfig;
$config = newExporterConfig();
$config
->setDelimiter("\t") // Customize delimiter. Default value is comma(,)
->setEnclosure("'") // Customize enclosure. Default value is double quotation(")
->setEscape("\\") // Customize escape character. Default value is backslash(\)
->setToCharset('SJIS-win') // Customize file encoding. Default value is null, no converting.
->setFromCharset('UTF-8') // Customize source encoding. Default value is null.
->setFileMode(CsvFileObject::FILE_MODE_WRITE) // Customize file mode and choose either write or append. Default value is write ('w'). See fopen() php docs
;

Unstrict Row Consistency Mode

By default, Goodby CSV throws StrictViolationException when it finds a row with a different column count to other columns. In the case you want to import such a CSV, you can call Interpreter::unstrict() to disable row consistency check at import.

rough.csv:

foo,bar,bazfoo,bar
foo
foo,bar,baz

useGoodby\CSV\Import\Standard\Interpreter;
useGoodby\CSV\Import\Standard\Lexer;
useGoodby\CSV\Import\Standard\LexerConfig;
$interpreter = newInterpreter();
$interpreter->unstrict(); // Ignore row column count consistency$lexer = newLexer(newLexerConfig());
$lexer->parse('rough.csv', $interpreter);

Examples

Import to Database via PDO

user.csv:

1,alice,alice@example.com2,bob,bob@example.com3,carol,carol@eample.com

useGoodby\CSV\Import\Standard\Lexer;
useGoodby\CSV\Import\Standard\Interpreter;
useGoodby\CSV\Import\Standard\LexerConfig;
$pdo = newPDO('mysql:host=localhost;dbname=test', 'root', 'root');
$pdo->query('CREATE TABLE IF NOT EXISTS user (id INT, `name` VARCHAR(255), email VARCHAR(255))');
$config = newLexerConfig();
$lexer = newLexer($config);
$interpreter = newInterpreter();
$interpreter->addObserver(function(array$columns) use ($pdo) {
$stmt = $pdo->prepare('INSERT INTO user (id, name, email) VALUES (?, ?, ?)');
$stmt->execute($columns);
});
$lexer->parse('user.csv', $interpreter);

Import from TSV (tab separated values) to array

temperature.tsv:

9Tokyo27	Singapore
-5	Seoul
7	Shanghai

useGoodby\CSV\Import\Standard\Lexer;
useGoodby\CSV\Import\Standard\Interpreter;
useGoodby\CSV\Import\Standard\LexerConfig;
$temperature = array();
$config = newLexerConfig();
$config->setDelimiter("\t");
$lexer = newLexer($config);
$interpreter = newInterpreter();
$interpreter->addObserver(function(array$row) use (&$temperature) {
$temperature[] = array(
'temperature' => $row[0],
'city' => $row[1],
);
});
$lexer->parse('temperature.tsv', $interpreter);
print_r($temperature);

Export from array

useGoodby\CSV\Export\Standard\Exporter;
useGoodby\CSV\Export\Standard\ExporterConfig;
$config = newExporterConfig();
$exporter = newExporter($config);
$exporter->export('php://output', array(
array('1', 'alice', 'alice@example.com'),
array('2', 'bob', 'bob@example.com'),
array('3', 'carol', 'carol@example.com'),
));

Export from database via PDO

useGoodby\CSV\Export\Standard\Exporter;
useGoodby\CSV\Export\Standard\ExporterConfig;
useGoodby\CSV\Export\Standard\CsvFileObject;
useGoodby\CSV\Export\Standard\Collection\PdoCollection;
$pdo = newPDO('mysql:host=localhost;dbname=test', 'root', 'root');
$pdo->query('CREATE TABLE IF NOT EXISTS user (id INT, `name` VARCHAR(255), email VARCHAR(255))');
$pdo->query("INSERT INTO user VALUES(1, 'alice', 'alice@example.com')");
$pdo->query("INSERT INTO user VALUES(2, 'bob', 'bob@example.com')");
$pdo->query("INSERT INTO user VALUES(3, 'carol', 'carol@example.com')");
$config = newExporterConfig();
$exporter = newExporter($config);
$stmt = $pdo->prepare("SELECT * FROM user");
$stmt->execute();
$exporter->export('php://output', newPdoCollection($stmt));

Export with CallbackCollection

useGoodby\CSV\Export\Standard\Exporter;
useGoodby\CSV\Export\Standard\ExporterConfig;
useGoodby\CSV\Export\Standard\Collection\CallbackCollection;
$data = array();
$data[] = array('user', 'name1');
$data[] = array('user', 'name2');
$data[] = array('user', 'name3');
$collection = newCallbackCollection($data, function($row) {
// apply custom format to the row$row[1] = $row[1] . '!';
return$row;
});
$config = newExporterConfig();
$exporter = newExporter($config);
$exporter->export('php://stdout', $collection);

Export in Symfony2 action

namespaceAcmeBundle\ExampleBundle\Controller;
useSymfony\Bundle\FrameworkBundle\Controller\Controller;
useSymfony\Component\HttpFoundation\StreamedResponse;
class DefaultController extends Controller
{
publicfunctioncsvExportAction()
{
$conn = $this->get('database_connection');
$stmt = $conn->prepare('SELECT * FROM somewhere');
$stmt->execute();
$response = newStreamedResponse();
$response->setStatusCode(200);
$response->headers->set('Content-Type', 'text/csv');
$response->setCallback(function() use($stmt) {
$config = newExporterConfig();
$exporter = newExporter($config);
$exporter->export('php://output', newPdoCollection($stmt->getIterator()));
});
$response->send();
return$response;
}
}

License

Csv is open-sourced software licensed under the MIT License - see the LICENSE file for details

Contributing

We works under test driven development.

Checkout master source code from github:

hub clone goodby/csv

Install components via composer:

# If you don't have composer.phar
./scripts/bundle-devtools.sh .
# If you have composer.phar
composer.phar install --dev

Run phpunit:

./vendor/bin/phpunit

Acknowledgement

Credits are found within composer.json file.