intriro/csv-bundle

Integration of Goodby CSV into Symfony2

v1.1.0 2020-01-10 13:35 UTC

Requires

• php: >=7.1
• goodby/csv: ^1.1
• symfony/framework-bundle: ^4.0 || ^5.0

Requires (Dev)

• phpunit/phpunit: ^6.0
• symfony/phpunit-bridge: ^2.7 || ^3.0 || ^4.0

MIT

• alsar

• symfony
• csv
• bundle
• goodby csv

README

Provides integration of the goodby/csv library into Symfony.

About Goodby CSV

Goodby CSV is a high memory efficient flexible and extendable open-source CSV import/export library for PHP.

Documentation is available here.

Installation

This bundle can be installed using composer by adding the following in the require section of your composer.json file:

{
    "require": {
        "intriro/csv-bundle": "^1.0"
    }
}

Register the bundle

You must register the bundle in your kernel:

<?php

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(

        // ...

        new Intriro\Bundle\CsvBundle\IntriroCsvBundle(),
    );

    // ...
}

Configuration

TODO

Configuring importers

# app/config/config.yml
intriro_csv:
    importers:
        foo: ~  # uses the default configuration

        bar:
            delimiter: "\t"         # Customize delimiter. Default value is comma(,)
            enclosure: "'"          # Customize enclosure. Default value is double quotation(")
            escape: "\\"            # Customize escape character. Default value is backslash(\)
            to_charset: UTF-8       # Customize target encoding. Default value is null, no converting.
            from_charset: SJIS-win  # Customize CSV file encoding. Default value is null.

Importers are ment to get data from a CSV file into your PHP code. The defined importers from the sample configuration are available as services in the container as intriro_csv.importer.foo and intriro_csv.importer.bar.

The services are instances of Goodby\CSV\Import\Standard\Lexer.

Configuring exporters

# app/config/config.yml
intriro_csv:
    exporters:
        foo: ~  # uses the default configuration

        bar:
            delimiter: "\t"         # Customize delimiter. Default value is comma(,)
            enclosure: "'"          # Customize enclosure. Default value is double quotation(")
            escape: "\\"            # Customize escape character. Default value is backslash(\)
            to_charset: SJIS-win    # Customize target encoding. Default value is null, no converting.
            from_charset: UTF-8     # Customize CSV file encoding. Default value is null.
            file_mode: w            # Customize file mode and choose either write or append. Default value is write ('w'). See fopen() php docs

The defined exporters from the sample configuration are available as services in the container as intriro_csv.exporter.foo and intriro_csv.exporter.bar.

The services are instances of Goodby\CSV\Export\Standard\Exporter.

License

This bundle is released under the MIT license. See the complete license in the bundle:

src/Resources/meta/LICENSE