README

This is just a very light weight package to write to a csv file, it's basically a wrapper around fputcsv. It also handles the file's creation, opening and closing.

Installation

You can install the package via composer:

composer require yazanstash/csv

Usage

$file = YazanStash\Csv::create();
// or
$file = YazanStash\Csv::create('/home/stash/Desktop/export.csv');

$file->delimiter('|')->enclosure("'")->write(['Hola Amigo!']);

You can choose between providing a file path and name to the create() method or letting it generate one, by default the generated file is located at /tmp/{random-file-name}.csv.
Caution: If the file already exists, the package will overwrite it.

Customizing the write parameters

To customize the parameters of writing, you have 3 dynamic methods available at your disposal, delimiter(), enclosure() and escapeCharacter(). Passing an argument will change the value, and calling the method without it will give you the current value of it. In the case of overwriting the value, it will give you back the object for those sick chains ;)

Writing to file

Use the write() method to write new lines to the file, the method expects an array of values to be written.
each call to write() will create a new line.

Getting the file path back

To get the written file path back, just call filePath() on the instance.

Manually closing the file

If you need to close the file manually for some reason (the package automatically does that upon destructing the instance), you can call closeFile() on the instance.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

yazanstash / csv

Maintainers

Details